Skip to content

Commit

Permalink
isseu #8: handle item changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmitriim
dmitriim committed Sep 27, 2024
1 parent c91f73a commit 16b07e6
Show file tree
Hide file tree
Showing 8 changed files with 707 additions and 151 deletions.
213 changes: 186 additions & 27 deletions classes/helper.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,22 @@ class helper {
*/
public const STUDENT_ROLE = 'student';

/**
* Cached student role object.
* @var stdClass
*/
private static $studentrole;

/**
* Add a new configuration item.
*
* @param int $itemid Item ID number
* @param string $itemtype Item type (tag, course, category).
* @param string $itemname Item name.
* @param array $courses Course to set up enrolment method. If not set, the no enrolment method will be created.
* @param array $courseids Course to set up enrolment method. If not set, the no enrolment method will be created.
* @return void
*/
public static function add_item(int $itemid, string $itemtype, string $itemname, array $courses = []): void {
public static function add_item(int $itemid, string $itemtype, string $itemname, array $courseids = []): void {
$cohort = self::get_cohort_by_item($itemid, $itemtype);

if (empty($cohort)) {
Expand All @@ -114,15 +120,8 @@ public static function add_item(int $itemid, string $itemtype, string $itemname,
self::add_rule($cohort, $itemtype);
// Add a tag to a custom profile field.
self::add_profile_field_item($itemtype, $itemname);

// Create enrolment method for the cohort for a given course.
if (!empty($courses)) {
foreach ($courses as $course) {
if (!empty($course)) {
self::add_enrolment_method($course, $cohort);
}
}
}
// Add enrolment method for given course ids.
self::add_enrolment_method($cohort, $courseids);
}

/**
Expand Down Expand Up @@ -151,6 +150,8 @@ public static function remove_item(int $itemid, string $itemtype, string $itemna
cohort_delete_cohort($cohort);
// Delete tag value from custom profile field list.
self::delete_profile_field_item($itemtype, $itemname);
// Clean up presets.
self::remove_item_from_presets($itemid, $itemtype);
// Clean up user data?
}
}
Expand Down Expand Up @@ -187,7 +188,6 @@ public static function rename_item(int $itemid, string $itemtype, string $newnam
// Update custom profile field.
self::update_profile_field_item($itemtype, $oldname, $newname);

// Update users data. TODO: move to adhoc task.
$field = $DB->get_record('user_info_field', ['shortname' => $itemtype]);

if ($field) {
Expand Down Expand Up @@ -244,26 +244,34 @@ public static function get_cohort_by_item(int $itemid, string $itemtype): ?stdCl
/**
* Helper method to add enrolment method to a course.
*
* @param stdClass $course Course.
* @param stdClass $cohort Cohort.
* @param array $courseids A list of course ids.
*
* @return void
*/
public static function add_enrolment_method(stdClass $course, stdClass $cohort): void {
public static function add_enrolment_method(stdClass $cohort, array $courseids): void {
global $DB;

$studentrole = self::get_student_role();

$fields = [
'enrol' => 'cohort',
'customint1' => $cohort->id,
'roleid' => $studentrole->id,
'courseid' => $course->id,
];
if (!empty($courseids)) {
list($sql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
$select = 'id ' . $sql;
$courses = $DB->get_records_select('course', $select, $params);

if (!$DB->record_exists('enrol', $fields)) {
$enrol = enrol_get_plugin('cohort');
$enrol->add_instance($course, $fields);
foreach ($courses as $course) {
$fields = [
'enrol' => 'cohort',
'customint1' => $cohort->id,
'roleid' => $studentrole->id,
'courseid' => $course->id,
];

if (!$DB->record_exists('enrol', $fields)) {
$enrol = enrol_get_plugin('cohort');
$enrol->add_instance($course, $fields);
}
}
}
}

Expand Down Expand Up @@ -464,10 +472,14 @@ public static function add_rule(stdClass $cohort, string $fieldshortname): void
*
* @return stdClass
*/
public static function get_student_role(): stdClass {
private static function get_student_role(): stdClass {
global $DB;

return $DB->get_record('role', ['shortname' => self::STUDENT_ROLE]);
if (empty(self::$studentrole)) {
self::$studentrole = $DB->get_record('role', ['shortname' => self::STUDENT_ROLE]);
}

return self::$studentrole;
}

/**
Expand Down Expand Up @@ -505,13 +517,15 @@ public static function update_course_category(int $courseid, int $newcategoryid)

if ($type == self::ITEM_TYPE_CATEGORY && !empty($oldcategoryidid)) {
self::remove_enrolment_method($oldcategoryidid, self::ITEM_TYPE_CATEGORY, $courseid);
$presets = self::get_presets_by_item($oldcategoryidid, self::ITEM_TYPE_CATEGORY);
self::remove_presets_enrolment_method($presets);
}
}

$cohort = self::get_cohort_by_item($newcategoryid, self::ITEM_TYPE_CATEGORY);
if ($cohort) {
$course = get_course($courseid);
self::add_enrolment_method($course, $cohort);
self::add_enrolment_method($cohort, [$courseid]);
self::add_presets_enrolment_method($newcategoryid, self::ITEM_TYPE_CATEGORY, [$courseid]);
}
}

Expand Down Expand Up @@ -610,4 +624,149 @@ public static function get_courses_by_tags(array $tagids): array {

return $DB->get_records_sql($sql, $params);
}

/**
* A tiny helper method to convert list of items from string to array.
*
* @param string|null $data
* @return array
*/
public static function explode_data(?string $data): array {
return !empty($data) ? explode(',', $data) : [];
}

/**
* Get list of presets by item type and ID.
*
* @param int $itemid Item ID.
* @param string $itemtype Itenm type.
*
* @return preset[]
*/
public static function get_presets_by_item(int $itemid, string $itemtype): array {
$results = [];

if (in_array($itemtype, self::get_field_types())) {
foreach (preset::get_records() as $preset) {
if (in_array($itemid, self::explode_data($preset->get($itemtype)))) {
$results[$preset->get('id')] = $preset;
}
}
}

return $results;
}

/**
* Get a list of field types.
*
* @return string[]
*/
public static function get_field_types(): array {
return [self::ITEM_TYPE_CATEGORY, self::ITEM_TYPE_COURSE, self::ITEM_TYPE_TAG];
}

/**
* Get list of course IDs for a given preset.
*
* @param preset $preset Preset
* @return array
*/
public static function get_course_ids_from_preset(preset $preset): array {
$courseids = [];

if (!empty($preset->get('category'))) {
$catcourses = array_keys(
self::get_courses_by_categories(explode(',', $preset->get('category')))
);

$courseids = array_unique(array_merge($courseids, $catcourses));
}

if (!empty($preset->get('course'))) {
$courses = explode(',', $preset->get('course'));
$courseids = array_unique(array_merge($courseids, $courses));
}

if (!empty($preset->get('tag'))) {
$tagcourses = array_keys(
self::get_courses_by_tags(explode(',', $preset->get('tag')))
);
$courseids = array_values(array_unique(array_merge($courseids, $tagcourses)));
}

return $courseids;
}

/**
* Removes a given item from presets.
*
* @param int $itemid Item ID.
* @param string $itemtype Item type (e.g. category, course or tag).
*/
private static function remove_item_from_presets(int $itemid, string $itemtype): void {
$presets = self::get_presets_by_item($itemid, $itemtype);

foreach ($presets as $preset) {
$items = self::explode_data($preset->get($itemtype));
if (($key = array_search($itemid, $items)) !== false) {
unset($items[$key]);
}
$preset->set($itemtype, implode(',', $items));
$preset->save();
}

self::remove_presets_enrolment_method($presets);
}

/**
* @param array $presets
*/
public static function remove_presets_enrolment_method(array $presets): void {
global $DB;

foreach ($presets as $preset) {
$cohort = self::get_cohort_by_item($preset->get('id'), self::ITEM_TYPE_PRESET);
if ($cohort) {
$presetcourses = self::get_course_ids_from_preset($preset);
$studentrole = self::get_student_role();

$fields = [
'enrol' => 'cohort',
'customint1' => $cohort->id,
'roleid' => $studentrole->id,
];

$instances = $DB->get_records('enrol', $fields);

if ($instances) {
$enrol = enrol_get_plugin('cohort');
foreach ($instances as $instance) {
// If enrolment instance belongs to a course that is no longer part of preset,
// them delete this enrolment instance.
if (!in_array($instance->courseid, $presetcourses)) {
$enrol->delete_instance($instance);
}
}
}
}
}
}

/**
* Adds presets enrolment method for a given item.
*
* @param int $itemid Item ID.
* @param string $itemtype Item type.
* @param array $courseids Courses to add enrolment method to.
*/
public static function add_presets_enrolment_method(int $itemid, string $itemtype, array $courseids = []): void {
$presets = helper::get_presets_by_item($itemid, $itemtype);
foreach ($presets as $preset) {
$cohort = helper::get_cohort_by_item($preset->get('id'), helper::ITEM_TYPE_PRESET);
if (!empty($cohort)) {
helper::add_enrolment_method($cohort, $courseids);
}
}
}
}
30 changes: 4 additions & 26 deletions classes/observer.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,6 @@ public static function course_category_updated(course_category_updated $event):
* @param course_category_deleted $event The event.
*/
public static function course_category_deleted(course_category_deleted $event): void {

$categoryid = $event->objectid;
$categoryname = $event->other['name'];

Expand All @@ -242,34 +241,13 @@ public static function course_category_deleted(course_category_deleted $event):
* @param preset_created $event The event.
*/
public static function preset_created(preset_created $event): void {
$courseids = [];

if (!empty($event->other['categories'])) {
$catcourses = array_keys(
helper::get_courses_by_categories(explode(',', $event->other['categories']))
);

$courseids = array_unique(array_merge($courseids, $catcourses));
}

if (!empty($event->other['courses'])) {
$courses = explode(',', $event->other['courses']);
$courseids = array_unique(array_merge($courseids, $courses));

}

if (!empty($event->other['tags'])) {
$tagcourses = array_keys(
helper::get_courses_by_tags(explode(',', $event->other['tags']))
);
$courseids = array_values(array_unique(array_merge($courseids, $tagcourses)));
}
$preset = preset::get_record(['id' => $event->other['presetid']]);

self::queue_adhoc_task('add_item', [
'itemid' => $event->other['presetid'],
'itemid' => $preset->get('id'),
'itemtype' => helper::ITEM_TYPE_PRESET,
'itemname' => $event->other['presetname'],
'courseids' => $courseids,
'itemname' => $preset->get('name'),
'courseids' => helper::get_course_ids_from_preset($preset),
]);
}

Expand Down
Loading

0 comments on commit 16b07e6

Please sign in to comment.