1 <?php

     2 

     3 /*

     4  * This file is part of the Symfony framework.

     5  *

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

     7  *

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

     9  * with this source code in the file LICENSE.

    10  */

    11 

    12 namespace Symfony\Component\Security\Http\Authentication;

    13 

    14 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;

    15 use Symfony\Component\HttpFoundation\Request;

    16 

    17 /**

    18  * Interface for a custom authentication success handler

    19  *

    20  * If you want to customize the success handling process, instead of

    21  * overwriting the respective listener globally, you can set a custom success

    22  * handler which implements this interface.

    23  *

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

    25  */

    26 interface AuthenticationSuccessHandlerInterface

    27 {

    28     /**

    29      * This is called when an interactive authentication attempt succeeds. This

    30      * is called by authentication listeners inheriting from

    31      * AbstractAuthenticationListener.

    32      *

    33      * @param Request        $request

    34      * @param TokenInterface $token

    35      *

    36      * @return Response the response to return

    37      */

    38     function onAuthenticationSuccess(Request $request, TokenInterface $token);

    39 }