Documentation

Google_Service_PostmasterTools_TrafficStats 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.
$dkimSuccessRatio  : mixed
$dmarcSuccessRatio  : mixed
$domainReputation  : mixed
$inboundEncryptionRatio  : mixed
$name  : mixed
$outboundEncryptionRatio  : mixed
$spfSuccessRatio  : mixed
$userReportedSpamRatio  : mixed
$collection_key  : mixed
$deliveryErrorsDataType  : mixed
$deliveryErrorsType  : mixed
$internal_gapi_mappings  : mixed
$ipReputationsDataType  : mixed
$ipReputationsType  : mixed
$modelData  : mixed
$processed  : mixed
$spammyFeedbackLoopsDataType  : mixed
$spammyFeedbackLoopsType  : 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
getDeliveryErrors()  : Google_Service_PostmasterTools_DeliveryError
getDkimSuccessRatio()  : mixed
getDmarcSuccessRatio()  : mixed
getDomainReputation()  : mixed
getInboundEncryptionRatio()  : mixed
getIpReputations()  : Google_Service_PostmasterTools_IpReputation
getName()  : mixed
getOutboundEncryptionRatio()  : mixed
getSpammyFeedbackLoops()  : Google_Service_PostmasterTools_FeedbackLoop
getSpfSuccessRatio()  : mixed
getUserReportedSpamRatio()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setDeliveryErrors()  : mixed
setDkimSuccessRatio()  : mixed
setDmarcSuccessRatio()  : mixed
setDomainReputation()  : mixed
setInboundEncryptionRatio()  : mixed
setIpReputations()  : mixed
setName()  : mixed
setOutboundEncryptionRatio()  : mixed
setSpammyFeedbackLoops()  : mixed
setSpfSuccessRatio()  : mixed
setUserReportedSpamRatio()  : 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

$inboundEncryptionRatio

public mixed $inboundEncryptionRatio

$outboundEncryptionRatio

public mixed $outboundEncryptionRatio

$userReportedSpamRatio

public mixed $userReportedSpamRatio

$collection_key

protected mixed $collection_key = 'spammyFeedbackLoops'

$deliveryErrorsDataType

protected mixed $deliveryErrorsDataType = 'array'

$deliveryErrorsType

protected mixed $deliveryErrorsType = 'Google_Service_PostmasterTools_DeliveryError'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$ipReputationsDataType

protected mixed $ipReputationsDataType = 'array'

$ipReputationsType

protected mixed $ipReputationsType = 'Google_Service_PostmasterTools_IpReputation'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$spammyFeedbackLoopsDataType

protected mixed $spammyFeedbackLoopsDataType = 'array'

$spammyFeedbackLoopsType

protected mixed $spammyFeedbackLoopsType = 'Google_Service_PostmasterTools_FeedbackLoop'

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 —

getDkimSuccessRatio()

public getDkimSuccessRatio() : mixed
Return values
mixed —

getDmarcSuccessRatio()

public getDmarcSuccessRatio() : mixed
Return values
mixed —

getDomainReputation()

public getDomainReputation() : mixed
Return values
mixed —

getInboundEncryptionRatio()

public getInboundEncryptionRatio() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getOutboundEncryptionRatio()

public getOutboundEncryptionRatio() : mixed
Return values
mixed —

getSpfSuccessRatio()

public getSpfSuccessRatio() : mixed
Return values
mixed —

getUserReportedSpamRatio()

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

setDeliveryErrors()

public setDeliveryErrors(mixed $deliveryErrors) : mixed
Parameters
$deliveryErrors : mixed
Return values
mixed —

setDkimSuccessRatio()

public setDkimSuccessRatio(mixed $dkimSuccessRatio) : mixed
Parameters
$dkimSuccessRatio : mixed
Return values
mixed —

setDmarcSuccessRatio()

public setDmarcSuccessRatio(mixed $dmarcSuccessRatio) : mixed
Parameters
$dmarcSuccessRatio : mixed
Return values
mixed —

setDomainReputation()

public setDomainReputation(mixed $domainReputation) : mixed
Parameters
$domainReputation : mixed
Return values
mixed —

setInboundEncryptionRatio()

public setInboundEncryptionRatio(mixed $inboundEncryptionRatio) : mixed
Parameters
$inboundEncryptionRatio : mixed
Return values
mixed —

setIpReputations()

public setIpReputations(mixed $ipReputations) : mixed
Parameters
$ipReputations : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

setOutboundEncryptionRatio()

public setOutboundEncryptionRatio(mixed $outboundEncryptionRatio) : mixed
Parameters
$outboundEncryptionRatio : mixed
Return values
mixed —

setSpammyFeedbackLoops()

public setSpammyFeedbackLoops(mixed $spammyFeedbackLoops) : mixed
Parameters
$spammyFeedbackLoops : mixed
Return values
mixed —

setSpfSuccessRatio()

public setSpfSuccessRatio(mixed $spfSuccessRatio) : mixed
Parameters
$spfSuccessRatio : mixed
Return values
mixed —

setUserReportedSpamRatio()

public setUserReportedSpamRatio(mixed $userReportedSpamRatio) : mixed
Parameters
$userReportedSpamRatio : 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