[Summary view] [Print] [Text view]

   1  <?php
   2  /*
   3   * Copyright 2010 Google Inc.
   4   *
   5   * Licensed under the Apache License, Version 2.0 (the "License");
   6   * you may not use this file except in compliance with the License.
   7   * You may obtain a copy of the License at
   8   *
   9   *     http://www.apache.org/licenses/LICENSE-2.0
  10   *
  11   * Unless required by applicable law or agreed to in writing, software
  12   * distributed under the License is distributed on an "AS IS" BASIS,
  13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   * See the License for the specific language governing permissions and
  15   * limitations under the License.
  16   */
  17  
  18  require_once "Google/Auth/Abstract.php";
  19  require_once "Google/Http/Request.php";
  20  
  21  /**
  22   * Simple API access implementation. Can either be used to make requests
  23   * completely unauthenticated, or by using a Simple API Access developer
  24   * key.
  25   * @author Chris Chabot <[email protected]>
  26   * @author Chirag Shah <[email protected]>
  27   */
  28  class Google_Auth_Simple extends Google_Auth_Abstract
  29  {
  30    private $key = null;
  31    private $client;
  32  
  33    public function __construct(Google_Client $client, $config = null)
  34    {
  35      $this->client = $client;
  36    }
  37  
  38    /**
  39     * Perform an authenticated / signed apiHttpRequest.
  40     * This function takes the apiHttpRequest, calls apiAuth->sign on it
  41     * (which can modify the request in what ever way fits the auth mechanism)
  42     * and then calls apiCurlIO::makeRequest on the signed request
  43     *
  44     * @param Google_Http_Request $request
  45     * @return Google_Http_Request The resulting HTTP response including the
  46     * responseHttpCode, responseHeaders and responseBody.
  47     */
  48    public function authenticatedRequest(Google_Http_Request $request)
  49    {
  50      $request = $this->sign($request);
  51      return $this->io->makeRequest($request);
  52    }
  53  
  54    public function sign(Google_Http_Request $request)
  55    {
  56      $key = $this->client->getClassConfig($this, 'developer_key');
  57      if ($key) {
  58        $request->setQueryParam('key', $key);
  59      }
  60      return $request;
  61    }
  62  }