blob: ee52ceaa578f062d7ef5cb90126388f2ea52abdc (
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<?php
/**
* TUser class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Revision: $ $Date: $
* @package System.Security
*/
/**
* Using IUserManager interface
*/
Prado::using('System.Security.IUserManager');
/**
* TUser class
*
* TUser implements basic user functionality for a prado application.
* To get the name of the user, use {@link getName Name} property.
* The property {@link getIsGuest IsGuest} tells if the user a guest/anonymous user.
* To obtain or test the roles that the user is in, use property
* {@link getRoles Roles} and call {@link isInRole()}, respectively.
*
* TUser is meant to be used together with {@link IUserManager}.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Revision: $ $Date: $
* @package System.Security
* @since 3.0
*/
class TUser extends TComponent implements IUser
{
/**
* @var IUserManager user manager
*/
private $_manager;
/**
* @var boolean if the user is a guest
*/
private $_isGuest=true;
/**
* @var string username
*/
private $_name='';
/**
* @var array user roles
*/
private $_roles=array();
/**
* Constructor.
* @param IUserManager user manager
*/
public function __construct(IUserManager $manager)
{
$this->_manager=$manager;
$this->_name=$manager->getGuestName();
}
/**
* @return IUserManager user manager
*/
public function getManager()
{
return $this->_manager;
}
/**
* @return string username
*/
public function getName()
{
return $this->_name;
}
/**
* @param string username
*/
public function setName($value)
{
$this->_name=$value;
}
/**
* @return boolean if the user is a guest
*/
public function getIsGuest()
{
return $this->_isGuest;
}
/**
* @param boolean if the user is a guest
*/
public function setIsGuest($value)
{
if($this->_isGuest=TPropertyValue::ensureBoolean($value))
{
$this->_name=$this->_manager->getGuestName();
$this->_roles=array();
}
}
/**
* @return array list of roles that the user is of
*/
public function getRoles()
{
return $this->_roles;
}
/**
* @return array|string list of roles that the user is of. If it is a string, roles are assumed by separated by comma
*/
public function setRoles($value)
{
if(is_array($value))
$this->_roles=$value;
else
{
$this->_roles=array();
foreach(explode(',',$value) as $role)
{
if(($role=trim($role))!=='')
$this->_roles[]=$role;
}
}
}
/**
* @param string role to be tested. Note, role is case-insensitive.
* @return boolean whether the user is of this role
*/
public function isInRole($role)
{
foreach($this->_roles as $r)
if(strcasecmp($role,$r)===0)
return true;
return false;
}
/**
* @return string user data that is serialized and will be stored in session
*/
public function saveToString()
{
return serialize(array($this->_name,$this->_roles,$this->_isGuest));
}
/**
* @param string user data that is serialized and restored from session
* @return IUser the user object
*/
public function loadFromString($data)
{
if(!empty($data))
{
$array=unserialize($data);
$this->_name=$array[0];
$this->_roles=$array[1];
$this->_isGuest=$array[2];
}
return $this;
}
}
?>
|
