Documentation

Google_Service_CloudSearch_PropertyDefinition 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.
$isFacetable  : mixed
$isRepeatable  : mixed
$isReturnable  : mixed
$isSortable  : mixed
$isSuggestable  : mixed
$isWildcardSearchable  : mixed
$name  : mixed
$booleanPropertyOptionsDataType  : mixed
$booleanPropertyOptionsType  : mixed
$datePropertyOptionsDataType  : mixed
$datePropertyOptionsType  : mixed
$displayOptionsDataType  : mixed
$displayOptionsType  : mixed
$doublePropertyOptionsDataType  : mixed
$doublePropertyOptionsType  : mixed
$enumPropertyOptionsDataType  : mixed
$enumPropertyOptionsType  : mixed
$htmlPropertyOptionsDataType  : mixed
$htmlPropertyOptionsType  : mixed
$integerPropertyOptionsDataType  : mixed
$integerPropertyOptionsType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$objectPropertyOptionsDataType  : mixed
$objectPropertyOptionsType  : mixed
$processed  : mixed
$textPropertyOptionsDataType  : mixed
$textPropertyOptionsType  : mixed
$timestampPropertyOptionsDataType  : mixed
$timestampPropertyOptionsType  : 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.
getBooleanPropertyOptions()  : Google_Service_CloudSearch_BooleanPropertyOptions
getDatePropertyOptions()  : Google_Service_CloudSearch_DatePropertyOptions
getDisplayOptions()  : Google_Service_CloudSearch_PropertyDisplayOptions
getDoublePropertyOptions()  : Google_Service_CloudSearch_DoublePropertyOptions
getEnumPropertyOptions()  : Google_Service_CloudSearch_EnumPropertyOptions
getHtmlPropertyOptions()  : Google_Service_CloudSearch_HtmlPropertyOptions
getIntegerPropertyOptions()  : Google_Service_CloudSearch_IntegerPropertyOptions
getIsFacetable()  : mixed
getIsRepeatable()  : mixed
getIsReturnable()  : mixed
getIsSortable()  : mixed
getIsSuggestable()  : mixed
getIsWildcardSearchable()  : mixed
getName()  : mixed
getObjectPropertyOptions()  : Google_Service_CloudSearch_ObjectPropertyOptions
getTextPropertyOptions()  : Google_Service_CloudSearch_TextPropertyOptions
getTimestampPropertyOptions()  : Google_Service_CloudSearch_TimestampPropertyOptions
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setBooleanPropertyOptions()  : mixed
setDatePropertyOptions()  : mixed
setDisplayOptions()  : mixed
setDoublePropertyOptions()  : mixed
setEnumPropertyOptions()  : mixed
setHtmlPropertyOptions()  : mixed
setIntegerPropertyOptions()  : mixed
setIsFacetable()  : mixed
setIsRepeatable()  : mixed
setIsReturnable()  : mixed
setIsSortable()  : mixed
setIsSuggestable()  : mixed
setIsWildcardSearchable()  : mixed
setName()  : mixed
setObjectPropertyOptions()  : mixed
setTextPropertyOptions()  : mixed
setTimestampPropertyOptions()  : 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

$booleanPropertyOptionsDataType

protected mixed $booleanPropertyOptionsDataType = ''

$booleanPropertyOptionsType

protected mixed $booleanPropertyOptionsType = 'Google_Service_CloudSearch_BooleanPropertyOptions'

$datePropertyOptionsType

protected mixed $datePropertyOptionsType = 'Google_Service_CloudSearch_DatePropertyOptions'

$displayOptionsType

protected mixed $displayOptionsType = 'Google_Service_CloudSearch_PropertyDisplayOptions'

$doublePropertyOptionsDataType

protected mixed $doublePropertyOptionsDataType = ''

$doublePropertyOptionsType

protected mixed $doublePropertyOptionsType = 'Google_Service_CloudSearch_DoublePropertyOptions'

$enumPropertyOptionsType

protected mixed $enumPropertyOptionsType = 'Google_Service_CloudSearch_EnumPropertyOptions'

$htmlPropertyOptionsType

protected mixed $htmlPropertyOptionsType = 'Google_Service_CloudSearch_HtmlPropertyOptions'

$integerPropertyOptionsDataType

protected mixed $integerPropertyOptionsDataType = ''

$integerPropertyOptionsType

protected mixed $integerPropertyOptionsType = 'Google_Service_CloudSearch_IntegerPropertyOptions'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$objectPropertyOptionsDataType

protected mixed $objectPropertyOptionsDataType = ''

$objectPropertyOptionsType

protected mixed $objectPropertyOptionsType = 'Google_Service_CloudSearch_ObjectPropertyOptions'

$processed

protected mixed $processed = array()

$textPropertyOptionsType

protected mixed $textPropertyOptionsType = 'Google_Service_CloudSearch_TextPropertyOptions'

$timestampPropertyOptionsDataType

protected mixed $timestampPropertyOptionsDataType = ''

$timestampPropertyOptionsType

protected mixed $timestampPropertyOptionsType = 'Google_Service_CloudSearch_TimestampPropertyOptions'

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 —

getIsWildcardSearchable()

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

setIsFacetable()

public setIsFacetable(mixed $isFacetable) : mixed
Parameters
$isFacetable : mixed
Return values
mixed —

setIsRepeatable()

public setIsRepeatable(mixed $isRepeatable) : mixed
Parameters
$isRepeatable : mixed
Return values
mixed —

setIsReturnable()

public setIsReturnable(mixed $isReturnable) : mixed
Parameters
$isReturnable : mixed
Return values
mixed —

setIsSortable()

public setIsSortable(mixed $isSortable) : mixed
Parameters
$isSortable : mixed
Return values
mixed —

setIsSuggestable()

public setIsSuggestable(mixed $isSuggestable) : mixed
Parameters
$isSuggestable : mixed
Return values
mixed —

setIsWildcardSearchable()

public setIsWildcardSearchable(mixed $isWildcardSearchable) : mixed
Parameters
$isWildcardSearchable : 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