coursegroup_service extends item_service
Service responsible for business rules of course groups.
Table of Contents
Constants
- FILEMANAGEROPTIONS = ['maxbytes' => 1024, 'subdirs' => 0, 'maxfiles' => 1, 'accepted_types' => ['web_image']]
- PER_PAGE = 50
- TYPE = \local_middag\extensions\coursegroup\model\coursegroup_item::TYPE
Properties
- $contextids : mixed
- $id : mixed
Methods
- all() : array<string|int, coursegroup_item>
- Returns all coursegroup items.
- all_enablers() : array<string|int, mixed>
- background() : moodle_url|string
- contents() : string
- Generates HTML representation of course contents.
- create() : item_interface
- Creates a new coursegroup item.
- delete() : void
- Deletes a coursegroup item.
- deleteurl() : moodle_url
- editurl() : moodle_url
- enrol() : bool
- find() : null|item_interface
- Returns a single coursegroup item.
- find_by_type() : array<string|int, mixed>
- get_contents() : array<int, object>
- Returns course and modules contained in this group.
- get_contextids() : array<string|int, mixed>
- get_course_options() : array<int, string>
- Returns list of courses available for this course group.
- get_course_with_contextid_options() : array<int, string>
- Returns list of context IDs from courses.
- get_coursegroup_by_courseid() : coursegroup_item|false
- get_expiration() : int
- get_facade_accessor() : string
- Return the service accessor key for this facade.
- get_metadata() : array<string|int, mixed>
- get_repository() : item_repository_interface
- inprogress() : bool
- item_available() : void
- item_completed() : bool
- item_get_url() : false|moodle_url
- Returns the first accessible URL for the user.
- list() : array<string|int, mixed>
- pending() : bool
- update() : item_interface
- Updates an existing course group, including the image filemanager.
Constants
FILEMANAGEROPTIONS
public
array<string|int, mixed>
FILEMANAGEROPTIONS
= ['maxbytes' => 1024, 'subdirs' => 0, 'maxfiles' => 1, 'accepted_types' => ['web_image']]
File manager options for image uploads
PER_PAGE
public
int
PER_PAGE
= 50
Pagination default for lists
TYPE
public
string
TYPE
= \local_middag\extensions\coursegroup\model\coursegroup_item::TYPE
Logical TYPE for this entity
Properties
$contextids
public
mixed
$contextids
$id
public
mixed
$id
Methods
all()
Returns all coursegroup items.
public
all() : array<string|int, coursegroup_item>
Tags
Return values
array<string|int, coursegroup_item>all_enablers()
public
all_enablers() : array<string|int, mixed>
Return values
array<string|int, mixed>background()
public
background(coursegroup_item $coursegroup_item) : moodle_url|string
Parameters
- $coursegroup_item : coursegroup_item
Return values
moodle_url|stringcontents()
Generates HTML representation of course contents.
public
contents(coursegroup_item $item) : string
Parameters
- $item : coursegroup_item
Tags
Return values
stringcreate()
Creates a new coursegroup item.
public
create(item_dto|item_dto_interface $dto) : item_interface
Parameters
- $dto : item_dto|item_dto_interface
Tags
Return values
item_interfacedelete()
Deletes a coursegroup item.
public
delete(int $id) : void
Parameters
- $id : int
Tags
deleteurl()
public
deleteurl() : moodle_url
Tags
Return values
moodle_urlediturl()
public
editurl() : moodle_url
Tags
Return values
moodle_urlenrol()
public
enrol() : bool
Return values
boolfind()
Returns a single coursegroup item.
public
find(int $id) : null|item_interface
Parameters
- $id : int
Tags
Return values
null|item_interfacefind_by_type()
public
static find_by_type(string $type) : array<string|int, mixed>
Parameters
- $type : string
Return values
array<string|int, mixed>get_contents()
Returns course and modules contained in this group.
public
get_contents(coursegroup_item $item) : array<int, object>
Parameters
- $item : coursegroup_item
Tags
Return values
array<int, object> —List of course and cm objects
get_contextids()
public
get_contextids() : array<string|int, mixed>
Return values
array<string|int, mixed>get_course_options()
Returns list of courses available for this course group.
public
get_course_options([int $id = 0 ]) : array<int, string>
Parameters
- $id : int = 0
Tags
Return values
array<int, string>get_course_with_contextid_options()
Returns list of context IDs from courses.
public
get_course_with_contextid_options([int $id = 0 ]) : array<int, string>
Parameters
- $id : int = 0
Tags
Return values
array<int, string>get_coursegroup_by_courseid()
public
get_coursegroup_by_courseid(mixed $id) : coursegroup_item|false
Parameters
- $id : mixed
Tags
Return values
coursegroup_item|falseget_expiration()
public
get_expiration(coursegroup_item $item) : int
Parameters
- $item : coursegroup_item
Tags
Return values
intget_facade_accessor()
Return the service accessor key for this facade.
public
static get_facade_accessor() : string
Return values
stringget_metadata()
public
static get_metadata(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed>get_repository()
public
static get_repository() : item_repository_interface
Return values
item_repository_interfaceinprogress()
public
inprogress() : bool
Tags
Return values
boolitem_available()
public
item_available() : void
item_completed()
public
item_completed() : bool
Tags
Return values
boolitem_get_url()
Returns the first accessible URL for the user.
public
item_get_url(coursegroup_item $item) : false|moodle_url
Parameters
- $item : coursegroup_item
Tags
Return values
false|moodle_urllist()
public
list(mixed $current_page, mixed $page_url) : array<string|int, mixed>
Parameters
- $current_page : mixed
- $page_url : mixed
Return values
array<string|int, mixed>pending()
public
pending() : bool
Tags
Return values
boolupdate()
Updates an existing course group, including the image filemanager.
public
update(item_dto $dto) : item_interface
Parameters
- $dto : item_dto