summaryrefslogtreecommitdiffstats
path: root/User/UserProviderInterface.php
blob: a91ace5ac0f34965f4d7c998a0ae6dc9adda9c54 (plain)
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
<?php

namespace Symfony\Component\Security\User;

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

/**
 * UserProviderInterface is the implementation that all user provider must
 * implement.
 *
 * @author Fabien Potencier <fabien.potencier@symfony-project.com>
 */
interface UserProviderInterface
{
    /**
     * Whether this provider is an aggregate of user providers
     *
     * @return Boolean
     */
    function isAggregate();

    /**
     * Loads the user for the given username.
     *
     * This method must throw UsernameNotFoundException if the user is not
     * found.
     *
     * @param  string $username The username
     *
     * @return array of the form: array(AccountInterface, string) with the
     *               implementation of AccountInterface, and the name of the provider
     *               that was used to retrieve it
     *
     * @throws UsernameNotFoundException if the user is not found
     */
     function loadUserByUsername($username);

     /**
      * Determines whether this provider supports the given provider name
      *
      * @param string $providerName
      * @return Boolean
      */
     function supports($providerName);
}