PropelUserProvider
PropelUserProvider
class PropelUserProvider implements UserProviderInterface
Provides easy to use provisioning for Propel model users.
Methods
__construct(string $class, string|null $property = null) Default constructor | ||
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(string $class, string|null $property = null)
Default constructor
Parameters
string | $class | The User model class. |
string|null | $property | The property to use to retrieve a user. |
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.2/Symfony/Bridge/Propel1/Security/User/PropelUserProvider.html