Documentation

Google_Service_Reportcard_Notice 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.
$category  : mixed
$consumer  : mixed
$creator  : mixed
$dashboardUrl  : mixed
$documentationUrl  : mixed
$groupKey  : mixed
$groupName  : mixed
$id  : mixed
$kind  : mixed
$longDescription  : mixed
$longDescriptionType  : mixed
$muteId  : mixed
$postingTask  : mixed
$postingTimeMs  : mixed
$score  : mixed
$shortDescription  : mixed
$sourceKey  : mixed
$sourceName  : mixed
$tag  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$targetDataType  : mixed
$targetType  : 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
getCategory()  : mixed
getConsumer()  : mixed
getCreator()  : mixed
getDashboardUrl()  : mixed
getDocumentationUrl()  : mixed
getGroupKey()  : mixed
getGroupName()  : mixed
getId()  : mixed
getKind()  : mixed
getLongDescription()  : mixed
getLongDescriptionType()  : mixed
getMuteId()  : mixed
getPostingTask()  : mixed
getPostingTimeMs()  : mixed
getScore()  : mixed
getShortDescription()  : mixed
getSourceKey()  : mixed
getSourceName()  : mixed
getTag()  : mixed
getTarget()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCategory()  : mixed
setConsumer()  : mixed
setCreator()  : mixed
setDashboardUrl()  : mixed
setDocumentationUrl()  : mixed
setGroupKey()  : mixed
setGroupName()  : mixed
setId()  : mixed
setKind()  : mixed
setLongDescription()  : mixed
setLongDescriptionType()  : mixed
setMuteId()  : mixed
setPostingTask()  : mixed
setPostingTimeMs()  : mixed
setScore()  : mixed
setShortDescription()  : mixed
setSourceKey()  : mixed
setSourceName()  : mixed
setTag()  : mixed
setTarget()  : 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

$category

public mixed $category

$consumer

public mixed $consumer

$dashboardUrl

public mixed $dashboardUrl

$documentationUrl

public mixed $documentationUrl

$groupKey

public mixed $groupKey

$groupName

public mixed $groupName

$longDescription

public mixed $longDescription

$longDescriptionType

public mixed $longDescriptionType

$postingTask

public mixed $postingTask

$postingTimeMs

public mixed $postingTimeMs

$shortDescription

public mixed $shortDescription

$sourceKey

public mixed $sourceKey

$sourceName

public mixed $sourceName

$collection_key

protected mixed $collection_key = 'target'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$targetDataType

protected mixed $targetDataType = 'array'

$targetType

protected mixed $targetType = 'Google_Service_Reportcard_Target'

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 —

getCategory()

public getCategory() : mixed
Return values
mixed —

getConsumer()

public getConsumer() : mixed
Return values
mixed —

getCreator()

public getCreator() : mixed
Return values
mixed —

getDashboardUrl()

public getDashboardUrl() : mixed
Return values
mixed —

getDocumentationUrl()

public getDocumentationUrl() : mixed
Return values
mixed —

getGroupKey()

public getGroupKey() : mixed
Return values
mixed —

getGroupName()

public getGroupName() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getLongDescription()

public getLongDescription() : mixed
Return values
mixed —

getLongDescriptionType()

public getLongDescriptionType() : mixed
Return values
mixed —

getMuteId()

public getMuteId() : mixed
Return values
mixed —

getPostingTask()

public getPostingTask() : mixed
Return values
mixed —

getPostingTimeMs()

public getPostingTimeMs() : mixed
Return values
mixed —

getScore()

public getScore() : mixed
Return values
mixed —

getShortDescription()

public getShortDescription() : mixed
Return values
mixed —

getSourceKey()

public getSourceKey() : mixed
Return values
mixed —

getSourceName()

public getSourceName() : mixed
Return values
mixed —

getTag()

public getTag() : mixed
Return values
mixed —

getTarget()

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

setCategory()

public setCategory(mixed $category) : mixed
Parameters
$category : mixed
Return values
mixed —

setConsumer()

public setConsumer(mixed $consumer) : mixed
Parameters
$consumer : mixed
Return values
mixed —

setCreator()

public setCreator(mixed $creator) : mixed
Parameters
$creator : mixed
Return values
mixed —

setDashboardUrl()

public setDashboardUrl(mixed $dashboardUrl) : mixed
Parameters
$dashboardUrl : mixed
Return values
mixed —

setDocumentationUrl()

public setDocumentationUrl(mixed $documentationUrl) : mixed
Parameters
$documentationUrl : mixed
Return values
mixed —

setGroupKey()

public setGroupKey(mixed $groupKey) : mixed
Parameters
$groupKey : mixed
Return values
mixed —

setGroupName()

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

setLongDescription()

public setLongDescription(mixed $longDescription) : mixed
Parameters
$longDescription : mixed
Return values
mixed —

setLongDescriptionType()

public setLongDescriptionType(mixed $longDescriptionType) : mixed
Parameters
$longDescriptionType : mixed
Return values
mixed —

setMuteId()

public setMuteId(mixed $muteId) : mixed
Parameters
$muteId : mixed
Return values
mixed —

setPostingTask()

public setPostingTask(mixed $postingTask) : mixed
Parameters
$postingTask : mixed
Return values
mixed —

setPostingTimeMs()

public setPostingTimeMs(mixed $postingTimeMs) : mixed
Parameters
$postingTimeMs : mixed
Return values
mixed —

setScore()

public setScore(mixed $score) : mixed
Parameters
$score : mixed
Return values
mixed —

setShortDescription()

public setShortDescription(mixed $shortDescription) : mixed
Parameters
$shortDescription : mixed
Return values
mixed —

setSourceKey()

public setSourceKey(mixed $sourceKey) : mixed
Parameters
$sourceKey : mixed
Return values
mixed —

setSourceName()

public setSourceName(mixed $sourceName) : mixed
Parameters
$sourceName : mixed
Return values
mixed —

setTag()

public setTag(mixed $tag) : mixed
Parameters
$tag : mixed
Return values
mixed —

setTarget()

public setTarget(mixed $target) : mixed
Parameters
$target : 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