Documentation

Google_Service_CloudSearch_NamedProperty 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.
$booleanValue  : mixed
$name  : mixed
$dateValuesDataType  : mixed
$dateValuesType  : mixed
$doubleValuesDataType  : mixed
$doubleValuesType  : mixed
$enumValuesDataType  : mixed
$enumValuesType  : mixed
$htmlValuesDataType  : mixed
$htmlValuesType  : mixed
$integerValuesDataType  : mixed
$integerValuesType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$objectValuesDataType  : mixed
$objectValuesType  : mixed
$processed  : mixed
$textValuesDataType  : mixed
$textValuesType  : mixed
$timestampValuesDataType  : mixed
$timestampValuesType  : 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.
getBooleanValue()  : mixed
getDateValues()  : Google_Service_CloudSearch_DateValues
getDoubleValues()  : Google_Service_CloudSearch_DoubleValues
getEnumValues()  : Google_Service_CloudSearch_EnumValues
getHtmlValues()  : Google_Service_CloudSearch_HtmlValues
getIntegerValues()  : Google_Service_CloudSearch_IntegerValues
getName()  : mixed
getObjectValues()  : Google_Service_CloudSearch_ObjectValues
getTextValues()  : Google_Service_CloudSearch_TextValues
getTimestampValues()  : Google_Service_CloudSearch_TimestampValues
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setBooleanValue()  : mixed
setDateValues()  : mixed
setDoubleValues()  : mixed
setEnumValues()  : mixed
setHtmlValues()  : mixed
setIntegerValues()  : mixed
setName()  : mixed
setObjectValues()  : mixed
setTextValues()  : mixed
setTimestampValues()  : 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

$dateValuesDataType

protected mixed $dateValuesDataType = ''

$dateValuesType

protected mixed $dateValuesType = 'Google_Service_CloudSearch_DateValues'

$doubleValuesDataType

protected mixed $doubleValuesDataType = ''

$doubleValuesType

protected mixed $doubleValuesType = 'Google_Service_CloudSearch_DoubleValues'

$enumValuesDataType

protected mixed $enumValuesDataType = ''

$enumValuesType

protected mixed $enumValuesType = 'Google_Service_CloudSearch_EnumValues'

$htmlValuesDataType

protected mixed $htmlValuesDataType = ''

$htmlValuesType

protected mixed $htmlValuesType = 'Google_Service_CloudSearch_HtmlValues'

$integerValuesDataType

protected mixed $integerValuesDataType = ''

$integerValuesType

protected mixed $integerValuesType = 'Google_Service_CloudSearch_IntegerValues'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$objectValuesDataType

protected mixed $objectValuesDataType = ''

$objectValuesType

protected mixed $objectValuesType = 'Google_Service_CloudSearch_ObjectValues'

$processed

protected mixed $processed = array()

$textValuesDataType

protected mixed $textValuesDataType = ''

$textValuesType

protected mixed $textValuesType = 'Google_Service_CloudSearch_TextValues'

$timestampValuesDataType

protected mixed $timestampValuesDataType = ''

$timestampValuesType

protected mixed $timestampValuesType = 'Google_Service_CloudSearch_TimestampValues'

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 —

getBooleanValue()

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

setBooleanValue()

public setBooleanValue(mixed $booleanValue) : mixed
Parameters
$booleanValue : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : 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