Documentation

Google_Service_Analytics_McfData 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.
$containsSampledData  : mixed
$id  : mixed
$itemsPerPage  : mixed
$kind  : mixed
$nextLink  : mixed
$previousLink  : mixed
$sampleSize  : mixed
$sampleSpace  : mixed
$selfLink  : mixed
$totalResults  : mixed
$totalsForAllResults  : mixed
$collection_key  : mixed
$columnHeadersDataType  : mixed
$columnHeadersType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$profileInfoDataType  : mixed
$profileInfoType  : mixed
$queryDataType  : mixed
$queryType  : mixed
$rowsDataType  : mixed
$rowsType  : 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
getColumnHeaders()  : Google_Service_Analytics_McfDataColumnHeaders
getContainsSampledData()  : mixed
getId()  : mixed
getItemsPerPage()  : mixed
getKind()  : mixed
getNextLink()  : mixed
getPreviousLink()  : mixed
getProfileInfo()  : Google_Service_Analytics_McfDataProfileInfo
getQuery()  : Google_Service_Analytics_McfDataQuery
getRows()  : Google_Service_Analytics_McfDataRows
getSampleSize()  : mixed
getSampleSpace()  : mixed
getSelfLink()  : mixed
getTotalResults()  : mixed
getTotalsForAllResults()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setColumnHeaders()  : mixed
setContainsSampledData()  : mixed
setId()  : mixed
setItemsPerPage()  : mixed
setKind()  : mixed
setNextLink()  : mixed
setPreviousLink()  : mixed
setProfileInfo()  : mixed
setQuery()  : mixed
setRows()  : mixed
setSampleSize()  : mixed
setSampleSpace()  : mixed
setSelfLink()  : mixed
setTotalResults()  : mixed
setTotalsForAllResults()  : 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

$containsSampledData

public mixed $containsSampledData

$itemsPerPage

public mixed $itemsPerPage

$previousLink

public mixed $previousLink

$sampleSize

public mixed $sampleSize

$sampleSpace

public mixed $sampleSpace

$totalResults

public mixed $totalResults

$totalsForAllResults

public mixed $totalsForAllResults

$collection_key

protected mixed $collection_key = 'rows'

$columnHeadersDataType

protected mixed $columnHeadersDataType = 'array'

$columnHeadersType

protected mixed $columnHeadersType = 'Google_Service_Analytics_McfDataColumnHeaders'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$profileInfoDataType

protected mixed $profileInfoDataType = ''

$profileInfoType

protected mixed $profileInfoType = 'Google_Service_Analytics_McfDataProfileInfo'

$queryDataType

protected mixed $queryDataType = ''

$queryType

protected mixed $queryType = 'Google_Service_Analytics_McfDataQuery'

$rowsDataType

protected mixed $rowsDataType = 'array'

$rowsType

protected mixed $rowsType = 'Google_Service_Analytics_McfDataRows'

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 —

getContainsSampledData()

public getContainsSampledData() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getItemsPerPage()

public getItemsPerPage() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getNextLink()

public getNextLink() : mixed
Return values
mixed —

getPreviousLink()

public getPreviousLink() : mixed
Return values
mixed —

getSampleSize()

public getSampleSize() : mixed
Return values
mixed —

getSampleSpace()

public getSampleSpace() : mixed
Return values
mixed —

getSelfLink()

public getSelfLink() : mixed
Return values
mixed —

getTotalResults()

public getTotalResults() : mixed
Return values
mixed —

getTotalsForAllResults()

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

setColumnHeaders()

public setColumnHeaders(mixed $columnHeaders) : mixed
Parameters
$columnHeaders : mixed
Return values
mixed —

setContainsSampledData()

public setContainsSampledData(mixed $containsSampledData) : mixed
Parameters
$containsSampledData : mixed
Return values
mixed —

setId()

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

setItemsPerPage()

public setItemsPerPage(mixed $itemsPerPage) : mixed
Parameters
$itemsPerPage : mixed
Return values
mixed —

setKind()

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

setNextLink()

public setNextLink(mixed $nextLink) : mixed
Parameters
$nextLink : mixed
Return values
mixed —

setPreviousLink()

public setPreviousLink(mixed $previousLink) : mixed
Parameters
$previousLink : mixed
Return values
mixed —

setRows()

public setRows(mixed $rows) : mixed
Parameters
$rows : mixed
Return values
mixed —

setSampleSize()

public setSampleSize(mixed $sampleSize) : mixed
Parameters
$sampleSize : mixed
Return values
mixed —

setSampleSpace()

public setSampleSpace(mixed $sampleSpace) : mixed
Parameters
$sampleSpace : mixed
Return values
mixed —

setSelfLink()

public setSelfLink(mixed $selfLink) : mixed
Parameters
$selfLink : mixed
Return values
mixed —

setTotalResults()

public setTotalResults(mixed $totalResults) : mixed
Parameters
$totalResults : mixed
Return values
mixed —

setTotalsForAllResults()

public setTotalsForAllResults(mixed $totalsForAllResults) : mixed
Parameters
$totalsForAllResults : 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