CsrfTokenManager
class CsrfTokenManager implements CsrfTokenManagerInterface
Стандартная реализация {@link CsrfTokenManagerInterface}.
Методы
| __construct(TokenGeneratorInterface $generator = null, TokenStorageInterface $storage = null) Создаёт новый поставщик CSRF, используя встроенное хранилище сессий PHP. | ||
| CsrfToken | getToken(string $tokenId) Возвращает токен CSRF для заданного идентификатора. | |
| CsrfToken | refreshToken(string $tokenId) Генерирует новое значение токена для заданного идентификатора. | |
| string|null | removeToken(string $tokenId) Деактивирует токен CSRF с заданным идентификатором, если он существует. | |
| bool | isTokenValid(CsrfToken $token) Возвращает, является ли заданный токен CSRF валидным. |
Подробное описание
__construct(TokenGeneratorInterface $generator = null, TokenStorageInterface $storage = null)
Создаёт новый поставщик CSRF, используя встроенное хранилище сессий PHP.
Параметры
| TokenGeneratorInterface | $generator | Генератор токенов |
| TokenStorageInterface | $storage | Хранилище сгенерированных токенов CSRF |
CsrfToken getToken(string $tokenId)
Возвращает токен CSRF для заданного идентификатора.
Если ранее для данного идентификатора токен не существовал, генерируется новый. В противном случае возвращается существующий токен (с тем же значением, а не с тем же экземпляром).
Параметры
| string | $tokenId | Идентификатор токена. Вы можете выбрать произвольное значение для идентификатора |
Значение возврата
| CsrfToken | Токен CSRF |
CsrfToken refreshToken(string $tokenId)
Генерирует новое значение токена для заданного идентификатора.
Этот метод сгенерирует новое значение токена для заданного идентификатора, независимо от того, существовало ли ранее значение токена или нет. Он может использоваться для обеспечения токенов, которые можно использовать только один раз, в средах с высокими требованиями к безопасности.
Параметры
| string | $tokenId | Идентификатор токена. Вы можете выбрать произвольное значение для идентификатора |
Значение возврата
| CsrfToken | Токен CSRF |
string|null removeToken(string $tokenId)
Деактивирует токен CSRF с заданным идентификатором, если он существует.
Параметры
| string | $tokenId | Идентификатор токена |
Значение возврата
| string|null | Возвращает удалённое значение токена, если оно существовало, в противном случае NULL |
bool isTokenValid(CsrfToken $token)
Возвращает, является ли заданный токен CSRF валидным.
Параметры
| CsrfToken | $token | Токен CSRF |
Значение возврата
| bool | Возвращает true, если токен валиден, в противном случае false |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Security/Csrf/CsrfTokenManager.html