vendor/symfony/security-http/LoginLink/LoginLinkHandlerInterface.php line 29

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\LoginLink;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\Security\Core\User\UserInterface;
  17. /**
  18.  * A class that is able to create and handle "magic" login links.
  19.  *
  20.  * @author Ryan Weaver <ryan@symfonycasts.com>
  21.  */
  22. interface LoginLinkHandlerInterface
  23. {
  24.     /**
  25.      * Generate a link that can be used to authenticate as the given user.
  26.      *
  27.      * @param int|null $lifetime When not null, the argument overrides any default lifetime previously set
  28.      */
  29.     public function createLoginLink(UserInterface $user, Request $request = null /* , int $lifetime = null */): LoginLinkDetails;
  31.     /**
  32.      * Validates if this request contains a login link and returns the associated User.
  33.      *
  34.      * Throw InvalidLoginLinkExceptionInterface if the link is invalid.
  35.      */
  36.     public function consumeLoginLink(Request $request): UserInterface;
  37. }