LogoutSuccessHandlerInterface.php 959 B

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