class coursegroup_service extends item_service

Service responsible for business rules of course groups.

Constants

TYPE

FILEMANAGEROPTIONS

PER_PAGE

Properties

$id
$contextids

Methods

create(item_dto_interface $dto)

Creates a new coursegroup item.

update(item_dto_interface $dto)

Updates an existing course group, including the image filemanager.

void
delete(int $id)

Deletes a coursegroup item.

item_interface|null
find(int $id)

Returns a single coursegroup item.

array
get_metadata(int $id)

Retrieve metadata for an item.

array
find_by_type(string $type)

Retrieve all items for the given TYPE.

get_repository()

Expose underlying repository (primarily for advanced orchestration).

array
all()

Returns all coursegroup items.

array
all_enablers()

No description

moodle_url|string
background(coursegroup_item $coursegroup_item)

No description

moodle_url
editurl()

No description

moodle_url
deleteurl()

No description

array
get_contextids()

No description

int
get_expiration(coursegroup_item $item)

No description

string
contents(coursegroup_item $item)

Generates HTML representation of course contents.

array
get_contents(coursegroup_item $item)

Returns course and modules contained in this group.

bool
item_completed()

No description

false|moodle_url
item_get_url(coursegroup_item $item)

Returns the first accessible URL for the user.

void
item_available()

No description

bool
pending()

No description

bool
inprogress()

No description

bool
enrol()

No description

coursegroup_item|false
get_coursegroup_by_courseid(int $id)

No description

array
get_course_options(int $id = 0)

Returns list of courses available for this course group.

array
get_course_with_contextid_options(int $id = 0)

Returns list of context IDs from courses.

array
list($current_page, $page_url)

No description

Details

in item_service at line 47
__construct(item_repository_interface $repository, audit_service_interface $event_service, item_revision_service_interface $revision_service, item_validator_service_interface $validator)

Constructor.

at line 79
item_interface create(item_dto_interface $dto)

Creates a new coursegroup item.

Parameters

item_dto_interface $dto

Return Value

item_interface

Exceptions

moodle_exception

at line 115
item_interface update(item_dto_interface $dto)

Updates an existing course group, including the image filemanager.

Parameters

item_dto_interface $dto

Return Value

item_interface

Exceptions

coding_exception
moodle_exception

at line 193
void delete(int $id)

Deletes a coursegroup item.

Parameters

int $id

Return Value

void

Exceptions

dml_exception
coding_exception

at line 148
item_interface|null find(int $id)

Returns a single coursegroup item.

Parameters

int $id

Return Value

item_interface|null

Exceptions

coding_exception
dml_exception

in item_service at line 167
array get_metadata(int $id)

Retrieve metadata for an item.

Parameters

int $id

Return Value

array

Exceptions

dml_exception

in item_service at line 180
array find_by_type(string $type)

Retrieve all items for the given TYPE.

Used by extensions implementing the TYPE pattern.

Parameters

string $type

Return Value

array

in item_service at line 188
item_repository_interface get_repository()

Expose underlying repository (primarily for advanced orchestration).

at line 173
array all()

Returns all coursegroup items.

Return Value

array

Exceptions

dml_exception
coding_exception

at line 178
array all_enablers()

No description

Return Value

array

at line 198
moodle_url|string background(coursegroup_item $coursegroup_item)

No description

Parameters

coursegroup_item $coursegroup_item

Return Value

moodle_url|string

at line 225
moodle_url editurl()

No description

Return Value

moodle_url

Exceptions

moodle_exception

at line 234
moodle_url deleteurl()

No description

Return Value

moodle_url

Exceptions

moodle_exception

at line 246
array get_contextids()

No description

Return Value

array

at line 263
int get_expiration(coursegroup_item $item)

No description

Parameters

coursegroup_item $item

Return Value

int

Exceptions

coding_exception

at line 286
string contents(coursegroup_item $item)

Generates HTML representation of course contents.

Parameters

coursegroup_item $item

Return Value

string

Exceptions

dml_exception
moodle_exception

at line 334
array get_contents(coursegroup_item $item)

Returns course and modules contained in this group.

Parameters

coursegroup_item $item

Return Value

array

List of course and cm objects

Exceptions

dml_exception
moodle_exception
coding_exception

at line 382
bool item_completed()

No description

Return Value

bool

Exceptions

dml_exception

at line 422
false|moodle_url item_get_url(coursegroup_item $item)

Returns the first accessible URL for the user.

Parameters

coursegroup_item $item

Return Value

false|moodle_url

Exceptions

coding_exception
dml_exception
moodle_exception

at line 434
void item_available()

No description

Return Value

void

at line 442
bool pending()

No description

Return Value

bool

Exceptions

dml_exception

at line 452
bool inprogress()

No description

Return Value

bool

Exceptions

coding_exception
moodle_exception

at line 466
bool enrol()

No description

Return Value

bool

at line 499
coursegroup_item|false get_coursegroup_by_courseid(int $id)

No description

Parameters

int $id

Return Value

coursegroup_item|false

Exceptions

coding_exception
dml_exception
moodle_exception

at line 530
array get_course_options(int $id = 0)

Returns list of courses available for this course group.

Parameters

int $id

Return Value

array

Exceptions

coding_exception
dml_exception
moodle_exception

at line 564
array get_course_with_contextid_options(int $id = 0)

Returns list of context IDs from courses.

Parameters

int $id

Return Value

array

Exceptions

coding_exception
dml_exception
moodle_exception

at line 578
array list($current_page, $page_url)

No description

Parameters

$current_page
$page_url

Return Value

array