Home » Documentation » Class Reference » CBaseUserIdentity

CBaseUserIdentity

Package	system.web.auth
Inheritance	abstract class CBaseUserIdentity » CComponent
Implements	IUserIdentity
Subclasses	CUserIdentity
Since	1.0
Version	$Id: CBaseUserIdentity.php 1896 2010-03-13 14:11:24Z qiang.xue $

CBaseUserIdentity is a base class implementing IUserIdentity.

CBaseUserIdentity implements the scheme for representing identity information that needs to be persisted. It also provides the way to represent the authentication errors.

Derived classes should implement IUserIdentity::authenticate and IUserIdentity::getId that are required by the IUserIdentity interface.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
errorCode	integer	the authentication error code.	CBaseUserIdentity
errorMessage	string	the authentication error message.	CBaseUserIdentity
id	mixed	Returns a value that uniquely represents the identity.	CBaseUserIdentity
isAuthenticated	whether	Returns a value indicating whether the identity is authenticated.	CBaseUserIdentity
name	string	Returns the display name for the identity (e.g. username).	CBaseUserIdentity
persistentStates	array	Returns the identity states that should be persisted.	CBaseUserIdentity

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
authenticate()	Authenticates the user.	IUserIdentity
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
clearState()	Removes the specified state.	CBaseUserIdentity
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()	Returns a value that uniquely represents the identity.	CBaseUserIdentity
getIsAuthenticated()	Returns a value indicating whether the identity is authenticated.	CBaseUserIdentity
getName()	Returns the display name for the identity (e.g. username).	CBaseUserIdentity
getPersistentStates()	Returns the identity states that should be persisted.	CBaseUserIdentity
getState()	Gets the persisted state by the specified name.	CBaseUserIdentity
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
raiseEvent()	Raises an event.	CComponent
setPersistentStates()	Sets an array of presistent states.	CBaseUserIdentity
setState()	Sets the named state with a given value.	CBaseUserIdentity

Property Details

errorCode property

public integer $errorCode;

the authentication error code. If there is an error, the error code will be non-zero. Defaults to 100, meaning unknown identity. Calling authenticate will change this value.

errorMessage property

public string $errorMessage;

the authentication error message. Defaults to empty.

id property read-only

public mixed getId()

Returns a value that uniquely represents the identity.

isAuthenticated property read-only

public whether getIsAuthenticated()

Returns a value indicating whether the identity is authenticated. This method is required by IUserIdentity.

name property read-only

public string getName()

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

persistentStates property

public array getPersistentStates()
public void setPersistentStates($states $states)

Returns the identity states that should be persisted. This method is required by IUserIdentity.

Method Details

clearState() method (available since v1.0.8)

public void clearState(string $name)
$name	string	the name of the state

Removes the specified state.

getId() method

public mixed getId()
{return}	mixed	a value that uniquely represents the identity (e.g. primary key value). The default implementation simply returns name.

Returns a value that uniquely represents the identity.

getIsAuthenticated() method

public whether getIsAuthenticated()
{return}	whether	the authentication is successful.

Returns a value indicating whether the identity is authenticated. This method is required by IUserIdentity.

getName() method

public string getName()
{return}	string	the display name for the identity. The default implementation simply returns empty string.

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

getPersistentStates() method

public array getPersistentStates()
{return}	array	the identity states that should be persisted.

Returns the identity states that should be persisted. This method is required by IUserIdentity.

getState() method

public mixed getState(string $name, mixed $defaultValue=NULL)
$name	string	the name of the state
$defaultValue	mixed	the default value to be returned if the named state does not exist
{return}	mixed	the value of the named state

Gets the persisted state by the specified name.

setPersistentStates() method

public void setPersistentStates($states $states)
$states	$states	array the identity states that should be persisted.

Sets an array of presistent states.

setState() method

public void setState(string $name, mixed $value)
$name	string	the name of the state
$value	mixed	the value of the named state

Sets the named state with a given value.