Documentation

Google_Service_CustomSearchAPI_SearchQueriesRequest 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.
$count  : mixed
$cr  : mixed
$cx  : mixed
$dateRestrict  : mixed
$disableCnTwTranslation  : mixed
$exactTerms  : mixed
$excludeTerms  : mixed
$fileType  : mixed
$filter  : mixed
$gl  : mixed
$googleHost  : mixed
$highRange  : mixed
$hl  : mixed
$hq  : mixed
$imgColorType  : mixed
$imgDominantColor  : mixed
$imgSize  : mixed
$imgType  : mixed
$inputEncoding  : mixed
$language  : mixed
$linkSite  : mixed
$lowRange  : mixed
$orTerms  : mixed
$outputEncoding  : mixed
$relatedSite  : mixed
$rights  : mixed
$safe  : mixed
$searchTerms  : mixed
$searchType  : mixed
$siteSearch  : mixed
$siteSearchFilter  : mixed
$sort  : mixed
$startIndex  : mixed
$startPage  : mixed
$title  : mixed
$totalResults  : mixed
$internal_gapi_mappings  : 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.
getCount()  : mixed
getCr()  : mixed
getCx()  : mixed
getDateRestrict()  : mixed
getDisableCnTwTranslation()  : mixed
getExactTerms()  : mixed
getExcludeTerms()  : mixed
getFileType()  : mixed
getFilter()  : mixed
getGl()  : mixed
getGoogleHost()  : mixed
getHighRange()  : mixed
getHl()  : mixed
getHq()  : mixed
getImgColorType()  : mixed
getImgDominantColor()  : mixed
getImgSize()  : mixed
getImgType()  : mixed
getInputEncoding()  : mixed
getLanguage()  : mixed
getLinkSite()  : mixed
getLowRange()  : mixed
getOrTerms()  : mixed
getOutputEncoding()  : mixed
getRelatedSite()  : mixed
getRights()  : mixed
getSafe()  : mixed
getSearchTerms()  : mixed
getSearchType()  : mixed
getSiteSearch()  : mixed
getSiteSearchFilter()  : mixed
getSort()  : mixed
getStartIndex()  : mixed
getStartPage()  : mixed
getTitle()  : mixed
getTotalResults()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setCount()  : mixed
setCr()  : mixed
setCx()  : mixed
setDateRestrict()  : mixed
setDisableCnTwTranslation()  : mixed
setExactTerms()  : mixed
setExcludeTerms()  : mixed
setFileType()  : mixed
setFilter()  : mixed
setGl()  : mixed
setGoogleHost()  : mixed
setHighRange()  : mixed
setHl()  : mixed
setHq()  : mixed
setImgColorType()  : mixed
setImgDominantColor()  : mixed
setImgSize()  : mixed
setImgType()  : mixed
setInputEncoding()  : mixed
setLanguage()  : mixed
setLinkSite()  : mixed
setLowRange()  : mixed
setOrTerms()  : mixed
setOutputEncoding()  : mixed
setRelatedSite()  : mixed
setRights()  : mixed
setSafe()  : mixed
setSearchTerms()  : mixed
setSearchType()  : mixed
setSiteSearch()  : mixed
setSiteSearchFilter()  : mixed
setSort()  : mixed
setStartIndex()  : mixed
setStartPage()  : mixed
setTitle()  : mixed
setTotalResults()  : 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

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$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 —

getDisableCnTwTranslation()

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

setCount()

public setCount(mixed $count) : mixed
Parameters
$count : mixed
Return values
mixed —

setDateRestrict()

public setDateRestrict(mixed $dateRestrict) : mixed
Parameters
$dateRestrict : mixed
Return values
mixed —

setDisableCnTwTranslation()

public setDisableCnTwTranslation(mixed $disableCnTwTranslation) : mixed
Parameters
$disableCnTwTranslation : mixed
Return values
mixed —

setExactTerms()

public setExactTerms(mixed $exactTerms) : mixed
Parameters
$exactTerms : mixed
Return values
mixed —

setExcludeTerms()

public setExcludeTerms(mixed $excludeTerms) : mixed
Parameters
$excludeTerms : mixed
Return values
mixed —

setFileType()

public setFileType(mixed $fileType) : mixed
Parameters
$fileType : mixed
Return values
mixed —

setFilter()

public setFilter(mixed $filter) : mixed
Parameters
$filter : mixed
Return values
mixed —

setGl()

public setGl(mixed $gl) : mixed
Parameters
$gl : mixed
Return values
mixed —

setGoogleHost()

public setGoogleHost(mixed $googleHost) : mixed
Parameters
$googleHost : mixed
Return values
mixed —

setHighRange()

public setHighRange(mixed $highRange) : mixed
Parameters
$highRange : mixed
Return values
mixed —

setHl()

public setHl(mixed $hl) : mixed
Parameters
$hl : mixed
Return values
mixed —

setHq()

public setHq(mixed $hq) : mixed
Parameters
$hq : mixed
Return values
mixed —

setImgColorType()

public setImgColorType(mixed $imgColorType) : mixed
Parameters
$imgColorType : mixed
Return values
mixed —

setImgDominantColor()

public setImgDominantColor(mixed $imgDominantColor) : mixed
Parameters
$imgDominantColor : mixed
Return values
mixed —

setImgSize()

public setImgSize(mixed $imgSize) : mixed
Parameters
$imgSize : mixed
Return values
mixed —

setImgType()

public setImgType(mixed $imgType) : mixed
Parameters
$imgType : mixed
Return values
mixed —

setInputEncoding()

public setInputEncoding(mixed $inputEncoding) : mixed
Parameters
$inputEncoding : mixed
Return values
mixed —

setLanguage()

public setLanguage(mixed $language) : mixed
Parameters
$language : mixed
Return values
mixed —

setLinkSite()

public setLinkSite(mixed $linkSite) : mixed
Parameters
$linkSite : mixed
Return values
mixed —

setLowRange()

public setLowRange(mixed $lowRange) : mixed
Parameters
$lowRange : mixed
Return values
mixed —

setOrTerms()

public setOrTerms(mixed $orTerms) : mixed
Parameters
$orTerms : mixed
Return values
mixed —

setOutputEncoding()

public setOutputEncoding(mixed $outputEncoding) : mixed
Parameters
$outputEncoding : mixed
Return values
mixed —

setRelatedSite()

public setRelatedSite(mixed $relatedSite) : mixed
Parameters
$relatedSite : mixed
Return values
mixed —

setRights()

public setRights(mixed $rights) : mixed
Parameters
$rights : mixed
Return values
mixed —

setSafe()

public setSafe(mixed $safe) : mixed
Parameters
$safe : mixed
Return values
mixed —

setSearchTerms()

public setSearchTerms(mixed $searchTerms) : mixed
Parameters
$searchTerms : mixed
Return values
mixed —

setSearchType()

public setSearchType(mixed $searchType) : mixed
Parameters
$searchType : mixed
Return values
mixed —

setSiteSearch()

public setSiteSearch(mixed $siteSearch) : mixed
Parameters
$siteSearch : mixed
Return values
mixed —

setSiteSearchFilter()

public setSiteSearchFilter(mixed $siteSearchFilter) : mixed
Parameters
$siteSearchFilter : mixed
Return values
mixed —

setSort()

public setSort(mixed $sort) : mixed
Parameters
$sort : mixed
Return values
mixed —

setStartIndex()

public setStartIndex(mixed $startIndex) : mixed
Parameters
$startIndex : mixed
Return values
mixed —

setStartPage()

public setStartPage(mixed $startPage) : mixed
Parameters
$startPage : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : mixed
Return values
mixed —

setTotalResults()

public setTotalResults(mixed $totalResults) : mixed
Parameters
$totalResults : 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