[Summary view]

Differences Between: [Versions 310 and 402] [Versions 310 and 403]

   1  <?php
   2  /*
   3   * Copyright 2011 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   * Class to hold information about an authenticated login.
  24   *
  25   * @author Brian Eaton <beaton@google.com>
  26   */
  27  class Google_Auth_LoginTicket
  28  {
  29    const USER_ATTR = "sub";
  30  
  31    // Information from id token envelope.
  32    private $envelope;
  33  
  34    // Information from id token payload.
  35    private $payload;
  36  
  37    /**
  38     * Creates a user based on the supplied token.
  39     *
  40     * @param string $envelope Header from a verified authentication token.
  41     * @param string $payload Information from a verified authentication token.
  42     */
  43    public function __construct($envelope, $payload)
  44    {
  45      $this->envelope = $envelope;
  46      $this->payload = $payload;
  47    }
  48  
  49    /**
  50     * Returns the numeric identifier for the user.
  51     * @throws Google_Auth_Exception
  52     * @return
  53     */
  54    public function getUserId()
  55    {
  56      if (array_key_exists(self::USER_ATTR, $this->payload)) {
  57        return $this->payload[self::USER_ATTR];
  58      }
  59      throw new Google_Auth_Exception("No user_id in token");
  60    }
  61  
  62    /**
  63     * Returns attributes from the login ticket.  This can contain
  64     * various information about the user session.
  65     * @return array
  66     */
  67    public function getAttributes()
  68    {
  69      return array("envelope" => $this->envelope, "payload" => $this->payload);
  70    }
  71  }