UserIdentity
| Inheritance | class UserIdentity » CUserIdentity » CBaseUserIdentity » CComponent |
|---|---|
| Implements | IUserIdentity |
| Source Code | app/components/UserIdentity.php |
UserIdentity represents the data needed to identity a user.
It contains the authentication method that checks if the provided
data can identity the user.
Public Properties
| Property | Type | Description | Defined 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
| Method | Description | Defined 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. | UserIdentity |
| 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 |
Method Details
authenticate()
method
|
public boolean authenticate()
| ||
| {return} | boolean | whether authentication succeeds. |
Source Code: app/components/UserIdentity.php#18 (show)
public function authenticate()
{
// check if login details exists in database
$record=Usuarios::model()->findByAttributes(array('usuario'=>$this->username));
//echo Yii::trace(CVarDumper::dumpAsString($record),'vardump');
if($record===null)
{
$this->errorCode=self::ERROR_USERNAME_INVALID;
}
else if($record->passwd!==md5($this->password)) // here I compare db password with password field
{
/*echo Yii::trace(CVarDumper::dumpAsString($this->password),'vardump');
echo Yii::trace(CVarDumper::dumpAsString($record->passwd),'vardump');*/
$this->errorCode=self::ERROR_PASSWORD_INVALID;
}
else
{
$this->setState('userId',$record->folio);
$this->setState('name', $record->nombre.' '.$record->aPaterno);
$this->errorCode=self::ERROR_NONE;
}
return !$this->errorCode;
/*$users=array(
// username => password
'demo'=>'demo',
'admin'=>'admin',
);
if(!isset($users[$this->username]))
$this->errorCode=self::ERROR_USERNAME_INVALID;
elseif($users[$this->username]!==$this->password)
$this->errorCode=self::ERROR_PASSWORD_INVALID;
else
$this->errorCode=self::ERROR_NONE;
return !$this->errorCode;*/
}
Authenticates a user. The example implementation makes sure if the username and password are both 'demo'. In practical applications, this should be changed to authenticate against some persistent user identity storage (e.g. database).