shipcloud PHP Client

PickupTime extends AbstractApiObject
in package

PickupTime class defines a time window when the carrier should pickup shipments.

Tags
category

Class

author

Daniel Muenter info@msltns.com

version
0.0.1
since
0.0.1
license

GPL 3 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Table of Contents

$id  : id
$required  : required
$earliest  : earliest
$latest  : latest
__construct()  : void
PickupTime constructor.
get_earliest()  : string
Getter method for earliest.
get_id()  : string|null
Getter method for id.
get_latest()  : string
Getter method for latest.
get_required_fields()  : array<string|int, mixed>
Getter method for id.
set_earliest()  : void
Setter method for earliest.
set_id()  : void
Setter method for id.
set_latest()  : void
Setter method for latest.
to_array()  : array<string|int, mixed>
Getter method for parameter array.
to_string()  : string
Getter method for string representation.

Properties

Methods

__construct()

PickupTime constructor.

public __construct(string $earliest, string $latest) : void
Parameters
$earliest : string
$latest : string
Tags
throws
ApiException
Return values
void —

get_earliest()

Getter method for earliest.

public get_earliest() : string
Return values
string —

The earliest.

get_id()

Getter method for id.

public get_id() : string|null
Return values
string|null —

The id.

get_latest()

Getter method for latest.

public get_latest() : string
Return values
string —

The latest.

get_required_fields()

Getter method for id.

public get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The id.

set_earliest()

Setter method for earliest.

public set_earliest(string $earliest) : void
Parameters
$earliest : string

The earliest to set.

Tags
throws
ApiException
Return values
void —

set_id()

Setter method for id.

public set_id(string $id) : void
Parameters
$id : string

The id to set.

Return values
void —

set_latest()

Setter method for latest.

public set_latest(string $latest) : void
Parameters
$latest : string

The latest to set.

Tags
throws
ApiException
Return values
void —

to_array()

Getter method for parameter array.

public to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The address object as array.

to_string()

Getter method for string representation.

public to_string() : string
Return values
string —

The object as string representation.

Search results