apiCustomsearchService.php 12.8 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
<?php
/*
 * Copyright (c) 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

require_once 'service/apiModel.php';
require_once 'service/apiService.php';
require_once 'service/apiServiceRequest.php';


  /**
   * The "cse" collection of methods.
   * Typical usage is:
   *  <code>
   *   $customsearchService = new apiCustomsearchService(...);
   *   $cse = $customsearchService->cse;
   *  </code>
   */
  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).
 *
 * <p>
 * Lets you search over a website or collection of websites
 * </p>
 *
 * <p>
 * For more information about this service, see the
 * <a href="http://code.google.com/apis/customsearch/v1/using_rest.html" target="_blank">API Documentation</a>
 * </p>
 *
 * @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';
    $this->io = $apiClient->getIo();

    $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 Search extends apiModel {

  public $promotions;
  public $kind;
  public $url;
  public $items;
  public $context;
  public $queries;

  public function setPromotions(Promotion $promotions) {
    $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(Result $items) {
    $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 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 ContextFacetsItems 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 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;
  }
  
}


class ResultPagemap extends apiModel {


}


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 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 Context extends apiModel {

  public $facets;
  public $title;

  public function setFacets(ContextFacetsItems $facets) {
    $this->facets = $facets;
  }

  public function getFacets() {
    return $this->facets;
  }
  
  public function setTitle($title) {
    $this->title = $title;
  }

  public function getTitle() {
    return $this->title;
  }
  
}


class SearchQueries extends apiModel {


}


class ContextFacets extends apiModel {

  public $items;

  public function setItems(/* array() */ $items) {
    $this->items = $items;
  }


}


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 Promotion extends apiModel {

  public $link;
  public $displayLink;
  public $image;
  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(PromotionBodyLines $bodyLines) {
    $this->bodyLines = $bodyLines;
  }

  public function getBodyLines() {
    return $this->bodyLines;
  }
  
  public function setTitle($title) {
    $this->title = $title;
  }

  public function getTitle() {
    return $this->title;
  }
  
}


class ResultPagemapItems extends apiModel {


}