yokai-php / security-token-bundle

Manager/TokenManagerInterface.php

<?php

namespace Yokai\SecurityTokenBundle\Manager;

use DateTime;
use Yokai\SecurityTokenBundle\Entity\Token;
use Yokai\SecurityTokenBundle\Exception\TokenExpiredException;
use Yokai\SecurityTokenBundle\Exception\TokenNotFoundException;
use Yokai\SecurityTokenBundle\Exception\TokenUsedException;

/**
 * @author Yann Eugoné <eugone.yann@gmail.com>
 */
interface TokenManagerInterface
{
    /**
     * @param string $purpose
     * @param string $value
     *
     * @return Token
     *
     * @throws TokenNotFoundException if the token cannot be found
     * @throws TokenExpiredException if the token is expired
     * @throws TokenUsedException if the token is used
     */
    public function get($purpose, $value);

    /**
     * @param string $purpose
     * @param mixed  $user
     * @param array  $payload
     *
     * @return Token
     */
    public function create($purpose, $user, array $payload = []);

    /**
     * @param Token         $token
     * @param DateTime|null $at
     *
     * @deprecated since version 2.2 and will be removed in 3.0
     */
    public function setUsed(Token $token, DateTime $at = null);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

Avoid variables with short names like $at. Configured minimum length is 3.

    /**
     * @param Token         $token
     * @param DateTime|null $at
     */
    public function consume(Token $token, DateTime $at = null);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

Avoid variables with short names like $at. Configured minimum length is 3.

    /**
     * @param Token $token
     *
     * @return mixed
     */
    public function getUser(Token $token);
}