Documentation

Google_Service_Books_Annotation 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.
$afterSelectedText  : mixed
$beforeSelectedText  : mixed
$created  : mixed
$data  : mixed
$deleted  : mixed
$highlightStyle  : mixed
$id  : mixed
$kind  : mixed
$layerId  : mixed
$pageIds  : mixed
$selectedText  : mixed
$selfLink  : mixed
$updated  : mixed
$volumeId  : mixed
$clientVersionRangesDataType  : mixed
$clientVersionRangesType  : mixed
$collection_key  : mixed
$currentVersionRangesDataType  : mixed
$currentVersionRangesType  : mixed
$internal_gapi_mappings  : mixed
$layerSummaryDataType  : mixed
$layerSummaryType  : 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
getAfterSelectedText()  : mixed
getBeforeSelectedText()  : mixed
getClientVersionRanges()  : Google_Service_Books_AnnotationClientVersionRanges
getCreated()  : mixed
getCurrentVersionRanges()  : Google_Service_Books_AnnotationCurrentVersionRanges
getData()  : mixed
getDeleted()  : mixed
getHighlightStyle()  : mixed
getId()  : mixed
getKind()  : mixed
getLayerId()  : mixed
getLayerSummary()  : Google_Service_Books_AnnotationLayerSummary
getPageIds()  : mixed
getSelectedText()  : mixed
getSelfLink()  : mixed
getUpdated()  : mixed
getVolumeId()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAfterSelectedText()  : mixed
setBeforeSelectedText()  : mixed
setClientVersionRanges()  : mixed
setCreated()  : mixed
setCurrentVersionRanges()  : mixed
setData()  : mixed
setDeleted()  : mixed
setHighlightStyle()  : mixed
setId()  : mixed
setKind()  : mixed
setLayerId()  : mixed
setLayerSummary()  : mixed
setPageIds()  : mixed
setSelectedText()  : mixed
setSelfLink()  : mixed
setUpdated()  : mixed
setVolumeId()  : 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

$afterSelectedText

public mixed $afterSelectedText

$beforeSelectedText

public mixed $beforeSelectedText

$clientVersionRangesDataType

protected mixed $clientVersionRangesDataType = ''

$clientVersionRangesType

protected mixed $clientVersionRangesType = 'Google_Service_Books_AnnotationClientVersionRanges'

$collection_key

protected mixed $collection_key = 'pageIds'

$currentVersionRangesDataType

protected mixed $currentVersionRangesDataType = ''

$currentVersionRangesType

protected mixed $currentVersionRangesType = 'Google_Service_Books_AnnotationCurrentVersionRanges'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$layerSummaryDataType

protected mixed $layerSummaryDataType = ''

$layerSummaryType

protected mixed $layerSummaryType = 'Google_Service_Books_AnnotationLayerSummary'

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

getAfterSelectedText()

public getAfterSelectedText() : mixed
Return values
mixed —

getBeforeSelectedText()

public getBeforeSelectedText() : mixed
Return values
mixed —

getCreated()

public getCreated() : mixed
Return values
mixed —

getData()

public getData() : mixed
Return values
mixed —

getDeleted()

public getDeleted() : mixed
Return values
mixed —

getHighlightStyle()

public getHighlightStyle() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getLayerId()

public getLayerId() : mixed
Return values
mixed —

getPageIds()

public getPageIds() : mixed
Return values
mixed —

getSelectedText()

public getSelectedText() : mixed
Return values
mixed —

getSelfLink()

public getSelfLink() : mixed
Return values
mixed —

getUpdated()

public getUpdated() : mixed
Return values
mixed —

getVolumeId()

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

setAfterSelectedText()

public setAfterSelectedText(mixed $afterSelectedText) : mixed
Parameters
$afterSelectedText : mixed
Return values
mixed —

setBeforeSelectedText()

public setBeforeSelectedText(mixed $beforeSelectedText) : mixed
Parameters
$beforeSelectedText : mixed
Return values
mixed —

setCreated()

public setCreated(mixed $created) : mixed
Parameters
$created : mixed
Return values
mixed —

setData()

public setData(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed —

setDeleted()

public setDeleted(mixed $deleted) : mixed
Parameters
$deleted : mixed
Return values
mixed —

setHighlightStyle()

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

setLayerId()

public setLayerId(mixed $layerId) : mixed
Parameters
$layerId : mixed
Return values
mixed —

setPageIds()

public setPageIds(mixed $pageIds) : mixed
Parameters
$pageIds : mixed
Return values
mixed —

setSelectedText()

public setSelectedText(mixed $selectedText) : mixed
Parameters
$selectedText : mixed
Return values
mixed —

setSelfLink()

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

setUpdated()

public setUpdated(mixed $updated) : mixed
Parameters
$updated : mixed
Return values
mixed —

setVolumeId()

public setVolumeId(mixed $volumeId) : mixed
Parameters
$volumeId : 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