Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403]

   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   * Simple API access implementation. Can either be used to make requests
  24   * completely unauthenticated, or by using a Simple API Access developer
  25   * key.
  26   */
  27  #[AllowDynamicProperties]
  28  class Google_Auth_Simple extends Google_Auth_Abstract
  29  {
  30    private $client;
  31  
  32    public function __construct(Google_Client $client, $config = null)
  33    {
  34      $this->client = $client;
  35    }
  36  
  37    /**
  38     * Perform an authenticated / signed apiHttpRequest.
  39     * This function takes the apiHttpRequest, calls apiAuth->sign on it
  40     * (which can modify the request in what ever way fits the auth mechanism)
  41     * and then calls apiCurlIO::makeRequest on the signed request
  42     *
  43     * @param Google_Http_Request $request
  44     * @return Google_Http_Request The resulting HTTP response including the
  45     * responseHttpCode, responseHeaders and responseBody.
  46     */
  47    public function authenticatedRequest(Google_Http_Request $request)
  48    {
  49      $request = $this->sign($request);
  50      return $this->io->makeRequest($request);
  51    }
  52  
  53    public function sign(Google_Http_Request $request)
  54    {
  55      $key = $this->client->getClassConfig($this, 'developer_key');
  56      if ($key) {
  57        $this->client->getLogger()->debug(
  58            'Simple API Access developer key authentication'
  59        );
  60        $request->setQueryParam('key', $key);
  61      }
  62      return $request;
  63    }
  64  }