AuthenticationEntryPointInterface.php 1020 B

12345678910111213141516171819202122232425262728293031323334
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Security\Http\EntryPoint;
  11. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  12. use Symfony\Component\HttpFoundation\Request;
  13. /**
  14. * AuthenticationEntryPointInterface is the interface used to start the
  15. * authentication scheme.
  16. *
  17. * @author Fabien Potencier <fabien@symfony.com>
  18. */
  19. interface AuthenticationEntryPointInterface
  20. {
  21. /**
  22. * Starts the authentication scheme.
  23. *
  24. * @param Request $request The request that resulted in an AuthenticationException
  25. * @param AuthenticationException $authException The exception that started the authentication process
  26. *
  27. * @return Response
  28. */
  29. public function start(Request $request, AuthenticationException $authException = null);
  30. }