Class SimpleID\Protocols\OAuth\RefreshToken

`extends`	`Token`
`implements`	`TokenGrantType`

An OAuth refresh token.

Refresh tokens are perpetual bearer tokens from which access tokens can be granted. As such, it implements the TokenGrantType interface.

To create and encode a token, use the create() static function. To parse an encoded token, use the decode() static function.

SimpleID\Protocols\OAuth\Token
- SimpleID\Protocols\OAuth\RefreshToken implements TokenGrantType

Located at core/Protocols/OAuth/RefreshToken.php

Methods


					
	protected

__construct()

Creates a refresh token

Overrides

SimpleID\Protocols\OAuth\Token::__construct()


					
	public

getType(): string

{@inheritdoc}

Returns

the token type

Implements

SimpleID\Protocols\OAuth\Token::getType()


					
	public
					static

decode(string $encoded): RefreshToken

Decodes an encoded token and returns an instance of this class containing the decoded data.

The decoded token can be checked for validity using the isValid()

and hasScope()

methods. The data can be obtained using the various get methods.

Parameters

$encoded

the encoded token

Returns

the decoded token


					
	public
					static

create(
	Authorization $authorization,
	array<string> $scope = [],
	TokenGrantType $source = null,
	array<string, mixed> $additional = [],
): RefreshToken|null

Encodes a token from parameters and returns an instance of this class.

The encoded token can be obtained using the getEncoded()

method.

Parameters

`$authorization`	the authorisation to use to create this token
`$scope`	the scope of this token - this must be a subset of the scope provided in `$authorization`
`$source`	if the token is created from a previous authorisation code or refresh token, the ID of those artefacts
`$additional`	any additional data to be stored on the server for this token


					
	public

getGrantRef()

Returns a reference to the identifier of the artefact that granted the token.

Normally the reference is simply a substring of the artefact's ID.

Returns

the reference of the grant identifier

Implements

SimpleID\Protocols\OAuth\TokenGrantType::getGrantRef()

Methods inherited from SimpleID\Protocols\OAuth\Token
`init(), isValid(), getID(), getAuthorization(), getScope(), hasScope(), getAdditionalData(), hasExpired(), getExpiry(), getEncoded(), revoke(), revokeAll(), getCacheKey(), parse(), encode(), getScopeRef(), resolveScope(), getScopeRefMap()`

Constants inherited from SimpleID\Protocols\OAuth\Token
`GRANT_REF_SEPARATOR, TTL_PERPETUAL, KEY_FQAID, KEY_TYPE, KEY_CACHE_HASH, KEY_ID, KEY_GRANTREF, KEY_SCOPEREF, KEY_EXPIRE`

Properties inherited from SimpleID\Protocols\OAuth\Token
`$branca, $id, $authorization, $scope, $expire, $grant_ref, $additional, $encoded, $is_parsed`

Namespaces

Classes

Interfaces

Class SimpleID\Protocols\OAuth\RefreshToken

Overrides

Returns

Implements

Parameters

Returns

Parameters

Returns

Implements