blob: fd7db297010bc072d88e84fba9cc254f5db8260a (
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
|
<?php
/**
* Core interfaces essential for TApplication class.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Security
*/
namespace Prado\Security;
/**
* IUser interface.
*
* This interface must be implemented by user objects.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Security
* @since 3.0
*/
interface IUser
{
/**
* @return string username
*/
public function getName();
/**
* @param string username
*/
public function setName($value);
/**
* @return boolean if the user is a guest
*/
public function getIsGuest();
/**
* @param boolean if the user is a guest
*/
public function setIsGuest($value);
/**
* @return array list of roles that the user is of
*/
public function getRoles();
/**
* @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);
/**
* @param string role to be tested
* @return boolean whether the user is of this role
*/
public function isInRole($role);
/**
* @return string user data that is serialized and will be stored in session
*/
public function saveToString();
/**
* @param string user data that is serialized and restored from session
* @return IUser the user object
*/
public function loadFromString($string);
}
|
