UserSecurityIdentity

class UserSecurityIdentity implements SecurityIdentityInterface

A SecurityIdentity implementation used for actual users

Methods

__construct(string $username, string $class)

Constructor

static UserSecurityIdentity fromAccount(UserInterface $user)

Creates a user security identity from a UserInterface

static UserSecurityIdentity fromToken(TokenInterface $token)

Creates a user security identity from a TokenInterface

string getUsername()

Returns the username

string getClass()

Returns the user's class name

equals(SecurityIdentityInterface $sid)

This method is used to compare two security identities in order to not rely on referential equality.

string __toString()

A textual representation of this security identity.

Details

__construct(string $username, string $class)

Constructor

Parameters

string $username the username representation
string $class the user's fully qualified class name

Exceptions

InvalidArgumentException

static UserSecurityIdentity fromAccount(UserInterface $user)

Creates a user security identity from a UserInterface

Parameters

UserInterface $user

Return Value

UserSecurityIdentity

static UserSecurityIdentity fromToken(TokenInterface $token)

Creates a user security identity from a TokenInterface

Parameters

TokenInterface $token

Return Value

UserSecurityIdentity

string getUsername()

Returns the username

Return Value

string

string getClass()

Returns the user's class name

Return Value

string

equals(SecurityIdentityInterface $sid)

This method is used to compare two security identities in order to not rely on referential equality.

Parameters

SecurityIdentityInterface $sid

string __toString()

A textual representation of this security identity.

This is not used for equality comparison, but only for debugging.

Return Value

string

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Security/Acl/Domain/UserSecurityIdentity.html