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
|
<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2009 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
interface Identity_Driver {
/**
* Return the guest user.
*
* @todo consider caching
*
* @return User_Model
*/
public function guest();
/**
* Create a new user.
*
* @param string $name
* @param string $full_name
* @param string $password
* @return User_Core
*/
public function create_user($name, $full_name, $password);
/**
* Is the password provided correct?
*
* @param user User Model
* @param string $password a plaintext password
* @return boolean true if the password is correct
*/
public function is_correct_password($user, $password);
/**
* Create the hashed passwords.
* @param string $password a plaintext password
* @return string hashed password
*/
public function hash_password($password);
/**
* Look up a user by id.
* @param integer $id the user id
* @return User_Core the user object, or null if the id was invalid.
*/
public function lookup_user($id);
/**
* Look up a user by name.
* @param string search field
* @param string search value
* @return User_Core the user object, or null if the name was invalid.
*/
public function lookup_user_by_field($field, $value);
/**
* Create a new group.
*
* @param string $name
* @return Group_Model
*/
public function create_group($name);
/**
* The group of all possible visitors. This includes the guest user.
*
* @return Group_Model
*/
public function everybody();
/**
* The group of all logged-in visitors. This does not include guest users.
*
* @return Group_Model
*/
public function registered_users();
/**
* Look up a group by id.
* @param integer $id the user id
* @return Group_Model the group object, or null if the id was invalid.
*/
public function lookup_group($id);
/**
* Look up a group by name.
* @param integer $id the group name
* @return Group_Model the group object, or null if the name was invalid.
*/
public function lookup_group_by_name($name);
/**
* List the users
* @param mixed options to apply to the selection of the user
* @todo Do a longer write up on format of filters (@see Database.php)
* @return array the group list.
*/
public function list_users($filter=array());
/**
* List the groups
* @param mixed options to apply to the selection of the user
* @todo Do a longer write up on format of filters (@see Database.php)
* @return array the group list.
*/
public function list_groups($filter=array());
/**
* Return the edit rules associated with an group.
*
* @param string $object_type to return rules for ("user"|"group")
* @return stdClass containing the rules
*/
public function get_edit_rules($object_type);
} // End User Driver
|
