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
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <robin@icewind.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vinicius Cubas Brand <vinicius@eita.org.br>
*
* @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/>
*
*/
namespace OCP;
/**
* Class Manager
*
* Hooks available in scope \OC\Group:
* - preAddUser(\OC\Group\Group $group, \OC\User\User $user)
* - postAddUser(\OC\Group\Group $group, \OC\User\User $user)
* - preRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
* - postRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
* - preDelete(\OC\Group\Group $group)
* - postDelete(\OC\Group\Group $group)
* - preCreate(string $groupId)
* - postCreate(\OC\Group\Group $group)
*
* @since 8.0.0
*/
interface IGroupManager {
/**
* Checks whether a given backend is used
*
* @param string $backendClass Full classname including complete namespace
* @return bool
* @since 8.1.0
*/
public function isBackendUsed($backendClass);
/**
* @param \OCP\GroupInterface $backend
* @since 8.0.0
*/
public function addBackend($backend);
/**
* @since 8.0.0
*/
public function clearBackends();
/**
* Get the active backends
* @return \OCP\GroupInterface[]
* @since 13.0.0
*/
public function getBackends();
/**
* @param string $gid
* @return \OCP\IGroup|null
* @since 8.0.0
*/
public function get($gid);
/**
* @param string $gid
* @return bool
* @since 8.0.0
*/
public function groupExists($gid);
/**
* @param string $gid
* @return \OCP\IGroup|null
* @since 8.0.0
*/
public function createGroup($gid);
/**
* @param string $search
* @param int $limit
* @param int $offset
* @return \OCP\IGroup[]
* @since 8.0.0
*/
public function search($search, $limit = null, $offset = null);
/**
* @param \OCP\IUser|null $user
* @return \OCP\IGroup[]
* @since 8.0.0
*/
public function getUserGroups(IUser $user = null);
/**
* @param \OCP\IUser $user
* @return array with group names
* @since 8.0.0
*/
public function getUserGroupIds(IUser $user);
/**
* get a list of all display names in a group
*
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of display names (value) and user ids (key)
* @since 8.0.0
*/
public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
/**
* Checks if a userId is in the admin group
* @param string $userId
* @return bool if admin
* @since 8.0.0
*/
public function isAdmin($userId);
/**
* Checks if a userId is in a group
* @param string $userId
* @param string $group
* @return bool if in group
* @since 8.0.0
*/
public function isInGroup($userId, $group);
}
|
