[Summary 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  if (!class_exists('Google_Client')) {
  19    require_once dirname(__FILE__) . '/../autoload.php';
  20  }
  21  
  22  /**
  23   * Abstract class for the Authentication in the API client
  24   * @author Chris Chabot <chabotc@google.com>
  25   *
  26   */
  27  abstract class Google_Auth_Abstract
  28  {
  29    /**
  30     * An utility function that first calls $this->auth->sign($request) and then
  31     * executes makeRequest() on that signed request. Used for when a request
  32     * should be authenticated
  33     * @param Google_Http_Request $request
  34     * @return Google_Http_Request $request
  35     */
  36    abstract public function authenticatedRequest(Google_Http_Request $request);
  37    abstract public function sign(Google_Http_Request $request);
  38  }