Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/category/ -> locallib.php (source)

[Source view]

Local stuff for category enrolment plugin.

Copyright: 2010 Petr Skoda {@link http://skodak.org}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 261 lines (11 kb)
Included or required:0 times
Referenced: 3 times
Includes or requires: 0 files

Defines 2 functions

  enrol_category_sync_course()
  enrol_category_sync_full()

Functions
Functions that are not part of a class:

enrol_category_sync_course($course)   X-Ref
Sync all category enrolments in one course

param: stdClass $course
return: void

enrol_category_sync_full(progress_trace $trace)   X-Ref
Synchronise courses in all categories.

It gets out-of-sync if:
- you move course to different category
- reorder categories
- disable enrol_category and enable it again

param: progress_trace $trace
return: int exit code - 0 is ok, 1 means error, 2 if plugin disabled