vendor/league/oauth2-client/src/Token/AccessToken.php line 25

Open in your IDE?
  1. <?php
  2. /**
  3.  * This file is part of the league/oauth2-client library
  4.  *
  5.  * For the full copyright and license information, please view the LICENSE
  6.  * file that was distributed with this source code.
  7.  *
  8.  * @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
  9.  * @license http://opensource.org/licenses/MIT MIT
  10.  * @link http://thephpleague.com/oauth2-client/ Documentation
  11.  * @link https://packagist.org/packages/league/oauth2-client Packagist
  12.  * @link https://github.com/thephpleague/oauth2-client GitHub
  13.  */
  15. namespace League\OAuth2\Client\Token;
  17. use InvalidArgumentException;
  18. use RuntimeException;
  20. /**
  21.  * Represents an access token.
  22.  *
  23.  * @link http://tools.ietf.org/html/rfc6749#section-1.4 Access Token (RFC 6749, ยง1.4)
  24.  */
  25. class AccessToken implements AccessTokenInterface, ResourceOwnerAccessTokenInterface
  26. {
  27.     /**
  28.      * @var string
  29.      */
  30.     protected $accessToken;
  32.     /**
  33.      * @var int
  34.      */
  35.     protected $expires;
  37.     /**
  38.      * @var string
  39.      */
  40.     protected $refreshToken;
  42.     /**
  43.      * @var string
  44.      */
  45.     protected $resourceOwnerId;
  47.     /**
  48.      * @var array
  49.      */
  50.     protected $values = [];
  52.     /**
  53.      * @var int
  54.      */
  55.     private static $timeNow;
  57.     /**
  58.      * Set the time now. This should only be used for testing purposes.
  59.      *
  60.      * @param int $timeNow the time in seconds since epoch
  61.      * @return void
  62.      */
  63.     public static function setTimeNow($timeNow)
  64.     {
  65.         self::$timeNow = $timeNow;
  66.     }
  68.     /**
  69.      * Reset the time now if it was set for test purposes.
  70.      *
  71.      * @return void
  72.      */
  73.     public static function resetTimeNow()
  74.     {
  75.         self::$timeNow = null;
  76.     }
  78.     /**
  79.      * @return int
  80.      */
  81.     public function getTimeNow()
  82.     {
  83.         return self::$timeNow ? self::$timeNow : time();
  84.     }
  86.     /**
  87.      * Constructs an access token.
  88.      *
  89.      * @param array $options An array of options returned by the service provider
  90.      *     in the access token request. The `access_token` option is required.
  91.      * @throws InvalidArgumentException if `access_token` is not provided in `$options`.
  92.      */
  93.     public function __construct(array $options = [])
  94.     {
  95.         if (empty($options['access_token'])) {
  96.             throw new InvalidArgumentException('Required option not passed: "access_token"');
  97.         }
  99.         $this->accessToken = $options['access_token'];
  101.         if (!empty($options['resource_owner_id'])) {
  102.             $this->resourceOwnerId = $options['resource_owner_id'];
  103.         }
  105.         if (!empty($options['refresh_token'])) {
  106.             $this->refreshToken = $options['refresh_token'];
  107.         }
  109.         // We need to know when the token expires. Show preference to
  110.         // 'expires_in' since it is defined in RFC6749 Section 5.1.
  111.         // Defer to 'expires' if it is provided instead.
  112.         if (isset($options['expires_in'])) {
  113.             if (!is_numeric($options['expires_in'])) {
  114.                 throw new \InvalidArgumentException('expires_in value must be an integer');
  115.             }
  117.             $this->expires = $options['expires_in'] != 0 ? $this->getTimeNow() + $options['expires_in'] : 0;
  118.         } elseif (!empty($options['expires'])) {
  119.             // Some providers supply the seconds until expiration rather than
  120.             // the exact timestamp. Take a best guess at which we received.
  121.             $expires = $options['expires'];
  123.             if (!$this->isExpirationTimestamp($expires)) {
  124.                 $expires += $this->getTimeNow();
  125.             }
  127.             $this->expires = $expires;
  128.         }
  130.         // Capture any additional values that might exist in the token but are
  131.         // not part of the standard response. Vendors will sometimes pass
  132.         // additional user data this way.
  133.         $this->values = array_diff_key($options, array_flip([
  134.             'access_token',
  135.             'resource_owner_id',
  136.             'refresh_token',
  137.             'expires_in',
  138.             'expires',
  139.         ]));
  140.     }
  142.     /**
  143.      * Check if a value is an expiration timestamp or second value.
  144.      *
  145.      * @param integer $value
  146.      * @return bool
  147.      */
  148.     protected function isExpirationTimestamp($value)
  149.     {
  150.         // If the given value is larger than the original OAuth 2 draft date,
  151.         // assume that it is meant to be a (possible expired) timestamp.
  152.         $oauth2InceptionDate = 1349067600; // 2012-10-01
  153.         return ($value > $oauth2InceptionDate);
  154.     }
  156.     /**
  157.      * @inheritdoc
  158.      */
  159.     public function getToken()
  160.     {
  161.         return $this->accessToken;
  162.     }
  164.     /**
  165.      * @inheritdoc
  166.      */
  167.     public function getRefreshToken()
  168.     {
  169.         return $this->refreshToken;
  170.     }
  172.     /**
  173.      * @inheritdoc
  174.      */
  175.     public function getExpires()
  176.     {
  177.         return $this->expires;
  178.     }
  180.     /**
  181.      * @inheritdoc
  182.      */
  183.     public function getResourceOwnerId()
  184.     {
  185.         return $this->resourceOwnerId;
  186.     }
  188.     /**
  189.      * @inheritdoc
  190.      */
  191.     public function hasExpired()
  192.     {
  193.         $expires = $this->getExpires();
  195.         if (empty($expires)) {
  196.             throw new RuntimeException('"expires" is not set on the token');
  197.         }
  199.         return $expires < time();
  200.     }
  202.     /**
  203.      * @inheritdoc
  204.      */
  205.     public function getValues()
  206.     {
  207.         return $this->values;
  208.     }
  210.     /**
  211.      * @inheritdoc
  212.      */
  213.     public function __toString()
  214.     {
  215.         return (string) $this->getToken();
  216.     }
  218.     /**
  219.      * @inheritdoc
  220.      */
  221.     public function jsonSerialize()
  222.     {
  223.         $parameters = $this->values;
  225.         if ($this->accessToken) {
  226.             $parameters['access_token'] = $this->accessToken;
  227.         }
  229.         if ($this->refreshToken) {
  230.             $parameters['refresh_token'] = $this->refreshToken;
  231.         }
  233.         if ($this->expires) {
  234.             $parameters['expires'] = $this->expires;
  235.         }
  237.         if ($this->resourceOwnerId) {
  238.             $parameters['resource_owner_id'] = $this->resourceOwnerId;
  239.         }
  241.         return $parameters;
  242.     }
  243. }