* $customsearchService = new apiCustomsearchService(...); * $cse = $customsearchService->cse; * */ class CseServiceResource extends apiServiceResource { /** * Returns metadata about the search performed, metadata about the custom search engine used for the * search, and the search results. (cse.list) * @param string $q Query * @param array $optParams Optional parameters. Valid optional parameters are listed below. * @opt_param string sort The sort expression to apply to the results * @opt_param string num Number of search results to return * @opt_param string googlehost The local Google domain to use to perform the search. * @opt_param string safe Search safety level * @opt_param string filter Controls turning on or off the duplicate content filter. * @opt_param string start The index of the first result to return * @opt_param string cx The custom search engine ID to scope this search query * @opt_param string lr The language restriction for the search results * @opt_param string cr Country restrict(s). * @opt_param string gl Geolocation of end user. * @opt_param string cref The URL of a linked custom search engine * @return Search */ public function listCse($q, $optParams = array()) { $params = array('q' => $q); $params = array_merge($params, $optParams); $data = $this->__call('list', array($params)); if ($this->useObjects()) { return new Search($data); } else { return $data; } } } /** * Service definition for Customsearch (v1). *
* Lets you search over a website or collection of websites *
** For more information about this service, see the * API Documentation *
* @author Google, Inc. */ class apiCustomsearchService extends apiService { public $cse; /** * Constructs the internal representation of the Customsearch service. * @param apiClient apiClient */ public function __construct(apiClient $apiClient) { $this->rpcPath = '/rpc'; $this->restBasePath = '/customsearch/'; $this->version = 'v1'; $this->serviceName = 'customsearch'; $apiClient->addService($this->serviceName, $this->version); $this->cse = new CseServiceResource($this, $this->serviceName, 'cse', json_decode('{"methods": {"list": {"parameters": {"sort": {"type": "string", "location": "query"}, "filter": {"enum": ["0", "1"], "type": "string", "location": "query"}, "cx": {"type": "string", "location": "query"}, "googlehost": {"type": "string", "location": "query"}, "safe": {"default": "off", "enum": ["high", "medium", "off"], "location": "query", "type": "string"}, "q": {"required": true, "type": "string", "location": "query"}, "start": {"type": "string", "location": "query"}, "num": {"default": "10", "type": "string", "location": "query"}, "lr": {"enum": ["lang_ar", "lang_bg", "lang_ca", "lang_cs", "lang_da", "lang_de", "lang_el", "lang_en", "lang_es", "lang_et", "lang_fi", "lang_fr", "lang_hr", "lang_hu", "lang_id", "lang_is", "lang_it", "lang_iw", "lang_ja", "lang_ko", "lang_lt", "lang_lv", "lang_nl", "lang_no", "lang_pl", "lang_pt", "lang_ro", "lang_ru", "lang_sk", "lang_sl", "lang_sr", "lang_sv", "lang_tr", "lang_zh-CN", "lang_zh-TW"], "type": "string", "location": "query"}, "cr": {"type": "string", "location": "query"}, "gl": {"type": "string", "location": "query"}, "cref": {"type": "string", "location": "query"}}, "id": "search.cse.list", "httpMethod": "GET", "path": "v1", "response": {"$ref": "Search"}}}}', true)); } } class Context extends apiModel { protected $__facetsType = 'ContextFacets'; protected $__facetsDataType = 'array'; public $facets; public $title; public function setFacets(/* array(ContextFacets) */ $facets) { $this->assertIsArray($facets, 'ContextFacets', __METHOD__); $this->facets = $facets; } public function getFacets() { return $this->facets; } public function setTitle($title) { $this->title = $title; } public function getTitle() { return $this->title; } } class ContextFacets extends apiModel { public $anchor; public $label; public function setAnchor($anchor) { $this->anchor = $anchor; } public function getAnchor() { return $this->anchor; } public function setLabel($label) { $this->label = $label; } public function getLabel() { return $this->label; } } class Promotion extends apiModel { public $link; public $displayLink; protected $__imageType = 'PromotionImage'; protected $__imageDataType = ''; public $image; protected $__bodyLinesType = 'PromotionBodyLines'; protected $__bodyLinesDataType = 'array'; public $bodyLines; public $title; public function setLink($link) { $this->link = $link; } public function getLink() { return $this->link; } public function setDisplayLink($displayLink) { $this->displayLink = $displayLink; } public function getDisplayLink() { return $this->displayLink; } public function setImage(PromotionImage $image) { $this->image = $image; } public function getImage() { return $this->image; } public function setBodyLines(/* array(PromotionBodyLines) */ $bodyLines) { $this->assertIsArray($bodyLines, 'PromotionBodyLines', __METHOD__); $this->bodyLines = $bodyLines; } public function getBodyLines() { return $this->bodyLines; } public function setTitle($title) { $this->title = $title; } public function getTitle() { return $this->title; } } class PromotionBodyLines extends apiModel { public $url; public $link; public $title; public function setUrl($url) { $this->url = $url; } public function getUrl() { return $this->url; } public function setLink($link) { $this->link = $link; } public function getLink() { return $this->link; } public function setTitle($title) { $this->title = $title; } public function getTitle() { return $this->title; } } class PromotionImage extends apiModel { public $source; public $width; public $height; public function setSource($source) { $this->source = $source; } public function getSource() { return $this->source; } public function setWidth($width) { $this->width = $width; } public function getWidth() { return $this->width; } public function setHeight($height) { $this->height = $height; } public function getHeight() { return $this->height; } } class Query extends apiModel { public $count; public $sort; public $outputEncoding; public $language; public $title; public $googleHost; public $safe; public $searchTerms; public $filter; public $startIndex; public $cx; public $startPage; public $inputEncoding; public $cr; public $gl; public $totalResults; public $cref; public function setCount($count) { $this->count = $count; } public function getCount() { return $this->count; } public function setSort($sort) { $this->sort = $sort; } public function getSort() { return $this->sort; } public function setOutputEncoding($outputEncoding) { $this->outputEncoding = $outputEncoding; } public function getOutputEncoding() { return $this->outputEncoding; } public function setLanguage($language) { $this->language = $language; } public function getLanguage() { return $this->language; } public function setTitle($title) { $this->title = $title; } public function getTitle() { return $this->title; } public function setGoogleHost($googleHost) { $this->googleHost = $googleHost; } public function getGoogleHost() { return $this->googleHost; } public function setSafe($safe) { $this->safe = $safe; } public function getSafe() { return $this->safe; } public function setSearchTerms($searchTerms) { $this->searchTerms = $searchTerms; } public function getSearchTerms() { return $this->searchTerms; } public function setFilter($filter) { $this->filter = $filter; } public function getFilter() { return $this->filter; } public function setStartIndex($startIndex) { $this->startIndex = $startIndex; } public function getStartIndex() { return $this->startIndex; } public function setCx($cx) { $this->cx = $cx; } public function getCx() { return $this->cx; } public function setStartPage($startPage) { $this->startPage = $startPage; } public function getStartPage() { return $this->startPage; } public function setInputEncoding($inputEncoding) { $this->inputEncoding = $inputEncoding; } public function getInputEncoding() { return $this->inputEncoding; } public function setCr($cr) { $this->cr = $cr; } public function getCr() { return $this->cr; } public function setGl($gl) { $this->gl = $gl; } public function getGl() { return $this->gl; } public function setTotalResults($totalResults) { $this->totalResults = $totalResults; } public function getTotalResults() { return $this->totalResults; } public function setCref($cref) { $this->cref = $cref; } public function getCref() { return $this->cref; } } class Result extends apiModel { public $kind; public $title; public $displayLink; public $cacheId; public $pagemap; public $snippet; public $htmlSnippet; public $link; public $htmlTitle; public function setKind($kind) { $this->kind = $kind; } public function getKind() { return $this->kind; } public function setTitle($title) { $this->title = $title; } public function getTitle() { return $this->title; } public function setDisplayLink($displayLink) { $this->displayLink = $displayLink; } public function getDisplayLink() { return $this->displayLink; } public function setCacheId($cacheId) { $this->cacheId = $cacheId; } public function getCacheId() { return $this->cacheId; } public function setPagemap($pagemap) { $this->pagemap = $pagemap; } public function getPagemap() { return $this->pagemap; } public function setSnippet($snippet) { $this->snippet = $snippet; } public function getSnippet() { return $this->snippet; } public function setHtmlSnippet($htmlSnippet) { $this->htmlSnippet = $htmlSnippet; } public function getHtmlSnippet() { return $this->htmlSnippet; } public function setLink($link) { $this->link = $link; } public function getLink() { return $this->link; } public function setHtmlTitle($htmlTitle) { $this->htmlTitle = $htmlTitle; } public function getHtmlTitle() { return $this->htmlTitle; } } class Search extends apiModel { protected $__promotionsType = 'Promotion'; protected $__promotionsDataType = 'array'; public $promotions; public $kind; protected $__urlType = 'SearchUrl'; protected $__urlDataType = ''; public $url; protected $__itemsType = 'Result'; protected $__itemsDataType = 'array'; public $items; protected $__contextType = 'Context'; protected $__contextDataType = ''; public $context; protected $__queriesType = 'Query'; protected $__queriesDataType = 'map'; public $queries; public function setPromotions(/* array(Promotion) */ $promotions) { $this->assertIsArray($promotions, 'Promotion', __METHOD__); $this->promotions = $promotions; } public function getPromotions() { return $this->promotions; } public function setKind($kind) { $this->kind = $kind; } public function getKind() { return $this->kind; } public function setUrl(SearchUrl $url) { $this->url = $url; } public function getUrl() { return $this->url; } public function setItems(/* array(Result) */ $items) { $this->assertIsArray($items, 'Result', __METHOD__); $this->items = $items; } public function getItems() { return $this->items; } public function setContext(Context $context) { $this->context = $context; } public function getContext() { return $this->context; } public function setQueries(Query $queries) { $this->queries = $queries; } public function getQueries() { return $this->queries; } } class SearchUrl extends apiModel { public $type; public $template; public function setType($type) { $this->type = $type; } public function getType() { return $this->type; } public function setTemplate($template) { $this->template = $template; } public function getTemplate() { return $this->template; } }