Documentation

Google_Service_Reseller_Subscription 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.
$billingMethod  : mixed
$creationTime  : mixed
$customerDomain  : mixed
$customerId  : mixed
$dealCode  : mixed
$kind  : mixed
$purchaseOrderId  : mixed
$resourceUiUrl  : mixed
$skuId  : mixed
$skuName  : mixed
$status  : mixed
$subscriptionId  : mixed
$suspensionReasons  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$planDataType  : mixed
$planType  : mixed
$processed  : mixed
$renewalSettingsDataType  : mixed
$renewalSettingsType  : mixed
$seatsDataType  : mixed
$seatsType  : mixed
$transferInfoDataType  : mixed
$transferInfoType  : mixed
$trialSettingsDataType  : mixed
$trialSettingsType  : 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
getBillingMethod()  : mixed
getCreationTime()  : mixed
getCustomerDomain()  : mixed
getCustomerId()  : mixed
getDealCode()  : mixed
getKind()  : mixed
getPlan()  : Google_Service_Reseller_SubscriptionPlan
getPurchaseOrderId()  : mixed
getRenewalSettings()  : Google_Service_Reseller_RenewalSettings
getResourceUiUrl()  : mixed
getSeats()  : Google_Service_Reseller_Seats
getSkuId()  : mixed
getSkuName()  : mixed
getStatus()  : mixed
getSubscriptionId()  : mixed
getSuspensionReasons()  : mixed
getTransferInfo()  : Google_Service_Reseller_SubscriptionTransferInfo
getTrialSettings()  : Google_Service_Reseller_SubscriptionTrialSettings
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setBillingMethod()  : mixed
setCreationTime()  : mixed
setCustomerDomain()  : mixed
setCustomerId()  : mixed
setDealCode()  : mixed
setKind()  : mixed
setPlan()  : mixed
setPurchaseOrderId()  : mixed
setRenewalSettings()  : mixed
setResourceUiUrl()  : mixed
setSeats()  : mixed
setSkuId()  : mixed
setSkuName()  : mixed
setStatus()  : mixed
setSubscriptionId()  : mixed
setSuspensionReasons()  : mixed
setTransferInfo()  : mixed
setTrialSettings()  : 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

$collection_key

protected mixed $collection_key = 'suspensionReasons'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$planType

protected mixed $planType = 'Google_Service_Reseller_SubscriptionPlan'

$processed

protected mixed $processed = array()

$renewalSettingsDataType

protected mixed $renewalSettingsDataType = ''

$renewalSettingsType

protected mixed $renewalSettingsType = 'Google_Service_Reseller_RenewalSettings'

$seatsType

protected mixed $seatsType = 'Google_Service_Reseller_Seats'

$transferInfoDataType

protected mixed $transferInfoDataType = ''

$transferInfoType

protected mixed $transferInfoType = 'Google_Service_Reseller_SubscriptionTransferInfo'

$trialSettingsDataType

protected mixed $trialSettingsDataType = ''

$trialSettingsType

protected mixed $trialSettingsType = 'Google_Service_Reseller_SubscriptionTrialSettings'

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

getBillingMethod()

public getBillingMethod() : mixed
Return values
mixed

getCreationTime()

public getCreationTime() : mixed
Return values
mixed

getCustomerDomain()

public getCustomerDomain() : mixed
Return values
mixed

getCustomerId()

public getCustomerId() : mixed
Return values
mixed

getDealCode()

public getDealCode() : mixed
Return values
mixed

getKind()

public getKind() : mixed
Return values
mixed

getPurchaseOrderId()

public getPurchaseOrderId() : mixed
Return values
mixed

getResourceUiUrl()

public getResourceUiUrl() : mixed
Return values
mixed

getSkuId()

public getSkuId() : mixed
Return values
mixed

getSkuName()

public getSkuName() : mixed
Return values
mixed

getStatus()

public getStatus() : mixed
Return values
mixed

getSubscriptionId()

public getSubscriptionId() : mixed
Return values
mixed

getSuspensionReasons()

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

setBillingMethod()

public setBillingMethod(mixed $billingMethod) : mixed
Parameters
$billingMethod : mixed
Return values
mixed

setCreationTime()

public setCreationTime(mixed $creationTime) : mixed
Parameters
$creationTime : mixed
Return values
mixed

setCustomerDomain()

public setCustomerDomain(mixed $customerDomain) : mixed
Parameters
$customerDomain : mixed
Return values
mixed

setCustomerId()

public setCustomerId(mixed $customerId) : mixed
Parameters
$customerId : mixed
Return values
mixed

setDealCode()

public setDealCode(mixed $dealCode) : mixed
Parameters
$dealCode : mixed
Return values
mixed

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed
Return values
mixed

setPurchaseOrderId()

public setPurchaseOrderId(mixed $purchaseOrderId) : mixed
Parameters
$purchaseOrderId : mixed
Return values
mixed

setResourceUiUrl()

public setResourceUiUrl(mixed $resourceUiUrl) : mixed
Parameters
$resourceUiUrl : mixed
Return values
mixed

setSkuId()

public setSkuId(mixed $skuId) : mixed
Parameters
$skuId : mixed
Return values
mixed

setSkuName()

public setSkuName(mixed $skuName) : mixed
Parameters
$skuName : mixed
Return values
mixed

setStatus()

public setStatus(mixed $status) : mixed
Parameters
$status : mixed
Return values
mixed

setSubscriptionId()

public setSubscriptionId(mixed $subscriptionId) : mixed
Parameters
$subscriptionId : mixed
Return values
mixed

setSuspensionReasons()

public setSuspensionReasons(mixed $suspensionReasons) : mixed
Parameters
$suspensionReasons : 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