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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Knut Ahlers <knut@ahlers.me>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Vincent Petry <vincent@nextcloud.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* TODO actually this is a IGroupBackend
*
* @since 4.5.0
*/
interface GroupInterface {
/**
* actions that user backends can define
*
* @since 12.0.0
*/
public const CREATE_GROUP = 0x00000001;
/**
* @since 12.0.0
*/
public const DELETE_GROUP = 0x00000010;
/**
* @since 12.0.0
*/
public const ADD_TO_GROUP = 0x00000100;
/**
* @since 12.0.0
* @deprecated 29.0.0
*/
public const REMOVE_FROM_GOUP = 0x00001000; // oops
/**
* @since 12.0.0
*/
public const REMOVE_FROM_GROUP = 0x00001000;
//OBSOLETE const GET_DISPLAYNAME = 0x00010000;
/**
* @since 12.0.0
*/
public const COUNT_USERS = 0x00100000;
/**
* @since 12.0.0
*/
public const GROUP_DETAILS = 0x01000000;
/**
* @since 13.0.0
*/
public const IS_ADMIN = 0x10000000;
/**
* Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
* @since 4.5.0
*
* Returns the supported actions as int to be
* compared with \OC_Group_Backend::CREATE_GROUP etc.
*/
public function implementsActions($actions);
/**
* is user in group?
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
* @since 4.5.0
*
* Checks whether the user is member of a group or not.
*/
public function inGroup($uid, $gid);
/**
* Get all groups a user belongs to
* @param string $uid Name of the user
* @return array an array of group names
* @since 4.5.0
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
*/
public function getUserGroups($uid);
/**
* @brief Get a list of all groups
*
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of group names
* @since 4.5.0
*
* Returns a list with all groups
*/
public function getGroups(string $search = '', int $limit = -1, int $offset = 0);
/**
* @brief Check if a group exists
*
* @param string $gid
* @return bool
* @since 4.5.0
*/
public function groupExists($gid);
/**
* @brief Get a list of user ids in a group matching the given search parameters.
*
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array<int,string> an array of user ids
* @since 4.5.0
* @deprecated 27.0.0 Use searchInGroup instead, for performance reasons
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
}
|
