Documentation

Google_Service_Customsearch_Result 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.
$cacheId  : mixed
$displayLink  : mixed
$fileFormat  : mixed
$formattedUrl  : mixed
$htmlFormattedUrl  : mixed
$htmlSnippet  : mixed
$htmlTitle  : mixed
$kind  : mixed
$link  : mixed
$mime  : mixed
$pagemap  : mixed
$snippet  : mixed
$title  : mixed
$collection_key  : mixed
$imageDataType  : mixed
$imageType  : mixed
$internal_gapi_mappings  : mixed
$labelsDataType  : mixed
$labelsType  : mixed
$modelData  : mixed
$processed  : 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
getCacheId()  : mixed
getDisplayLink()  : mixed
getFileFormat()  : mixed
getFormattedUrl()  : mixed
getHtmlFormattedUrl()  : mixed
getHtmlSnippet()  : mixed
getHtmlTitle()  : mixed
getImage()  : Google_Service_Customsearch_ResultImage
getKind()  : mixed
getLabels()  : Google_Service_Customsearch_ResultLabels
getLink()  : mixed
getMime()  : mixed
getPagemap()  : mixed
getSnippet()  : mixed
getTitle()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCacheId()  : mixed
setDisplayLink()  : mixed
setFileFormat()  : mixed
setFormattedUrl()  : mixed
setHtmlFormattedUrl()  : mixed
setHtmlSnippet()  : mixed
setHtmlTitle()  : mixed
setImage()  : mixed
setKind()  : mixed
setLabels()  : mixed
setLink()  : mixed
setMime()  : mixed
setPagemap()  : mixed
setSnippet()  : mixed
setTitle()  : 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

$displayLink

public mixed $displayLink

$fileFormat

public mixed $fileFormat

$formattedUrl

public mixed $formattedUrl

$htmlFormattedUrl

public mixed $htmlFormattedUrl

$htmlSnippet

public mixed $htmlSnippet

$htmlTitle

public mixed $htmlTitle

$collection_key

protected mixed $collection_key = 'labels'

$imageDataType

protected mixed $imageDataType = ''

$imageType

protected mixed $imageType = 'Google_Service_Customsearch_ResultImage'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$labelsDataType

protected mixed $labelsDataType = 'array'

$labelsType

protected mixed $labelsType = 'Google_Service_Customsearch_ResultLabels'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

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 —

getCacheId()

public getCacheId() : mixed
Return values
mixed —

getDisplayLink()

public getDisplayLink() : mixed
Return values
mixed —

getFileFormat()

public getFileFormat() : mixed
Return values
mixed —

getFormattedUrl()

public getFormattedUrl() : mixed
Return values
mixed —

getHtmlFormattedUrl()

public getHtmlFormattedUrl() : mixed
Return values
mixed —

getHtmlSnippet()

public getHtmlSnippet() : mixed
Return values
mixed —

getHtmlTitle()

public getHtmlTitle() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getLink()

public getLink() : mixed
Return values
mixed —

getMime()

public getMime() : mixed
Return values
mixed —

getPagemap()

public getPagemap() : mixed
Return values
mixed —

getSnippet()

public getSnippet() : mixed
Return values
mixed —

getTitle()

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

setCacheId()

public setCacheId(mixed $cacheId) : mixed
Parameters
$cacheId : mixed
Return values
mixed —

setDisplayLink()

public setDisplayLink(mixed $displayLink) : mixed
Parameters
$displayLink : mixed
Return values
mixed —

setFileFormat()

public setFileFormat(mixed $fileFormat) : mixed
Parameters
$fileFormat : mixed
Return values
mixed —

setFormattedUrl()

public setFormattedUrl(mixed $formattedUrl) : mixed
Parameters
$formattedUrl : mixed
Return values
mixed —

setHtmlFormattedUrl()

public setHtmlFormattedUrl(mixed $htmlFormattedUrl) : mixed
Parameters
$htmlFormattedUrl : mixed
Return values
mixed —

setHtmlSnippet()

public setHtmlSnippet(mixed $htmlSnippet) : mixed
Parameters
$htmlSnippet : mixed
Return values
mixed —

setHtmlTitle()

public setHtmlTitle(mixed $htmlTitle) : mixed
Parameters
$htmlTitle : mixed
Return values
mixed —

setKind()

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

setLabels()

public setLabels(mixed $labels) : mixed
Parameters
$labels : mixed
Return values
mixed —

setLink()

public setLink(mixed $link) : mixed
Parameters
$link : mixed
Return values
mixed —

setMime()

public setMime(mixed $mime) : mixed
Parameters
$mime : mixed
Return values
mixed —

setPagemap()

public setPagemap(mixed $pagemap) : mixed
Parameters
$pagemap : mixed
Return values
mixed —

setSnippet()

public setSnippet(mixed $snippet) : mixed
Parameters
$snippet : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : 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