ChainUserProvider
class ChainUserProvider implements UserProviderInterface
Chain User Provider.
This provider calls several leaf providers in a chain until one is able to handle the request.
Methods
| __construct(array $providers) | ||
| array | getProviders() | |
| UserInterface | loadUserByUsername(string $username) Loads the user for the given username. | |
| UserInterface | refreshUser(UserInterface $user) Refreshes the user for the account interface. | |
| bool | supportsClass(string $class) Whether this provider supports the given user class. |
Details
__construct(array $providers)
Parameters
| array | $providers |
array getProviders()
Return Value
| array |
UserInterface loadUserByUsername(string $username)
Loads the user for the given username.
This method must throw UsernameNotFoundException if the user is not found.
Parameters
| string | $username | The username |
Return Value
| UserInterface |
Exceptions
| UsernameNotFoundException | if the user is not found |
UserInterface refreshUser(UserInterface $user)
Refreshes the user for the account interface.
It is up to the implementation to decide if the user data should be totally reloaded (e.g. from the database), or if the UserInterface object can just be merged into some internal array of users / identity map.
Parameters
| UserInterface | $user |
Return Value
| UserInterface |
Exceptions
| UnsupportedUserException | if the account is not supported |
bool supportsClass(string $class)
Whether this provider supports the given user class.
Parameters
| string | $class |
Return Value
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Security/Core/User/ChainUserProvider.html