fkooman\OAuth\Client\AccessToken::__toString()

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

1 Method

Rating	Name	Duplication	Size	Complexity
A	AccessToken::getToken()	0	4	1

<?php
/**
 *  Copyright (C) 2017 François Kooman <fkooman@tuxed.net>.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace fkooman\OAuth\Client;

use DateTime;

/**
 * AccessToken object containing the response from the OAuth 2.0 provider's
 * token response.
 */
class AccessToken
{
    /** @var string */
    private $accessToken;

    /** @var string */
    private $tokenType;

    /** @var string */
    private $scope;

    /** @var string|null */
    private $refreshToken;

    /** @var \DateTime */
    private $expiresAt;

    public function __construct($accessToken, $tokenType, $scope, $refreshToken, DateTime $expiresAt)
    {
        $this->accessToken = $accessToken;
        $this->tokenType = $tokenType;
        $this->scope = $scope;
        $this->refreshToken = $refreshToken;
        $this->expiresAt = $expiresAt;
    }

    /**
     * Get the access token.
     *
     * @return string the access token
     *
     * @see https://tools.ietf.org/html/rfc6749#section-5.1
     */
    public function getToken()
    {
        return $this->accessToken;
    }

    /**
     * Get the token type.
     *
     * @return string the token type
     *
     * @see https://tools.ietf.org/html/rfc6749#section-7.1
     */
    public function getTokenType()
    {
        return $this->tokenType;
    }

    /**
     * Get the scope.
     *
     * @return string the scope
     *
     * @see https://tools.ietf.org/html/rfc6749#section-3.3
     */
    public function getScope()
    {
        return $this->scope;
    }

    /**
     * Get the refresh token.
     *
     * @return string|null the refresh token
     *
     * @see https://tools.ietf.org/html/rfc6749#section-1.5
     */
    public function getRefreshToken()
    {
        return $this->refreshToken;
    }

    /**
     * @return DateTime
     */
    public function getExpiresAt()
    {
        return $this->expiresAt;
    }

    /**
     * @param DateTime|null $dateTime
     *
     * @return bool
     */
    public function isExpired(DateTime $dateTime = null)
    {
        if (is_null($dateTime)) {
            $dateTime = new DateTime();
        }

        return $dateTime >= $this->expiresAt;
    }

    /**
     * @return string
     */
    public function json()
    {
        return json_encode(
            [
                'access_token' => $this->accessToken,
                'token_type' => $this->tokenType,
                'scope' => $this->scope,
                'refresh_token' => $this->refreshToken,
                'expires_at' => $this->expiresAt->format('Y-m-d H:i:s'),
            ]
        );
    }

    /**
     * @param string $jsonData
     *
     * @return AccessToken
     */
    public static function fromJson($jsonData)
    {
        // XXX verify json decoding, verify all keys
        $tokenData = json_decode($jsonData, true);

        return new self(
            $tokenData['access_token'],
            $tokenData['token_type'],
            $tokenData['scope'],
            $tokenData['refresh_token'],
            new DateTime($tokenData['expires_at'])
        );
    }
}