Symfony2 API
Class

Symfony\Component\Security\Core\Authentication\Token\AnonymousToken

class AnonymousToken extends AbstractToken

AnonymousToken represents an anonymous token.

Methods

__construct(string $key, string $user, array $roles = array())

Constructor.
RoleInterface[] getRoles()

Returns the user roles.

 from AbstractToken
string getUsername()

Returns the username.

 from AbstractToken
mixed getUser()

Returns a user representation.

 from AbstractToken
setUser(mixed $user)

Sets a user.

 from AbstractToken
Boolean isAuthenticated()

Returns whether the user is authenticated or not.

 from AbstractToken
setAuthenticated($authenticated)

Sets the authenticated flag.

 from AbstractToken
eraseCredentials()

Removes sensitive information from the token.

 from AbstractToken
serialize()

{@inheritdoc}
unserialize($serialized)

{@inheritdoc}
array getAttributes()

Returns the token attributes.

 from AbstractToken
setAttributes(array $attributes)

Sets the token attributes.

 from AbstractToken
Boolean hasAttribute(string $name)

Returns true if the attribute exists.

 from AbstractToken
mixed getAttribute(string $name)

Returns an attribute value.

 from AbstractToken
setAttribute(string $name, mixed $value)

Sets an attribute.

 from AbstractToken
string __toString()

Returns a string representation of the Token.

 from AbstractToken
mixed getCredentials()

Returns the user credentials.
string getKey()

Returns the key.

Details

at line 31
public __construct(string $key, string $user, array $roles = array())

Constructor.

Parameters

string $key The key shared with the authentication provider
string $user The user
array $roles An array of roles

Exceptions

InvalidArgumentException

in AbstractToken at line 60
public RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[] An array of RoleInterface instances.

in AbstractToken at line 68
public string getUsername()

Returns the username.

Return Value

string

in AbstractToken at line 77
public mixed getUser()

Returns a user representation.

Return Value

mixed either returns an object which implements __toString(), or a primitive string is returned.

in AbstractToken at line 91
public setUser(mixed $user)

Sets a user.

Parameters

mixed $user The user

in AbstractToken at line 121
public Boolean isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

Boolean true if the token has been authenticated, false otherwise

in AbstractToken at line 129
public setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

in AbstractToken at line 137
public eraseCredentials()

Removes sensitive information from the token.

at line 61
public serialize()

{@inheritdoc}

at line 69
public unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

in AbstractToken at line 165
public array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

in AbstractToken at line 175
public setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

in AbstractToken at line 187
public Boolean hasAttribute(string $name)

Returns true if the attribute exists.

Parameters

string $name The attribute name

Return Value

Boolean true if the attribute exists, false otherwise

in AbstractToken at line 201
public mixed getAttribute(string $name)

Returns an attribute value.

Parameters

string $name The attribute name

Return Value

mixed The attribute value

Exceptions

InvalidArgumentException When attribute doesn't exist for this token

in AbstractToken at line 216
public setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

string $name The attribute name
mixed $value The attribute value

in AbstractToken at line 224
public string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line 43
public mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials

at line 53
public string getKey()

Returns the key.

Return Value

string The Key