vendor/symfony/security-http/Firewall/AbstractListener.php line 24

Open in your IDE?
  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\Firewall;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpKernel\Event\RequestEvent;
  17. /**
  18.  * A base class for listeners that can tell whether they should authenticate incoming requests.
  19.  *
  20.  * @author Nicolas Grekas <p@tchwork.com>
  21.  */
  22. abstract class AbstractListener
  23. {
  24.     final public function __invoke(RequestEvent $event)
  25.     {
  26.         if (false !== $this->supports($event->getRequest())) {
  27.             $this->authenticate($event);
  28.         }
  29.     }
  31.     /**
  32.      * Tells whether the authenticate() method should be called or not depending on the incoming request.
  33.      *
  34.      * Returning null means authenticate() can be called lazily when accessing the token storage.
  35.      */
  36.     abstract public function supports(Request $request): ?bool;
  38.     /**
  39.      * Does whatever is required to authenticate the request, typically calling $event->setResponse() internally.
  40.      */
  41.     abstract public function authenticate(RequestEvent $event);
  42. }