\OCPGroupInterface

TODO actually this is a IGroupBackend

Summary

Methods
Constants
implementsActions()
inGroup()
getUserGroups()
getGroups()
groupExists()
usersInGroup()
isVisibleForScope()
CREATE_GROUP
DELETE_GROUP
ADD_TO_GROUP
REMOVE_FROM_GOUP
REMOVE_FROM_GROUP
COUNT_USERS
GROUP_DETAILS
No protected methods found
N/A
No private methods found
N/A

Constants

CREATE_GROUP

CREATE_GROUP

actions that user backends can define

DELETE_GROUP

DELETE_GROUP

ADD_TO_GROUP

ADD_TO_GROUP

REMOVE_FROM_GOUP

REMOVE_FROM_GOUP

REMOVE_FROM_GROUP

REMOVE_FROM_GROUP

COUNT_USERS

COUNT_USERS

GROUP_DETAILS

GROUP_DETAILS

Methods

implementsActions()

implementsActions(integer  $actions) : boolean

Check if backend implements actions

Parameters

integer $actions

bitwise-or'ed actions

Returns

boolean

inGroup()

inGroup(string  $uid, string  $gid) : boolean

is user in group?

Parameters

string $uid

uid of the user

string $gid

gid of the group

Returns

boolean

getUserGroups()

getUserGroups(string  $uid) : array

Get all groups a user belongs to

Parameters

string $uid

Name of the user

Returns

array —

an array of group names

getGroups()

getGroups(string  $search = '', integer  $limit = -1, integer  $offset) : array

get a list of all groups

Parameters

string $search
integer $limit
integer $offset

Returns

array —

an array of group names

groupExists()

groupExists(string  $gid) : boolean

check if a group exists

Parameters

string $gid

Returns

boolean

usersInGroup()

usersInGroup(string  $gid, string  $search = '', integer  $limit = -1, integer  $offset) : array

get a list of all users in a group

Parameters

string $gid
string $search
integer $limit
integer $offset

Returns

array —

an array of user ids

isVisibleForScope()

isVisibleForScope(string|null  $scope) : boolean

Returns whether the groups are visible for a given scope.

Parameters

string|null $scope

scope string

Returns

boolean —

true if searchable, false otherwise