Versions
Look up a class, method, property or event

IUserIdentity

Package system.base
Inheritance interface IUserIdentity
Subclasses CBaseUserIdentity, CUserIdentity
Since 1.0
Source Code framework/base/interfaces.php
IUserIdentity interface is implemented by a user identity class.

An identity represents a way to authenticate a user and retrieve information needed to uniquely identity the user. It is normally used with the user application component.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
authenticate() Authenticates the user. IUserIdentity
getId() Returns a value that uniquely represents the identity. IUserIdentity
getIsAuthenticated() Returns a value indicating whether the identity is authenticated. IUserIdentity
getName() Returns the display name for the identity (e.g. username). IUserIdentity
getPersistentStates() Returns the additional identity information that needs to be persistent during the user session. IUserIdentity

Method Details

authenticate() method
abstract public boolean authenticate()
{return} boolean whether authentication succeeds.
Source Code: framework/base/interfaces.php#255 (show)
public function authenticate();

Authenticates the user. The information needed to authenticate the user are usually provided in the constructor.

getId() method
abstract public mixed getId()
{return} mixed a value that uniquely represents the identity (e.g. primary key value).
Source Code: framework/base/interfaces.php#265 (show)
public function getId();

Returns a value that uniquely represents the identity.

getIsAuthenticated() method
abstract public boolean getIsAuthenticated()
{return} boolean whether the identity is valid.
Source Code: framework/base/interfaces.php#260 (show)
public function getIsAuthenticated();

Returns a value indicating whether the identity is authenticated.

getName() method
abstract public string getName()
{return} string the display name for the identity.
Source Code: framework/base/interfaces.php#270 (show)
public function getName();

Returns the display name for the identity (e.g. username).

getPersistentStates() method
abstract public array getPersistentStates()
{return} array additional identity information that needs to be persistent during the user session (excluding id).
Source Code: framework/base/interfaces.php#275 (show)
public function getPersistentStates();

Returns the additional identity information that needs to be persistent during the user session.

Total 1 comment

#1286 report it
Ivo Roper at 2009/09/29 08:17pm
a note: overrides of persistent state functions aren't required...

...unless you need to do something special. They all just maintain the private _state array, and unless you need to do something specific with dynamic states, getPersistentStates() et al, don't need to be touched.

Leave a comment

Please to leave your comment.