Documentation

Google_Service_ShoppingContent_OrderLineItem 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.
$id  : mixed
$quantityCanceled  : mixed
$quantityDelivered  : mixed
$quantityOrdered  : mixed
$quantityPending  : mixed
$quantityReadyForPickup  : mixed
$quantityReturned  : mixed
$quantityShipped  : mixed
$quantityUndeliverable  : mixed
$adjustmentsDataType  : mixed
$adjustmentsType  : mixed
$annotationsDataType  : mixed
$annotationsType  : mixed
$cancellationsDataType  : mixed
$cancellationsType  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$priceDataType  : mixed
$priceType  : mixed
$processed  : mixed
$productDataType  : mixed
$productType  : mixed
$returnInfoDataType  : mixed
$returnInfoType  : mixed
$returnsDataType  : mixed
$returnsType  : mixed
$shippingDetailsDataType  : mixed
$shippingDetailsType  : mixed
$taxDataType  : mixed
$taxType  : 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
getAdjustments()  : Google_Service_ShoppingContent_OrderLineItemAdjustment
getAnnotations()  : Google_Service_ShoppingContent_OrderMerchantProvidedAnnotation
getCancellations()  : Google_Service_ShoppingContent_OrderCancellation
getId()  : mixed
getPrice()  : Google_Service_ShoppingContent_Price
getProduct()  : Google_Service_ShoppingContent_OrderLineItemProduct
getQuantityCanceled()  : mixed
getQuantityDelivered()  : mixed
getQuantityOrdered()  : mixed
getQuantityPending()  : mixed
getQuantityReadyForPickup()  : mixed
getQuantityReturned()  : mixed
getQuantityShipped()  : mixed
getQuantityUndeliverable()  : mixed
getReturnInfo()  : Google_Service_ShoppingContent_OrderLineItemReturnInfo
getReturns()  : Google_Service_ShoppingContent_OrderReturn
getShippingDetails()  : Google_Service_ShoppingContent_OrderLineItemShippingDetails
getTax()  : Google_Service_ShoppingContent_Price
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAdjustments()  : mixed
setAnnotations()  : mixed
setCancellations()  : mixed
setId()  : mixed
setPrice()  : mixed
setProduct()  : mixed
setQuantityCanceled()  : mixed
setQuantityDelivered()  : mixed
setQuantityOrdered()  : mixed
setQuantityPending()  : mixed
setQuantityReadyForPickup()  : mixed
setQuantityReturned()  : mixed
setQuantityShipped()  : mixed
setQuantityUndeliverable()  : mixed
setReturnInfo()  : mixed
setReturns()  : mixed
setShippingDetails()  : mixed
setTax()  : 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

$quantityReadyForPickup

public mixed $quantityReadyForPickup

$adjustmentsDataType

protected mixed $adjustmentsDataType = 'array'

$adjustmentsType

protected mixed $adjustmentsType = 'Google_Service_ShoppingContent_OrderLineItemAdjustment'

$annotationsDataType

protected mixed $annotationsDataType = 'array'

$annotationsType

protected mixed $annotationsType = 'Google_Service_ShoppingContent_OrderMerchantProvidedAnnotation'

$cancellationsDataType

protected mixed $cancellationsDataType = 'array'

$cancellationsType

protected mixed $cancellationsType = 'Google_Service_ShoppingContent_OrderCancellation'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$priceType

protected mixed $priceType = 'Google_Service_ShoppingContent_Price'

$processed

protected mixed $processed = array()

$productType

protected mixed $productType = 'Google_Service_ShoppingContent_OrderLineItemProduct'

$returnInfoDataType

protected mixed $returnInfoDataType = ''

$returnInfoType

protected mixed $returnInfoType = 'Google_Service_ShoppingContent_OrderLineItemReturnInfo'

$returnsType

protected mixed $returnsType = 'Google_Service_ShoppingContent_OrderReturn'

$shippingDetailsDataType

protected mixed $shippingDetailsDataType = ''

$shippingDetailsType

protected mixed $shippingDetailsType = 'Google_Service_ShoppingContent_OrderLineItemShippingDetails'

$taxType

protected mixed $taxType = 'Google_Service_ShoppingContent_Price'

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 —

getQuantityCanceled()

public getQuantityCanceled() : mixed
Return values
mixed —

getQuantityDelivered()

public getQuantityDelivered() : mixed
Return values
mixed —

getQuantityOrdered()

public getQuantityOrdered() : mixed
Return values
mixed —

getQuantityPending()

public getQuantityPending() : mixed
Return values
mixed —

getQuantityReadyForPickup()

public getQuantityReadyForPickup() : mixed
Return values
mixed —

getQuantityReturned()

public getQuantityReturned() : mixed
Return values
mixed —

getQuantityShipped()

public getQuantityShipped() : mixed
Return values
mixed —

getQuantityUndeliverable()

public getQuantityUndeliverable() : 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 —

setAdjustments()

public setAdjustments(mixed $adjustments) : mixed
Parameters
$adjustments : mixed
Return values
mixed —

setAnnotations()

public setAnnotations(mixed $annotations) : mixed
Parameters
$annotations : mixed
Return values
mixed —

setCancellations()

public setCancellations(mixed $cancellations) : mixed
Parameters
$cancellations : mixed
Return values
mixed —

setId()

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

setQuantityCanceled()

public setQuantityCanceled(mixed $quantityCanceled) : mixed
Parameters
$quantityCanceled : mixed
Return values
mixed —

setQuantityDelivered()

public setQuantityDelivered(mixed $quantityDelivered) : mixed
Parameters
$quantityDelivered : mixed
Return values
mixed —

setQuantityOrdered()

public setQuantityOrdered(mixed $quantityOrdered) : mixed
Parameters
$quantityOrdered : mixed
Return values
mixed —

setQuantityPending()

public setQuantityPending(mixed $quantityPending) : mixed
Parameters
$quantityPending : mixed
Return values
mixed —

setQuantityReadyForPickup()

public setQuantityReadyForPickup(mixed $quantityReadyForPickup) : mixed
Parameters
$quantityReadyForPickup : mixed
Return values
mixed —

setQuantityReturned()

public setQuantityReturned(mixed $quantityReturned) : mixed
Parameters
$quantityReturned : mixed
Return values
mixed —

setQuantityShipped()

public setQuantityShipped(mixed $quantityShipped) : mixed
Parameters
$quantityShipped : mixed
Return values
mixed —

setQuantityUndeliverable()

public setQuantityUndeliverable(mixed $quantityUndeliverable) : mixed
Parameters
$quantityUndeliverable : mixed
Return values
mixed —

setReturns()

public setReturns(mixed $returns) : mixed
Parameters
$returns : 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