IGroup
in
Interface IGroup
Tags
Table of Contents
Methods
- addUser() : void
- add a user to the group
- canAddUser() : bool
- canRemoveUser() : bool
- count() : int|bool
- returns the number of users matching the search string
- countDisabled() : int|bool
- returns the number of disabled users
- delete() : bool
- Delete the group
- getBackendNames() : array<string|int, string>
- Get the names of the backends the group is connected to
- getDisplayName() : string
- Returns the group display name
- getGID() : string
- getUsers() : array<string|int, IUser>
- get all users in the group
- hideFromCollaboration() : bool
- inGroup() : bool
- check if a user is in the group
- removeUser() : void
- Remove a user from the group
- searchDisplayName() : array<string|int, IUser>
- Search for users in the group by displayname
- searchUsers() : array<string|int, IUser>
- search for users in the group by userid
- setDisplayName() : bool
- Set the group display name
Methods
addUser()
add a user to the group
public
addUser(IUser $user) : void
Parameters
- $user : IUser
Tags
canAddUser()
public
canAddUser() : bool
Tags
Return values
boolcanRemoveUser()
public
canRemoveUser() : bool
Tags
Return values
boolcount()
returns the number of users matching the search string
public
count([string $search = '' ]) : int|bool
Parameters
- $search : string = ''
Tags
Return values
int|boolcountDisabled()
returns the number of disabled users
public
countDisabled() : int|bool
Tags
Return values
int|booldelete()
Delete the group
public
delete() : bool
Tags
Return values
boolgetBackendNames()
Get the names of the backends the group is connected to
public
getBackendNames() : array<string|int, string>
Tags
Return values
array<string|int, string>getDisplayName()
Returns the group display name
public
getDisplayName() : string
Tags
Return values
stringgetGID()
public
getGID() : string
Tags
Return values
stringgetUsers()
get all users in the group
public
getUsers() : array<string|int, IUser>
Tags
Return values
array<string|int, IUser>hideFromCollaboration()
public
hideFromCollaboration() : bool
Tags
Return values
boolinGroup()
check if a user is in the group
public
inGroup(IUser $user) : bool
Parameters
- $user : IUser
Tags
Return values
boolremoveUser()
Remove a user from the group
public
removeUser(IUser $user) : void
Parameters
- $user : IUser
Tags
searchDisplayName()
Search for users in the group by displayname
public
searchDisplayName(string $search[, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, IUser>
Parameters
- $search : string
- $limit : int|null = null
- $offset : int|null = null
Tags
Return values
array<string|int, IUser>searchUsers()
search for users in the group by userid
public
searchUsers(string $search[, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, IUser>
Parameters
- $search : string
- $limit : int|null = null
- $offset : int|null = null
Tags
Return values
array<string|int, IUser>setDisplayName()
Set the group display name
public
setDisplayName(string $displayName) : bool
Parameters
- $displayName : string