Interface UserProviderInterface

Represents a class that loads UserInterface objects from some source for the authentication system.

In a typical authentication configuration, a username (i.e. some unique user identifier) credential enters the system (via form login, or any method). The user provider that is configured with that authentication method is asked to load the UserInterface object for the given username (via loadUserByUsername) so that the rest of the process can continue.

Internally, a user provider can load users from any source (databases, configuration, web service). This is totally independent of how the authentication information is submitted or what the UserInterface object looks like.

Direct known implementers

Symfony\Component\Security\Core\User\ChainUserProvider, Symfony\Component\Security\Core\User\InMemoryUserProvider

Namespace: Symfony\Component\Security\Core\User
Author: Fabien Potencier <fabien@symfony.com>
See: Symfony\Component\Security\Core\User\UserInterface
Located at UserProviderInterface.php

Methods summary
`public Symfony\Component\Security\Core\User\UserInterface`	# `loadUserByUsername( string $username )` Loads the user for the given username. Loads the user for the given username. This method must throw UsernameNotFoundException if the user is not found. Parameters `$username` `string` $username The username Returns `Symfony\Component\Security\Core\User\UserInterface` Throws `Symfony\Component\Security\Core\Exception\UsernameNotFoundException` if the user is not found See UsernameNotFoundException
`public Symfony\Component\Security\Core\User\UserInterface`	# `refreshUser( Symfony\Component\Security\Core\User\UserInterface $user )` Refreshes the user for the account interface. 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 `$user` `Symfony\Component\Security\Core\User\UserInterface` $user Returns `Symfony\Component\Security\Core\User\UserInterface` Throws `Symfony\Component\Security\Core\Exception\UnsupportedUserException` if the account is not supported
`public boolean`	# `supportsClass( string $class )` Whether this provider supports the given user class Whether this provider supports the given user class Parameters `$class` `string` $class Returns `boolean`

Namespaces

Classes

Interfaces

Interface UserProviderInterface

Direct known implementers

Parameters

Returns

Throws

See

Parameters

Returns

Throws

Parameters

Returns