Documentation

Google_Service_Playmoviespartner_Avail 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.
$altId  : mixed
$captionExemption  : mixed
$captionIncluded  : mixed
$contentId  : mixed
$displayName  : mixed
$encodeId  : mixed
$end  : mixed
$episodeAltId  : mixed
$episodeNumber  : mixed
$episodeTitleInternalAlias  : mixed
$formatProfile  : mixed
$licenseType  : mixed
$pphNames  : mixed
$priceType  : mixed
$priceValue  : mixed
$productId  : mixed
$ratingReason  : mixed
$ratingSystem  : mixed
$ratingValue  : mixed
$releaseDate  : mixed
$seasonAltId  : mixed
$seasonNumber  : mixed
$seasonTitleInternalAlias  : mixed
$seriesAltId  : mixed
$seriesTitleInternalAlias  : mixed
$start  : mixed
$storeLanguage  : mixed
$suppressionLiftDate  : mixed
$territory  : mixed
$titleInternalAlias  : mixed
$videoId  : mixed
$workType  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : 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
getAltId()  : mixed
getCaptionExemption()  : mixed
getCaptionIncluded()  : mixed
getContentId()  : mixed
getDisplayName()  : mixed
getEncodeId()  : mixed
getEnd()  : mixed
getEpisodeAltId()  : mixed
getEpisodeNumber()  : mixed
getEpisodeTitleInternalAlias()  : mixed
getFormatProfile()  : mixed
getLicenseType()  : mixed
getPphNames()  : mixed
getPriceType()  : mixed
getPriceValue()  : mixed
getProductId()  : mixed
getRatingReason()  : mixed
getRatingSystem()  : mixed
getRatingValue()  : mixed
getReleaseDate()  : mixed
getSeasonAltId()  : mixed
getSeasonNumber()  : mixed
getSeasonTitleInternalAlias()  : mixed
getSeriesAltId()  : mixed
getSeriesTitleInternalAlias()  : mixed
getStart()  : mixed
getStoreLanguage()  : mixed
getSuppressionLiftDate()  : mixed
getTerritory()  : mixed
getTitleInternalAlias()  : mixed
getVideoId()  : mixed
getWorkType()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAltId()  : mixed
setCaptionExemption()  : mixed
setCaptionIncluded()  : mixed
setContentId()  : mixed
setDisplayName()  : mixed
setEncodeId()  : mixed
setEnd()  : mixed
setEpisodeAltId()  : mixed
setEpisodeNumber()  : mixed
setEpisodeTitleInternalAlias()  : mixed
setFormatProfile()  : mixed
setLicenseType()  : mixed
setPphNames()  : mixed
setPriceType()  : mixed
setPriceValue()  : mixed
setProductId()  : mixed
setRatingReason()  : mixed
setRatingSystem()  : mixed
setRatingValue()  : mixed
setReleaseDate()  : mixed
setSeasonAltId()  : mixed
setSeasonNumber()  : mixed
setSeasonTitleInternalAlias()  : mixed
setSeriesAltId()  : mixed
setSeriesTitleInternalAlias()  : mixed
setStart()  : mixed
setStoreLanguage()  : mixed
setSuppressionLiftDate()  : mixed
setTerritory()  : mixed
setTitleInternalAlias()  : mixed
setVideoId()  : mixed
setWorkType()  : 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

$captionExemption

public mixed $captionExemption

$captionIncluded

public mixed $captionIncluded

$contentId

public mixed $contentId

$displayName

public mixed $displayName

$encodeId

public mixed $encodeId

$episodeAltId

public mixed $episodeAltId

$episodeNumber

public mixed $episodeNumber

$episodeTitleInternalAlias

public mixed $episodeTitleInternalAlias

$formatProfile

public mixed $formatProfile

$licenseType

public mixed $licenseType

$pphNames

public mixed $pphNames

$priceType

public mixed $priceType

$priceValue

public mixed $priceValue

$productId

public mixed $productId

$ratingReason

public mixed $ratingReason

$ratingSystem

public mixed $ratingSystem

$ratingValue

public mixed $ratingValue

$releaseDate

public mixed $releaseDate

$seasonAltId

public mixed $seasonAltId

$seasonNumber

public mixed $seasonNumber

$seasonTitleInternalAlias

public mixed $seasonTitleInternalAlias

$seriesAltId

public mixed $seriesAltId

$seriesTitleInternalAlias

public mixed $seriesTitleInternalAlias

$storeLanguage

public mixed $storeLanguage

$suppressionLiftDate

public mixed $suppressionLiftDate

$territory

public mixed $territory

$titleInternalAlias

public mixed $titleInternalAlias

$videoId

public mixed $videoId

$workType

public mixed $workType

$collection_key

protected mixed $collection_key = 'pphNames'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

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

getAltId()

public getAltId() : mixed
Return values
mixed —

getCaptionExemption()

public getCaptionExemption() : mixed
Return values
mixed —

getCaptionIncluded()

public getCaptionIncluded() : mixed
Return values
mixed —

getContentId()

public getContentId() : mixed
Return values
mixed —

getDisplayName()

public getDisplayName() : mixed
Return values
mixed —

getEncodeId()

public getEncodeId() : mixed
Return values
mixed —

getEnd()

public getEnd() : mixed
Return values
mixed —

getEpisodeAltId()

public getEpisodeAltId() : mixed
Return values
mixed —

getEpisodeNumber()

public getEpisodeNumber() : mixed
Return values
mixed —

getEpisodeTitleInternalAlias()

public getEpisodeTitleInternalAlias() : mixed
Return values
mixed —

getFormatProfile()

public getFormatProfile() : mixed
Return values
mixed —

getLicenseType()

public getLicenseType() : mixed
Return values
mixed —

getPphNames()

public getPphNames() : mixed
Return values
mixed —

getPriceType()

public getPriceType() : mixed
Return values
mixed —

getPriceValue()

public getPriceValue() : mixed
Return values
mixed —

getProductId()

public getProductId() : mixed
Return values
mixed —

getRatingReason()

public getRatingReason() : mixed
Return values
mixed —

getRatingSystem()

public getRatingSystem() : mixed
Return values
mixed —

getRatingValue()

public getRatingValue() : mixed
Return values
mixed —

getReleaseDate()

public getReleaseDate() : mixed
Return values
mixed —

getSeasonAltId()

public getSeasonAltId() : mixed
Return values
mixed —

getSeasonNumber()

public getSeasonNumber() : mixed
Return values
mixed —

getSeasonTitleInternalAlias()

public getSeasonTitleInternalAlias() : mixed
Return values
mixed —

getSeriesAltId()

public getSeriesAltId() : mixed
Return values
mixed —

getSeriesTitleInternalAlias()

public getSeriesTitleInternalAlias() : mixed
Return values
mixed —

getStart()

public getStart() : mixed
Return values
mixed —

getStoreLanguage()

public getStoreLanguage() : mixed
Return values
mixed —

getSuppressionLiftDate()

public getSuppressionLiftDate() : mixed
Return values
mixed —

getTerritory()

public getTerritory() : mixed
Return values
mixed —

getTitleInternalAlias()

public getTitleInternalAlias() : mixed
Return values
mixed —

getVideoId()

public getVideoId() : mixed
Return values
mixed —

getWorkType()

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

setAltId()

public setAltId(mixed $altId) : mixed
Parameters
$altId : mixed
Return values
mixed —

setCaptionExemption()

public setCaptionExemption(mixed $captionExemption) : mixed
Parameters
$captionExemption : mixed
Return values
mixed —

setCaptionIncluded()

public setCaptionIncluded(mixed $captionIncluded) : mixed
Parameters
$captionIncluded : mixed
Return values
mixed —

setContentId()

public setContentId(mixed $contentId) : mixed
Parameters
$contentId : mixed
Return values
mixed —

setDisplayName()

public setDisplayName(mixed $displayName) : mixed
Parameters
$displayName : mixed
Return values
mixed —

setEncodeId()

public setEncodeId(mixed $encodeId) : mixed
Parameters
$encodeId : mixed
Return values
mixed —

setEnd()

public setEnd(mixed $end) : mixed
Parameters
$end : mixed
Return values
mixed —

setEpisodeAltId()

public setEpisodeAltId(mixed $episodeAltId) : mixed
Parameters
$episodeAltId : mixed
Return values
mixed —

setEpisodeNumber()

public setEpisodeNumber(mixed $episodeNumber) : mixed
Parameters
$episodeNumber : mixed
Return values
mixed —

setEpisodeTitleInternalAlias()

public setEpisodeTitleInternalAlias(mixed $episodeTitleInternalAlias) : mixed
Parameters
$episodeTitleInternalAlias : mixed
Return values
mixed —

setFormatProfile()

public setFormatProfile(mixed $formatProfile) : mixed
Parameters
$formatProfile : mixed
Return values
mixed —

setLicenseType()

public setLicenseType(mixed $licenseType) : mixed
Parameters
$licenseType : mixed
Return values
mixed —

setPphNames()

public setPphNames(mixed $pphNames) : mixed
Parameters
$pphNames : mixed
Return values
mixed —

setPriceType()

public setPriceType(mixed $priceType) : mixed
Parameters
$priceType : mixed
Return values
mixed —

setPriceValue()

public setPriceValue(mixed $priceValue) : mixed
Parameters
$priceValue : mixed
Return values
mixed —

setProductId()

public setProductId(mixed $productId) : mixed
Parameters
$productId : mixed
Return values
mixed —

setRatingReason()

public setRatingReason(mixed $ratingReason) : mixed
Parameters
$ratingReason : mixed
Return values
mixed —

setRatingSystem()

public setRatingSystem(mixed $ratingSystem) : mixed
Parameters
$ratingSystem : mixed
Return values
mixed —

setRatingValue()

public setRatingValue(mixed $ratingValue) : mixed
Parameters
$ratingValue : mixed
Return values
mixed —

setReleaseDate()

public setReleaseDate(mixed $releaseDate) : mixed
Parameters
$releaseDate : mixed
Return values
mixed —

setSeasonAltId()

public setSeasonAltId(mixed $seasonAltId) : mixed
Parameters
$seasonAltId : mixed
Return values
mixed —

setSeasonNumber()

public setSeasonNumber(mixed $seasonNumber) : mixed
Parameters
$seasonNumber : mixed
Return values
mixed —

setSeasonTitleInternalAlias()

public setSeasonTitleInternalAlias(mixed $seasonTitleInternalAlias) : mixed
Parameters
$seasonTitleInternalAlias : mixed
Return values
mixed —

setSeriesAltId()

public setSeriesAltId(mixed $seriesAltId) : mixed
Parameters
$seriesAltId : mixed
Return values
mixed —

setSeriesTitleInternalAlias()

public setSeriesTitleInternalAlias(mixed $seriesTitleInternalAlias) : mixed
Parameters
$seriesTitleInternalAlias : mixed
Return values
mixed —

setStart()

public setStart(mixed $start) : mixed
Parameters
$start : mixed
Return values
mixed —

setStoreLanguage()

public setStoreLanguage(mixed $storeLanguage) : mixed
Parameters
$storeLanguage : mixed
Return values
mixed —

setSuppressionLiftDate()

public setSuppressionLiftDate(mixed $suppressionLiftDate) : mixed
Parameters
$suppressionLiftDate : mixed
Return values
mixed —

setTerritory()

public setTerritory(mixed $territory) : mixed
Parameters
$territory : mixed
Return values
mixed —

setTitleInternalAlias()

public setTitleInternalAlias(mixed $titleInternalAlias) : mixed
Parameters
$titleInternalAlias : mixed
Return values
mixed —

setVideoId()

public setVideoId(mixed $videoId) : mixed
Parameters
$videoId : mixed
Return values
mixed —

setWorkType()

public setWorkType(mixed $workType) : mixed
Parameters
$workType : 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