blob: ee37b64d4d9d3187762482f75180a341ecde22fc (
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
|
<?php
/**
* IUserManager interface file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2005-2015 The PRADO Group
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Security
*/
/**
* IUserManager interface
*
* IUserManager specifies the interface that must be implemented by
* a user manager class if it is to be used together with {@link TAuthManager}
* and {@link TUser}.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package System.Security
* @since 3.0
*/
interface IUserManager
{
/**
* @return string name for a guest user.
*/
public function getGuestName();
/**
* Returns a user instance given the user name.
* @param string user name, null if it is a guest.
* @return TUser the user instance, null if the specified username is not in the user database.
*/
public function getUser($username=null);
/**
* Returns a user instance according to auth data stored in a cookie.
* @param THttpCookie the cookie storing user authentication information
* @return TUser the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data.
* @since 3.1.1
*/
public function getUserFromCookie($cookie);
/**
* Saves user auth data into a cookie.
* @param THttpCookie the cookie to receive the user auth data.
* @since 3.1.1
*/
public function saveUserToCookie($cookie);
/**
* Validates if the username and password are correct.
* @param string user name
* @param string password
* @return boolean true if validation is successful, false otherwise.
*/
public function validateUser($username,$password);
}
|
