<?php

/*

 * This file is part of the Symfony framework.

 *

 * (c) Fabien Potencier <fabien@symfony.com>

 *

 * This source file is subject to the MIT license that is bundled

 * with this source code in the file LICENSE.

 */

namespace Symfony\Component\Security\Http\Logout;

use Symfony\Component\HttpFoundation\Request;

use Symfony\Component\HttpKernel\Event\GetResponseEvent;

/**

 * LogoutSuccesshandlerInterface.

 *

 * In contrast to the LogoutHandlerInterface, this interface can return a response

 * which is then used instead of the default behavior.

 *

 * If you want to only perform some logout related clean-up task, use the

 * LogoutHandlerInterface instead.

 *

 * @author Johannes M. Schmitt <schmittjoh@gmail.com>

 */

interface LogoutSuccessHandlerInterface

{

    /**

     * Creates a Response object to send upon a successful logout.

     *

     * @param Request $request

     * @return Response never null

     */

    function onLogoutSuccess(Request $request);

}