blob: 560e75a5fa0edfddde4568d8722124da0ea3684b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
<?php
/**
* CUserIdentity class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright © 2008-2011 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* CUserIdentity is a base class for representing identities that are authenticated based on a username and a password.
*
* Derived classes should implement {@link authenticate} with the actual
* authentication scheme (e.g. checking username and password against a DB table).
*
* By default, CUserIdentity assumes the {@link username} is a unique identifier
* and thus use it as the {@link id ID} of the identity.
*
* @property string $id The unique identifier for the identity.
* @property string $name The display name for the identity.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id: CUserIdentity.php 3426 2011-10-25 00:01:09Z alexander.makarow $
* @package system.web.auth
* @since 1.0
*/
class CUserIdentity extends CBaseUserIdentity
{
/**
* @var string username
*/
public $username;
/**
* @var string password
*/
public $password;
/**
* Constructor.
* @param string $username username
* @param string $password password
*/
public function __construct($username,$password)
{
$this->username=$username;
$this->password=$password;
}
/**
* Authenticates a user based on {@link username} and {@link password}.
* Derived classes should override this method, or an exception will be thrown.
* This method is required by {@link IUserIdentity}.
* @return boolean whether authentication succeeds.
*/
public function authenticate()
{
throw new CException(Yii::t('yii','{class}::authenticate() must be implemented.',array('{class}'=>get_class($this))));
}
/**
* Returns the unique identifier for the identity.
* The default implementation simply returns {@link username}.
* This method is required by {@link IUserIdentity}.
* @return string the unique identifier for the identity.
*/
public function getId()
{
return $this->username;
}
/**
* Returns the display name for the identity.
* The default implementation simply returns {@link username}.
* This method is required by {@link IUserIdentity}.
* @return string the display name for the identity.
*/
public function getName()
{
return $this->username;
}
}
|
