TokenProviderInterface

interface TokenProviderInterface

Interface for TokenProviders.

Methods

PersistentTokenInterface loadTokenBySeries(string $series)

Loads the active token for the given series.

deleteTokenBySeries(string $series)

Deletes all tokens belonging to series.

updateToken(string $series, string $tokenValue, DateTime $lastUsed)

Updates the token according to this data.

createNewToken(PersistentTokenInterface $token)

Creates a new token.

Details

PersistentTokenInterface loadTokenBySeries(string $series)

Loads the active token for the given series.

Parameters

string $series

Return Value

PersistentTokenInterface

Exceptions

TokenNotFoundException if the token is not found

deleteTokenBySeries(string $series)

Deletes all tokens belonging to series.

Parameters

string $series

updateToken(string $series, string $tokenValue, DateTime $lastUsed)

Updates the token according to this data.

Parameters

string $series
string $tokenValue
DateTime $lastUsed

Exceptions

TokenNotFoundException if the token is not found

createNewToken(PersistentTokenInterface $token)

Creates a new token.

Parameters

PersistentTokenInterface $token