vendor/symfony/security-http/Logout/LogoutSuccessHandlerInterface.php line 18

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\Logout;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\Security\Http\Event\LogoutEvent;
  18. trigger_deprecation('symfony/security-http', '5.1', 'The "%s" interface is deprecated, create a listener for the "%s" event instead.', LogoutSuccessHandlerInterface::class, LogoutEvent::class);
  20. /**
  21.  * LogoutSuccesshandlerInterface.
  22.  *
  23.  * In contrast to the LogoutHandlerInterface, this interface can return a response
  24.  * which is then used instead of the default behavior.
  25.  *
  26.  * If you want to only perform some logout related clean-up task, use the
  27.  * LogoutHandlerInterface instead.
  28.  *
  29.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  30.  *
  31.  * @deprecated since Symfony 5.1
  32.  */
  33. interface LogoutSuccessHandlerInterface
  34. {
  35.     /**
  36.      * Creates a Response object to send upon a successful logout.
  37.      *
  38.      * @return Response
  39.      */
  40.     public function onLogoutSuccess(Request $request);
  41. }