Classes List

Symfony\Component\Security\Guard\AuthenticatorInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Security\Guard;

use Symfony\Component\HttpFoundation\Request;

/** * The interface for all "guard" authenticators. * * The methods on this interface are called throughout the guard authentication * process to give you the power to control most parts of the process from * one location. * * @author Ryan Weaver <ryan@knpuniversity.com> * @author Amaury Leroux de Lens <amaury@lerouxdelens.com> */
interface AuthenticatorInterface extends GuardAuthenticatorInterface
{
    /** * Does the authenticator support the given Request? * * If this returns false, the authenticator will be skipped. * * @param Request $request * * @return bool */
    public function supports(Request $request);

    /** * Get the authentication credentials from the request and return them * as any type (e.g. an associate array). * * Whatever value you return here will be passed to getUser() and checkCredentials() * * For example, for a form login, you might: * * return array( * 'username' => $request->request->get('_username'), * 'password' => $request->request->get('_password'), * ); * * Or for an API token that's on a header, you might use: * * return array('api_key' => $request->headers->get('X-API-TOKEN')); * * @param Request $request * * @return mixed Any non-null value * * @throws \UnexpectedValueException If null is returned */
    public function getCredentials(Request $request);
}