OpenXE/vendor/league/oauth2-client/src/Token/AccessTokenInterface.php
2021-05-21 08:49:41 +02:00

73 lines
1.7 KiB
PHP

<?php
/**
* This file is part of the league/oauth2-client library
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
* @license http://opensource.org/licenses/MIT MIT
* @link http://thephpleague.com/oauth2-client/ Documentation
* @link https://packagist.org/packages/league/oauth2-client Packagist
* @link https://github.com/thephpleague/oauth2-client GitHub
*/
namespace League\OAuth2\Client\Token;
use JsonSerializable;
use RuntimeException;
interface AccessTokenInterface extends JsonSerializable
{
/**
* Returns the access token string of this instance.
*
* @return string
*/
public function getToken();
/**
* Returns the refresh token, if defined.
*
* @return string|null
*/
public function getRefreshToken();
/**
* Returns the expiration timestamp in seconds, if defined.
*
* @return integer|null
*/
public function getExpires();
/**
* Checks if this token has expired.
*
* @return boolean true if the token has expired, false otherwise.
* @throws RuntimeException if 'expires' is not set on the token.
*/
public function hasExpired();
/**
* Returns additional vendor values stored in the token.
*
* @return array
*/
public function getValues();
/**
* Returns a string representation of the access token
*
* @return string
*/
public function __toString();
/**
* Returns an array of parameters to serialize when this is serialized with
* json_encode().
*
* @return array
*/
public function jsonSerialize();
}