eZPublishCommunityProject  2013.9
eZ\Publish\Core\MVC\Symfony\Security\User\Identity Class Reference

Represents a user "identity", or footprint. More...

+ Inheritance diagram for eZ\Publish\Core\MVC\Symfony\Security\User\Identity:
+ Collaboration diagram for eZ\Publish\Core\MVC\Symfony\Security\User\Identity:

Public Member Functions

 __construct ()
 
 addInformation (array $information)
 Registers several pieces of information in the identity. More...
 
 getHash ()
 Returns the hash of the current identity (e.g. More...
 
 getInformation ()
 Returns registered information. More...
 
 replaceInformation (array $information)
 Replaces the information already registered in the identity. More...
 
 setInformation ($informationName, $informationValue)
 Registers an information in the identity. More...
 

Protected Member Functions

 resetHash ()
 Resets current hash. More...
 

Protected Attributes

 $hash
 
 $identityInfo
 

Detailed Description

Represents a user "identity", or footprint.

Instance can be transformed to a hash and used as an identity token.

Constructor & Destructor Documentation

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::__construct ( )

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::addInformation ( array  $information)

Registers several pieces of information in the identity.

Parameters
array$informationHash where key is the information type and value is a scalar.

Implements eZ\Publish\SPI\User\Identity.

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::getHash ( )

Returns the hash of the current identity (e.g.

md5, sha1...)

Returns
string

Implements eZ\Publish\SPI\User\Identity.

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::getInformation ( )

Returns registered information.

Returns
array

Implements eZ\Publish\SPI\User\Identity.

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::replaceInformation ( array  $information)

Replaces the information already registered in the identity.

Parameters
array$informationHash where key is the information type and value is a scalar.

Implements eZ\Publish\SPI\User\Identity.

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::setInformation (   $informationName,
  $informationValue 
)

Registers an information in the identity.

Parameters
string$informationName
scalar$informationValue

Implements eZ\Publish\SPI\User\Identity.

Member Data Documentation

eZ\Publish\Core\MVC\Symfony\Security\User\Identity::$hash
protected
eZ\Publish\Core\MVC\Symfony\Security\User\Identity::$identityInfo
protected

The documentation for this class was generated from the following file: