Documentation

Google_Service_Dfareporting_OrderDocument 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.
$accountId  : mixed
$advertiserId  : mixed
$amendedOrderDocumentId  : mixed
$approvedByUserProfileIds  : mixed
$cancelled  : mixed
$effectiveDate  : mixed
$id  : mixed
$kind  : mixed
$lastSentRecipients  : mixed
$lastSentTime  : mixed
$orderId  : mixed
$projectId  : mixed
$signed  : mixed
$subaccountId  : mixed
$title  : mixed
$type  : mixed
$collection_key  : mixed
$createdInfoDataType  : mixed
$createdInfoType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : 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
getAccountId()  : mixed
getAdvertiserId()  : mixed
getAmendedOrderDocumentId()  : mixed
getApprovedByUserProfileIds()  : mixed
getCancelled()  : mixed
getCreatedInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getEffectiveDate()  : mixed
getId()  : mixed
getKind()  : mixed
getLastSentRecipients()  : mixed
getLastSentTime()  : mixed
getOrderId()  : mixed
getProjectId()  : mixed
getSigned()  : mixed
getSubaccountId()  : mixed
getTitle()  : mixed
getType()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAccountId()  : mixed
setAdvertiserId()  : mixed
setAmendedOrderDocumentId()  : mixed
setApprovedByUserProfileIds()  : mixed
setCancelled()  : mixed
setCreatedInfo()  : mixed
setEffectiveDate()  : mixed
setId()  : mixed
setKind()  : mixed
setLastSentRecipients()  : mixed
setLastSentTime()  : mixed
setOrderId()  : mixed
setProjectId()  : mixed
setSigned()  : mixed
setSubaccountId()  : mixed
setTitle()  : mixed
setType()  : 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

$amendedOrderDocumentId

public mixed $amendedOrderDocumentId

$approvedByUserProfileIds

public mixed $approvedByUserProfileIds

$collection_key

protected mixed $collection_key = 'lastSentRecipients'

$createdInfoDataType

protected mixed $createdInfoDataType = ''

$createdInfoType

protected mixed $createdInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

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 —

getAccountId()

public getAccountId() : mixed
Return values
mixed —

getAdvertiserId()

public getAdvertiserId() : mixed
Return values
mixed —

getAmendedOrderDocumentId()

public getAmendedOrderDocumentId() : mixed
Return values
mixed —

getApprovedByUserProfileIds()

public getApprovedByUserProfileIds() : mixed
Return values
mixed —

getCancelled()

public getCancelled() : mixed
Return values
mixed —

getEffectiveDate()

public getEffectiveDate() : mixed
Return values
mixed —

getLastSentRecipients()

public getLastSentRecipients() : mixed
Return values
mixed —

getLastSentTime()

public getLastSentTime() : mixed
Return values
mixed —

getOrderId()

public getOrderId() : mixed
Return values
mixed —

getProjectId()

public getProjectId() : mixed
Return values
mixed —

getSigned()

public getSigned() : mixed
Return values
mixed —

getSubaccountId()

public getSubaccountId() : mixed
Return values
mixed —

getTitle()

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

setAccountId()

public setAccountId(mixed $accountId) : mixed
Parameters
$accountId : mixed
Return values
mixed —

setAdvertiserId()

public setAdvertiserId(mixed $advertiserId) : mixed
Parameters
$advertiserId : mixed
Return values
mixed —

setAmendedOrderDocumentId()

public setAmendedOrderDocumentId(mixed $amendedOrderDocumentId) : mixed
Parameters
$amendedOrderDocumentId : mixed
Return values
mixed —

setApprovedByUserProfileIds()

public setApprovedByUserProfileIds(mixed $approvedByUserProfileIds) : mixed
Parameters
$approvedByUserProfileIds : mixed
Return values
mixed —

setCancelled()

public setCancelled(mixed $cancelled) : mixed
Parameters
$cancelled : mixed
Return values
mixed —

setEffectiveDate()

public setEffectiveDate(mixed $effectiveDate) : mixed
Parameters
$effectiveDate : 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 —

setLastSentRecipients()

public setLastSentRecipients(mixed $lastSentRecipients) : mixed
Parameters
$lastSentRecipients : mixed
Return values
mixed —

setLastSentTime()

public setLastSentTime(mixed $lastSentTime) : mixed
Parameters
$lastSentTime : mixed
Return values
mixed —

setOrderId()

public setOrderId(mixed $orderId) : mixed
Parameters
$orderId : mixed
Return values
mixed —

setProjectId()

public setProjectId(mixed $projectId) : mixed
Parameters
$projectId : mixed
Return values
mixed —

setSigned()

public setSigned(mixed $signed) : mixed
Parameters
$signed : mixed
Return values
mixed —

setSubaccountId()

public setSubaccountId(mixed $subaccountId) : mixed
Parameters
$subaccountId : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : mixed
Return values
mixed —

setType()

public setType(mixed $type) : mixed
Parameters
$type : 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