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

/*
 * 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.
 */

namespace Symfony\Component\Security\User;

/**
 * UserProviderInterface is the implementation that all user provider must
 * implement.
 *
 * @author Fabien Potencier <fabien.potencier@symfony-project.com>
 */
interface UserProviderInterface
{
    /**
     * Loads the user for the given username.
     *
     * This method must throw UsernameNotFoundException if the user is not
     * found.
     *
     * @throws UsernameNotFoundException if the user is not found
     * @param string $username The username
     *
     * @return AccountInterface
     */
     function loadUserByUsername($username);

     /**
      * Loads the user for the account interface.
      *
      * It is up to the implementation if it decides to reload the user data
      * from the database, or if it simply merges the passed User into the 
      * identity map of an entity manager.
      *
      * @throws UnsupportedAccountException if the account is not supported
      * @param AccountInterface $user
      *
      * @return AccountInterface
      */
     function loadUserByAccount(AccountInterface $user);
}