interface AttributesBasedUserProviderInterface implementsUserProviderInterface

Overrides UserProviderInterface to add an "attributes" argument on loadUserByIdentifier.

This is particularly useful with self-contained access tokens.

Methods

bool
supportsClass(string$class)

Whether this provider supports the given user class.

loadUserByIdentifier(string$identifier,array$attributes =[])

Loads the user for the given user identifier (e.g. username or email) and attributes.

Details

UserInterface refreshUser(UserInterface$user)

Refreshes the user.

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 user is not supported
UserNotFoundException if the user is not found

bool supportsClass(string$class)

Whether this provider supports the given user class.

Parameters

string $class

Return Value

bool

UserInterface loadUserByIdentifier(string$identifier,array$attributes =[])

Loads the user for the given user identifier (e.g. username or email) and attributes.

This method must throw UserNotFoundException if the user is not found.

Parameters

string $identifier
array $attributes

Return Value

UserInterface

Exceptions

UserNotFoundException