Documentation

Google_Service_Books_VolumeAccessInfo extends Google_Model
in package

This class defines attributes, valid values, and usage which is generated from a given json schema.

http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5

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.
$accessViewStatus  : mixed
$country  : mixed
$driveImportedContentLink  : mixed
$embeddable  : mixed
$explicitOfflineLicenseManagement  : mixed
$publicDomain  : mixed
$quoteSharingAllowed  : mixed
$textToSpeechPermission  : mixed
$viewability  : mixed
$viewOrderUrl  : mixed
$webReaderLink  : mixed
$downloadAccessDataType  : mixed
$downloadAccessType  : mixed
$epubDataType  : mixed
$epubType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$pdfDataType  : mixed
$pdfType  : 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.
getAccessViewStatus()  : mixed
getCountry()  : mixed
getDownloadAccess()  : Google_Service_Books_DownloadAccessRestriction
getDriveImportedContentLink()  : mixed
getEmbeddable()  : mixed
getEpub()  : Google_Service_Books_VolumeAccessInfoEpub
getExplicitOfflineLicenseManagement()  : mixed
getPdf()  : Google_Service_Books_VolumeAccessInfoPdf
getPublicDomain()  : mixed
getQuoteSharingAllowed()  : mixed
getTextToSpeechPermission()  : mixed
getViewability()  : mixed
getViewOrderUrl()  : mixed
getWebReaderLink()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setAccessViewStatus()  : mixed
setCountry()  : mixed
setDownloadAccess()  : mixed
setDriveImportedContentLink()  : mixed
setEmbeddable()  : mixed
setEpub()  : mixed
setExplicitOfflineLicenseManagement()  : mixed
setPdf()  : mixed
setPublicDomain()  : mixed
setQuoteSharingAllowed()  : mixed
setTextToSpeechPermission()  : mixed
setViewability()  : mixed
setViewOrderUrl()  : mixed
setWebReaderLink()  : 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.
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
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

$explicitOfflineLicenseManagement

public mixed $explicitOfflineLicenseManagement

$downloadAccessType

protected mixed $downloadAccessType = 'Google_Service_Books_DownloadAccessRestriction'

$epubType

protected mixed $epubType = 'Google_Service_Books_VolumeAccessInfoEpub'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$pdfType

protected mixed $pdfType = 'Google_Service_Books_VolumeAccessInfoPdf'

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

getAccessViewStatus()

public getAccessViewStatus() : mixed
Return values
mixed —

getDriveImportedContentLink()

public getDriveImportedContentLink() : mixed
Return values
mixed —

getExplicitOfflineLicenseManagement()

public getExplicitOfflineLicenseManagement() : mixed
Return values
mixed —

getPublicDomain()

public getPublicDomain() : mixed
Return values
mixed —

getQuoteSharingAllowed()

public getQuoteSharingAllowed() : mixed
Return values
mixed —

getTextToSpeechPermission()

public getTextToSpeechPermission() : mixed
Return values
mixed —

getViewability()

public getViewability() : mixed
Return values
mixed —

getViewOrderUrl()

public getViewOrderUrl() : mixed
Return values
mixed —

getWebReaderLink()

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

setAccessViewStatus()

public setAccessViewStatus(mixed $accessViewStatus) : mixed
Parameters
$accessViewStatus : mixed
Return values
mixed —

setCountry()

public setCountry(mixed $country) : mixed
Parameters
$country : mixed
Return values
mixed —

setDriveImportedContentLink()

public setDriveImportedContentLink(mixed $driveImportedContentLink) : mixed
Parameters
$driveImportedContentLink : mixed
Return values
mixed —

setEmbeddable()

public setEmbeddable(mixed $embeddable) : mixed
Parameters
$embeddable : mixed
Return values
mixed —

setExplicitOfflineLicenseManagement()

public setExplicitOfflineLicenseManagement(mixed $explicitOfflineLicenseManagement) : mixed
Parameters
$explicitOfflineLicenseManagement : mixed
Return values
mixed —

setPublicDomain()

public setPublicDomain(mixed $publicDomain) : mixed
Parameters
$publicDomain : mixed
Return values
mixed —

setQuoteSharingAllowed()

public setQuoteSharingAllowed(mixed $quoteSharingAllowed) : mixed
Parameters
$quoteSharingAllowed : mixed
Return values
mixed —

setTextToSpeechPermission()

public setTextToSpeechPermission(mixed $textToSpeechPermission) : mixed
Parameters
$textToSpeechPermission : mixed
Return values
mixed —

setViewability()

public setViewability(mixed $viewability) : mixed
Parameters
$viewability : mixed
Return values
mixed —

setViewOrderUrl()

public setViewOrderUrl(mixed $viewOrderUrl) : mixed
Parameters
$viewOrderUrl : mixed
Return values
mixed —

setWebReaderLink()

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

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 —

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