Documentation

Google_Service_CloudSearch_SearchResponse 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.
$hasMoreResults  : mixed
$resultCountEstimate  : mixed
$resultCountExact  : mixed
$collection_key  : mixed
$debugInfoDataType  : mixed
$debugInfoType  : mixed
$errorInfoDataType  : mixed
$errorInfoType  : mixed
$facetResultsDataType  : mixed
$facetResultsType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$queryInterpretationDataType  : mixed
$queryInterpretationType  : mixed
$resultCountsDataType  : mixed
$resultCountsType  : mixed
$resultsDataType  : mixed
$resultsType  : mixed
$spellResultsDataType  : mixed
$spellResultsType  : mixed
$structuredResultsDataType  : mixed
$structuredResultsType  : 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
getDebugInfo()  : Google_Service_CloudSearch_ResponseDebugInfo
getErrorInfo()  : Google_Service_CloudSearch_ErrorInfo
getFacetResults()  : Google_Service_CloudSearch_FacetResult
getHasMoreResults()  : mixed
getQueryInterpretation()  : Google_Service_CloudSearch_QueryInterpretation
getResultCountEstimate()  : mixed
getResultCountExact()  : mixed
getResultCounts()  : Google_Service_CloudSearch_ResultCounts
getResults()  : Google_Service_CloudSearch_SearchResult
getSpellResults()  : Google_Service_CloudSearch_SpellResult
getStructuredResults()  : Google_Service_CloudSearch_StructuredResult
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setDebugInfo()  : mixed
setErrorInfo()  : mixed
setFacetResults()  : mixed
setHasMoreResults()  : mixed
setQueryInterpretation()  : mixed
setResultCountEstimate()  : mixed
setResultCountExact()  : mixed
setResultCounts()  : mixed
setResults()  : mixed
setSpellResults()  : mixed
setStructuredResults()  : 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 = 'structuredResults'

$debugInfoType

protected mixed $debugInfoType = 'Google_Service_CloudSearch_ResponseDebugInfo'

$errorInfoType

protected mixed $errorInfoType = 'Google_Service_CloudSearch_ErrorInfo'

$facetResultsDataType

protected mixed $facetResultsDataType = 'array'

$facetResultsType

protected mixed $facetResultsType = 'Google_Service_CloudSearch_FacetResult'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$queryInterpretationDataType

protected mixed $queryInterpretationDataType = ''

$queryInterpretationType

protected mixed $queryInterpretationType = 'Google_Service_CloudSearch_QueryInterpretation'

$resultCountsDataType

protected mixed $resultCountsDataType = ''

$resultCountsType

protected mixed $resultCountsType = 'Google_Service_CloudSearch_ResultCounts'

$resultsType

protected mixed $resultsType = 'Google_Service_CloudSearch_SearchResult'

$spellResultsDataType

protected mixed $spellResultsDataType = 'array'

$spellResultsType

protected mixed $spellResultsType = 'Google_Service_CloudSearch_SpellResult'

$structuredResultsDataType

protected mixed $structuredResultsDataType = 'array'

$structuredResultsType

protected mixed $structuredResultsType = 'Google_Service_CloudSearch_StructuredResult'

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 —

getHasMoreResults()

public getHasMoreResults() : mixed
Return values
mixed —

getResultCountEstimate()

public getResultCountEstimate() : mixed
Return values
mixed —

getResultCountExact()

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

setFacetResults()

public setFacetResults(mixed $facetResults) : mixed
Parameters
$facetResults : mixed
Return values
mixed —

setHasMoreResults()

public setHasMoreResults(mixed $hasMoreResults) : mixed
Parameters
$hasMoreResults : mixed
Return values
mixed —

setResultCountEstimate()

public setResultCountEstimate(mixed $resultCountEstimate) : mixed
Parameters
$resultCountEstimate : mixed
Return values
mixed —

setResultCountExact()

public setResultCountExact(mixed $resultCountExact) : mixed
Parameters
$resultCountExact : mixed
Return values
mixed —

setResults()

public setResults(mixed $results) : mixed
Parameters
$results : mixed
Return values
mixed —

setSpellResults()

public setSpellResults(mixed $spellResults) : mixed
Parameters
$spellResults : mixed
Return values
mixed —

setStructuredResults()

public setStructuredResults(mixed $structuredResults) : mixed
Parameters
$structuredResults : 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