Documentation

Google_Service_Books_VolumeUserInfo 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.
$acquiredTime  : mixed
$acquisitionType  : mixed
$entitlementType  : mixed
$isFamilySharedFromUser  : mixed
$isFamilySharedToUser  : mixed
$isFamilySharingAllowed  : mixed
$isFamilySharingDisabledByFop  : mixed
$isInMyBooks  : mixed
$isPreordered  : mixed
$isPurchased  : mixed
$isUploaded  : mixed
$rentalState  : mixed
$updated  : mixed
$copyDataType  : mixed
$copyType  : mixed
$familySharingDataType  : mixed
$familySharingType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$readingPositionDataType  : mixed
$readingPositionType  : mixed
$rentalPeriodDataType  : mixed
$rentalPeriodType  : mixed
$reviewDataType  : mixed
$reviewType  : mixed
$userUploadedVolumeInfoDataType  : mixed
$userUploadedVolumeInfoType  : 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.
getAcquiredTime()  : mixed
getAcquisitionType()  : mixed
getCopy()  : Google_Service_Books_VolumeUserInfoCopy
getEntitlementType()  : mixed
getFamilySharing()  : Google_Service_Books_VolumeUserInfoFamilySharing
getIsFamilySharedFromUser()  : mixed
getIsFamilySharedToUser()  : mixed
getIsFamilySharingAllowed()  : mixed
getIsFamilySharingDisabledByFop()  : mixed
getIsInMyBooks()  : mixed
getIsPreordered()  : mixed
getIsPurchased()  : mixed
getIsUploaded()  : mixed
getReadingPosition()  : Google_Service_Books_ReadingPosition
getRentalPeriod()  : Google_Service_Books_VolumeUserInfoRentalPeriod
getRentalState()  : mixed
getReview()  : Google_Service_Books_Review
getUpdated()  : mixed
getUserUploadedVolumeInfo()  : Google_Service_Books_VolumeUserInfoUserUploadedVolumeInfo
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setAcquiredTime()  : mixed
setAcquisitionType()  : mixed
setCopy()  : mixed
setEntitlementType()  : mixed
setFamilySharing()  : mixed
setIsFamilySharedFromUser()  : mixed
setIsFamilySharedToUser()  : mixed
setIsFamilySharingAllowed()  : mixed
setIsFamilySharingDisabledByFop()  : mixed
setIsInMyBooks()  : mixed
setIsPreordered()  : mixed
setIsPurchased()  : mixed
setIsUploaded()  : mixed
setReadingPosition()  : mixed
setRentalPeriod()  : mixed
setRentalState()  : mixed
setReview()  : mixed
setUpdated()  : mixed
setUserUploadedVolumeInfo()  : 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

$isFamilySharingDisabledByFop

public mixed $isFamilySharingDisabledByFop

$copyType

protected mixed $copyType = 'Google_Service_Books_VolumeUserInfoCopy'

$familySharingDataType

protected mixed $familySharingDataType = ''

$familySharingType

protected mixed $familySharingType = 'Google_Service_Books_VolumeUserInfoFamilySharing'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$readingPositionDataType

protected mixed $readingPositionDataType = ''

$readingPositionType

protected mixed $readingPositionType = 'Google_Service_Books_ReadingPosition'

$rentalPeriodDataType

protected mixed $rentalPeriodDataType = ''

$rentalPeriodType

protected mixed $rentalPeriodType = 'Google_Service_Books_VolumeUserInfoRentalPeriod'

$reviewType

protected mixed $reviewType = 'Google_Service_Books_Review'

$userUploadedVolumeInfoDataType

protected mixed $userUploadedVolumeInfoDataType = ''

$userUploadedVolumeInfoType

protected mixed $userUploadedVolumeInfoType = 'Google_Service_Books_VolumeUserInfoUserUploadedVolumeInfo'

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 —

getAcquiredTime()

public getAcquiredTime() : mixed
Return values
mixed —

getAcquisitionType()

public getAcquisitionType() : mixed
Return values
mixed —

getEntitlementType()

public getEntitlementType() : mixed
Return values
mixed —

getIsFamilySharedFromUser()

public getIsFamilySharedFromUser() : mixed
Return values
mixed —

getIsFamilySharedToUser()

public getIsFamilySharedToUser() : mixed
Return values
mixed —

getIsFamilySharingAllowed()

public getIsFamilySharingAllowed() : mixed
Return values
mixed —

getIsFamilySharingDisabledByFop()

public getIsFamilySharingDisabledByFop() : mixed
Return values
mixed —

getIsInMyBooks()

public getIsInMyBooks() : mixed
Return values
mixed —

getIsPreordered()

public getIsPreordered() : mixed
Return values
mixed —

getIsPurchased()

public getIsPurchased() : mixed
Return values
mixed —

getIsUploaded()

public getIsUploaded() : mixed
Return values
mixed —

getRentalState()

public getRentalState() : mixed
Return values
mixed —

getUpdated()

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

setAcquiredTime()

public setAcquiredTime(mixed $acquiredTime) : mixed
Parameters
$acquiredTime : mixed
Return values
mixed —

setAcquisitionType()

public setAcquisitionType(mixed $acquisitionType) : mixed
Parameters
$acquisitionType : mixed
Return values
mixed —

setEntitlementType()

public setEntitlementType(mixed $entitlementType) : mixed
Parameters
$entitlementType : mixed
Return values
mixed —

setIsFamilySharedFromUser()

public setIsFamilySharedFromUser(mixed $isFamilySharedFromUser) : mixed
Parameters
$isFamilySharedFromUser : mixed
Return values
mixed —

setIsFamilySharedToUser()

public setIsFamilySharedToUser(mixed $isFamilySharedToUser) : mixed
Parameters
$isFamilySharedToUser : mixed
Return values
mixed —

setIsFamilySharingAllowed()

public setIsFamilySharingAllowed(mixed $isFamilySharingAllowed) : mixed
Parameters
$isFamilySharingAllowed : mixed
Return values
mixed —

setIsFamilySharingDisabledByFop()

public setIsFamilySharingDisabledByFop(mixed $isFamilySharingDisabledByFop) : mixed
Parameters
$isFamilySharingDisabledByFop : mixed
Return values
mixed —

setIsInMyBooks()

public setIsInMyBooks(mixed $isInMyBooks) : mixed
Parameters
$isInMyBooks : mixed
Return values
mixed —

setIsPreordered()

public setIsPreordered(mixed $isPreordered) : mixed
Parameters
$isPreordered : mixed
Return values
mixed —

setIsPurchased()

public setIsPurchased(mixed $isPurchased) : mixed
Parameters
$isPurchased : mixed
Return values
mixed —

setIsUploaded()

public setIsUploaded(mixed $isUploaded) : mixed
Parameters
$isUploaded : mixed
Return values
mixed —

setRentalState()

public setRentalState(mixed $rentalState) : mixed
Parameters
$rentalState : mixed
Return values
mixed —

setUpdated()

public setUpdated(mixed $updated) : mixed
Parameters
$updated : 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