Documentation

Google_Service_Partners_HistoricalOffer extends Google_Model
in package

This class defines attributes, valid values, and usage which is generated from a given json schema.

http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5

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.
$adwordsUrl  : mixed
$clientEmail  : mixed
$clientId  : mixed
$clientName  : mixed
$creationTime  : mixed
$expirationTime  : mixed
$lastModifiedTime  : mixed
$offerCode  : mixed
$offerCountryCode  : mixed
$offerType  : mixed
$senderName  : mixed
$status  : 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.
getAdwordsUrl()  : mixed
getClientEmail()  : mixed
getClientId()  : mixed
getClientName()  : mixed
getCreationTime()  : mixed
getExpirationTime()  : mixed
getLastModifiedTime()  : mixed
getOfferCode()  : mixed
getOfferCountryCode()  : mixed
getOfferType()  : mixed
getSenderName()  : mixed
getStatus()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setAdwordsUrl()  : mixed
setClientEmail()  : mixed
setClientId()  : mixed
setClientName()  : mixed
setCreationTime()  : mixed
setExpirationTime()  : mixed
setLastModifiedTime()  : mixed
setOfferCode()  : mixed
setOfferCountryCode()  : mixed
setOfferType()  : mixed
setSenderName()  : mixed
setStatus()  : 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.
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
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

$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 —

getAdwordsUrl()

public getAdwordsUrl() : mixed
Return values
mixed —

getClientEmail()

public getClientEmail() : mixed
Return values
mixed —

getClientName()

public getClientName() : mixed
Return values
mixed —

getCreationTime()

public getCreationTime() : mixed
Return values
mixed —

getExpirationTime()

public getExpirationTime() : mixed
Return values
mixed —

getLastModifiedTime()

public getLastModifiedTime() : mixed
Return values
mixed —

getOfferCode()

public getOfferCode() : mixed
Return values
mixed —

getOfferCountryCode()

public getOfferCountryCode() : mixed
Return values
mixed —

getOfferType()

public getOfferType() : mixed
Return values
mixed —

getSenderName()

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

setAdwordsUrl()

public setAdwordsUrl(mixed $adwordsUrl) : mixed
Parameters
$adwordsUrl : mixed
Return values
mixed —

setClientEmail()

public setClientEmail(mixed $clientEmail) : mixed
Parameters
$clientEmail : mixed
Return values
mixed —

setClientId()

public setClientId(mixed $clientId) : mixed
Parameters
$clientId : mixed
Return values
mixed —

setClientName()

public setClientName(mixed $clientName) : mixed
Parameters
$clientName : mixed
Return values
mixed —

setCreationTime()

public setCreationTime(mixed $creationTime) : mixed
Parameters
$creationTime : mixed
Return values
mixed —

setExpirationTime()

public setExpirationTime(mixed $expirationTime) : mixed
Parameters
$expirationTime : mixed
Return values
mixed —

setLastModifiedTime()

public setLastModifiedTime(mixed $lastModifiedTime) : mixed
Parameters
$lastModifiedTime : mixed
Return values
mixed —

setOfferCode()

public setOfferCode(mixed $offerCode) : mixed
Parameters
$offerCode : mixed
Return values
mixed —

setOfferCountryCode()

public setOfferCountryCode(mixed $offerCountryCode) : mixed
Parameters
$offerCountryCode : mixed
Return values
mixed —

setOfferType()

public setOfferType(mixed $offerType) : mixed
Parameters
$offerType : mixed
Return values
mixed —

setSenderName()

public setSenderName(mixed $senderName) : mixed
Parameters
$senderName : mixed
Return values
mixed —

setStatus()

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

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 —

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