Documentation

Google_Service_Firestore_FieldTransform 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.
$fieldPath  : mixed
$setToServerValue  : mixed
$appendMissingElementsDataType  : mixed
$appendMissingElementsType  : mixed
$incrementDataType  : mixed
$incrementType  : mixed
$internal_gapi_mappings  : mixed
$maximumDataType  : mixed
$maximumType  : mixed
$minimumDataType  : mixed
$minimumType  : mixed
$modelData  : mixed
$processed  : mixed
$removeAllFromArrayDataType  : mixed
$removeAllFromArrayType  : 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.
getAppendMissingElements()  : Google_Service_Firestore_ArrayValue
getFieldPath()  : mixed
getIncrement()  : Google_Service_Firestore_Value
getMaximum()  : Google_Service_Firestore_Value
getMinimum()  : Google_Service_Firestore_Value
getRemoveAllFromArray()  : Google_Service_Firestore_ArrayValue
getSetToServerValue()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setAppendMissingElements()  : mixed
setFieldPath()  : mixed
setIncrement()  : mixed
setMaximum()  : mixed
setMinimum()  : mixed
setRemoveAllFromArray()  : mixed
setSetToServerValue()  : 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

$appendMissingElementsDataType

protected mixed $appendMissingElementsDataType = ''

$appendMissingElementsType

protected mixed $appendMissingElementsType = 'Google_Service_Firestore_ArrayValue'

$incrementType

protected mixed $incrementType = 'Google_Service_Firestore_Value'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$maximumType

protected mixed $maximumType = 'Google_Service_Firestore_Value'

$minimumType

protected mixed $minimumType = 'Google_Service_Firestore_Value'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$removeAllFromArrayDataType

protected mixed $removeAllFromArrayDataType = ''

$removeAllFromArrayType

protected mixed $removeAllFromArrayType = 'Google_Service_Firestore_ArrayValue'

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 —

getFieldPath()

public getFieldPath() : mixed
Return values
mixed —

getSetToServerValue()

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

setFieldPath()

public setFieldPath(mixed $fieldPath) : mixed
Parameters
$fieldPath : mixed
Return values
mixed —

setSetToServerValue()

public setSetToServerValue(mixed $setToServerValue) : mixed
Parameters
$setToServerValue : 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