group_support extends facade
Facade for local_middag\framework\support\moodle\group_support.
Tags
Table of Contents
Methods
- add_member() : bool
- add_user_in_group() : bool
- create_group() : int|null
- get_facade_accessor() : string
- Return the service accessor key for this facade.
- get_group_by_name() : int|bool
- get_group_options() : array<string|int, mixed>
- get_groups() : array<string|int, mixed>
- is_member() : bool
Methods
add_member()
public
static add_member(int $groupid, int $userid) : bool
Parameters
- $groupid : int
- $userid : int
Return values
booladd_user_in_group()
public
static add_user_in_group(int $courseid, int $userid, string $groupname) : bool
Parameters
- $courseid : int
- $userid : int
- $groupname : string
Return values
boolcreate_group()
public
static create_group(int $courseid, string $groupname[, string $idnumber = = '\'\'' ][, string $description = = '\'\'' ]) : int|null
Parameters
- $courseid : int
- $groupname : string
- $idnumber : string = = '\'\''
- $description : string = = '\'\''
Return values
int|nullget_facade_accessor()
Return the service accessor key for this facade.
public
static get_facade_accessor() : string
Return values
stringget_group_by_name()
public
static get_group_by_name(int $courseid, string $groupname) : int|bool
Parameters
- $courseid : int
- $groupname : string
Return values
int|boolget_group_options()
public
static get_group_options([context|null $coursecontext = = 'null' ]) : array<string|int, mixed>
Parameters
- $coursecontext : context|null = = 'null'
Return values
array<string|int, mixed>get_groups()
public
static get_groups(int $courseid, int $userid) : array<string|int, mixed>
Parameters
- $courseid : int
- $userid : int
Return values
array<string|int, mixed>is_member()
public
static is_member(int $groupid, int $userid) : bool
Parameters
- $groupid : int
- $userid : int