Documentation

Google_Service_Books_VolumeVolumeInfo 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.
$allowAnonLogging  : mixed
$authors  : mixed
$averageRating  : mixed
$canonicalVolumeLink  : mixed
$categories  : mixed
$comicsContent  : mixed
$contentVersion  : mixed
$description  : mixed
$infoLink  : mixed
$language  : mixed
$mainCategory  : mixed
$maturityRating  : mixed
$pageCount  : mixed
$previewLink  : mixed
$printedPageCount  : mixed
$printType  : mixed
$publishedDate  : mixed
$publisher  : mixed
$ratingsCount  : mixed
$samplePageCount  : mixed
$subtitle  : mixed
$title  : mixed
$collection_key  : mixed
$dimensionsDataType  : mixed
$dimensionsType  : mixed
$imageLinksDataType  : mixed
$imageLinksType  : mixed
$industryIdentifiersDataType  : mixed
$industryIdentifiersType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$panelizationSummaryDataType  : mixed
$panelizationSummaryType  : mixed
$processed  : mixed
$readingModesDataType  : mixed
$readingModesType  : mixed
$seriesInfoDataType  : mixed
$seriesInfoType  : 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
getAllowAnonLogging()  : mixed
getAuthors()  : mixed
getAverageRating()  : mixed
getCanonicalVolumeLink()  : mixed
getCategories()  : mixed
getComicsContent()  : mixed
getContentVersion()  : mixed
getDescription()  : mixed
getDimensions()  : Google_Service_Books_VolumeVolumeInfoDimensions
getImageLinks()  : Google_Service_Books_VolumeVolumeInfoImageLinks
getIndustryIdentifiers()  : Google_Service_Books_VolumeVolumeInfoIndustryIdentifiers
getInfoLink()  : mixed
getLanguage()  : mixed
getMainCategory()  : mixed
getMaturityRating()  : mixed
getPageCount()  : mixed
getPanelizationSummary()  : Google_Service_Books_VolumeVolumeInfoPanelizationSummary
getPreviewLink()  : mixed
getPrintedPageCount()  : mixed
getPrintType()  : mixed
getPublishedDate()  : mixed
getPublisher()  : mixed
getRatingsCount()  : mixed
getReadingModes()  : Google_Service_Books_VolumeVolumeInfoReadingModes
getSamplePageCount()  : mixed
getSeriesInfo()  : Google_Service_Books_Volumeseriesinfo
getSubtitle()  : mixed
getTitle()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAllowAnonLogging()  : mixed
setAuthors()  : mixed
setAverageRating()  : mixed
setCanonicalVolumeLink()  : mixed
setCategories()  : mixed
setComicsContent()  : mixed
setContentVersion()  : mixed
setDescription()  : mixed
setDimensions()  : mixed
setImageLinks()  : mixed
setIndustryIdentifiers()  : mixed
setInfoLink()  : mixed
setLanguage()  : mixed
setMainCategory()  : mixed
setMaturityRating()  : mixed
setPageCount()  : mixed
setPanelizationSummary()  : mixed
setPreviewLink()  : mixed
setPrintedPageCount()  : mixed
setPrintType()  : mixed
setPublishedDate()  : mixed
setPublisher()  : mixed
setRatingsCount()  : mixed
setReadingModes()  : mixed
setSamplePageCount()  : mixed
setSeriesInfo()  : mixed
setSubtitle()  : mixed
setTitle()  : 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

$dimensionsType

protected mixed $dimensionsType = 'Google_Service_Books_VolumeVolumeInfoDimensions'

$imageLinksType

protected mixed $imageLinksType = 'Google_Service_Books_VolumeVolumeInfoImageLinks'

$industryIdentifiersDataType

protected mixed $industryIdentifiersDataType = 'array'

$industryIdentifiersType

protected mixed $industryIdentifiersType = 'Google_Service_Books_VolumeVolumeInfoIndustryIdentifiers'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$panelizationSummaryDataType

protected mixed $panelizationSummaryDataType = ''

$panelizationSummaryType

protected mixed $panelizationSummaryType = 'Google_Service_Books_VolumeVolumeInfoPanelizationSummary'

$processed

protected mixed $processed = array()

$readingModesType

protected mixed $readingModesType = 'Google_Service_Books_VolumeVolumeInfoReadingModes'

$seriesInfoType

protected mixed $seriesInfoType = 'Google_Service_Books_Volumeseriesinfo'

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 —

getAllowAnonLogging()

public getAllowAnonLogging() : mixed
Return values
mixed —

getAverageRating()

public getAverageRating() : mixed
Return values
mixed —

getCanonicalVolumeLink()

public getCanonicalVolumeLink() : mixed
Return values
mixed —

getComicsContent()

public getComicsContent() : mixed
Return values
mixed —

getContentVersion()

public getContentVersion() : mixed
Return values
mixed —

getDescription()

public getDescription() : mixed
Return values
mixed —

getMainCategory()

public getMainCategory() : mixed
Return values
mixed —

getMaturityRating()

public getMaturityRating() : mixed
Return values
mixed —

getPreviewLink()

public getPreviewLink() : mixed
Return values
mixed —

getPrintedPageCount()

public getPrintedPageCount() : mixed
Return values
mixed —

getPublishedDate()

public getPublishedDate() : mixed
Return values
mixed —

getRatingsCount()

public getRatingsCount() : mixed
Return values
mixed —

getSamplePageCount()

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

setAllowAnonLogging()

public setAllowAnonLogging(mixed $allowAnonLogging) : mixed
Parameters
$allowAnonLogging : mixed
Return values
mixed —

setAuthors()

public setAuthors(mixed $authors) : mixed
Parameters
$authors : mixed
Return values
mixed —

setAverageRating()

public setAverageRating(mixed $averageRating) : mixed
Parameters
$averageRating : mixed
Return values
mixed —

setCanonicalVolumeLink()

public setCanonicalVolumeLink(mixed $canonicalVolumeLink) : mixed
Parameters
$canonicalVolumeLink : mixed
Return values
mixed —

setCategories()

public setCategories(mixed $categories) : mixed
Parameters
$categories : mixed
Return values
mixed —

setComicsContent()

public setComicsContent(mixed $comicsContent) : mixed
Parameters
$comicsContent : mixed
Return values
mixed —

setContentVersion()

public setContentVersion(mixed $contentVersion) : mixed
Parameters
$contentVersion : mixed
Return values
mixed —

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed —

setIndustryIdentifiers()

public setIndustryIdentifiers(mixed $industryIdentifiers) : mixed
Parameters
$industryIdentifiers : mixed
Return values
mixed —

setInfoLink()

public setInfoLink(mixed $infoLink) : mixed
Parameters
$infoLink : mixed
Return values
mixed —

setLanguage()

public setLanguage(mixed $language) : mixed
Parameters
$language : mixed
Return values
mixed —

setMainCategory()

public setMainCategory(mixed $mainCategory) : mixed
Parameters
$mainCategory : mixed
Return values
mixed —

setMaturityRating()

public setMaturityRating(mixed $maturityRating) : mixed
Parameters
$maturityRating : mixed
Return values
mixed —

setPageCount()

public setPageCount(mixed $pageCount) : mixed
Parameters
$pageCount : mixed
Return values
mixed —

setPreviewLink()

public setPreviewLink(mixed $previewLink) : mixed
Parameters
$previewLink : mixed
Return values
mixed —

setPrintedPageCount()

public setPrintedPageCount(mixed $printedPageCount) : mixed
Parameters
$printedPageCount : mixed
Return values
mixed —

setPrintType()

public setPrintType(mixed $printType) : mixed
Parameters
$printType : mixed
Return values
mixed —

setPublishedDate()

public setPublishedDate(mixed $publishedDate) : mixed
Parameters
$publishedDate : mixed
Return values
mixed —

setPublisher()

public setPublisher(mixed $publisher) : mixed
Parameters
$publisher : mixed
Return values
mixed —

setRatingsCount()

public setRatingsCount(mixed $ratingsCount) : mixed
Parameters
$ratingsCount : mixed
Return values
mixed —

setSamplePageCount()

public setSamplePageCount(mixed $samplePageCount) : mixed
Parameters
$samplePageCount : mixed
Return values
mixed —

setSubtitle()

public setSubtitle(mixed $subtitle) : mixed
Parameters
$subtitle : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : 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