1. class
  2. Symfony
  3. Component
  4. Security
  5. Csrf
  6. TokenStorage
  7. NativeSessionTokenStorage

NativeSessionTokenStorage

class NativeSessionTokenStorage implements TokenStorageInterface

Token storage that uses PHP's native session handling.

Constants

SESSION_NAMESPACE

The namespace used to store values in the session.

Methods

__construct(string $namespace = self::SESSION_NAMESPACE)

Initializes the storage with a session namespace.

string
getToken(string $tokenId)

Reads a stored CSRF token.

setToken(string $tokenId, string $token)

Stores a CSRF token.

bool
hasToken(string $tokenId)

Checks whether a token with the given token ID exists.

string|null
removeToken(string $tokenId)

Removes a CSRF token.

Details

at line line 48
__construct(string $namespace = self::SESSION_NAMESPACE)

Initializes the storage with a session namespace.

Parameters

string $namespace The namespace under which the token is stored in the session

at line line 56
string getToken(string $tokenId)

Reads a stored CSRF token.

Parameters

string $tokenId The token ID

Return Value

string The stored token

Exceptions

TokenNotFoundException If the token ID does not exist

at line line 72
setToken(string $tokenId, string $token)

Stores a CSRF token.

Parameters

string $tokenId The token ID
string $token The CSRF token

at line line 84
bool hasToken(string $tokenId)

Checks whether a token with the given token ID exists.

Parameters

string $tokenId The token ID

Return Value

bool Whether a token exists with the given ID

at line line 96
string|null removeToken(string $tokenId)

Removes a CSRF token.

Parameters

string $tokenId The token ID

Return Value

string|null Returns the removed token if one existed, NULL otherwise