Classes List

Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Security\Csrf\TokenStorage;

/** * Stores CSRF tokens. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface TokenStorageInterface
{
    /** * Reads a stored CSRF token. * * @param string $tokenId The token ID * * @return string The stored token * * @throws \Symfony\Component\Security\Csrf\Exception\TokenNotFoundException If the token ID does not exist */
    public function getToken($tokenId);

    /** * Stores a CSRF token. * * @param string $tokenId The token ID * @param string $token The CSRF token */
    public function setToken($tokenId$token);

    /** * Removes a CSRF token. * * @param string $tokenId The token ID * * @return string|null Returns the removed token if one existed, NULL * otherwise */
    public function removeToken($tokenId);

    /** * Checks whether a token with the given token ID exists. * * @param string $tokenId The token ID * * @return bool Whether a token exists with the given ID */
    public function hasToken($tokenId);
}