interface CsrfTokenManagerInterface
Manages CSRF tokens.
Methods
CsrfToken | getToken(string $tokenId) Returns a CSRF token for the given ID. | |
CsrfToken | refreshToken(string $tokenId) Generates a new token value for the given ID. | |
string|null | removeToken(string $tokenId) Invalidates the CSRF token with the given ID, if one exists. | |
bool | isTokenValid(CsrfToken $token) Returns whether the given CSRF token is valid. |
Details
CsrfToken getToken(string $tokenId)
Returns a CSRF token for the given ID.
If previously no token existed for the given ID, a new token is generated. Otherwise the existing token is returned (with the same value, not the same instance).
CsrfToken refreshToken(string $tokenId)
Generates a new token value for the given ID.
This method will generate a new token for the given token ID, independent of whether a token value previously existed or not. It can be used to enforce once-only tokens in environments with high security needs.
string|null removeToken(string $tokenId)
Invalidates the CSRF token with the given ID, if one exists.
bool isTokenValid(CsrfToken $token)
Returns whether the given CSRF token is valid.
Please login to continue.