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
|
<?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 IdentityProvider_Driver {
/**
* Return the guest user.
*
* @return User_Definition the user object
*/
public function guest();
/**
* Return the primary admin user.
*
* @return User_Definition the user object
*/
public function admin_user();
/**
* Create a new user.
*
* @param string $name
* @param string $full_name
* @param string $password
* @param string $email
* @return User_Definition the user object
*/
public function create_user($name, $full_name, $password, $email);
/**
* Is the password provided correct?
*
* @param user User_Definition the user object
* @param string $password a plaintext password
* @return boolean true if the password is correct
*/
public function is_correct_password($user, $password);
/**
* Look up a user by id.
* @param integer $id
* @return User_Definition the user object, or null if the name was invalid.
*/
public function lookup_user($id);
/**
* Look up a user by name.
* @param string $name
* @return User_Definition the user object, or null if the name was invalid.
*/
public function lookup_user_by_name($name);
/**
* Create a new group.
*
* @param string $name
* @return Group_Definition the group object
*/
public function create_group($name);
/**
* The group of all possible visitors. This includes the guest user.
*
* @return Group_Definition the group object
*/
public function everybody();
/**
* The group of all logged-in visitors. This does not include guest users.
*
* @return Group_Definition the group object
*/
public function registered_users();
/**
* List the users
* @param array $ids array of ids to return the user objects for
* @return array the user list.
*/
public function get_user_list($ids);
/**
* Look up a group by id.
* @param integer $id id
* @return Group_Definition the user object, or null if the name was invalid.
*/
public function lookup_group($id);
/**
* Look up the group by name.
* @param string $name the name of the group to locate
* @return Group_Definition
*/
public function lookup_group_by_name($name);
/**
* List the groups defined in the Identity Provider
*/
public function groups();
/**
* Add the user to the specified group
* @param User_Definition the user to add to the group
* @param int the group_id
*/
static function add_user_to_group($user, $group_id);
/**
* Remove the user to the specified group
* @param User_Definition the user to add to the group
* @param int the group id
*/
static function remove_user_from_group($user, $group_id);
} // End Identity Driver Definition
interface Group_Definition {}
interface User_Definition {}
|
