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
|
<?php
/**
* TDbUserManager 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 System.Security
*/
/**
* TDbUser class
*
* TDbUser is the base user class for using together with {@link TDbUserManager}.
* Two methods are declared and must be implemented in the descendant classes:
* - {@link validateUser()}: validates if username and password are correct entries.
* - {@link createUser()}: creates a new user instance given the username
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package System.Security
* @since 3.1.0
*/
abstract class TDbUser extends TUser
{
private $_connection;
/**
* Returns a database connection that may be used to retrieve data from database.
*
* @return TDbConnection database connection that may be used to retrieve data from database
*/
public function getDbConnection()
{
if($this->_connection===null)
{
$userManager=$this->getManager();
if($userManager instanceof TDbUserManager)
{
$connection=$userManager->getDbConnection();
if($connection instanceof TDbConnection)
{
$connection->setActive(true);
$this->_connection=$connection;
}
}
if($this->_connection===null)
throw new TConfigurationException('dbuser_dbconnection_invalid');
}
return $this->_connection;
}
/**
* Validates if username and password are correct entries.
* Usually, this is accomplished by checking if the user database
* contains this (username, password) pair.
* You may use {@link getDbConnection DbConnection} to deal with database.
* @param string username (case-sensitive)
* @param string password
* @return boolean whether the validation succeeds
*/
abstract public function validateUser($username,$password);
/**
* Creates a new user instance given the username.
* This method usually needs to retrieve necessary user information
* (e.g. role, name, rank, etc.) from the user database according to
* the specified username. The newly created user instance should be
* initialized with these information.
*
* If the username is invalid (not found in the user database), null
* should be returned.
*
* You may use {@link getDbConnection DbConnection} to deal with database.
*
* @param string username (case-sensitive)
* @return TDbUser the newly created and initialized user instance
*/
abstract public function createUser($username);
/**
* Creates a new user instance given the cookie containing auth data.
*
* This method is invoked when {@link TAuthManager::setAllowAutoLogin AllowAutoLogin} is set true.
* The default implementation simply returns null, meaning no user instance can be created
* from the given cookie.
*
* If you want to support automatic login (remember login), you should override this method.
* Typically, you obtain the username and a unique token from the cookie's value.
* You then verify the token is valid and use the username to create a user instance.
*
* @param THttpCookie the cookie storing user authentication information
* @return TDbUser the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data.
* @see saveUserToCookie
* @since 3.1.1
*/
public function createUserFromCookie($cookie)
{
return null;
}
/**
* Saves necessary auth data into a cookie.
* This method is invoked when {@link TAuthManager::setAllowAutoLogin AllowAutoLogin} is set true.
* The default implementation does nothing, meaning auth data is not stored in the cookie
* (and thus automatic login is not supported.)
*
* If you want to support automatic login (remember login), you should override this method.
* Typically, you generate a unique token according to the current login information
* and save it together with the username in the cookie's value.
* You should avoid revealing the password in the generated token.
*
* @param THttpCookie the cookie to store the user auth information
* @see createUserFromCookie
* @since 3.1.1
*/
public function saveUserToCookie($cookie)
{
}
}
|
