0 follower

CUserIdentity

Package system.web.auth
Inheritance class CUserIdentity » CBaseUserIdentity » CComponent
Implements IUserIdentity
Since 1.0
Source Code framework/web/auth/CUserIdentity.php
CUserIdentity is a base class for representing identities that are authenticated based on a username and a password.

Derived classes should implement authenticate with the actual authentication scheme (e.g. checking username and password against a DB table).

By default, CUserIdentity assumes the username is a unique identifier and thus use it as the ID of the identity.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
errorCode integer the authentication error code. CBaseUserIdentity
errorMessage string the authentication error message. CBaseUserIdentity
id string Returns the unique identifier for the identity. CUserIdentity
isAuthenticated boolean Returns a value indicating whether the identity is authenticated. CBaseUserIdentity
name string Returns the display name for the identity. CUserIdentity
password string password CUserIdentity
persistentStates array Returns the identity states that should be persisted. CBaseUserIdentity
username string username CUserIdentity

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CUserIdentity
__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 a user based on username and password. CUserIdentity
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 the unique identifier for the identity. CUserIdentity
getIsAuthenticated() Returns a value indicating whether the identity is authenticated. CBaseUserIdentity
getName() Returns the display name for the identity. CUserIdentity
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 persistent states. CBaseUserIdentity
setState() Sets the named state with a given value. CBaseUserIdentity

Property Details

id property read-only
public string getId()

Returns the unique identifier for the identity. The default implementation simply returns username. This method is required by IUserIdentity.

name property read-only
public string getName()

Returns the display name for the identity. The default implementation simply returns username. This method is required by IUserIdentity.

password property
public string $password;

password

username property
public string $username;

username

Method Details

__construct() method
public void __construct(string $username, string $password)
$username string username
$password string password
Source Code: framework/web/auth/CUserIdentity.php#43 (show)
public function __construct($username,$password)
{
    $this->username=$username;
    $this->password=$password;
}

Constructor.

authenticate() method
public boolean authenticate()
{return} boolean whether authentication succeeds.
Source Code: framework/web/auth/CUserIdentity.php#56 (show)
public function authenticate()
{
    throw new CException(Yii::t('yii','{class}::authenticate() must be implemented.',array('{class}'=>get_class($this))));
}

Authenticates a user based on username and password. Derived classes should override this method, or an exception will be thrown. This method is required by IUserIdentity.

getId() method
public string getId()
{return} string the unique identifier for the identity.
Source Code: framework/web/auth/CUserIdentity.php#67 (show)
public function getId()
{
    return $this->username;
}

Returns the unique identifier for the identity. The default implementation simply returns username. This method is required by IUserIdentity.

getName() method
public string getName()
{return} string the display name for the identity.
Source Code: framework/web/auth/CUserIdentity.php#78 (show)
public function getName()
{
    return $this->username;
}

Returns the display name for the identity. The default implementation simply returns username. This method is required by IUserIdentity.