Documentation

Google_Service_ShoppingContent_OrderShipment extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$carrier  : mixed
$creationDate  : mixed
$deliveryDate  : mixed
$id  : mixed
$shipmentGroupId  : mixed
$status  : mixed
$trackingId  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$lineItemsDataType  : mixed
$lineItemsType  : mixed
$modelData  : mixed
$processed  : mixed
$scheduledDeliveryDetailsDataType  : mixed
$scheduledDeliveryDetailsType  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getCarrier()  : mixed
getCreationDate()  : mixed
getDeliveryDate()  : mixed
getId()  : mixed
getLineItems()  : Google_Service_ShoppingContent_OrderShipmentLineItemShipment
getScheduledDeliveryDetails()  : Google_Service_ShoppingContent_OrderShipmentScheduledDeliveryDetails
getShipmentGroupId()  : mixed
getStatus()  : mixed
getTrackingId()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCarrier()  : mixed
setCreationDate()  : mixed
setDeliveryDate()  : mixed
setId()  : mixed
setLineItems()  : mixed
setScheduledDeliveryDetails()  : mixed
setShipmentGroupId()  : mixed
setStatus()  : mixed
setTrackingId()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$collection_key

protected mixed $collection_key = 'lineItems'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$lineItemsDataType

protected mixed $lineItemsDataType = 'array'

$lineItemsType

protected mixed $lineItemsType = 'Google_Service_ShoppingContent_OrderShipmentLineItemShipment'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$scheduledDeliveryDetailsDataType

protected mixed $scheduledDeliveryDetailsDataType = ''

$scheduledDeliveryDetailsType

protected mixed $scheduledDeliveryDetailsType = 'Google_Service_ShoppingContent_OrderShipmentScheduledDeliveryDetails'

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getCarrier()

public getCarrier() : mixed
Return values
mixed —

getCreationDate()

public getCreationDate() : mixed
Return values
mixed —

getDeliveryDate()

public getDeliveryDate() : mixed
Return values
mixed —

getShipmentGroupId()

public getShipmentGroupId() : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

getTrackingId()

public getTrackingId() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setCarrier()

public setCarrier(mixed $carrier) : mixed
Parameters
$carrier : mixed
Return values
mixed —

setCreationDate()

public setCreationDate(mixed $creationDate) : mixed
Parameters
$creationDate : mixed
Return values
mixed —

setDeliveryDate()

public setDeliveryDate(mixed $deliveryDate) : mixed
Parameters
$deliveryDate : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

setLineItems()

public setLineItems(mixed $lineItems) : mixed
Parameters
$lineItems : mixed
Return values
mixed —

setShipmentGroupId()

public setShipmentGroupId(mixed $shipmentGroupId) : mixed
Parameters
$shipmentGroupId : mixed
Return values
mixed —

setStatus()

public setStatus(mixed $status) : mixed
Parameters
$status : mixed
Return values
mixed —

setTrackingId()

public setTrackingId(mixed $trackingId) : mixed
Parameters
$trackingId : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results