LogoutSuccessHandlerInterface.php 950 B

12345678910111213141516171819202122232425262728293031323334353637
  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\Logout;
  11. use Symfony\Component\HttpFoundation\Request;
  12. /**
  13. * LogoutSuccesshandlerInterface.
  14. *
  15. * In contrast to the LogoutHandlerInterface, this interface can return a response
  16. * which is then used instead of the default behavior.
  17. *
  18. * If you want to only perform some logout related clean-up task, use the
  19. * LogoutHandlerInterface instead.
  20. *
  21. * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  22. */
  23. interface LogoutSuccessHandlerInterface
  24. {
  25. /**
  26. * Creates a Response object to send upon a successful logout.
  27. *
  28. * @param Request $request
  29. *
  30. * @return Response never null
  31. */
  32. public function onLogoutSuccess(Request $request);
  33. }