Documentation

Google_Service_ShoppingContent_Order 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.
$acknowledged  : mixed
$id  : mixed
$kind  : mixed
$merchantId  : mixed
$merchantOrderId  : mixed
$paymentStatus  : mixed
$placedDate  : mixed
$status  : mixed
$taxCollector  : mixed
$annotationsDataType  : mixed
$annotationsType  : mixed
$billingAddressDataType  : mixed
$billingAddressType  : mixed
$collection_key  : mixed
$customerDataType  : mixed
$customerType  : mixed
$deliveryDetailsDataType  : mixed
$deliveryDetailsType  : mixed
$internal_gapi_mappings  : mixed
$lineItemsDataType  : mixed
$lineItemsType  : mixed
$modelData  : mixed
$netPriceAmountDataType  : mixed
$netPriceAmountType  : mixed
$netTaxAmountDataType  : mixed
$netTaxAmountType  : mixed
$pickupDetailsDataType  : mixed
$pickupDetailsType  : mixed
$processed  : mixed
$promotionsDataType  : mixed
$promotionsType  : mixed
$refundsDataType  : mixed
$refundsType  : mixed
$shipmentsDataType  : mixed
$shipmentsType  : mixed
$shippingCostDataType  : mixed
$shippingCostTaxDataType  : mixed
$shippingCostTaxType  : mixed
$shippingCostType  : 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
getAcknowledged()  : mixed
getAnnotations()  : Google_Service_ShoppingContent_OrderOrderAnnotation
getBillingAddress()  : Google_Service_ShoppingContent_OrderAddress
getCustomer()  : Google_Service_ShoppingContent_OrderCustomer
getDeliveryDetails()  : Google_Service_ShoppingContent_OrderDeliveryDetails
getId()  : mixed
getKind()  : mixed
getLineItems()  : Google_Service_ShoppingContent_OrderLineItem
getMerchantId()  : mixed
getMerchantOrderId()  : mixed
getNetPriceAmount()  : Google_Service_ShoppingContent_Price
getNetTaxAmount()  : Google_Service_ShoppingContent_Price
getPaymentStatus()  : mixed
getPickupDetails()  : Google_Service_ShoppingContent_OrderPickupDetails
getPlacedDate()  : mixed
getPromotions()  : Google_Service_ShoppingContent_OrderPromotion
getRefunds()  : Google_Service_ShoppingContent_OrderRefund
getShipments()  : Google_Service_ShoppingContent_OrderShipment
getShippingCost()  : Google_Service_ShoppingContent_Price
getShippingCostTax()  : Google_Service_ShoppingContent_Price
getStatus()  : mixed
getTaxCollector()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAcknowledged()  : mixed
setAnnotations()  : mixed
setBillingAddress()  : mixed
setCustomer()  : mixed
setDeliveryDetails()  : mixed
setId()  : mixed
setKind()  : mixed
setLineItems()  : mixed
setMerchantId()  : mixed
setMerchantOrderId()  : mixed
setNetPriceAmount()  : mixed
setNetTaxAmount()  : mixed
setPaymentStatus()  : mixed
setPickupDetails()  : mixed
setPlacedDate()  : mixed
setPromotions()  : mixed
setRefunds()  : mixed
setShipments()  : mixed
setShippingCost()  : mixed
setShippingCostTax()  : mixed
setStatus()  : mixed
setTaxCollector()  : 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

$acknowledged

public mixed $acknowledged

$merchantId

public mixed $merchantId

$merchantOrderId

public mixed $merchantOrderId

$paymentStatus

public mixed $paymentStatus

$placedDate

public mixed $placedDate

$status

public mixed $status

$taxCollector

public mixed $taxCollector

$annotationsDataType

protected mixed $annotationsDataType = 'array'

$annotationsType

protected mixed $annotationsType = 'Google_Service_ShoppingContent_OrderOrderAnnotation'

$billingAddressDataType

protected mixed $billingAddressDataType = ''

$billingAddressType

protected mixed $billingAddressType = 'Google_Service_ShoppingContent_OrderAddress'

$collection_key

protected mixed $collection_key = 'shipments'

$customerDataType

protected mixed $customerDataType = ''

$customerType

protected mixed $customerType = 'Google_Service_ShoppingContent_OrderCustomer'

$deliveryDetailsDataType

protected mixed $deliveryDetailsDataType = ''

$deliveryDetailsType

protected mixed $deliveryDetailsType = 'Google_Service_ShoppingContent_OrderDeliveryDetails'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$lineItemsDataType

protected mixed $lineItemsDataType = 'array'

$lineItemsType

protected mixed $lineItemsType = 'Google_Service_ShoppingContent_OrderLineItem'

$modelData

protected mixed $modelData = array()

$netPriceAmountDataType

protected mixed $netPriceAmountDataType = ''

$netPriceAmountType

protected mixed $netPriceAmountType = 'Google_Service_ShoppingContent_Price'

$netTaxAmountDataType

protected mixed $netTaxAmountDataType = ''

$netTaxAmountType

protected mixed $netTaxAmountType = 'Google_Service_ShoppingContent_Price'

$pickupDetailsDataType

protected mixed $pickupDetailsDataType = ''

$pickupDetailsType

protected mixed $pickupDetailsType = 'Google_Service_ShoppingContent_OrderPickupDetails'

$processed

protected mixed $processed = array()

$promotionsDataType

protected mixed $promotionsDataType = 'array'

$promotionsType

protected mixed $promotionsType = 'Google_Service_ShoppingContent_OrderPromotion'

$refundsDataType

protected mixed $refundsDataType = 'array'

$refundsType

protected mixed $refundsType = 'Google_Service_ShoppingContent_OrderRefund'

$shipmentsDataType

protected mixed $shipmentsDataType = 'array'

$shipmentsType

protected mixed $shipmentsType = 'Google_Service_ShoppingContent_OrderShipment'

$shippingCostDataType

protected mixed $shippingCostDataType = ''

$shippingCostTaxDataType

protected mixed $shippingCostTaxDataType = ''

$shippingCostTaxType

protected mixed $shippingCostTaxType = 'Google_Service_ShoppingContent_Price'

$shippingCostType

protected mixed $shippingCostType = '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 —

getAcknowledged()

public getAcknowledged() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getMerchantId()

public getMerchantId() : mixed
Return values
mixed —

getMerchantOrderId()

public getMerchantOrderId() : mixed
Return values
mixed —

getPaymentStatus()

public getPaymentStatus() : mixed
Return values
mixed —

getPlacedDate()

public getPlacedDate() : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

getTaxCollector()

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

setAcknowledged()

public setAcknowledged(mixed $acknowledged) : mixed
Parameters
$acknowledged : mixed
Return values
mixed —

setAnnotations()

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

setId()

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

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed
Return values
mixed —

setLineItems()

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

setMerchantId()

public setMerchantId(mixed $merchantId) : mixed
Parameters
$merchantId : mixed
Return values
mixed —

setMerchantOrderId()

public setMerchantOrderId(mixed $merchantOrderId) : mixed
Parameters
$merchantOrderId : mixed
Return values
mixed —

setPaymentStatus()

public setPaymentStatus(mixed $paymentStatus) : mixed
Parameters
$paymentStatus : mixed
Return values
mixed —

setPlacedDate()

public setPlacedDate(mixed $placedDate) : mixed
Parameters
$placedDate : mixed
Return values
mixed —

setPromotions()

public setPromotions(mixed $promotions) : mixed
Parameters
$promotions : mixed
Return values
mixed —

setRefunds()

public setRefunds(mixed $refunds) : mixed
Parameters
$refunds : mixed
Return values
mixed —

setShipments()

public setShipments(mixed $shipments) : mixed
Parameters
$shipments : mixed
Return values
mixed —

setStatus()

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

setTaxCollector()

public setTaxCollector(mixed $taxCollector) : mixed
Parameters
$taxCollector : 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