2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Library of useful functions
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 * @package core_course
25 defined('MOODLE_INTERNAL') ||
die;
27 use core_course\external\course_summary_exporter
;
28 use core_courseformat\base
as course_format
;
29 use core_courseformat\formatactions
;
30 use core\output\local\action_menu\subpanel
as action_menu_subpanel
;
32 require_once($CFG->libdir
.'/completionlib.php');
33 require_once($CFG->libdir
.'/filelib.php');
34 require_once($CFG->libdir
.'/datalib.php');
35 require_once($CFG->dirroot
.'/course/format/lib.php');
37 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
38 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
41 * Number of courses to display when summaries are included.
43 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
45 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
47 // Max courses in log dropdown before switching to optional.
48 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
49 // Max users in log dropdown before switching to optional.
50 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
51 define('FRONTPAGENEWS', '0');
52 define('FRONTPAGECATEGORYNAMES', '2');
53 define('FRONTPAGECATEGORYCOMBO', '4');
54 define('FRONTPAGEENROLLEDCOURSELIST', '5');
55 define('FRONTPAGEALLCOURSELIST', '6');
56 define('FRONTPAGECOURSESEARCH', '7');
57 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
58 define('EXCELROWS', 65535);
59 define('FIRSTUSEDEXCELROW', 3);
61 define('MOD_CLASS_ACTIVITY', 0);
62 define('MOD_CLASS_RESOURCE', 1);
64 define('COURSE_TIMELINE_ALLINCLUDINGHIDDEN', 'allincludinghidden');
65 define('COURSE_TIMELINE_ALL', 'all');
66 define('COURSE_TIMELINE_PAST', 'past');
67 define('COURSE_TIMELINE_INPROGRESS', 'inprogress');
68 define('COURSE_TIMELINE_FUTURE', 'future');
69 define('COURSE_TIMELINE_SEARCH', 'search');
70 define('COURSE_FAVOURITES', 'favourites');
71 define('COURSE_TIMELINE_HIDDEN', 'hidden');
72 define('COURSE_CUSTOMFIELD', 'customfield');
73 define('COURSE_DB_QUERY_LIMIT', 1000);
74 /** Searching for all courses that have no value for the specified custom field. */
75 define('COURSE_CUSTOMFIELD_EMPTY', -1);
77 // Course activity chooser footer default display option.
78 define('COURSE_CHOOSER_FOOTER_NONE', 'hidden');
80 // Download course content options.
81 define('DOWNLOAD_COURSE_CONTENT_DISABLED', 0);
82 define('DOWNLOAD_COURSE_CONTENT_ENABLED', 1);
83 define('DOWNLOAD_COURSE_CONTENT_SITE_DEFAULT', 2);
85 function make_log_url($module, $url) {
88 if (strpos($url, 'report/') === 0) {
89 // there is only one report type, course reports are deprecated
99 if (strpos($url, '../') === 0) {
100 $url = ltrim($url, '.');
102 $url = "/course/$url";
106 $url = "/calendar/$url";
110 $url = "/$module/$url";
123 $url = "/message/$url";
126 $url = "/notes/$url";
135 $url = "/grade/$url";
138 $url = "/mod/$module/$url";
142 //now let's sanitise urls - there might be some ugly nasties:-(
143 $parts = explode('?', $url);
144 $script = array_shift($parts);
145 if (strpos($script, 'http') === 0) {
146 $script = clean_param($script, PARAM_URL
);
148 $script = clean_param($script, PARAM_PATH
);
153 $query = implode('', $parts);
154 $query = str_replace('&', '&', $query); // both & and & are stored in db :-|
155 $parts = explode('&', $query);
156 $eq = urlencode('=');
157 foreach ($parts as $key=>$part) {
158 $part = urlencode(urldecode($part));
159 $part = str_replace($eq, '=', $part);
160 $parts[$key] = $part;
162 $query = '?'.implode('&', $parts);
165 return $script.$query;
169 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
170 $modname="", $modid=0, $modaction="", $groupid=0) {
173 // It is assumed that $date is the GMT time of midnight for that day,
174 // and so the next 86400 seconds worth of logs are printed.
176 /// Setup for group handling.
178 // TODO: I don't understand group/context/etc. enough to be able to do
179 // something interesting with it here
180 // What is the context of a remote course?
182 /// If the group mode is separate, and this user does not have editing privileges,
183 /// then only the user's group can be viewed.
184 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
185 // $groupid = get_current_group($course->id);
187 /// If this course doesn't have groups, no groupid can be specified.
188 //else if (!$course->groupmode) {
197 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
199 LEFT JOIN {user} u ON l.userid = u.id
203 $where .= "l.hostid = :hostid";
204 $params['hostid'] = $hostid;
206 // TODO: Is 1 really a magic number referring to the sitename?
207 if ($course != SITEID ||
$modid != 0) {
208 $where .= " AND l.course=:courseid";
209 $params['courseid'] = $course;
213 $where .= " AND l.module = :modname";
214 $params['modname'] = $modname;
217 if ('site_errors' === $modid) {
218 $where .= " AND ( l.action='error' OR l.action='infected' )";
220 //TODO: This assumes that modids are the same across sites... probably
222 $where .= " AND l.cmid = :modid";
223 $params['modid'] = $modid;
227 $firstletter = substr($modaction, 0, 1);
228 if ($firstletter == '-') {
229 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
230 $params['modaction'] = '%'.substr($modaction, 1).'%';
232 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
233 $params['modaction'] = '%'.$modaction.'%';
238 $where .= " AND l.userid = :user";
239 $params['user'] = $user;
243 $enddate = $date +
86400;
244 $where .= " AND l.time > :date AND l.time < :enddate";
245 $params['date'] = $date;
246 $params['enddate'] = $enddate;
250 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
251 if(!empty($result['totalcount'])) {
252 $where .= " ORDER BY $order";
253 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
255 $result['logs'] = array();
261 * Checks the integrity of the course data.
263 * In summary - compares course_sections.sequence and course_modules.section.
265 * More detailed, checks that:
266 * - course_sections.sequence contains each module id not more than once in the course
267 * - for each moduleid from course_sections.sequence the field course_modules.section
268 * refers to the same section id (this means course_sections.sequence is more
269 * important if they are different)
270 * - ($fullcheck only) each module in the course is present in one of
271 * course_sections.sequence
272 * - ($fullcheck only) removes non-existing course modules from section sequences
274 * If there are any mismatches, the changes are made and records are updated in DB.
276 * Course cache is NOT rebuilt if there are any errors!
278 * This function is used each time when course cache is being rebuilt with $fullcheck = false
279 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
281 * @param int $courseid id of the course
282 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
283 * the list of enabled course modules in the course. Retrieved from DB if not specified.
284 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
285 * @param array $sections records from course_sections table for this course.
286 * Retrieved from DB if not specified
287 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
288 * course modules from sequences. Only to be used in site maintenance mode when we are
289 * sure that another user is not in the middle of the process of moving/removing a module.
290 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
291 * @return array array of messages with found problems. Empty output means everything is ok
293 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
296 if ($sections === null) {
297 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
300 // Retrieve all records from course_modules regardless of module type visibility.
301 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
303 if ($rawmods === null) {
304 $rawmods = get_course_mods($courseid);
306 if (!$fullcheck && (empty($sections) ||
empty($rawmods))) {
307 // If either of the arrays is empty, no modules are displayed anyway.
310 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
312 // First make sure that each module id appears in section sequences only once.
313 // If it appears in several section sequences the last section wins.
314 // If it appears twice in one section sequence, the first occurence wins.
315 $modsection = array();
316 foreach ($sections as $sectionid => $section) {
317 $sections[$sectionid]->newsequence
= $section->sequence
;
318 if (!empty($section->sequence
)) {
319 $sequence = explode(",", $section->sequence
);
320 $sequenceunique = array_unique($sequence);
321 if (count($sequenceunique) != count($sequence)) {
322 // Some course module id appears in this section sequence more than once.
323 ksort($sequenceunique); // Preserve initial order of modules.
324 $sequence = array_values($sequenceunique);
325 $sections[$sectionid]->newsequence
= join(',', $sequence);
326 $messages[] = $debuggingprefix.'Sequence for course section ['.
327 $sectionid.'] is "'.$sections[$sectionid]->sequence
.'", must be "'.$sections[$sectionid]->newsequence
.'"';
329 foreach ($sequence as $cmid) {
330 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
331 // Some course module id appears to be in more than one section's sequences.
332 $wrongsectionid = $modsection[$cmid];
333 $sections[$wrongsectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence
. ','), ',');
334 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
335 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
337 $modsection[$cmid] = $sectionid;
342 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
344 foreach ($rawmods as $cmid => $mod) {
345 if (!isset($modsection[$cmid])) {
346 // This is a module that is not mentioned in course_section.sequence at all.
347 // Add it to the section $mod->section or to the last available section.
348 if ($mod->section
&& isset($sections[$mod->section
])) {
349 $modsection[$cmid] = $mod->section
;
351 $firstsection = reset($sections);
352 $modsection[$cmid] = $firstsection->id
;
354 $sections[$modsection[$cmid]]->newsequence
= trim($sections[$modsection[$cmid]]->newsequence
.','.$cmid, ',');
355 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
356 $modsection[$cmid].']';
359 foreach ($modsection as $cmid => $sectionid) {
360 if (!isset($rawmods[$cmid])) {
361 // Section $sectionid refers to module id that does not exist.
362 $sections[$sectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence
.','), ',');
363 $messages[] = $debuggingprefix.'Course module ['.$cmid.
364 '] does not exist but is present in the sequence of section ['.$sectionid.']';
369 // Update changed sections.
370 if (!$checkonly && !empty($messages)) {
371 foreach ($sections as $sectionid => $section) {
372 if ($section->newsequence
!== $section->sequence
) {
373 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence
));
378 // Now make sure that all modules point to the correct sections.
379 foreach ($rawmods as $cmid => $mod) {
380 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section
) {
382 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
384 $messages[] = $debuggingprefix.'Course module ['.$cmid.
385 '] points to section ['.$mod->section
.'] instead of ['.$modsection[$cmid].']';
393 * Returns an array where the key is the module name (component name without 'mod_')
394 * and the value is a lang_string object with a human-readable string.
396 * @param bool $plural If true, the function returns the plural forms of the names.
397 * @param bool $resetcache If true, the static cache will be reset
398 * @return lang_string[] Localised human-readable names of all used modules.
400 function get_module_types_names($plural = false, $resetcache = false) {
401 static $modnames = null;
403 if ($modnames === null ||
$resetcache) {
404 $modnames = array(0 => array(), 1 => array());
405 if ($allmods = $DB->get_records("modules")) {
406 foreach ($allmods as $mod) {
407 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible
) {
408 $modnames[0][$mod->name
] = get_string("modulename", "$mod->name", null, true);
409 $modnames[1][$mod->name
] = get_string("modulenameplural", "$mod->name", null, true);
414 return $modnames[(int)$plural];
418 * Set highlighted section. Only one section can be highlighted at the time.
420 * @param int $courseid course id
421 * @param int $marker highlight section with this number, 0 means remove higlightin
424 function course_set_marker($courseid, $marker) {
426 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
427 if ($COURSE && $COURSE->id
== $courseid) {
428 $COURSE->marker
= $marker;
430 core_courseformat\base
::reset_course_cache($courseid);
431 course_modinfo
::clear_instance_cache($courseid);
435 * For a given course section, marks it visible or hidden,
436 * and does the same for every activity in that section
438 * @param int $courseid course id
439 * @param int $sectionnumber The section number to adjust
440 * @param int $visibility The new visibility
441 * @return array A list of resources which were hidden in the section
443 function set_section_visible($courseid, $sectionnumber, $visibility) {
446 $resourcestotoggle = array();
447 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
448 course_update_section($courseid, $section, array('visible' => $visibility));
450 // Determine which modules are visible for AJAX update
451 $modules = !empty($section->sequence
) ?
explode(',', $section->sequence
) : array();
452 if (!empty($modules)) {
453 list($insql, $params) = $DB->get_in_or_equal($modules);
454 $select = 'id ' . $insql . ' AND visible = ?';
455 array_push($params, $visibility);
457 $select .= ' AND visibleold = 1';
459 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
462 return $resourcestotoggle;
466 * Return the course category context for the category with id $categoryid, except
467 * that if $categoryid is 0, return the system context.
469 * @param integer $categoryid a category id or 0.
470 * @return context the corresponding context
472 function get_category_or_system_context($categoryid) {
474 return context_coursecat
::instance($categoryid, IGNORE_MISSING
);
476 return context_system
::instance();
481 * Print the buttons relating to course requests.
483 * @param context $context current page context.
484 * @deprecated since Moodle 4.0
485 * @todo Final deprecation MDL-73976
487 function print_course_request_buttons($context) {
488 global $CFG, $DB, $OUTPUT;
489 debugging("print_course_request_buttons() is deprecated. " .
490 "This is replaced with the category_action_bar tertiary navigation.", DEBUG_DEVELOPER
);
491 if (empty($CFG->enablecourserequests
)) {
494 if (course_request
::can_request($context)) {
495 // Print a button to request a new course.
497 if ($context instanceof context_coursecat
) {
498 $params['category'] = $context->instanceid
;
500 echo $OUTPUT->single_button(new moodle_url('/course/request.php', $params),
501 get_string('requestcourse'), 'get');
503 /// Print a button to manage pending requests
504 if (has_capability('moodle/site:approvecourse', $context)) {
505 $disabled = !$DB->record_exists('course_request', array());
506 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
511 * Does the user have permission to edit things in this category?
513 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
514 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
516 function can_edit_in_category($categoryid = 0) {
517 $context = get_category_or_system_context($categoryid);
518 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
521 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
523 function add_course_module($mod) {
526 $mod->added
= time();
529 $cmid = $DB->insert_record("course_modules", $mod);
530 rebuild_course_cache($mod->course
, true);
535 * Creates a course section and adds it to the specified position
537 * @param int|stdClass $courseorid course id or course object
538 * @param int $position position to add to, 0 means to the end. If position is greater than
539 * number of existing secitons, the section is added to the end. This will become sectionnum of the
540 * new section. All existing sections at this or bigger position will be shifted down.
541 * @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
542 * @return stdClass created section object
544 function course_create_section($courseorid, $position = 0, $skipcheck = false) {
545 return formatactions
::section($courseorid)->create($position, $skipcheck);
549 * Creates missing course section(s) and rebuilds course cache
551 * @param int|stdClass $courseorid course id or course object
552 * @param int|array $sections list of relative section numbers to create
553 * @return bool if there were any sections created
555 function course_create_sections_if_missing($courseorid, $sections) {
556 if (!is_array($sections)) {
557 $sections = array($sections);
559 return formatactions
::section($courseorid)->create_if_missing($sections);
563 * Adds an existing module to the section
565 * Updates both tables {course_sections} and {course_modules}
567 * Note: This function does not use modinfo PROVIDED that the section you are
568 * adding the module to already exists. If the section does not exist, it will
569 * build modinfo if necessary and create the section.
571 * @param int|stdClass $courseorid course id or course object
572 * @param int $cmid id of the module already existing in course_modules table
573 * @param int $sectionnum relative number of the section (field course_sections.section)
574 * If section does not exist it will be created
575 * @param int|stdClass $beforemod id or object with field id corresponding to the module
576 * before which the module needs to be included. Null for inserting in the
578 * @return int The course_sections ID where the module is inserted
580 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
582 if (is_object($beforemod)) {
583 $beforemod = $beforemod->id
;
585 if (is_object($courseorid)) {
586 $courseid = $courseorid->id
;
588 $courseid = $courseorid;
590 // Do not try to use modinfo here, there is no guarantee it is valid!
591 $section = $DB->get_record('course_sections',
592 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING
);
594 // This function call requires modinfo.
595 course_create_sections_if_missing($courseorid, $sectionnum);
596 $section = $DB->get_record('course_sections',
597 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST
);
600 $modarray = explode(",", trim($section->sequence
));
601 if (empty($section->sequence
)) {
602 $newsequence = "$cmid";
603 } else if ($beforemod && ($key = moodle_array_keys_filter($modarray, $beforemod))) {
604 $insertarray = array($cmid, $beforemod);
605 array_splice($modarray, $key[0], 1, $insertarray);
606 $newsequence = implode(",", $modarray);
608 $newsequence = "$section->sequence,$cmid";
610 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id
));
611 $DB->set_field('course_modules', 'section', $section->id
, array('id' => $cmid));
612 rebuild_course_cache($courseid, true);
613 return $section->id
; // Return course_sections ID that was used.
617 * Change the group mode of a course module.
619 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
620 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
622 * @param int $id course module ID.
623 * @param int $groupmode the new groupmode value.
624 * @return bool True if the $groupmode was updated.
626 function set_coursemodule_groupmode($id, $groupmode) {
628 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST
);
629 if ($cm->groupmode
!= $groupmode) {
630 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id
));
631 \course_modinfo
::purge_course_module_cache($cm->course
, $cm->id
);
632 rebuild_course_cache($cm->course
, false, true);
634 return ($cm->groupmode
!= $groupmode);
637 function set_coursemodule_idnumber($id, $idnumber) {
639 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST
);
640 if ($cm->idnumber
!= $idnumber) {
641 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id
));
642 \course_modinfo
::purge_course_module_cache($cm->course
, $cm->id
);
643 rebuild_course_cache($cm->course
, false, true);
645 return ($cm->idnumber
!= $idnumber);
649 * Set downloadcontent value to course module.
651 * @param int $id The id of the module.
652 * @param bool $downloadcontent Whether the module can be downloaded when download course content is enabled.
653 * @return bool True if downloadcontent has been updated, false otherwise.
655 function set_downloadcontent(int $id, bool $downloadcontent): bool {
657 $cm = $DB->get_record('course_modules', ['id' => $id], 'id, course, downloadcontent', MUST_EXIST
);
658 if ($cm->downloadcontent
!= $downloadcontent) {
659 $DB->set_field('course_modules', 'downloadcontent', $downloadcontent, ['id' => $cm->id
]);
660 rebuild_course_cache($cm->course
, true);
662 return ($cm->downloadcontent
!= $downloadcontent);
666 * Set the visibility of a module and inherent properties.
668 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
669 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
671 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
672 * has been moved to {@link set_section_visible()} which was the only place from which
673 * the parameter was used.
675 * If $rebuildcache is set to false, the calling code is responsible for ensuring the cache is purged
676 * and rebuilt as appropriate. Consider using this if set_coursemodule_visible is called multiple times
679 * @param int $id of the module
680 * @param int $visible state of the module
681 * @param int $visibleoncoursepage state of the module on the course page
682 * @param bool $rebuildcache If true (default), perform a partial cache purge and rebuild.
683 * @return bool false when the module was not found, true otherwise
685 function set_coursemodule_visible($id, $visible, $visibleoncoursepage = 1, bool $rebuildcache = true) {
687 require_once($CFG->libdir
.'/gradelib.php');
688 require_once($CFG->dirroot
.'/calendar/lib.php');
690 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
694 // Create events and propagate visibility to associated grade items if the value has changed.
695 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
696 if ($cm->visible
== $visible && $cm->visibleoncoursepage
== $visibleoncoursepage) {
700 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module
))) {
703 if (($cm->visible
!= $visible) &&
704 ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename)))) {
705 foreach($events as $event) {
707 $event = new calendar_event($event);
708 $event->toggle_visibility(true);
710 $event = new calendar_event($event);
711 $event->toggle_visibility(false);
716 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
717 // affect visibleold to allow for an original visibility restore. See set_section_visible().
718 $cminfo = new stdClass();
720 $cminfo->visible
= $visible;
721 $cminfo->visibleoncoursepage
= $visibleoncoursepage;
722 $cminfo->visibleold
= $visible;
723 $DB->update_record('course_modules', $cminfo);
725 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
726 // Note that this must be done after updating the row in course_modules, in case
727 // the modules grade_item_update function needs to access $cm->visible.
728 if ($cm->visible
!= $visible &&
729 plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY
) &&
730 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
731 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
732 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
733 } else if ($cm->visible
!= $visible) {
734 $grade_items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance
, 'courseid'=>$cm->course
));
736 foreach ($grade_items as $grade_item) {
737 $grade_item->set_hidden(!$visible);
743 \course_modinfo
::purge_course_module_cache($cm->course
, $cm->id
);
744 rebuild_course_cache($cm->course
, false, true);
750 * Changes the course module name
752 * @param int $id course module id
753 * @param string $name new value for a name
754 * @return bool whether a change was made
756 function set_coursemodule_name($id, $name) {
758 require_once($CFG->libdir
. '/gradelib.php');
760 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
762 $module = new \
stdClass();
763 $module->id
= $cm->instance
;
765 // Escape strings as they would be by mform.
766 if (!empty($CFG->formatstringstriptags
)) {
767 $module->name
= clean_param($name, PARAM_TEXT
);
769 $module->name
= clean_param($name, PARAM_CLEANHTML
);
771 if ($module->name
=== $cm->name ||
strval($module->name
) === '') {
774 if (\core_text
::strlen($module->name
) > 255) {
775 throw new \
moodle_exception('maximumchars', 'moodle', '', 255);
778 $module->timemodified
= time();
779 $DB->update_record($cm->modname
, $module);
780 $cm->name
= $module->name
;
781 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
782 \course_modinfo
::purge_course_module_cache($cm->course
, $cm->id
);
783 rebuild_course_cache($cm->course
, false, true);
785 // Attempt to update the grade item if relevant.
786 $grademodule = $DB->get_record($cm->modname
, array('id' => $cm->instance
));
787 $grademodule->cmidnumber
= $cm->idnumber
;
788 $grademodule->modname
= $cm->modname
;
789 grade_update_mod_grades($grademodule);
791 // Update calendar events with the new name.
792 course_module_update_calendar_events($cm->modname
, $grademodule, $cm);
798 * This function will handle the whole deletion process of a module. This includes calling
799 * the modules delete_instance function, deleting files, events, grades, conditional data,
800 * the data in the course_module and course_sections table and adding a module deletion
803 * @param int $cmid the course module id
804 * @param bool $async whether or not to try to delete the module using an adhoc task. Async also depends on a plugin hook.
805 * @throws moodle_exception
808 function course_delete_module($cmid, $async = false) {
809 // Check the 'course_module_background_deletion_recommended' hook first.
810 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
811 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
812 // It's up to plugins to handle things like whether or not they are enabled.
813 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
814 foreach ($pluginsfunction as $plugintype => $plugins) {
815 foreach ($plugins as $pluginfunction) {
816 if ($pluginfunction()) {
817 return course_module_flag_for_async_deletion($cmid);
825 require_once($CFG->libdir
.'/gradelib.php');
826 require_once($CFG->libdir
.'/questionlib.php');
827 require_once($CFG->dirroot
.'/blog/lib.php');
828 require_once($CFG->dirroot
.'/calendar/lib.php');
830 // Get the course module.
831 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
835 // Get the module context.
836 $modcontext = context_module
::instance($cm->id
);
838 // Get the course module name.
839 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
841 // Get the file location of the delete_instance function for this module.
842 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
844 // Include the file required to call the delete_instance function for this module.
845 if (file_exists($modlib)) {
846 require_once($modlib);
848 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
849 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
852 $deleteinstancefunction = $modulename . '_delete_instance';
854 // Ensure the delete_instance function exists for this module.
855 if (!function_exists($deleteinstancefunction)) {
856 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
857 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
860 // Allow plugins to use this course module before we completely delete it.
861 if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
862 foreach ($pluginsfunction as $plugintype => $plugins) {
863 foreach ($plugins as $pluginfunction) {
864 $pluginfunction($cm);
869 // Call the delete_instance function, if it returns false throw an exception.
870 if (!$deleteinstancefunction($cm->instance
)) {
871 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
872 "Cannot delete the module $modulename (instance).");
875 question_delete_activity($cm);
877 // Remove all module files in case modules forget to do that.
878 $fs = get_file_storage();
879 $fs->delete_area_files($modcontext->id
);
881 // Delete events from calendar.
882 if ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename))) {
883 $coursecontext = context_course
::instance($cm->course
);
884 foreach($events as $event) {
885 $event->context
= $coursecontext;
886 $calendarevent = calendar_event
::load($event);
887 $calendarevent->delete();
891 // Delete grade items, outcome items and grades attached to modules.
892 if ($grade_items = grade_item
::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
893 'iteminstance' => $cm->instance
, 'courseid' => $cm->course
))) {
894 foreach ($grade_items as $grade_item) {
895 $grade_item->delete('moddelete');
899 // Delete associated blogs and blog tag instances.
900 blog_remove_associations_for_module($modcontext->id
);
902 // Delete completion and availability data; it is better to do this even if the
903 // features are not turned on, in case they were turned on previously (these will be
904 // very quick on an empty table).
905 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id
));
906 $DB->delete_records('course_modules_viewed', ['coursemoduleid' => $cm->id
]);
907 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id
,
908 'course' => $cm->course
,
909 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY
));
911 // Delete all tag instances associated with the instance of this module.
912 core_tag_tag
::delete_instances('mod_' . $modulename, null, $modcontext->id
);
913 core_tag_tag
::remove_all_item_tags('core', 'course_modules', $cm->id
);
915 // Notify the competency subsystem.
916 \core_competency\api
::hook_course_module_deleted($cm);
918 // Delete the context.
919 context_helper
::delete_instance(CONTEXT_MODULE
, $cm->id
);
921 // Delete the module from the course_modules table.
922 $DB->delete_records('course_modules', array('id' => $cm->id
));
924 // Delete module from that section.
925 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
926 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
927 "Cannot delete the module $modulename (instance) from section.");
930 // Trigger event for course module delete action.
931 $event = \core\event\course_module_deleted
::create(array(
932 'courseid' => $cm->course
,
933 'context' => $modcontext,
934 'objectid' => $cm->id
,
936 'modulename' => $modulename,
937 'instanceid' => $cm->instance
,
940 $event->add_record_snapshot('course_modules', $cm);
942 \course_modinfo
::purge_course_module_cache($cm->course
, $cm->id
);
943 rebuild_course_cache($cm->course
, false, true);
947 * Schedule a course module for deletion in the background using an adhoc task.
949 * This method should not be called directly. Instead, please use course_delete_module($cmid, true), to denote async deletion.
950 * The real deletion of the module is handled by the task, which calls 'course_delete_module($cmid)'.
952 * @param int $cmid the course module id.
953 * @return bool whether the module was successfully scheduled for deletion.
954 * @throws \moodle_exception
956 function course_module_flag_for_async_deletion($cmid) {
957 global $CFG, $DB, $USER;
958 require_once($CFG->libdir
.'/gradelib.php');
959 require_once($CFG->libdir
.'/questionlib.php');
960 require_once($CFG->dirroot
.'/blog/lib.php');
961 require_once($CFG->dirroot
.'/calendar/lib.php');
963 // Get the course module.
964 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
968 // We need to be reasonably certain the deletion is going to succeed before we background the process.
969 // Make the necessary delete_instance checks, etc. before proceeding further. Throw exceptions if required.
971 // Get the course module name.
972 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
974 // Get the file location of the delete_instance function for this module.
975 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
977 // Include the file required to call the delete_instance function for this module.
978 if (file_exists($modlib)) {
979 require_once($modlib);
981 throw new \
moodle_exception('cannotdeletemodulemissinglib', '', '', null,
982 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
985 $deleteinstancefunction = $modulename . '_delete_instance';
987 // Ensure the delete_instance function exists for this module.
988 if (!function_exists($deleteinstancefunction)) {
989 throw new \
moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
990 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
993 // We are going to defer the deletion as we can't be sure how long the module's pre_delete code will run for.
994 $cm->deletioninprogress
= '1';
995 $DB->update_record('course_modules', $cm);
997 // Create an adhoc task for the deletion of the course module. The task takes an array of course modules for removal.
998 $removaltask = new \core_course\task\
course_delete_modules();
999 $removaltask->set_custom_data(array(
1000 'cms' => array($cm),
1001 'userid' => $USER->id
,
1002 'realuserid' => \core\session\manager
::get_realuser()->id
1005 // Queue the task for the next run.
1006 \core\task\manager
::queue_adhoc_task($removaltask);
1008 // Reset the course cache to hide the module.
1009 rebuild_course_cache($cm->course
, true);
1013 * Checks whether the given course has any course modules scheduled for adhoc deletion.
1015 * @param int $courseid the id of the course.
1016 * @param bool $onlygradable whether to check only gradable modules or all modules.
1017 * @return bool true if the course contains any modules pending deletion, false otherwise.
1019 function course_modules_pending_deletion(int $courseid, bool $onlygradable = false) : bool {
1020 if (empty($courseid)) {
1024 if ($onlygradable) {
1025 // Fetch modules with grade items.
1026 if (!$coursegradeitems = grade_item
::fetch_all(['itemtype' => 'mod', 'courseid' => $courseid])) {
1027 // Return early when there is none.
1032 $modinfo = get_fast_modinfo($courseid);
1033 foreach ($modinfo->get_cms() as $module) {
1034 if ($module->deletioninprogress
== '1') {
1035 if ($onlygradable) {
1036 // Check if the module being deleted is in the list of course modules with grade items.
1037 foreach ($coursegradeitems as $coursegradeitem) {
1038 if ($coursegradeitem->itemmodule
== $module->modname
&& $coursegradeitem->iteminstance
== $module->instance
) {
1039 // The module being deleted is within the gradable modules.
1052 * Checks whether the course module, as defined by modulename and instanceid, is scheduled for deletion within the given course.
1054 * @param int $courseid the course id.
1055 * @param string $modulename the module name. E.g. 'assign', 'book', etc.
1056 * @param int $instanceid the module instance id.
1057 * @return bool true if the course module is pending deletion, false otherwise.
1059 function course_module_instance_pending_deletion($courseid, $modulename, $instanceid) {
1060 if (empty($courseid) ||
empty($modulename) ||
empty($instanceid)) {
1063 $modinfo = get_fast_modinfo($courseid);
1064 $instances = $modinfo->get_instances_of($modulename);
1065 return isset($instances[$instanceid]) && $instances[$instanceid]->deletioninprogress
;
1068 function delete_mod_from_section($modid, $sectionid) {
1071 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1073 $modarray = explode(",", $section->sequence
);
1075 if ($key = moodle_array_keys_filter($modarray, $modid)) {
1076 array_splice($modarray, $key[0], 1);
1077 $newsequence = implode(",", $modarray);
1078 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id
));
1079 rebuild_course_cache($section->course
, true);
1090 * This function updates the calendar events from the information stored in the module table and the course
1093 * @param string $modulename Module name
1094 * @param stdClass $instance Module object. Either the $instance or the $cm must be supplied.
1095 * @param stdClass $cm Course module object. Either the $instance or the $cm must be supplied.
1096 * @return bool Returns true if calendar events are updated.
1097 * @since Moodle 3.3.4
1099 function course_module_update_calendar_events($modulename, $instance = null, $cm = null) {
1102 if (isset($instance) ||
isset($cm)) {
1104 if (!isset($instance)) {
1105 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1108 $cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
);
1111 course_module_calendar_event_update_process($instance, $cm);
1119 * Update all instances through out the site or in a course.
1121 * @param string $modulename Module type to update.
1122 * @param integer $courseid Course id to update events. 0 for the whole site.
1123 * @return bool Returns True if the update was successful.
1124 * @since Moodle 3.3.4
1126 function course_module_bulk_update_calendar_events($modulename, $courseid = 0) {
1131 if (!$instances = $DB->get_records($modulename, array('course' => $courseid))) {
1135 if (!$instances = $DB->get_records($modulename)) {
1140 foreach ($instances as $instance) {
1141 if ($cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
)) {
1142 course_module_calendar_event_update_process($instance, $cm);
1149 * Calendar events for a module instance are updated.
1151 * @param stdClass $instance Module instance object.
1152 * @param stdClass $cm Course Module object.
1153 * @since Moodle 3.3.4
1155 function course_module_calendar_event_update_process($instance, $cm) {
1156 // We need to call *_refresh_events() first because some modules delete 'old' events at the end of the code which
1157 // will remove the completion events.
1158 $refresheventsfunction = $cm->modname
. '_refresh_events';
1159 if (function_exists($refresheventsfunction)) {
1160 call_user_func($refresheventsfunction, $cm->course
, $instance, $cm);
1162 $completionexpected = (!empty($cm->completionexpected
)) ?
$cm->completionexpected
: null;
1163 \core_completion\api
::update_completion_date_event($cm->id
, $cm->modname
, $instance, $completionexpected);
1167 * Moves a section within a course, from a position to another.
1168 * Be very careful: $section and $destination refer to section number,
1171 * @param object $course
1172 * @param int $section Section number (not id!!!)
1173 * @param int $destination
1174 * @param bool $ignorenumsections
1175 * @return boolean Result
1177 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1178 /// Moves a whole course section up and down within the course
1181 if (!$destination && $destination != 0) {
1185 // compartibility with course formats using field 'numsections'
1186 $courseformatoptions = course_get_format($course)->get_format_options();
1187 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1188 ($destination > $courseformatoptions['numsections'])) ||
($destination < 1)) {
1192 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1193 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id
),
1194 'section ASC, id ASC', 'id, section')) {
1198 $movedsections = reorder_sections($sections, $section, $destination);
1200 // Update all sections. Do this in 2 steps to avoid breaking database
1201 // uniqueness constraint
1202 $transaction = $DB->start_delegated_transaction();
1203 foreach ($movedsections as $id => $position) {
1204 if ((int) $sections[$id] !== $position) {
1205 $DB->set_field('course_sections', 'section', -$position, ['id' => $id]);
1206 // Invalidate the section cache by given section id.
1207 course_modinfo
::purge_course_section_cache_by_id($course->id
, $id);
1210 foreach ($movedsections as $id => $position) {
1211 if ((int) $sections[$id] !== $position) {
1212 $DB->set_field('course_sections', 'section', $position, ['id' => $id]);
1213 // Invalidate the section cache by given section id.
1214 course_modinfo
::purge_course_section_cache_by_id($course->id
, $id);
1218 // If we move the highlighted section itself, then just highlight the destination.
1219 // Adjust the higlighted section location if we move something over it either direction.
1220 if ($section == $course->marker
) {
1221 course_set_marker($course->id
, $destination);
1222 } else if ($section > $course->marker
&& $course->marker
>= $destination) {
1223 course_set_marker($course->id
, $course->marker+
1);
1224 } else if ($section < $course->marker
&& $course->marker
<= $destination) {
1225 course_set_marker($course->id
, $course->marker
-1);
1228 $transaction->allow_commit();
1229 rebuild_course_cache($course->id
, true, true);
1234 * This method will delete a course section and may delete all modules inside it.
1236 * No permissions are checked here, use {@link course_can_delete_section()} to
1237 * check if section can actually be deleted.
1239 * @param int|stdClass $course
1240 * @param int|stdClass|section_info $sectionornum
1241 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1242 * @param bool $async whether or not to try to delete the section using an adhoc task. Async also depends on a plugin hook.
1243 * @return bool whether section was deleted
1245 function course_delete_section($course, $sectionornum, $forcedeleteifnotempty = true, $async = false) {
1246 $sectionnum = (is_object($sectionornum)) ?
$sectionornum->section
: (int)$sectionornum;
1247 $sectioninfo = get_fast_modinfo($course)->get_section_info($sectionnum);
1248 if (!$sectioninfo) {
1251 return formatactions
::section($course)->delete($sectioninfo, $forcedeleteifnotempty, $async);
1255 * Course section deletion, using an adhoc task for deletion of the modules it contains.
1256 * 1. Schedule all modules within the section for adhoc removal.
1257 * 2. Move all modules to course section 0.
1258 * 3. Delete the resulting empty section.
1260 * @param \stdClass $section the section to schedule for deletion.
1261 * @param bool $forcedeleteifnotempty whether to force section deletion if it contains modules.
1262 * @return bool true if the section was scheduled for deletion, false otherwise.
1264 function course_delete_section_async($section, $forcedeleteifnotempty = true) {
1265 if (!is_object($section) ||
empty($section->id
) ||
empty($section->course
)) {
1268 $sectioninfo = get_fast_modinfo($section->course
)->get_section_info_by_id($section->id
);
1269 if (!$sectioninfo) {
1272 return formatactions
::section($section->course
)->delete_async($sectioninfo, $forcedeleteifnotempty);
1276 * Updates the course section
1278 * This function does not check permissions or clean values - this has to be done prior to calling it.
1280 * @param int|stdClass $course
1281 * @param stdClass $section record from course_sections table - it will be updated with the new values
1282 * @param array|stdClass $data
1284 function course_update_section($course, $section, $data) {
1287 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1289 // Some fields can not be updated using this method.
1290 $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1291 $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible
);
1292 if (array_key_exists('name', $data) && \core_text
::strlen($data['name']) > 255) {
1293 throw new moodle_exception('maximumchars', 'moodle', '', 255);
1296 // Update record in the DB and course format options.
1297 $data['id'] = $section->id
;
1298 $data['timemodified'] = time();
1299 $DB->update_record('course_sections', $data);
1300 // Invalidate the section cache by given section id.
1301 course_modinfo
::purge_course_section_cache_by_id($courseid, $section->id
);
1302 rebuild_course_cache($courseid, false, true);
1303 course_get_format($courseid)->update_section_format_options($data);
1305 // Update fields of the $section object.
1306 foreach ($data as $key => $value) {
1307 if (property_exists($section, $key)) {
1308 $section->$key = $value;
1312 // Trigger an event for course section update.
1313 $event = \core\event\course_section_updated
::create(
1315 'objectid' => $section->id
,
1316 'courseid' => $courseid,
1317 'context' => context_course
::instance($courseid),
1318 'other' => array('sectionnum' => $section->section
)
1323 // If section visibility was changed, hide the modules in this section too.
1324 if ($changevisibility && !empty($section->sequence
)) {
1325 $modules = explode(',', $section->sequence
);
1327 foreach ($modules as $moduleid) {
1328 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1330 if ($data['visible']) {
1331 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1332 set_coursemodule_visible($moduleid, $cm->visibleold
, $cm->visibleoncoursepage
, false);
1334 // We hide the section, so we hide the module but we store the original state in visibleold.
1335 set_coursemodule_visible($moduleid, 0, $cm->visibleoncoursepage
, false);
1336 $DB->set_field('course_modules', 'visibleold', $cm->visible
, ['id' => $moduleid]);
1338 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1341 \course_modinfo
::purge_course_modules_cache($courseid, $cmids);
1342 rebuild_course_cache($courseid, false, true);
1347 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1349 * @param int|stdClass $course
1350 * @param int|stdClass|section_info $section
1353 function course_can_delete_section($course, $section) {
1354 if (is_object($section)) {
1355 $section = $section->section
;
1358 // Not possible to delete 0-section.
1361 // Course format should allow to delete sections.
1362 if (!course_get_format($course)->can_delete_section($section)) {
1365 // Make sure user has capability to update course and move sections.
1366 $context = context_course
::instance(is_object($course) ?
$course->id
: $course);
1367 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1370 // Make sure user has capability to delete each activity in this section.
1371 $modinfo = get_fast_modinfo($course);
1372 if (!empty($modinfo->sections
[$section])) {
1373 foreach ($modinfo->sections
[$section] as $cmid) {
1374 if (!has_capability('moodle/course:manageactivities', context_module
::instance($cmid))) {
1383 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1384 * an original position number and a target position number, rebuilds the array so that the
1385 * move is made without any duplication of section positions.
1386 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1387 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1389 * @param array $sections
1390 * @param int $origin_position
1391 * @param int $target_position
1394 function reorder_sections($sections, $origin_position, $target_position) {
1395 if (!is_array($sections)) {
1399 // We can't move section position 0
1400 if ($origin_position < 1) {
1401 echo "We can't move section position 0";
1405 // Locate origin section in sections array
1406 if (!$origin_key = array_search($origin_position, $sections)) {
1407 echo "searched position not in sections array";
1408 return false; // searched position not in sections array
1411 // Extract origin section
1412 $origin_section = $sections[$origin_key];
1413 unset($sections[$origin_key]);
1415 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1417 $append_array = array();
1418 foreach ($sections as $id => $position) {
1420 $append_array[$id] = $position;
1421 unset($sections[$id]);
1423 if ($position == $target_position) {
1424 if ($target_position < $origin_position) {
1425 $append_array[$id] = $position;
1426 unset($sections[$id]);
1432 // Append moved section
1433 $sections[$origin_key] = $origin_section;
1435 // Append rest of array (if applicable)
1436 if (!empty($append_array)) {
1437 foreach ($append_array as $id => $position) {
1438 $sections[$id] = $position;
1442 // Renumber positions
1444 foreach ($sections as $id => $p) {
1445 $sections[$id] = $position;
1454 * Move the module object $mod to the specified $section
1455 * If $beforemod exists then that is the module
1456 * before which $modid should be inserted
1458 * @param stdClass|cm_info $mod
1459 * @param stdClass|section_info $section
1460 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1461 * before which the module needs to be included. Null for inserting in the
1462 * end of the section
1463 * @return int new value for module visibility (0 or 1)
1465 function moveto_module($mod, $section, $beforemod=NULL) {
1466 global $OUTPUT, $DB;
1468 // Current module visibility state - return value of this function.
1469 $modvisible = $mod->visible
;
1471 // Remove original module from original section.
1472 if (! delete_mod_from_section($mod->id
, $mod->section
)) {
1473 echo $OUTPUT->notification("Could not delete module from existing section");
1476 // Add the module into the new section.
1477 course_add_cm_to_section($section->course
, $mod->id
, $section->section
, $beforemod);
1479 // If moving to a hidden section then hide module.
1480 if ($mod->section
!= $section->id
) {
1481 if (!$section->visible
&& $mod->visible
) {
1482 // Module was visible but must become hidden after moving to hidden section.
1484 set_coursemodule_visible($mod->id
, 0);
1485 // Set visibleold to 1 so module will be visible when section is made visible.
1486 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id
));
1488 if ($section->visible
&& !$mod->visible
) {
1489 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1490 set_coursemodule_visible($mod->id
, $mod->visibleold
);
1491 $modvisible = $mod->visibleold
;
1499 * Returns the list of all editing actions that current user can perform on the module
1501 * @param cm_info $mod The module to produce editing buttons for
1502 * @param int $indent The current indenting (default -1 means no move left-right actions)
1503 * @param int $sr The section to link back to (used for creating the links)
1504 * @return array array of action_link or pix_icon objects
1506 function course_get_cm_edit_actions(cm_info
$mod, $indent = -1, $sr = null) {
1507 global $COURSE, $SITE, $CFG;
1511 $coursecontext = context_course
::instance($mod->course
);
1512 $modcontext = context_module
::instance($mod->id
);
1513 $courseformat = course_get_format($mod->get_course());
1514 $usecomponents = $courseformat->supports_components();
1515 $sectioninfo = $mod->get_section_info();
1517 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1518 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1520 // No permission to edit anything.
1521 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1525 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1530 'delete', 'move', 'moveright', 'moveleft', 'editsettings',
1531 'duplicate', 'availability'
1535 $str->assign
= get_string('assignroles', 'role');
1536 $str->groupmode
= get_string('groupmode', 'group');
1539 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1542 $baseurl->param('sr', $sr);
1547 if ($hasmanageactivities) {
1548 $actions['update'] = new action_menu_link_secondary(
1549 new moodle_url($baseurl, array('update' => $mod->id
)),
1550 new pix_icon('t/edit', '', 'moodle', array('class' => 'iconsmall')),
1552 array('class' => 'editing_update', 'data-action' => 'update')
1556 // Move (only for component compatible formats).
1557 if ($hasmanageactivities && $usecomponents) {
1558 $actions['move'] = new action_menu_link_secondary(
1559 new moodle_url($baseurl, [
1560 'sesskey' => sesskey(),
1563 new pix_icon('i/dragdrop', '', 'moodle', ['class' => 'iconsmall']),
1566 'class' => 'editing_movecm',
1567 'data-action' => 'moveCm',
1568 'data-id' => $mod->id
,
1574 if ($hasmanageactivities && $indent >= 0) {
1575 $indentlimits = new stdClass();
1576 $indentlimits->min
= 0;
1577 // Legacy indentation could continue using a limit of 16,
1578 // but components based formats will be forced to use one level indentation only.
1579 $indentlimits->max
= ($usecomponents) ?
1 : 16;
1580 if (right_to_left()) { // Exchange arrows on RTL
1581 $rightarrow = 't/left';
1582 $leftarrow = 't/right';
1584 $rightarrow = 't/right';
1585 $leftarrow = 't/left';
1588 if ($indent >= $indentlimits->max
) {
1589 $enabledclass = 'hidden';
1593 $actions['moveright'] = new action_menu_link_secondary(
1594 new moodle_url($baseurl, ['id' => $mod->id
, 'indent' => '1']),
1595 new pix_icon($rightarrow, '', 'moodle', ['class' => 'iconsmall']),
1598 'class' => 'editing_moveright ' . $enabledclass,
1599 'data-action' => ($usecomponents) ?
'cmMoveRight' : 'moveright',
1600 'data-keepopen' => true,
1601 'data-sectionreturn' => $sr,
1602 'data-id' => $mod->id
,
1606 if ($indent <= $indentlimits->min
) {
1607 $enabledclass = 'hidden';
1611 $actions['moveleft'] = new action_menu_link_secondary(
1612 new moodle_url($baseurl, ['id' => $mod->id
, 'indent' => '-1']),
1613 new pix_icon($leftarrow, '', 'moodle', ['class' => 'iconsmall']),
1616 'class' => 'editing_moveleft ' . $enabledclass,
1617 'data-action' => ($usecomponents) ?
'cmMoveLeft' : 'moveleft',
1618 'data-keepopen' => true,
1619 'data-sectionreturn' => $sr,
1620 'data-id' => $mod->id
,
1626 // Hide/Show/Available/Unavailable.
1627 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1628 $availabilityclass = $courseformat->get_output_classname('content\\cm\\visibility');
1629 /** @var core_courseformat\output\local\content\cm\visibility */
1630 $availability = new $availabilityclass($courseformat, $sectioninfo, $mod);
1631 $availabilitychoice = $availability->get_choice_list();
1632 if ($availabilitychoice->count_options() > 1) {
1633 $actions['availability'] = new action_menu_subpanel(
1635 $availabilitychoice,
1636 ['class' => 'editing_availability'],
1637 new pix_icon('t/hide', '', 'moodle', array('class' => 'iconsmall'))
1642 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1643 if (has_all_capabilities($dupecaps, $coursecontext) &&
1644 plugin_supports('mod', $mod->modname
, FEATURE_BACKUP_MOODLE2
) &&
1645 course_allowed_module($mod->get_course(), $mod->modname
)) {
1646 $actions['duplicate'] = new action_menu_link_secondary(
1647 new moodle_url($baseurl, ['duplicate' => $mod->id
]),
1648 new pix_icon('t/copy', '', 'moodle', array('class' => 'iconsmall')),
1651 'class' => 'editing_duplicate',
1652 'data-action' => ($courseformat->supports_components()) ?
'cmDuplicate' : 'duplicate',
1653 'data-sectionreturn' => $sr,
1654 'data-id' => $mod->id
,
1660 if (has_capability('moodle/role:assign', $modcontext)){
1661 $actions['assign'] = new action_menu_link_secondary(
1662 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id
)),
1663 new pix_icon('t/assignroles', '', 'moodle', array('class' => 'iconsmall')),
1665 array('class' => 'editing_assign', 'data-action' => 'assignroles', 'data-sectionreturn' => $sr)
1670 if ($courseformat->show_groupmode($mod) && $usecomponents && !$mod->coursegroupmodeforce
) {
1671 $groupmodeclass = $courseformat->get_output_classname('content\\cm\\groupmode');
1672 /** @var core_courseformat\output\local\content\cm\groupmode */
1673 $groupmode = new $groupmodeclass($courseformat, $sectioninfo, $mod);
1674 $actions['groupmode'] = new action_menu_subpanel(
1676 $groupmode->get_choice_list(),
1677 ['class' => 'editing_groupmode'],
1678 new pix_icon('i/groupv', '', 'moodle', ['class' => 'iconsmall'])
1683 if ($hasmanageactivities) {
1684 $actions['delete'] = new action_menu_link_secondary(
1685 new moodle_url($baseurl, ['delete' => $mod->id
]),
1686 new pix_icon('t/delete', '', 'moodle', ['class' => 'iconsmall']),
1689 'class' => 'editing_delete text-danger',
1690 'data-action' => ($usecomponents) ?
'cmDelete' : 'delete',
1691 'data-sectionreturn' => $sr,
1692 'data-id' => $mod->id
,
1701 * Returns the move action.
1703 * @param cm_info $mod The module to produce a move button for
1704 * @param int $sr The section to link back to (used for creating the links)
1705 * @return The markup for the move action, or an empty string if not available.
1707 function course_get_cm_move(cm_info
$mod, $sr = null) {
1713 $modcontext = context_module
::instance($mod->id
);
1714 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1717 $str = get_strings(array('move'));
1720 if (!isset($baseurl)) {
1721 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1724 $baseurl->param('sr', $sr);
1728 if ($hasmanageactivities) {
1729 $pixicon = 'i/dragdrop';
1731 if (!course_ajax_enabled($mod->get_course())) {
1732 // Override for course frontpage until we get drag/drop working there.
1733 $pixicon = 't/move';
1737 'class' => 'editing_move',
1738 'data-action' => 'move',
1739 'data-sectionreturn' => $sr,
1740 'title' => $str->move
,
1741 'aria-label' => $str->move
,
1743 return html_writer
::link(
1744 new moodle_url($baseurl, ['copy' => $mod->id
]),
1745 $OUTPUT->pix_icon($pixicon, '', 'moodle', ['class' => 'iconsmall']),
1753 * given a course object with shortname & fullname, this function will
1754 * truncate the the number of chars allowed and add ... if it was too long
1756 function course_format_name ($course,$max=100) {
1758 $context = context_course
::instance($course->id
);
1759 $shortname = format_string($course->shortname
, true, array('context' => $context));
1760 $fullname = format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
1761 $str = $shortname.': '. $fullname;
1762 if (core_text
::strlen($str) <= $max) {
1766 return core_text
::substr($str,0,$max-3).'...';
1771 * Is the user allowed to add this type of module to this course?
1772 * @param object $course the course settings. Only $course->id is used.
1773 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1774 * @param \stdClass $user the user to check, defaults to the global user if not provided.
1775 * @return bool whether the current user is allowed to add this type of module to this course.
1777 function course_allowed_module($course, $modname, \stdClass
$user = null) {
1779 $user = $user ??
$USER;
1780 if (is_numeric($modname)) {
1781 throw new coding_exception('Function course_allowed_module no longer
1782 supports numeric module ids. Please update your code to pass the module name.');
1785 $capability = 'mod/' . $modname . ':addinstance';
1786 if (!get_capability_info($capability)) {
1787 // Debug warning that the capability does not exist, but no more than once per page.
1788 static $warned = array();
1789 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
1790 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM
) {
1791 debugging('The module ' . $modname . ' does not define the standard capability ' .
1792 $capability , DEBUG_DEVELOPER
);
1793 $warned[$modname] = 1;
1796 // If the capability does not exist, the module can always be added.
1800 $coursecontext = context_course
::instance($course->id
);
1801 return has_capability($capability, $coursecontext, $user);
1805 * Efficiently moves many courses around while maintaining
1806 * sortorder in order.
1808 * @param array $courseids is an array of course ids
1809 * @param int $categoryid
1810 * @return bool success
1812 function move_courses($courseids, $categoryid) {
1815 if (empty($courseids)) {
1820 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
1824 $courseids = array_reverse($courseids);
1825 $newparent = context_coursecat
::instance($category->id
);
1828 list($where, $params) = $DB->get_in_or_equal($courseids);
1829 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
1830 foreach ($dbcourses as $dbcourse) {
1831 $course = new stdClass();
1832 $course->id
= $dbcourse->id
;
1833 $course->timemodified
= time();
1834 $course->category
= $category->id
;
1835 $course->sortorder
= $category->sortorder +
get_max_courses_in_category() - $i++
;
1836 if ($category->visible
== 0) {
1837 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
1838 // to previous state if somebody unhides the category.
1839 $course->visible
= 0;
1842 $DB->update_record('course', $course);
1844 // Update context, so it can be passed to event.
1845 $context = context_course
::instance($course->id
);
1846 $context->update_moved($newparent);
1848 // Trigger a course updated event.
1849 $event = \core\event\course_updated
::create(array(
1850 'objectid' => $course->id
,
1851 'context' => context_course
::instance($course->id
),
1852 'other' => array('shortname' => $dbcourse->shortname
,
1853 'fullname' => $dbcourse->fullname
,
1854 'updatedfields' => array('category' => $category->id
))
1858 fix_course_sortorder();
1859 cache_helper
::purge_by_event('changesincourse');
1865 * Returns the display name of the given section that the course prefers
1867 * Implementation of this function is provided by course format
1868 * @see core_courseformat\base::get_section_name()
1870 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
1871 * @param int|stdClass $section Section object from database or just field course_sections.section
1872 * @return string Display name that the course format prefers, e.g. "Week 2"
1874 function get_section_name($courseorid, $section) {
1875 return course_get_format($courseorid)->get_section_name($section);
1879 * Tells if current course format uses sections
1881 * @param string $format Course format ID e.g. 'weeks' $course->format
1884 function course_format_uses_sections($format) {
1885 $course = new stdClass();
1886 $course->format
= $format;
1887 return course_get_format($course)->uses_sections();
1891 * Returns the information about the ajax support in the given source format
1893 * The returned object's property (boolean)capable indicates that
1894 * the course format supports Moodle course ajax features.
1896 * @param string $format
1899 function course_format_ajax_support($format) {
1900 $course = new stdClass();
1901 $course->format
= $format;
1902 return course_get_format($course)->supports_ajax();
1906 * Can the current user delete this course?
1907 * Course creators have exception,
1908 * 1 day after the creation they can sill delete the course.
1909 * @param int $courseid
1912 function can_delete_course($courseid) {
1915 $context = context_course
::instance($courseid);
1917 if (has_capability('moodle/course:delete', $context)) {
1921 // hack: now try to find out if creator created this course recently (1 day)
1922 if (!has_capability('moodle/course:create', $context)) {
1926 $since = time() - 60*60*24;
1927 $course = get_course($courseid);
1929 if ($course->timecreated
< $since) {
1930 return false; // Return if the course was not created in last 24 hours.
1933 $logmanger = get_log_manager();
1934 $readers = $logmanger->get_readers('\core\log\sql_reader');
1935 $reader = reset($readers);
1937 if (empty($reader)) {
1938 return false; // No log reader found.
1942 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
1943 $params = array('userid' => $USER->id
, 'since' => $since, 'courseid' => $course->id
, 'eventname' => '\core\event\course_created');
1945 return (bool)$reader->get_events_select_count($select, $params);
1949 * Save the Your name for 'Some role' strings.
1951 * @param integer $courseid the id of this course.
1952 * @param array $data the data that came from the course settings form.
1954 function save_local_role_names($courseid, $data) {
1956 $context = context_course
::instance($courseid);
1958 foreach ($data as $fieldname => $value) {
1959 if (strpos($fieldname, 'role_') !== 0) {
1962 list($ignored, $roleid) = explode('_', $fieldname);
1964 // make up our mind whether we want to delete, update or insert
1966 $DB->delete_records('role_names', array('contextid' => $context->id
, 'roleid' => $roleid));
1968 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id
, 'roleid' => $roleid))) {
1969 $rolename->name
= $value;
1970 $DB->update_record('role_names', $rolename);
1973 $rolename = new stdClass
;
1974 $rolename->contextid
= $context->id
;
1975 $rolename->roleid
= $roleid;
1976 $rolename->name
= $value;
1977 $DB->insert_record('role_names', $rolename);
1979 // This will ensure the course contacts cache is purged..
1980 core_course_category
::role_assignment_changed($roleid, $context);
1985 * Returns options to use in course overviewfiles filemanager
1987 * @param null|stdClass|core_course_list_element|int $course either object that has 'id' property or just the course id;
1988 * may be empty if course does not exist yet (course create form)
1989 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
1990 * or null if overviewfiles are disabled
1992 function course_overviewfiles_options($course) {
1994 if (empty($CFG->courseoverviewfileslimit
)) {
1998 // Create accepted file types based on config value, falling back to default all.
1999 $acceptedtypes = (new \core_form\filetypes_util
)->normalize_file_types($CFG->courseoverviewfilesext
);
2000 if (in_array('*', $acceptedtypes) ||
empty($acceptedtypes)) {
2001 $acceptedtypes = '*';
2005 'maxfiles' => $CFG->courseoverviewfileslimit
,
2006 'maxbytes' => $CFG->maxbytes
,
2008 'accepted_types' => $acceptedtypes
2010 if (!empty($course->id
)) {
2011 $options['context'] = context_course
::instance($course->id
);
2012 } else if (is_int($course) && $course > 0) {
2013 $options['context'] = context_course
::instance($course);
2019 * Create a course and either return a $course object
2021 * Please note this functions does not verify any access control,
2022 * the calling code is responsible for all validation (usually it is the form definition).
2024 * @param array $editoroptions course description editor options
2025 * @param object $data - all the data needed for an entry in the 'course' table
2026 * @return object new course instance
2028 function create_course($data, $editoroptions = NULL) {
2031 //check the categoryid - must be given for all new courses
2032 $category = $DB->get_record('course_categories', array('id'=>$data->category
), '*', MUST_EXIST
);
2034 // Check if the shortname already exists.
2035 if (!empty($data->shortname
)) {
2036 if ($DB->record_exists('course', array('shortname' => $data->shortname
))) {
2037 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2041 // Check if the idnumber already exists.
2042 if (!empty($data->idnumber
)) {
2043 if ($DB->record_exists('course', array('idnumber' => $data->idnumber
))) {
2044 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2048 if (empty($CFG->enablecourserelativedates
)) {
2049 // Make sure we're not setting the relative dates mode when the setting is disabled.
2050 unset($data->relativedatesmode
);
2053 if ($errorcode = course_validate_dates((array)$data)) {
2054 throw new moodle_exception($errorcode);
2057 // Check if timecreated is given.
2058 $data->timecreated
= !empty($data->timecreated
) ?
$data->timecreated
: time();
2059 $data->timemodified
= $data->timecreated
;
2061 // place at beginning of any category
2062 $data->sortorder
= 0;
2064 if ($editoroptions) {
2065 // summary text is updated later, we need context to store the files first
2066 $data->summary
= '';
2067 $data->summary_format
= $data->summary_editor
['format'];
2070 // Get default completion settings as a fallback in case the enablecompletion field is not set.
2071 $courseconfig = get_config('moodlecourse');
2072 $defaultcompletion = !empty($CFG->enablecompletion
) ?
$courseconfig->enablecompletion
: COMPLETION_DISABLED
;
2073 $enablecompletion = $data->enablecompletion ??
$defaultcompletion;
2074 // Unset showcompletionconditions when completion tracking is not enabled for the course.
2075 if ($enablecompletion == COMPLETION_DISABLED
) {
2076 unset($data->showcompletionconditions
);
2077 } else if (!isset($data->showcompletionconditions
)) {
2078 // Show completion conditions should have a default value when completion is enabled. Set it to the site defaults.
2079 // This scenario can happen when a course is created through data generators or through a web service.
2080 $data->showcompletionconditions
= $courseconfig->showcompletionconditions
;
2083 if (!isset($data->visible
)) {
2084 // data not from form, add missing visibility info
2085 $data->visible
= $category->visible
;
2087 $data->visibleold
= $data->visible
;
2089 $newcourseid = $DB->insert_record('course', $data);
2090 $context = context_course
::instance($newcourseid, MUST_EXIST
);
2092 if ($editoroptions) {
2093 // Save the files used in the summary editor and store
2094 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2095 $DB->set_field('course', 'summary', $data->summary
, array('id'=>$newcourseid));
2096 $DB->set_field('course', 'summaryformat', $data->summary_format
, array('id'=>$newcourseid));
2098 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2099 // Save the course overviewfiles
2100 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2103 // update course format options
2104 course_get_format($newcourseid)->update_course_format_options($data);
2106 $course = course_get_format($newcourseid)->get_course();
2108 fix_course_sortorder();
2109 // purge appropriate caches in case fix_course_sortorder() did not change anything
2110 cache_helper
::purge_by_event('changesincourse');
2112 // Trigger a course created event.
2113 $event = \core\event\course_created
::create(array(
2114 'objectid' => $course->id
,
2115 'context' => $context,
2116 'other' => array('shortname' => $course->shortname
,
2117 'fullname' => $course->fullname
)
2123 blocks_add_default_course_blocks($course);
2125 // Create default section and initial sections if specified (unless they've already been created earlier).
2126 // We do not want to call course_create_sections_if_missing() because to avoid creating course cache.
2127 $numsections = isset($data->numsections
) ?
$data->numsections
: 0;
2128 $existingsections = $DB->get_fieldset_sql('SELECT section from {course_sections} WHERE course = ?', [$newcourseid]);
2129 $newsections = array_diff(range(0, $numsections), $existingsections);
2130 foreach ($newsections as $sectionnum) {
2131 course_create_section($newcourseid, $sectionnum, true);
2134 // Save any custom role names.
2135 save_local_role_names($course->id
, (array)$data);
2137 // set up enrolments
2138 enrol_course_updated(true, $course, $data);
2140 // Update course tags.
2141 if (isset($data->tags
)) {
2142 core_tag_tag
::set_item_tags('core', 'course', $course->id
, $context, $data->tags
);
2144 // Set up communication.
2145 if (core_communication\api
::is_available()) {
2146 // Check for default provider config setting.
2147 $defaultprovider = get_config('moodlecourse', 'coursecommunicationprovider');
2148 $provider = (isset($data->selectedcommunication
)) ?
$data->selectedcommunication
: $defaultprovider;
2150 if (!empty($provider)) {
2151 // Prepare the communication api data.
2152 $courseimage = course_get_courseimage($course);
2153 $communicationroomname = !empty($data->communicationroomname
) ?
$data->communicationroomname
: $data->fullname
;
2155 // Communication api call.
2156 $communication = \core_communication\api
::load_by_instance(
2158 component
: 'core_course',
2159 instancetype
: 'coursecommunication',
2160 instanceid
: $course->id
,
2161 provider
: $provider,
2163 $communication->create_and_configure_room(
2164 $communicationroomname,
2165 $courseimage ?
: null,
2171 // Save custom fields if there are any of them in the form.
2172 $handler = core_course\customfield\course_handler
::create();
2173 // Make sure to set the handler's parent context first.
2174 $coursecatcontext = context_coursecat
::instance($category->id
);
2175 $handler->set_parent_context($coursecatcontext);
2176 // Save the custom field data.
2177 $data->id
= $course->id
;
2178 $handler->instance_form_save($data, true);
2186 * Please note this functions does not verify any access control,
2187 * the calling code is responsible for all validation (usually it is the form definition).
2189 * @param object $data - all the data needed for an entry in the 'course' table
2190 * @param array $editoroptions course description editor options
2193 function update_course($data, $editoroptions = NULL) {
2196 // Prevent changes on front page course.
2197 if ($data->id
== SITEID
) {
2198 throw new moodle_exception('invalidcourse', 'error');
2201 $oldcourse = course_get_format($data->id
)->get_course();
2202 $context = context_course
::instance($oldcourse->id
);
2204 // Make sure we're not changing whatever the course's relativedatesmode setting is.
2205 unset($data->relativedatesmode
);
2207 // Capture the updated fields for the log data.
2208 $updatedfields = [];
2209 foreach (get_object_vars($oldcourse) as $field => $value) {
2210 if ($field == 'summary_editor') {
2211 if (($data->$field)['text'] !== $value['text']) {
2212 // The summary might be very long, we don't wan't to fill up the log record with the full text.
2213 $updatedfields[$field] = '(updated)';
2215 } else if ($field == 'tags' && isset($data->tags
)) {
2216 // Tags might not have the same array keys, just check the values.
2217 if (array_values($data->$field) !== array_values($value)) {
2218 $updatedfields[$field] = $data->$field;
2221 if (isset($data->$field) && $data->$field != $value) {
2222 $updatedfields[$field] = $data->$field;
2227 $data->timemodified
= time();
2229 if ($editoroptions) {
2230 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2232 if ($overviewfilesoptions = course_overviewfiles_options($data->id
)) {
2233 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2236 // Check we don't have a duplicate shortname.
2237 if (!empty($data->shortname
) && $oldcourse->shortname
!= $data->shortname
) {
2238 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname
, $data->id
))) {
2239 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2243 // Check we don't have a duplicate idnumber.
2244 if (!empty($data->idnumber
) && $oldcourse->idnumber
!= $data->idnumber
) {
2245 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber
, $data->id
))) {
2246 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2250 if ($errorcode = course_validate_dates((array)$data)) {
2251 throw new moodle_exception($errorcode);
2254 if (!isset($data->category
) or empty($data->category
)) {
2255 // prevent nulls and 0 in category field
2256 unset($data->category
);
2258 $changesincoursecat = $movecat = (isset($data->category
) and $oldcourse->category
!= $data->category
);
2260 if (!isset($data->visible
)) {
2261 // data not from form, add missing visibility info
2262 $data->visible
= $oldcourse->visible
;
2265 if ($data->visible
!= $oldcourse->visible
) {
2266 // reset the visibleold flag when manually hiding/unhiding course
2267 $data->visibleold
= $data->visible
;
2268 $changesincoursecat = true;
2271 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category
));
2272 if (empty($newcategory->visible
)) {
2273 // make sure when moving into hidden category the course is hidden automatically
2279 // Set newsitems to 0 if format does not support announcements.
2280 if (isset($data->format
)) {
2281 $newcourseformat = course_get_format((object)['format' => $data->format
]);
2282 if (!$newcourseformat->supports_news()) {
2283 $data->newsitems
= 0;
2287 // Set showcompletionconditions to null when completion tracking has been disabled for the course.
2288 if (isset($data->enablecompletion
) && $data->enablecompletion
== COMPLETION_DISABLED
) {
2289 $data->showcompletionconditions
= null;
2292 // Check if provider is selected.
2293 $provider = $data->selectedcommunication ??
null;
2294 // If the course moved to hidden category, set provider to none.
2295 if ($changesincoursecat && empty($data->visible
)) {
2299 // Attempt to get the communication provider if it wasn't provided in the data.
2300 if (empty($provider) && core_communication\api
::is_available()) {
2301 $provider = \core_communication\api
::load_by_instance(
2303 component
: 'core_course',
2304 instancetype
: 'coursecommunication',
2305 instanceid
: $data->id
,
2309 // Communication api call.
2310 if (!empty($provider) && core_communication\api
::is_available()) {
2311 // Prepare the communication api data.
2312 $courseimage = course_get_courseimage($data);
2314 // This nasty logic is here because of hide course doesn't pass anything in the data object.
2315 if (!empty($data->communicationroomname
)) {
2316 $communicationroomname = $data->communicationroomname
;
2318 $communicationroomname = $data->fullname ??
$oldcourse->fullname
;
2321 // Update communication room membership of enrolled users.
2322 require_once($CFG->libdir
. '/enrollib.php');
2323 $courseusers = enrol_get_course_users($data->id
);
2324 $enrolledusers = [];
2326 foreach ($courseusers as $user) {
2327 $enrolledusers[] = $user->id
;
2330 // Existing communication provider.
2331 $communication = \core_communication\api
::load_by_instance(
2333 component
: 'core_course',
2334 instancetype
: 'coursecommunication',
2335 instanceid
: $data->id
,
2337 $existingprovider = $communication->get_provider();
2338 $addusersrequired = false;
2339 $enablenewprovider = false;
2340 $instanceexists = true;
2342 // Action required changes if provider has changed.
2343 if ($provider !== $existingprovider) {
2344 // Provider changed, flag new one to be enabled.
2345 $enablenewprovider = true;
2347 // If provider set to none, remove all the members from previous provider.
2348 if ($provider === 'none' && $existingprovider !== '') {
2349 $communication->remove_members_from_room($enrolledusers);
2351 // If previous provider was not none and current provider is not none,
2352 // remove members from previous provider.
2353 $existingprovider !== '' &&
2354 $existingprovider !== 'none'
2356 $communication->remove_members_from_room($enrolledusers);
2357 $addusersrequired = true;
2359 // If previous provider was none and current provider is not none,
2360 // remove members from previous provider.
2361 ($existingprovider === '' ||
$existingprovider === 'none')
2363 $addusersrequired = true;
2366 // Disable previous provider, if one was enabled.
2367 if ($existingprovider !== '' && $existingprovider !== 'none') {
2368 $communication->update_room(
2369 active
: \core_communication\processor
::PROVIDER_INACTIVE
,
2373 // Switch to the newly selected provider so it can be updated.
2374 if ($provider !== 'none') {
2375 $communication = \core_communication\api
::load_by_instance(
2377 component
: 'core_course',
2378 instancetype
: 'coursecommunication',
2379 instanceid
: $data->id
,
2380 provider
: $provider,
2383 // Create it if it does not exist.
2384 if ($communication->get_provider() === '') {
2385 $communication->create_and_configure_room(
2386 communicationroomname
: $communicationroomname,
2387 avatar
: $courseimage,
2391 $communication = \core_communication\api
::load_by_instance(
2393 component
: 'core_course',
2394 instancetype
: 'coursecommunication',
2395 instanceid
: $data->id
,
2396 provider
: $provider,
2399 $addusersrequired = true;
2400 $instanceexists = false;
2405 if ($provider !== 'none' && $instanceexists) {
2406 // Update the currently enabled provider's room data.
2407 // Newly created providers do not need to run this, the create process handles it.
2408 $communication->update_room(
2409 active
: $enablenewprovider ? \core_communication\processor
::PROVIDER_ACTIVE
: null,
2410 communicationroomname
: $communicationroomname,
2411 avatar
: $courseimage,
2416 // Complete room membership tasks if required.
2417 // Newly created providers complete the user mapping but do not queue the task
2418 // (it will be handled by the room creation task).
2419 if ($addusersrequired) {
2420 $communication->add_members_to_room($enrolledusers, $instanceexists);
2424 // Update custom fields if there are any of them in the form.
2425 $handler = core_course\customfield\course_handler
::create();
2426 $handler->instance_form_save($data);
2428 // Update with the new data
2429 $DB->update_record('course', $data);
2430 // make sure the modinfo cache is reset
2431 rebuild_course_cache($data->id
);
2433 // Purge course image cache in case if course image has been updated.
2434 \cache
::make('core', 'course_image')->delete($data->id
);
2436 // update course format options with full course data
2437 course_get_format($data->id
)->update_course_format_options($data, $oldcourse);
2439 $course = $DB->get_record('course', array('id'=>$data->id
));
2442 $newparent = context_coursecat
::instance($course->category
);
2443 $context->update_moved($newparent);
2445 $fixcoursesortorder = $movecat ||
(isset($data->sortorder
) && ($oldcourse->sortorder
!= $data->sortorder
));
2446 if ($fixcoursesortorder) {
2447 fix_course_sortorder();
2450 // purge appropriate caches in case fix_course_sortorder() did not change anything
2451 cache_helper
::purge_by_event('changesincourse');
2452 if ($changesincoursecat) {
2453 cache_helper
::purge_by_event('changesincoursecat');
2456 // Test for and remove blocks which aren't appropriate anymore
2457 blocks_remove_inappropriate($course);
2459 // Save any custom role names.
2460 save_local_role_names($course->id
, $data);
2462 // update enrol settings
2463 enrol_course_updated(false, $course, $data);
2465 // Update course tags.
2466 if (isset($data->tags
)) {
2467 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2470 // Trigger a course updated event.
2471 $event = \core\event\course_updated
::create(array(
2472 'objectid' => $course->id
,
2473 'context' => context_course
::instance($course->id
),
2474 'other' => array('shortname' => $course->shortname
,
2475 'fullname' => $course->fullname
,
2476 'updatedfields' => $updatedfields)
2481 if ($oldcourse->format
!== $course->format
) {
2482 // Remove all options stored for the previous format
2483 // We assume that new course format migrated everything it needed watching trigger
2484 // 'course_updated' and in method format_XXX::update_course_format_options()
2485 $DB->delete_records('course_format_options',
2486 array('courseid' => $course->id
, 'format' => $oldcourse->format
));
2489 // Delete theme usage cache if the theme has been changed.
2490 if (isset($data->theme
) && ($data->theme
!= $oldcourse->theme
)) {
2491 theme_delete_used_in_context_cache($data->theme
, $oldcourse->theme
);
2496 * Calculate the average number of enrolled participants per course.
2498 * This is intended for statistics purposes during the site registration. Only visible courses are taken into account.
2499 * Front page enrolments are excluded.
2501 * @param bool $onlyactive Consider only active enrolments in enabled plugins and obey the enrolment time restrictions.
2502 * @param int $lastloginsince If specified, count only users who logged in after this timestamp.
2505 function average_number_of_participants(bool $onlyactive = false, int $lastloginsince = null): float {
2510 $sql = "SELECT DISTINCT ue.userid, e.courseid
2511 FROM {user_enrolments} ue
2512 JOIN {enrol} e ON e.id = ue.enrolid
2513 JOIN {course} c ON c.id = e.courseid ";
2515 if ($onlyactive ||
$lastloginsince) {
2516 $sql .= "JOIN {user} u ON u.id = ue.userid ";
2519 $sql .= "WHERE e.courseid <> " . SITEID
. " AND c.visible = 1 ";
2522 $sql .= "AND ue.status = :active
2523 AND e.status = :enabled
2524 AND ue.timestart < :now1
2525 AND (ue.timeend = 0 OR ue.timeend > :now2) ";
2527 // Same as in the enrollib - the rounding should help caching in the database.
2528 $now = round(time(), -2);
2531 'active' => ENROL_USER_ACTIVE
,
2532 'enabled' => ENROL_INSTANCE_ENABLED
,
2538 if ($lastloginsince) {
2539 $sql .= "AND u.lastlogin > :lastlogin ";
2540 $params['lastlogin'] = $lastloginsince;
2543 $sql = "SELECT COUNT(*)
2546 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2548 // Get the number of visible courses (exclude the front page).
2549 $coursetotal = $DB->count_records('course', ['visible' => 1]);
2550 $coursetotal = $coursetotal - 1;
2552 if (empty($coursetotal)) {
2553 $participantaverage = 0;
2556 $participantaverage = $enrolmenttotal / $coursetotal;
2559 return $participantaverage;
2563 * Average number of course modules
2566 function average_number_of_courses_modules() {
2569 //count total of visible course module (except front page)
2570 $sql = 'SELECT COUNT(*) FROM (
2571 SELECT cm.course, cm.module
2572 FROM {course} c, {course_modules} cm
2573 WHERE c.id = cm.course
2576 AND c.visible = 1) total';
2577 $params = array('siteid' => $SITE->id
);
2578 $moduletotal = $DB->count_records_sql($sql, $params);
2581 //count total of visible courses (minus front page)
2582 $coursetotal = $DB->count_records('course', array('visible' => 1));
2583 $coursetotal = $coursetotal - 1 ;
2585 //average of course module
2586 if (empty($coursetotal)) {
2587 $coursemoduleaverage = 0;
2589 $coursemoduleaverage = $moduletotal / $coursetotal;
2592 return $coursemoduleaverage;
2596 * This class pertains to course requests and contains methods associated with
2597 * create, approving, and removing course requests.
2599 * Please note we do not allow embedded images here because there is no context
2600 * to store them with proper access control.
2602 * @copyright 2009 Sam Hemelryk
2603 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2606 * @property-read int $id
2607 * @property-read string $fullname
2608 * @property-read string $shortname
2609 * @property-read string $summary
2610 * @property-read int $summaryformat
2611 * @property-read int $summarytrust
2612 * @property-read string $reason
2613 * @property-read int $requester
2615 class course_request
{
2618 * This is the stdClass that stores the properties for the course request
2619 * and is externally accessed through the __get magic method
2622 protected $properties;
2625 * An array of options for the summary editor used by course request forms.
2626 * This is initially set by {@link summary_editor_options()}
2630 protected static $summaryeditoroptions;
2633 * Static function to prepare the summary editor for working with a course
2637 * @param null|stdClass $data Optional, an object containing the default values
2638 * for the form, these may be modified when preparing the
2639 * editor so this should be called before creating the form
2640 * @return stdClass An object that can be used to set the default values for
2643 public static function prepare($data=null) {
2644 if ($data === null) {
2645 $data = new stdClass
;
2647 $data = file_prepare_standard_editor($data, 'summary', self
::summary_editor_options());
2652 * Static function to create a new course request when passed an array of properties
2655 * This function also handles saving any files that may have been used in the editor
2658 * @param stdClass $data
2659 * @return course_request The newly created course request
2661 public static function create($data) {
2662 global $USER, $DB, $CFG;
2663 $data->requester
= $USER->id
;
2665 // Setting the default category if none set.
2666 if (empty($data->category
) ||
!empty($CFG->lockrequestcategory
)) {
2667 $data->category
= $CFG->defaultrequestcategory
;
2670 // Summary is a required field so copy the text over
2671 $data->summary
= $data->summary_editor
['text'];
2672 $data->summaryformat
= $data->summary_editor
['format'];
2674 $data->id
= $DB->insert_record('course_request', $data);
2676 // Create a new course_request object and return it
2677 $request = new course_request($data);
2679 // Notify the admin if required.
2680 if ($users = get_users_from_config($CFG->courserequestnotify
, 'moodle/site:approvecourse')) {
2683 $a->link
= "$CFG->wwwroot/course/pending.php";
2684 $a->user
= fullname($USER);
2685 $subject = get_string('courserequest');
2686 $message = get_string('courserequestnotifyemail', 'admin', $a);
2687 foreach ($users as $user) {
2688 $request->notify($user, $USER, 'courserequested', $subject, $message);
2696 * Returns an array of options to use with a summary editor
2698 * @uses course_request::$summaryeditoroptions
2699 * @return array An array of options to use with the editor
2701 public static function summary_editor_options() {
2703 if (self
::$summaryeditoroptions === null) {
2704 self
::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2706 return self
::$summaryeditoroptions;
2710 * Loads the properties for this course request object. Id is required and if
2711 * only id is provided then we load the rest of the properties from the database
2713 * @param stdClass|int $properties Either an object containing properties
2714 * or the course_request id to load
2716 public function __construct($properties) {
2718 if (empty($properties->id
)) {
2719 if (empty($properties)) {
2720 throw new coding_exception('You must provide a course request id when creating a course_request object');
2723 $properties = new stdClass
;
2724 $properties->id
= (int)$id;
2727 if (empty($properties->requester
)) {
2728 if (!($this->properties
= $DB->get_record('course_request', array('id' => $properties->id
)))) {
2729 throw new \
moodle_exception('unknowncourserequest');
2732 $this->properties
= $properties;
2734 $this->properties
->collision
= null;
2738 * Returns the requested property
2740 * @param string $key
2743 public function __get($key) {
2744 return $this->properties
->$key;
2748 * Override this to ensure empty($request->blah) calls return a reliable answer...
2750 * This is required because we define the __get method
2753 * @return bool True is it not empty, false otherwise
2755 public function __isset($key) {
2756 return (!empty($this->properties
->$key));
2760 * Returns the user who requested this course
2762 * Uses a static var to cache the results and cut down the number of db queries
2764 * @staticvar array $requesters An array of cached users
2765 * @return stdClass The user who requested the course
2767 public function get_requester() {
2769 static $requesters= array();
2770 if (!array_key_exists($this->properties
->requester
, $requesters)) {
2771 $requesters[$this->properties
->requester
] = $DB->get_record('user', array('id'=>$this->properties
->requester
));
2773 return $requesters[$this->properties
->requester
];
2777 * Checks that the shortname used by the course does not conflict with any other
2778 * courses that exist
2780 * @param string|null $shortnamemark The string to append to the requests shortname
2781 * should a conflict be found
2782 * @return bool true is there is a conflict, false otherwise
2784 public function check_shortname_collision($shortnamemark = '[*]') {
2787 if ($this->properties
->collision
!== null) {
2788 return $this->properties
->collision
;
2791 if (empty($this->properties
->shortname
)) {
2792 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER
);
2793 $this->properties
->collision
= false;
2794 } else if ($DB->record_exists('course', array('shortname' => $this->properties
->shortname
))) {
2795 if (!empty($shortnamemark)) {
2796 $this->properties
->shortname
.= ' '.$shortnamemark;
2798 $this->properties
->collision
= true;
2800 $this->properties
->collision
= false;
2802 return $this->properties
->collision
;
2806 * Checks user capability to approve a requested course
2808 * If course was requested without category for some reason (might happen if $CFG->defaultrequestcategory is
2809 * misconfigured), we check capabilities 'moodle/site:approvecourse' and 'moodle/course:changecategory'.
2813 public function can_approve() {
2816 if ($this->properties
->category
) {
2817 $category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
);
2818 } else if ($CFG->defaultrequestcategory
) {
2819 $category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
);
2822 return has_capability('moodle/site:approvecourse', $category->get_context());
2825 // We can not determine the context where the course should be created. The approver should have
2826 // both capabilities to approve courses and change course category in the system context.
2827 return has_all_capabilities(['moodle/site:approvecourse', 'moodle/course:changecategory'], context_system
::instance());
2831 * Returns the category where this course request should be created
2833 * Note that we don't check here that user has a capability to view
2834 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2835 * 'moodle/course:changecategory'
2837 * @return core_course_category
2839 public function get_category() {
2841 if ($this->properties
->category
&& ($category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
))) {
2843 } else if ($CFG->defaultrequestcategory
&&
2844 ($category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
))) {
2847 return core_course_category
::get_default();
2852 * This function approves the request turning it into a course
2854 * This function converts the course request into a course, at the same time
2855 * transferring any files used in the summary to the new course and then removing
2856 * the course request and the files associated with it.
2858 * @return int The id of the course that was created from this request
2860 public function approve() {
2861 global $CFG, $DB, $USER;
2863 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
2865 $user = $DB->get_record('user', array('id' => $this->properties
->requester
, 'deleted'=>0), '*', MUST_EXIST
);
2867 $courseconfig = get_config('moodlecourse');
2869 // Transfer appropriate settings
2870 $data = clone($this->properties
);
2872 unset($data->reason
);
2873 unset($data->requester
);
2876 $category = $this->get_category();
2877 $data->category
= $category->id
;
2878 // Set misc settings
2879 $data->requested
= 1;
2881 // Apply course default settings
2882 $data->format
= $courseconfig->format
;
2883 $data->newsitems
= $courseconfig->newsitems
;
2884 $data->showgrades
= $courseconfig->showgrades
;
2885 $data->showreports
= $courseconfig->showreports
;
2886 $data->maxbytes
= $courseconfig->maxbytes
;
2887 $data->groupmode
= $courseconfig->groupmode
;
2888 $data->groupmodeforce
= $courseconfig->groupmodeforce
;
2889 $data->visible
= $courseconfig->visible
;
2890 $data->visibleold
= $data->visible
;
2891 $data->lang
= $courseconfig->lang
;
2892 $data->enablecompletion
= $courseconfig->enablecompletion
;
2893 $data->numsections
= $courseconfig->numsections
;
2894 $data->startdate
= usergetmidnight(time());
2895 if ($courseconfig->courseenddateenabled
) {
2896 $data->enddate
= usergetmidnight(time()) +
$courseconfig->courseduration
;
2899 list($data->fullname
, $data->shortname
) = restore_dbops
::calculate_course_names(0, $data->fullname
, $data->shortname
);
2901 $course = create_course($data);
2902 $context = context_course
::instance($course->id
, MUST_EXIST
);
2904 // add enrol instances
2905 if (!$DB->record_exists('enrol', array('courseid'=>$course->id
, 'enrol'=>'manual'))) {
2906 if ($manual = enrol_get_plugin('manual')) {
2907 $manual->add_default_instance($course);
2911 // enrol the requester as teacher if necessary
2912 if (!empty($CFG->creatornewroleid
) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2913 enrol_try_internal_enrol($course->id
, $user->id
, $CFG->creatornewroleid
);
2918 $a = new stdClass();
2919 $a->name
= format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
2920 $a->url
= $CFG->wwwroot
.'/course/view.php?id=' . $course->id
;
2921 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a), $course->id
);
2927 * Reject a course request
2929 * This function rejects a course request, emailing the requesting user the
2930 * provided notice and then removing the request from the database
2932 * @param string $notice The message to display to the user
2934 public function reject($notice) {
2936 $user = $DB->get_record('user', array('id' => $this->properties
->requester
), '*', MUST_EXIST
);
2937 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2942 * Deletes the course request and any associated files
2944 public function delete() {
2946 $DB->delete_records('course_request', array('id' => $this->properties
->id
));
2950 * Send a message from one user to another using events_trigger
2952 * @param object $touser
2953 * @param object $fromuser
2954 * @param string $name
2955 * @param string $subject
2956 * @param string $message
2957 * @param int|null $courseid
2959 protected function notify($touser, $fromuser, $name, $subject, $message, $courseid = null) {
2960 $eventdata = new \core\message\
message();
2961 $eventdata->courseid
= empty($courseid) ? SITEID
: $courseid;
2962 $eventdata->component
= 'moodle';
2963 $eventdata->name
= $name;
2964 $eventdata->userfrom
= $fromuser;
2965 $eventdata->userto
= $touser;
2966 $eventdata->subject
= $subject;
2967 $eventdata->fullmessage
= $message;
2968 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
2969 $eventdata->fullmessagehtml
= '';
2970 $eventdata->smallmessage
= '';
2971 $eventdata->notification
= 1;
2972 message_send($eventdata);
2976 * Checks if current user can request a course in this context
2978 * @param context $context
2981 public static function can_request(context
$context) {
2983 if (empty($CFG->enablecourserequests
)) {
2986 if (has_capability('moodle/course:create', $context)) {
2990 if ($context instanceof context_system
) {
2991 $defaultcontext = context_coursecat
::instance($CFG->defaultrequestcategory
, IGNORE_MISSING
);
2992 return $defaultcontext &&
2993 has_capability('moodle/course:request', $defaultcontext);
2994 } else if ($context instanceof context_coursecat
) {
2995 if (!$CFG->lockrequestcategory ||
$CFG->defaultrequestcategory
== $context->instanceid
) {
2996 return has_capability('moodle/course:request', $context);
3004 * Return a list of page types
3005 * @param string $pagetype current page type
3006 * @param context $parentcontext Block's parent context
3007 * @param context $currentcontext Current context of block
3008 * @return array array of page types
3010 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3011 if ($pagetype === 'course-index' ||
$pagetype === 'course-index-category') {
3012 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3013 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3014 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3016 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) ||
$coursecontext->instanceid
== SITEID
)) {
3017 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3018 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3020 // Otherwise consider it a page inside a course even if $currentcontext is null
3021 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3022 'course-*' => get_string('page-course-x', 'pagetype'),
3023 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3030 * Determine whether course ajax should be enabled for the specified course
3032 * @param stdClass $course The course to test against
3033 * @return boolean Whether course ajax is enabled or note
3035 function course_ajax_enabled($course) {
3036 global $CFG, $PAGE, $SITE;
3038 // The user must be editing for AJAX to be included
3039 if (!$PAGE->user_is_editing()) {
3043 // Check that the theme suports
3044 if (!$PAGE->theme
->enablecourseajax
) {
3048 // Check that the course format supports ajax functionality
3049 // The site 'format' doesn't have information on course format support
3050 if ($SITE->id
!== $course->id
) {
3051 $courseformatajaxsupport = course_format_ajax_support($course->format
);
3052 if (!$courseformatajaxsupport->capable
) {
3057 // All conditions have been met so course ajax should be enabled
3062 * Include the relevant javascript and language strings for the resource
3063 * toolbox YUI module
3065 * @param integer $id The ID of the course being applied to
3066 * @param array $usedmodules An array containing the names of the modules in use on the page
3067 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3068 * @param stdClass $config An object containing configuration parameters for ajax modules including:
3069 * * resourceurl The URL to post changes to for resource changes
3070 * * sectionurl The URL to post changes to for section changes
3071 * * pageparams Additional parameters to pass through in the post
3074 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3075 global $CFG, $PAGE, $SITE;
3077 // Init the course editor module to support UI components.
3078 $format = course_get_format($course);
3079 include_course_editor($format);
3081 // Ensure that ajax should be included
3082 if (!course_ajax_enabled($course)) {
3086 // Component based formats don't use YUI drag and drop anymore.
3087 if (!$format->supports_components() && course_format_uses_sections($course->format
)) {
3090 $config = new stdClass();
3093 // The URL to use for resource changes.
3094 if (!isset($config->resourceurl
)) {
3095 $config->resourceurl
= '/course/rest.php';
3098 // The URL to use for section changes.
3099 if (!isset($config->sectionurl
)) {
3100 $config->sectionurl
= '/course/rest.php';
3103 // Any additional parameters which need to be included on page submission.
3104 if (!isset($config->pageparams
)) {
3105 $config->pageparams
= array();
3108 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3110 'courseid' => $course->id
,
3111 'ajaxurl' => $config->sectionurl
,
3112 'config' => $config,
3115 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3117 'courseid' => $course->id
,
3118 'ajaxurl' => $config->resourceurl
,
3119 'config' => $config,
3122 // Require various strings for the command toolbox.
3123 $PAGE->requires
->strings_for_js(array(
3126 'deletechecktypename',
3128 'edittitleinstructions',
3138 'movecoursesection',
3141 'emptydragdropregion',
3147 // Include section-specific strings for formats which support sections.
3148 if (course_format_uses_sections($course->format
)) {
3149 $PAGE->requires
->strings_for_js(array(
3152 ), 'format_' . $course->format
);
3155 // For confirming resource deletion we need the name of the module in question.
3156 foreach ($usedmodules as $module => $modname) {
3157 $PAGE->requires
->string_for_js('pluginname', $module);
3160 // Load drag and drop upload AJAX.
3161 require_once($CFG->dirroot
.'/course/dnduploadlib.php');
3162 dndupload_add_to_course($course, $enabledmodules);
3165 $PAGE->requires
->js_call_amd('core_course/actions', 'initCoursePage', array($course->format
));
3171 * Include and configure the course editor modules.
3173 * @param course_format $format the course format instance.
3175 function include_course_editor(course_format
$format) {
3176 global $PAGE, $SITE;
3178 $course = $format->get_course();
3180 if ($SITE->id
=== $course->id
) {
3184 $statekey = course_format
::session_cache($course);
3186 // Edition mode and some format specs must be passed to the init method.
3188 'editing' => $format->show_editor(),
3189 'supportscomponents' => $format->supports_components(),
3190 'statekey' => $statekey,
3191 'overriddenStrings' => $format->get_editor_custom_strings(),
3193 // All the new editor elements will be loaded after the course is presented and
3194 // the initial course state will be generated using core_course_get_state webservice.
3195 $PAGE->requires
->js_call_amd('core_courseformat/courseeditor', 'setViewFormat', [$course->id
, $setup]);
3199 * Returns the sorted list of available course formats, filtered by enabled if necessary
3201 * @param bool $enabledonly return only formats that are enabled
3202 * @return array array of sorted format names
3204 function get_sorted_course_formats($enabledonly = false) {
3206 $formats = core_component
::get_plugin_list('format');
3208 if (!empty($CFG->format_plugins_sortorder
)) {
3209 $order = explode(',', $CFG->format_plugins_sortorder
);
3210 $order = array_merge(array_intersect($order, array_keys($formats)),
3211 array_diff(array_keys($formats), $order));
3213 $order = array_keys($formats);
3215 if (!$enabledonly) {
3218 $sortedformats = array();
3219 foreach ($order as $formatname) {
3220 if (!get_config('format_'.$formatname, 'disabled')) {
3221 $sortedformats[] = $formatname;
3224 return $sortedformats;
3228 * The URL to use for the specified course (with section)
3230 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3231 * @param int|stdClass $section Section object from database or just field course_sections.section
3232 * if omitted the course view page is returned
3233 * @param array $options options for view URL. At the moment core uses:
3234 * 'navigation' (bool) if true and section has no separate page, the function returns null
3235 * 'sr' (int) used by multipage formats to specify to which section to return
3236 * @return moodle_url The url of course
3238 function course_get_url($courseorid, $section = null, $options = array()) {
3239 return course_get_format($courseorid)->get_view_url($section, $options);
3246 * - capability checks and other checks
3247 * - create the module from the module info
3249 * @param object $module
3250 * @return object the created module info
3251 * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3253 function create_module($moduleinfo) {
3256 require_once($CFG->dirroot
. '/course/modlib.php');
3258 // Check manadatory attributs.
3259 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3260 if (plugin_supports('mod', $moduleinfo->modulename
, FEATURE_MOD_INTRO
, true)) {
3261 $mandatoryfields[] = 'introeditor';
3263 foreach($mandatoryfields as $mandatoryfield) {
3264 if (!isset($moduleinfo->{$mandatoryfield})) {
3265 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3269 // Some additional checks (capability / existing instances).
3270 $course = $DB->get_record('course', array('id'=>$moduleinfo->course
), '*', MUST_EXIST
);
3271 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename
, $moduleinfo->section
);
3274 $moduleinfo->module
= $module->id
;
3275 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3284 * - capability and other checks
3285 * - update the module
3287 * @param object $module
3288 * @return object the updated module info
3289 * @throws moodle_exception if current user is not allowed to update the module
3291 function update_module($moduleinfo) {
3294 require_once($CFG->dirroot
. '/course/modlib.php');
3296 // Check the course module exists.
3297 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule
, 0, false, MUST_EXIST
);
3299 // Check the course exists.
3300 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
3302 // Some checks (capaibility / existing instances).
3303 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3305 // Retrieve few information needed by update_moduleinfo.
3306 $moduleinfo->modulename
= $cm->modname
;
3307 if (!isset($moduleinfo->scale
)) {
3308 $moduleinfo->scale
= 0;
3310 $moduleinfo->type
= 'mod';
3312 // Update the module.
3313 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3319 * Duplicate a module on the course for ajax.
3321 * @see mod_duplicate_module()
3322 * @param object $course The course
3323 * @param object $cm The course module to duplicate
3324 * @param int $sr The section to link back to (used for creating the links)
3325 * @throws moodle_exception if the plugin doesn't support duplication
3326 * @return Object containing:
3327 * - fullcontent: The HTML markup for the created CM
3328 * - cmid: The CMID of the newly created CM
3329 * - redirect: Whether to trigger a redirect following this change
3331 function mod_duplicate_activity($course, $cm, $sr = null) {
3334 $newcm = duplicate_module($course, $cm);
3336 $resp = new stdClass();
3339 $format = course_get_format($course);
3340 $renderer = $format->get_renderer($PAGE);
3341 $modinfo = $format->get_modinfo();
3342 $section = $modinfo->get_section_info($newcm->sectionnum
);
3344 // Get the new element html content.
3345 $resp->fullcontent
= $renderer->course_section_updated_cm_item($format, $section, $newcm);
3347 $resp->cmid
= $newcm->id
;
3349 // Trigger a redirect.
3350 $resp->redirect
= true;
3356 * Api to duplicate a module.
3358 * @param object $course course object.
3359 * @param object $cm course module object to be duplicated.
3360 * @param int $sectionid section ID new course module will be placed in.
3361 * @param bool $changename updates module name with text from duplicatedmodule lang string.
3365 * @throws coding_exception
3366 * @throws moodle_exception
3367 * @throws restore_controller_exception
3369 * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3371 function duplicate_module($course, $cm, int $sectionid = null, bool $changename = true): ?cm_info
{
3372 global $CFG, $DB, $USER;
3373 require_once($CFG->dirroot
. '/backup/util/includes/backup_includes.php');
3374 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
3375 require_once($CFG->libdir
. '/filelib.php');
3377 $a = new stdClass();
3378 $a->modtype
= get_string('modulename', $cm->modname
);
3379 $a->modname
= format_string($cm->name
);
3381 if (!plugin_supports('mod', $cm->modname
, FEATURE_BACKUP_MOODLE2
)) {
3382 throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3385 // Backup the activity.
3387 $bc = new backup_controller(backup
::TYPE_1ACTIVITY
, $cm->id
, backup
::FORMAT_MOODLE
,
3388 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
);
3390 $backupid = $bc->get_backupid();
3391 $backupbasepath = $bc->get_plan()->get_basepath();
3393 $bc->execute_plan();
3397 // Restore the backup immediately.
3399 $rc = new restore_controller($backupid, $course->id
,
3400 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
, backup
::TARGET_CURRENT_ADDING
);
3402 // Make sure that the restore_general_groups setting is always enabled when duplicating an activity.
3403 $plan = $rc->get_plan();
3404 $groupsetting = $plan->get_setting('groups');
3405 if (empty($groupsetting->get_value())) {
3406 $groupsetting->set_value(true);
3409 $cmcontext = context_module
::instance($cm->id
);
3410 if (!$rc->execute_precheck()) {
3411 $precheckresults = $rc->get_precheck_results();
3412 if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3413 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3414 fulldelete($backupbasepath);
3419 $rc->execute_plan();
3421 // Now a bit hacky part follows - we try to get the cmid of the newly
3422 // restored copy of the module.
3424 $tasks = $rc->get_plan()->get_tasks();
3425 foreach ($tasks as $task) {
3426 if (is_subclass_of($task, 'restore_activity_task')) {
3427 if ($task->get_old_contextid() == $cmcontext->id
) {
3428 $newcmid = $task->get_moduleid();
3436 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3437 fulldelete($backupbasepath);
3440 // If we know the cmid of the new course module, let us move it
3441 // right below the original one. otherwise it will stay at the
3442 // end of the section.
3444 // Proceed with activity renaming before everything else. We don't use APIs here to avoid
3445 // triggering a lot of create/update duplicated events.
3446 $newcm = get_coursemodule_from_id($cm->modname
, $newcmid, $cm->course
);
3448 // Add ' (copy)' language string postfix to duplicated module.
3449 $newname = get_string('duplicatedmodule', 'moodle', $newcm->name
);
3450 set_coursemodule_name($newcm->id
, $newname);
3453 $section = $DB->get_record('course_sections', ['id' => $sectionid ??
$cm->section
, 'course' => $cm->course
]);
3454 if (isset($sectionid)) {
3455 moveto_module($newcm, $section);
3457 $modarray = explode(",", trim($section->sequence
));
3458 $cmindex = array_search($cm->id
, $modarray);
3459 if ($cmindex !== false && $cmindex < count($modarray) - 1) {
3460 moveto_module($newcm, $section, $modarray[$cmindex +
1]);
3464 // Update calendar events with the duplicated module.
3465 // The following line is to be removed in MDL-58906.
3466 course_module_update_calendar_events($newcm->modname
, null, $newcm);
3468 // Trigger course module created event. We can trigger the event only if we know the newcmid.
3469 $newcm = get_fast_modinfo($cm->course
)->get_cm($newcmid);
3470 $event = \core\event\course_module_created
::create_from_cm($newcm);
3474 return isset($newcm) ?
$newcm : null;
3478 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3479 * Sorts by descending order of time.
3481 * @param stdClass $a First object
3482 * @param stdClass $b Second object
3483 * @return int 0,1,-1 representing the order
3485 function compare_activities_by_time_desc($a, $b) {
3486 // Make sure the activities actually have a timestamp property.
3487 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3490 // We treat instances without timestamp as if they have a timestamp of 0.
3491 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3494 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3497 if ($a->timestamp
== $b->timestamp
) {
3500 return ($a->timestamp
> $b->timestamp
) ?
-1 : 1;
3504 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3505 * Sorts by ascending order of time.
3507 * @param stdClass $a First object
3508 * @param stdClass $b Second object
3509 * @return int 0,1,-1 representing the order
3511 function compare_activities_by_time_asc($a, $b) {
3512 // Make sure the activities actually have a timestamp property.
3513 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3516 // We treat instances without timestamp as if they have a timestamp of 0.
3517 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3520 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3523 if ($a->timestamp
== $b->timestamp
) {
3526 return ($a->timestamp
< $b->timestamp
) ?
-1 : 1;
3530 * Changes the visibility of a course.
3532 * @param int $courseid The course to change.
3533 * @param bool $show True to make it visible, false otherwise.
3536 function course_change_visibility($courseid, $show = true) {
3537 $course = new stdClass
;
3538 $course->id
= $courseid;
3539 $course->visible
= ($show) ?
'1' : '0';
3540 $course->visibleold
= $course->visible
;
3541 update_course($course);
3546 * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3548 * @param stdClass|core_course_list_element $course
3549 * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3552 function course_change_sortorder_by_one($course, $up) {
3554 $params = array($course->sortorder
, $course->category
);
3556 $select = 'sortorder < ? AND category = ?';
3557 $sort = 'sortorder DESC';
3559 $select = 'sortorder > ? AND category = ?';
3560 $sort = 'sortorder ASC';
3562 fix_course_sortorder();
3563 $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3565 $swapcourse = reset($swapcourse);
3566 $DB->set_field('course', 'sortorder', $swapcourse->sortorder
, array('id' => $course->id
));
3567 $DB->set_field('course', 'sortorder', $course->sortorder
, array('id' => $swapcourse->id
));
3568 // Finally reorder courses.
3569 fix_course_sortorder();
3570 cache_helper
::purge_by_event('changesincourse');
3577 * Changes the sort order of courses in a category so that the first course appears after the second.
3579 * @param int|stdClass $courseorid The course to focus on.
3580 * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3583 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3586 if (!is_object($courseorid)) {
3587 $course = get_course($courseorid);
3589 $course = $courseorid;
3592 if ((int)$moveaftercourseid === 0) {
3593 // We've moving the course to the start of the queue.
3594 $sql = 'SELECT sortorder
3596 WHERE category = :categoryid
3597 ORDER BY sortorder';
3599 'categoryid' => $course->category
3601 $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE
);
3603 $sql = 'UPDATE {course}
3604 SET sortorder = sortorder + 1
3605 WHERE category = :categoryid
3608 'categoryid' => $course->category
,
3609 'id' => $course->id
,
3611 $DB->execute($sql, $params);
3612 $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id
));
3613 } else if ($course->id
=== $moveaftercourseid) {
3614 // They're the same - moronic.
3615 debugging("Invalid move after course given.", DEBUG_DEVELOPER
);
3618 // Moving this course after the given course. It could be before it could be after.
3619 $moveaftercourse = get_course($moveaftercourseid);
3620 if ($course->category
!== $moveaftercourse->category
) {
3621 debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER
);
3624 // Increment all courses in the same category that are ordered after the moveafter course.
3625 // This makes a space for the course we're moving.
3626 $sql = 'UPDATE {course}
3627 SET sortorder = sortorder + 1
3628 WHERE category = :categoryid
3629 AND sortorder > :sortorder';
3631 'categoryid' => $moveaftercourse->category
,
3632 'sortorder' => $moveaftercourse->sortorder
3634 $DB->execute($sql, $params);
3635 $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder +
1, array('id' => $course->id
));
3637 fix_course_sortorder();
3638 cache_helper
::purge_by_event('changesincourse');
3643 * Trigger course viewed event. This API function is used when course view actions happens,
3644 * usually in course/view.php but also in external functions.
3646 * @param stdClass $context course context object
3647 * @param int $sectionnumber section number
3650 function course_view($context, $sectionnumber = 0) {
3652 $eventdata = array('context' => $context);
3654 if (!empty($sectionnumber)) {
3655 $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3658 $event = \core\event\course_viewed
::create($eventdata);
3661 user_accesstime_log($context->instanceid
);
3665 * Returns courses tagged with a specified tag.
3667 * @param core_tag_tag $tag
3668 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3669 * are displayed on the page and the per-page limit may be bigger
3670 * @param int $fromctx context id where the link was displayed, may be used by callbacks
3671 * to display items in the same context first
3672 * @param int $ctx context id where to search for records
3673 * @param bool $rec search in subcontexts as well
3674 * @param int $page 0-based number of page being displayed
3675 * @return \core_tag\output\tagindex
3677 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3680 $perpage = $exclusivemode ?
$CFG->coursesperpage
: 5;
3681 $displayoptions = array(
3682 'limit' => $perpage,
3683 'offset' => $page * $perpage,
3684 'viewmoreurl' => null,
3687 $courserenderer = $PAGE->get_renderer('core', 'course');
3688 $totalcount = core_course_category
::search_courses_count(array('tagid' => $tag->id
, 'ctx' => $ctx, 'rec' => $rec));
3689 $content = $courserenderer->tagged_courses($tag->id
, $exclusivemode, $ctx, $rec, $displayoptions);
3690 $totalpages = ceil($totalcount / $perpage);
3692 return new core_tag\output\tagindex
($tag, 'core', 'course', $content,
3693 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3697 * Implements callback inplace_editable() allowing to edit values in-place
3699 * @param string $itemtype
3700 * @param int $itemid
3701 * @param mixed $newvalue
3702 * @return \core\output\inplace_editable
3704 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3705 if ($itemtype === 'activityname') {
3706 return \core_courseformat\output\local\content\cm\title
::update($itemid, $newvalue);
3711 * This function calculates the minimum and maximum cutoff values for the timestart of
3714 * It will return an array with two values, the first being the minimum cutoff value and
3715 * the second being the maximum cutoff value. Either or both values can be null, which
3716 * indicates there is no minimum or maximum, respectively.
3718 * If a cutoff is required then the function must return an array containing the cutoff
3719 * timestamp and error string to display to the user if the cutoff value is violated.
3721 * A minimum and maximum cutoff return value will look like:
3723 * [1505704373, 'The date must be after this date'],
3724 * [1506741172, 'The date must be before this date']
3727 * @param calendar_event $event The calendar event to get the time range for
3728 * @param stdClass $course The course object to get the range from
3729 * @return array Returns an array with min and max date.
3731 function core_course_core_calendar_get_valid_event_timestart_range(\calendar_event
$event, $course) {
3735 if ($course->startdate
) {
3738 get_string('errorbeforecoursestart', 'calendar')
3742 return [$mindate, $maxdate];
3746 * Render the message drawer to be included in the top of the body of each page.
3748 * @return string HTML
3750 function core_course_drawer(): string {
3753 // Only add course index on non-site course pages.
3754 if (!$PAGE->course ||
$PAGE->course
->id
== SITEID
) {
3758 // Show course index to users can access the course only.
3759 if (!can_access_course($PAGE->course
, null, '', true)) {
3763 $format = course_get_format($PAGE->course
);
3764 $renderer = $format->get_renderer($PAGE);
3765 if (method_exists($renderer, 'course_index_drawer')) {
3766 return $renderer->course_index_drawer($format);
3773 * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3775 * This is a callback used by the tag area core/course_modules to search for course modules
3776 * tagged with a specific tag.
3778 * @param core_tag_tag $tag
3779 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3780 * are displayed on the page and the per-page limit may be bigger
3781 * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3782 * to display items in the same context first
3783 * @param int $contextid context id where to search for records
3784 * @param bool $recursivecontext search in subcontexts as well
3785 * @param int $page 0-based number of page being displayed
3786 * @return \core_tag\output\tagindex
3788 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3789 $recursivecontext = 1, $page = 0) {
3791 $perpage = $exclusivemode ?
20 : 5;
3793 // Build select query.
3794 $ctxselect = context_helper
::get_preload_record_columns_sql('ctx');
3795 $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3796 FROM {course_modules} cm
3797 JOIN {tag_instance} tt ON cm.id = tt.itemid
3798 JOIN {course} c ON cm.course = c.id
3799 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3800 WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3801 AND cm.deletioninprogress = 0
3802 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3804 $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id
, 'component' => 'core',
3805 'coursemodulecontextlevel' => CONTEXT_MODULE
);
3807 $context = context
::instance_by_id($contextid);
3808 $query .= $recursivecontext ?
' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3809 $params['contextid'] = $context->id
;
3810 $params['path'] = $context->path
.'/%';
3813 $query .= ' ORDER BY';
3814 if ($fromcontextid) {
3815 // In order-clause specify that modules from inside "fromctx" context should be returned first.
3816 $fromcontext = context
::instance_by_id($fromcontextid);
3817 $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3818 $params['fromcontextid'] = $fromcontext->id
;
3819 $params['frompath'] = $fromcontext->path
.'/%';
3821 $query .= ' c.sortorder, cm.id';
3822 $totalpages = $page +
1;
3824 // Use core_tag_index_builder to build and filter the list of items.
3825 // Request one item more than we need so we know if next page exists.
3826 $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage +
1);
3827 while ($item = $builder->has_item_that_needs_access_check()) {
3828 context_helper
::preload_from_record($item);
3829 $courseid = $item->courseid
;
3830 if (!$builder->can_access_course($courseid)) {
3831 $builder->set_accessible($item, false);
3834 $modinfo = get_fast_modinfo($builder->get_course($courseid));
3835 // Set accessibility of this item and all other items in the same course.
3836 $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3837 if ($taggeditem->courseid
== $courseid) {
3838 $cm = $modinfo->get_cm($taggeditem->cmid
);
3839 $builder->set_accessible($taggeditem, $cm->uservisible
);
3844 $items = $builder->get_items();
3845 if (count($items) > $perpage) {
3846 $totalpages = $page +
2; // We don't need exact page count, just indicate that the next page exists.
3850 // Build the display contents.
3852 $tagfeed = new core_tag\output\tagfeed
();
3853 foreach ($items as $item) {
3854 context_helper
::preload_from_record($item);
3855 $course = $builder->get_course($item->courseid
);
3856 $modinfo = get_fast_modinfo($course);
3857 $cm = $modinfo->get_cm($item->cmid
);
3858 $courseurl = course_get_url($item->courseid
, $cm->sectionnum
);
3859 $cmname = $cm->get_formatted_name();
3860 if (!$exclusivemode) {
3861 $cmname = shorten_text($cmname, 100);
3863 $cmname = html_writer
::link($cm->url?
:$courseurl, $cmname);
3864 $coursename = format_string($course->fullname
, true,
3865 array('context' => context_course
::instance($item->courseid
)));
3866 $coursename = html_writer
::link($courseurl, $coursename);
3867 $icon = html_writer
::empty_tag('img', array('src' => $cm->get_icon_url()));
3868 $tagfeed->add($icon, $cmname, $coursename);
3871 $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3872 $tagfeed->export_for_template($OUTPUT));
3874 return new core_tag\output\tagindex
($tag, 'core', 'course_modules', $content,
3875 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3880 * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3881 * This function also handles the frontpage course.
3883 * @param stdClass $context context object (it can be a course context or the system context for frontpage settings)
3884 * @param stdClass $course the course where the settings are being rendered
3885 * @return stdClass the navigation options in a course and their availability status
3888 function course_get_user_navigation_options($context, $course = null) {
3891 $isloggedin = isloggedin();
3892 $isguestuser = isguestuser();
3893 $isfrontpage = $context->contextlevel
== CONTEXT_SYSTEM
;
3896 $sitecontext = $context;
3898 $sitecontext = context_system
::instance();
3901 // Sets defaults for all options.
3902 $options = (object) [
3905 'competencies' => false,
3908 'participants' => false,
3911 'communication' => false,
3914 $options->blogs
= !empty($CFG->enableblogs
) &&
3915 ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL ||
3916 ($CFG->bloglevel
== BLOG_SITE_LEVEL
and ($isloggedin and !$isguestuser)))
3917 && has_capability('moodle/blog:view', $sitecontext);
3919 $options->notes
= !empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
3921 // Frontpage settings?
3923 // We are on the front page, so make sure we use the proper capability (site:viewparticipants).
3924 $options->participants
= course_can_view_participants($sitecontext);
3925 $options->badges
= !empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $sitecontext);
3926 $options->tags
= !empty($CFG->usetags
) && $isloggedin;
3927 $options->search
= !empty($CFG->enableglobalsearch
) && has_capability('moodle/search:query', $sitecontext);
3929 // We are in a course, so make sure we use the proper capability (course:viewparticipants).
3930 $options->participants
= course_can_view_participants($context);
3932 // Only display badges if they are enabled and the current user can manage them or if they can view them and have,
3933 // at least, one available badge.
3934 if (!empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
)) {
3935 $canmanage = has_any_capability([
3936 'moodle/badges:createbadge',
3937 'moodle/badges:awardbadge',
3938 'moodle/badges:configurecriteria',
3939 'moodle/badges:configuremessages',
3940 'moodle/badges:configuredetails',
3941 'moodle/badges:deletebadge',
3948 // This only needs to be calculated if the user can't manage badges (to improve performance).
3949 $canview = has_capability('moodle/badges:viewbadges', $context);
3951 require_once($CFG->dirroot
.'/lib/badgeslib.php');
3952 if (is_null($course)) {
3953 $totalbadges = count(badges_get_badges(BADGE_TYPE_SITE
, 0, '', '', 0, 0, $USER->id
));
3955 $totalbadges = count(badges_get_badges(BADGE_TYPE_COURSE
, $course->id
, '', '', 0, 0, $USER->id
));
3960 $options->badges
= ($canmanage ||
($canview && $totalbadges > 0));
3962 // Add view grade report is permitted.
3965 if (has_capability('moodle/grade:viewall', $context)) {
3967 } else if (!empty($course->showgrades
)) {
3968 $reports = core_component
::get_plugin_list('gradereport');
3969 if (is_array($reports) && count($reports) > 0) { // Get all installed reports.
3970 arsort($reports); // User is last, we want to test it first.
3971 foreach ($reports as $plugin => $plugindir) {
3972 if (has_capability('gradereport/'.$plugin.':view', $context)) {
3973 // Stop when the first visible plugin is found.
3980 $options->grades
= $grades;
3983 if (\core_communication\api
::is_available()) {
3984 $options->communication
= has_capability('moodle/course:configurecoursecommunication', $context);
3987 if (\core_competency\api
::is_enabled()) {
3988 $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
3989 $options->competencies
= has_any_capability($capabilities, $context);
3995 * Return an object with the list of administration options in a course that are available or not for the current user.
3996 * This function also handles the frontpage settings.
3998 * @param stdClass $course course object (for frontpage it should be a clone of $SITE)
3999 * @param stdClass $context context object (course context)
4000 * @return stdClass the administration options in a course and their availability status
4003 function course_get_user_administration_options($course, $context) {
4005 $isfrontpage = $course->id
== SITEID
;
4006 $completionenabled = $CFG->enablecompletion
&& $course->enablecompletion
;
4007 $hascompletionoptions = count(core_completion\manager
::get_available_completion_options($course->id
)) > 0;
4008 $options = new stdClass
;
4009 $options->update
= has_capability('moodle/course:update', $context);
4010 $options->editcompletion
= $CFG->enablecompletion
&& $course->enablecompletion
&&
4011 ($options->update ||
$hascompletionoptions);
4012 $options->filters
= has_capability('moodle/filter:manage', $context) &&
4013 count(filter_get_available_in_context($context)) > 0;
4014 $options->reports
= has_capability('moodle/site:viewreports', $context);
4015 $options->backup
= has_capability('moodle/backup:backupcourse', $context);
4016 $options->restore
= has_capability('moodle/restore:restorecourse', $context);
4017 $options->copy
= \core_course\management\helper
::can_copy_course($course->id
);
4018 $options->files
= ($course->legacyfiles
== 2 && has_capability('moodle/course:managefiles', $context));
4020 if (!$isfrontpage) {
4021 $options->tags
= has_capability('moodle/course:tag', $context);
4022 $options->gradebook
= has_capability('moodle/grade:manage', $context);
4023 $options->outcomes
= !empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $context);
4024 $options->badges
= !empty($CFG->enablebadges
);
4025 $options->import
= has_capability('moodle/restore:restoretargetimport', $context);
4026 $options->reset
= has_capability('moodle/course:reset', $context);
4027 $options->roles
= has_capability('moodle/role:switchroles', $context);
4029 // Set default options to false.
4030 $listofoptions = array('tags', 'gradebook', 'outcomes', 'badges', 'import', 'publish', 'reset', 'roles', 'grades');
4032 foreach ($listofoptions as $option) {
4033 $options->$option = false;
4041 * Validates course start and end dates.
4043 * Checks that the end course date is not greater than the start course date.
4045 * $coursedata['startdate'] or $coursedata['enddate'] may not be set, it depends on the form and user input.
4047 * @param array $coursedata May contain startdate and enddate timestamps, depends on the user input.
4048 * @return mixed False if everything alright, error codes otherwise.
4050 function course_validate_dates($coursedata) {
4052 // If both start and end dates are set end date should be later than the start date.
4053 if (!empty($coursedata['startdate']) && !empty($coursedata['enddate']) &&
4054 ($coursedata['enddate'] < $coursedata['startdate'])) {
4055 return 'enddatebeforestartdate';
4058 // If start date is not set end date can not be set.
4059 if (empty($coursedata['startdate']) && !empty($coursedata['enddate'])) {
4060 return 'nostartdatenoenddate';
4067 * Check for course updates in the given context level instances (only modules supported right Now)
4069 * @param stdClass $course course object
4070 * @param array $tocheck instances to check for updates
4071 * @param array $filter check only for updates in these areas
4072 * @return array list of warnings and instances with updates information
4075 function course_check_updates($course, $tocheck, $filter = array()) {
4078 $instances = array();
4079 $warnings = array();
4080 $modulescallbacksupport = array();
4081 $modinfo = get_fast_modinfo($course);
4083 $supportedplugins = get_plugin_list_with_function('mod', 'check_updates_since');
4086 foreach ($tocheck as $instance) {
4087 if ($instance['contextlevel'] == 'module') {
4088 // Check module visibility.
4090 $cm = $modinfo->get_cm($instance['id']);
4091 } catch (Exception
$e) {
4092 $warnings[] = array(
4094 'itemid' => $instance['id'],
4095 'warningcode' => 'cmidnotincourse',
4096 'message' => 'This module id does not belong to this course.'
4101 if (!$cm->uservisible
) {
4102 $warnings[] = array(
4104 'itemid' => $instance['id'],
4105 'warningcode' => 'nonuservisible',
4106 'message' => 'You don\'t have access to this module.'
4110 if (empty($supportedplugins['mod_' . $cm->modname
])) {
4111 $warnings[] = array(
4113 'itemid' => $instance['id'],
4114 'warningcode' => 'missingcallback',
4115 'message' => 'This module does not implement the check_updates_since callback: ' . $instance['contextlevel'],
4119 // Retrieve the module instance.
4120 $instances[] = array(
4121 'contextlevel' => $instance['contextlevel'],
4122 'id' => $instance['id'],
4123 'updates' => call_user_func($cm->modname
. '_check_updates_since', $cm, $instance['since'], $filter)
4127 $warnings[] = array(
4128 'item' => 'contextlevel',
4129 'itemid' => $instance['id'],
4130 'warningcode' => 'contextlevelnotsupported',
4131 'message' => 'Context level not yet supported ' . $instance['contextlevel'],
4135 return array($instances, $warnings);
4139 * This function classifies a course as past, in progress or future.
4141 * This function may incur a DB hit to calculate course completion.
4142 * @param stdClass $course Course record
4143 * @param stdClass $user User record (optional - defaults to $USER).
4144 * @param completion_info $completioninfo Completion record for the user (optional - will be fetched if required).
4145 * @return string (one of COURSE_TIMELINE_FUTURE, COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_PAST)
4147 function course_classify_for_timeline($course, $user = null, $completioninfo = null) {
4150 if ($user == null) {
4154 if ($completioninfo == null) {
4155 $completioninfo = new completion_info($course);
4158 // Let plugins override data for timeline classification.
4159 $pluginsfunction = get_plugins_with_function('extend_course_classify_for_timeline', 'lib.php');
4160 foreach ($pluginsfunction as $plugintype => $plugins) {
4161 foreach ($plugins as $pluginfunction) {
4162 $pluginfunction($course, $user, $completioninfo);
4168 if (!empty($course->enddate
) && (course_classify_end_date($course) < $today)) {
4169 return COURSE_TIMELINE_PAST
;
4172 // Course was completed.
4173 if ($completioninfo->is_enabled() && $completioninfo->is_course_complete($user->id
)) {
4174 return COURSE_TIMELINE_PAST
;
4177 // Start date not reached.
4178 if (!empty($course->startdate
) && (course_classify_start_date($course) > $today)) {
4179 return COURSE_TIMELINE_FUTURE
;
4182 // Everything else is in progress.
4183 return COURSE_TIMELINE_INPROGRESS
;
4187 * This function calculates the end date to use for display classification purposes,
4188 * incorporating the grace period, if any.
4190 * @param stdClass $course The course record.
4191 * @return int The new enddate.
4193 function course_classify_end_date($course) {
4195 $coursegraceperiodafter = (empty($CFG->coursegraceperiodafter
)) ?
0 : $CFG->coursegraceperiodafter
;
4196 $enddate = (new \
DateTimeImmutable())->setTimestamp($course->enddate
)->modify("+{$coursegraceperiodafter} days");
4197 return $enddate->getTimestamp();
4201 * This function calculates the start date to use for display classification purposes,
4202 * incorporating the grace period, if any.
4204 * @param stdClass $course The course record.
4205 * @return int The new startdate.
4207 function course_classify_start_date($course) {
4209 $coursegraceperiodbefore = (empty($CFG->coursegraceperiodbefore
)) ?
0 : $CFG->coursegraceperiodbefore
;
4210 $startdate = (new \
DateTimeImmutable())->setTimestamp($course->startdate
)->modify("-{$coursegraceperiodbefore} days");
4211 return $startdate->getTimestamp();
4215 * Group a list of courses into either past, future, or in progress.
4217 * The return value will be an array indexed by the COURSE_TIMELINE_* constants
4218 * with each value being an array of courses in that group.
4221 * COURSE_TIMELINE_PAST => [... list of past courses ...],
4222 * COURSE_TIMELINE_FUTURE => [],
4223 * COURSE_TIMELINE_INPROGRESS => []
4226 * @param array $courses List of courses to be grouped.
4229 function course_classify_courses_for_timeline(array $courses) {
4230 return array_reduce($courses, function($carry, $course) {
4231 $classification = course_classify_for_timeline($course);
4232 array_push($carry[$classification], $course);
4236 COURSE_TIMELINE_PAST
=> [],
4237 COURSE_TIMELINE_FUTURE
=> [],
4238 COURSE_TIMELINE_INPROGRESS
=> []
4243 * Get the list of enrolled courses for the current user.
4245 * This function returns a Generator. The courses will be loaded from the database
4246 * in chunks rather than a single query.
4248 * @param int $limit Restrict result set to this amount
4249 * @param int $offset Skip this number of records from the start of the result set
4250 * @param string|null $sort SQL string for sorting
4251 * @param string|null $fields SQL string for fields to be returned
4252 * @param int $dbquerylimit The number of records to load per DB request
4253 * @param array $includecourses courses ids to be restricted
4254 * @param array $hiddencourses courses ids to be excluded
4257 function course_get_enrolled_courses_for_logged_in_user(
4260 string $sort = null,
4261 string $fields = null,
4262 int $dbquerylimit = COURSE_DB_QUERY_LIMIT
,
4263 array $includecourses = [],
4264 array $hiddencourses = []
4267 $haslimit = !empty($limit);
4269 $querylimit = (!$haslimit ||
$limit > $dbquerylimit) ?
$dbquerylimit : $limit;
4271 while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, $includecourses, false, $offset, $hiddencourses)) {
4272 yield from
$courses;
4274 $recordsloaded +
= $querylimit;
4276 if (count($courses) < $querylimit) {
4279 if ($haslimit && $recordsloaded >= $limit) {
4283 $offset +
= $querylimit;
4288 * Get the list of enrolled courses the current user searched for.
4290 * This function returns a Generator. The courses will be loaded from the database
4291 * in chunks rather than a single query.
4293 * @param int $limit Restrict result set to this amount
4294 * @param int $offset Skip this number of records from the start of the result set
4295 * @param string|null $sort SQL string for sorting
4296 * @param string|null $fields SQL string for fields to be returned
4297 * @param int $dbquerylimit The number of records to load per DB request
4298 * @param array $searchcriteria contains search criteria
4299 * @param array $options display options, same as in get_courses() except 'recursive' is ignored -
4300 * search is always category-independent
4303 function course_get_enrolled_courses_for_logged_in_user_from_search(
4306 string $sort = null,
4307 string $fields = null,
4308 int $dbquerylimit = COURSE_DB_QUERY_LIMIT
,
4309 array $searchcriteria = [],
4313 $haslimit = !empty($limit);
4315 $querylimit = (!$haslimit ||
$limit > $dbquerylimit) ?
$dbquerylimit : $limit;
4316 $ids = core_course_category
::search_courses($searchcriteria, $options);
4318 // If no courses were found matching the criteria return back.
4323 while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, $ids, false, $offset)) {
4324 yield from
$courses;
4326 $recordsloaded +
= $querylimit;
4328 if (count($courses) < $querylimit) {
4331 if ($haslimit && $recordsloaded >= $limit) {
4335 $offset +
= $querylimit;
4340 * Search the given $courses for any that match the given $classification up to the specified
4343 * This function will return the subset of courses that match the classification as well as the
4344 * number of courses it had to process to build that subset.
4346 * It is recommended that for larger sets of courses this function is given a Generator that loads
4347 * the courses from the database in chunks.
4349 * @param array|Traversable $courses List of courses to process
4350 * @param string $classification One of the COURSE_TIMELINE_* constants
4351 * @param int $limit Limit the number of results to this amount
4352 * @return array First value is the filtered courses, second value is the number of courses processed
4354 function course_filter_courses_by_timeline_classification(
4356 string $classification,
4360 if (!in_array($classification,
4361 [COURSE_TIMELINE_ALLINCLUDINGHIDDEN
, COURSE_TIMELINE_ALL
, COURSE_TIMELINE_PAST
, COURSE_TIMELINE_INPROGRESS
,
4362 COURSE_TIMELINE_FUTURE
, COURSE_TIMELINE_HIDDEN
, COURSE_TIMELINE_SEARCH
])) {
4363 $message = 'Classification must be one of COURSE_TIMELINE_ALLINCLUDINGHIDDEN, COURSE_TIMELINE_ALL, COURSE_TIMELINE_PAST, '
4364 . 'COURSE_TIMELINE_INPROGRESS, COURSE_TIMELINE_SEARCH or COURSE_TIMELINE_FUTURE';
4365 throw new moodle_exception($message);
4368 $filteredcourses = [];
4369 $numberofcoursesprocessed = 0;
4372 foreach ($courses as $course) {
4373 $numberofcoursesprocessed++
;
4374 $pref = get_user_preferences('block_myoverview_hidden_course_' . $course->id
, 0);
4376 // Added as of MDL-63457 toggle viewability for each user.
4377 if ($classification == COURSE_TIMELINE_ALLINCLUDINGHIDDEN ||
($classification == COURSE_TIMELINE_HIDDEN
&& $pref) ||
4378 $classification == COURSE_TIMELINE_SEARCH||
4379 (($classification == COURSE_TIMELINE_ALL ||
$classification == course_classify_for_timeline($course)) && !$pref)) {
4380 $filteredcourses[] = $course;
4384 if ($limit && $filtermatches >= $limit) {
4385 // We've found the number of requested courses. No need to continue searching.
4390 // Return the number of filtered courses as well as the number of courses that were searched
4391 // in order to find the matching courses. This allows the calling code to do some kind of
4393 return [$filteredcourses, $numberofcoursesprocessed];
4397 * Search the given $courses for any that match the given $classification up to the specified
4400 * This function will return the subset of courses that are favourites as well as the
4401 * number of courses it had to process to build that subset.
4403 * It is recommended that for larger sets of courses this function is given a Generator that loads
4404 * the courses from the database in chunks.
4406 * @param array|Traversable $courses List of courses to process
4407 * @param array $favouritecourseids Array of favourite courses.
4408 * @param int $limit Limit the number of results to this amount
4409 * @return array First value is the filtered courses, second value is the number of courses processed
4411 function course_filter_courses_by_favourites(
4413 $favouritecourseids,
4417 $filteredcourses = [];
4418 $numberofcoursesprocessed = 0;
4421 foreach ($courses as $course) {
4422 $numberofcoursesprocessed++
;
4424 if (in_array($course->id
, $favouritecourseids)) {
4425 $filteredcourses[] = $course;
4429 if ($limit && $filtermatches >= $limit) {
4430 // We've found the number of requested courses. No need to continue searching.
4435 // Return the number of filtered courses as well as the number of courses that were searched
4436 // in order to find the matching courses. This allows the calling code to do some kind of
4438 return [$filteredcourses, $numberofcoursesprocessed];
4442 * Search the given $courses for any that have a $customfieldname value that matches the given
4443 * $customfieldvalue, up to the specified $limit.
4445 * This function will return the subset of courses that matches the value as well as the
4446 * number of courses it had to process to build that subset.
4448 * It is recommended that for larger sets of courses this function is given a Generator that loads
4449 * the courses from the database in chunks.
4451 * @param array|Traversable $courses List of courses to process
4452 * @param string $customfieldname the shortname of the custom field to match against
4453 * @param string $customfieldvalue the value this custom field needs to match
4454 * @param int $limit Limit the number of results to this amount
4455 * @return array First value is the filtered courses, second value is the number of courses processed
4457 function course_filter_courses_by_customfield(
4469 // Prepare the list of courses to search through.
4471 foreach ($courses as $course) {
4472 $coursesbyid[$course->id
] = $course;
4474 if (!$coursesbyid) {
4477 list($csql, $params) = $DB->get_in_or_equal(array_keys($coursesbyid), SQL_PARAMS_NAMED
);
4479 // Get the id of the custom field.
4482 FROM {customfield_field} f
4483 JOIN {customfield_category} cat ON cat.id = f.categoryid
4484 WHERE f.shortname = ?
4485 AND cat.component = 'core_course'
4486 AND cat.area = 'course'
4488 $fieldid = $DB->get_field_sql($sql, [$customfieldname]);
4493 // Get a list of courseids that match that custom field value.
4494 if ($customfieldvalue == COURSE_CUSTOMFIELD_EMPTY
) {
4495 $comparevalue = $DB->sql_compare_text('cd.value');
4499 LEFT JOIN {customfield_data} cd ON cd.instanceid = c.id AND cd.fieldid = :fieldid
4501 AND (cd.value IS NULL OR $comparevalue = '' OR $comparevalue = '0')
4503 $params['fieldid'] = $fieldid;
4504 $matchcourseids = $DB->get_fieldset_sql($sql, $params);
4506 $comparevalue = $DB->sql_compare_text('value');
4507 $select = "fieldid = :fieldid AND $comparevalue = :customfieldvalue AND instanceid $csql";
4508 $params['fieldid'] = $fieldid;
4509 $params['customfieldvalue'] = $customfieldvalue;
4510 $matchcourseids = $DB->get_fieldset_select('customfield_data', 'instanceid', $select, $params);
4513 // Prepare the list of courses to return.
4514 $filteredcourses = [];
4515 $numberofcoursesprocessed = 0;
4518 foreach ($coursesbyid as $course) {
4519 $numberofcoursesprocessed++
;
4521 if (in_array($course->id
, $matchcourseids)) {
4522 $filteredcourses[] = $course;
4526 if ($limit && $filtermatches >= $limit) {
4527 // We've found the number of requested courses. No need to continue searching.
4532 // Return the number of filtered courses as well as the number of courses that were searched
4533 // in order to find the matching courses. This allows the calling code to do some kind of
4535 return [$filteredcourses, $numberofcoursesprocessed];
4539 * Check module updates since a given time.
4540 * This function checks for updates in the module config, file areas, completion, grades, comments and ratings.
4542 * @param cm_info $cm course module data
4543 * @param int $from the time to check
4544 * @param array $fileareas additional file ares to check
4545 * @param array $filter if we need to filter and return only selected updates
4546 * @return stdClass object with the different updates
4549 function course_check_module_updates_since($cm, $from, $fileareas = array(), $filter = array()) {
4550 global $DB, $CFG, $USER;
4552 $context = $cm->context
;
4553 $mod = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
4555 $updates = new stdClass();
4556 $course = get_course($cm->course
);
4557 $component = 'mod_' . $cm->modname
;
4559 // Check changes in the module configuration.
4560 if (isset($mod->timemodified
) and (empty($filter) or in_array('configuration', $filter))) {
4561 $updates->configuration
= (object) array('updated' => false);
4562 if ($updates->configuration
->updated
= $mod->timemodified
> $from) {
4563 $updates->configuration
->timeupdated
= $mod->timemodified
;
4567 // Check for updates in files.
4568 if (plugin_supports('mod', $cm->modname
, FEATURE_MOD_INTRO
)) {
4569 $fileareas[] = 'intro';
4571 if (!empty($fileareas) and (empty($filter) or in_array('fileareas', $filter))) {
4572 $fs = get_file_storage();
4573 $files = $fs->get_area_files($context->id
, $component, $fileareas, false, "filearea, timemodified DESC", false, $from);
4574 foreach ($fileareas as $filearea) {
4575 $updates->{$filearea . 'files'} = (object) array('updated' => false);
4577 foreach ($files as $file) {
4578 $updates->{$file->get_filearea() . 'files'}->updated
= true;
4579 $updates->{$file->get_filearea() . 'files'}->itemids
[] = $file->get_id();
4583 // Check completion.
4584 $supportcompletion = plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_HAS_RULES
);
4585 $supportcompletion = $supportcompletion or plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_TRACKS_VIEWS
);
4586 if ($supportcompletion and (empty($filter) or in_array('completion', $filter))) {
4587 $updates->completion
= (object) array('updated' => false);
4588 $completion = new completion_info($course);
4589 // Use wholecourse to cache all the modules the first time.
4590 $completiondata = $completion->get_data($cm, true);
4591 if ($updates->completion
->updated
= !empty($completiondata->timemodified
) && $completiondata->timemodified
> $from) {
4592 $updates->completion
->timemodified
= $completiondata->timemodified
;
4597 $supportgrades = plugin_supports('mod', $cm->modname
, FEATURE_GRADE_HAS_GRADE
);
4598 $supportgrades = $supportgrades or plugin_supports('mod', $cm->modname
, FEATURE_GRADE_OUTCOMES
);
4599 if ($supportgrades and (empty($filter) or (in_array('gradeitems', $filter) or in_array('outcomes', $filter)))) {
4600 require_once($CFG->libdir
. '/gradelib.php');
4601 $grades = grade_get_grades($course->id
, 'mod', $cm->modname
, $mod->id
, $USER->id
);
4603 if (empty($filter) or in_array('gradeitems', $filter)) {
4604 $updates->gradeitems
= (object) array('updated' => false);
4605 foreach ($grades->items
as $gradeitem) {
4606 foreach ($gradeitem->grades
as $grade) {
4607 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4608 $updates->gradeitems
->updated
= true;
4609 $updates->gradeitems
->itemids
[] = $gradeitem->id
;
4615 if (empty($filter) or in_array('outcomes', $filter)) {
4616 $updates->outcomes
= (object) array('updated' => false);
4617 foreach ($grades->outcomes
as $outcome) {
4618 foreach ($outcome->grades
as $grade) {
4619 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4620 $updates->outcomes
->updated
= true;
4621 $updates->outcomes
->itemids
[] = $outcome->id
;
4629 if (plugin_supports('mod', $cm->modname
, FEATURE_COMMENT
) and (empty($filter) or in_array('comments', $filter))) {
4630 $updates->comments
= (object) array('updated' => false);
4631 require_once($CFG->dirroot
. '/comment/lib.php');
4632 require_once($CFG->dirroot
. '/comment/locallib.php');
4633 $manager = new comment_manager();
4634 $comments = $manager->get_component_comments_since($course, $context, $component, $from, $cm);
4635 if (!empty($comments)) {
4636 $updates->comments
->updated
= true;
4637 $updates->comments
->itemids
= array_keys($comments);
4642 if (plugin_supports('mod', $cm->modname
, FEATURE_RATE
) and (empty($filter) or in_array('ratings', $filter))) {
4643 $updates->ratings
= (object) array('updated' => false);
4644 require_once($CFG->dirroot
. '/rating/lib.php');
4645 $manager = new rating_manager();
4646 $ratings = $manager->get_component_ratings_since($context, $component, $from);
4647 if (!empty($ratings)) {
4648 $updates->ratings
->updated
= true;
4649 $updates->ratings
->itemids
= array_keys($ratings);
4657 * Returns true if the user can view the participant page, false otherwise,
4659 * @param context $context The context we are checking.
4662 function course_can_view_participants($context) {
4663 $viewparticipantscap = 'moodle/course:viewparticipants';
4664 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4665 $viewparticipantscap = 'moodle/site:viewparticipants';
4668 return has_any_capability([$viewparticipantscap, 'moodle/course:enrolreview'], $context);
4672 * Checks if a user can view the participant page, if not throws an exception.
4674 * @param context $context The context we are checking.
4675 * @throws required_capability_exception
4677 function course_require_view_participants($context) {
4678 if (!course_can_view_participants($context)) {
4679 $viewparticipantscap = 'moodle/course:viewparticipants';
4680 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4681 $viewparticipantscap = 'moodle/site:viewparticipants';
4683 throw new required_capability_exception($context, $viewparticipantscap, 'nopermissions', '');
4688 * Return whether the user can download from the specified backup file area in the given context.
4690 * @param string $filearea the backup file area. E.g. 'course', 'backup' or 'automated'.
4691 * @param \context $context
4692 * @param stdClass $user the user object. If not provided, the current user will be checked.
4693 * @return bool true if the user is allowed to download in the context, false otherwise.
4695 function can_download_from_backup_filearea($filearea, \context
$context, stdClass
$user = null) {
4696 $candownload = false;
4697 switch ($filearea) {
4700 $candownload = has_capability('moodle/backup:downloadfile', $context, $user);
4703 // Given the automated backups may contain userinfo, we restrict access such that only users who are able to
4704 // restore with userinfo are able to download the file. Users can't create these backups, so checking 'backup:userinfo'
4705 // doesn't make sense here.
4706 $candownload = has_capability('moodle/backup:downloadfile', $context, $user) &&
4707 has_capability('moodle/restore:userinfo', $context, $user);
4713 return $candownload;
4717 * Get a list of hidden courses
4719 * @param int|object|null $user User override to get the filter from. Defaults to current user
4720 * @return array $ids List of hidden courses
4721 * @throws coding_exception
4723 function get_hidden_courses_on_timeline($user = null) {
4730 $preferences = get_user_preferences(null, null, $user);
4732 foreach ($preferences as $key => $value) {
4733 if (preg_match('/block_myoverview_hidden_course_(\d)+/', $key)) {
4734 $id = preg_split('/block_myoverview_hidden_course_/', $key);
4743 * Returns a list of the most recently courses accessed by a user
4745 * @param int $userid User id from which the courses will be obtained
4746 * @param int $limit Restrict result set to this amount
4747 * @param int $offset Skip this number of records from the start of the result set
4748 * @param string|null $sort SQL string for sorting
4751 function course_get_recent_courses(int $userid = null, int $limit = 0, int $offset = 0, string $sort = null) {
4753 global $CFG, $USER, $DB;
4755 if (empty($userid)) {
4756 $userid = $USER->id
;
4760 'id', 'idnumber', 'summary', 'summaryformat', 'startdate', 'enddate', 'category',
4761 'shortname', 'fullname', 'timeaccess', 'component', 'visible',
4762 'showactivitydates', 'showcompletionconditions', 'pdfexportfont'
4766 $sort = 'timeaccess DESC';
4768 // The SQL string for sorting can define sorting by multiple columns.
4769 $rawsorts = explode(',', $sort);
4771 // Validate and trim the sort parameters in the SQL string for sorting.
4772 foreach ($rawsorts as $rawsort) {
4773 $sort = trim($rawsort);
4774 $sortparams = explode(' ', $sort);
4775 // A valid sort statement can not have more than 2 params (ex. 'summary desc' or 'timeaccess').
4776 if (count($sortparams) > 2) {
4777 throw new invalid_parameter_exception(
4778 'Invalid structure of the sort parameter, allowed structure: fieldname [ASC|DESC].');
4780 $sortfield = trim($sortparams[0]);
4781 // Validate the value which defines the field to sort by.
4782 if (!in_array($sortfield, $basefields)) {
4783 throw new invalid_parameter_exception('Invalid field in the sort parameter, allowed fields: ' .
4784 implode(', ', $basefields) . '.');
4786 $sortdirection = isset($sortparams[1]) ?
trim($sortparams[1]) : '';
4787 // Validate the value which defines the sort direction (if present).
4788 $allowedsortdirections = ['asc', 'desc'];
4789 if (!empty($sortdirection) && !in_array(strtolower($sortdirection), $allowedsortdirections)) {
4790 throw new invalid_parameter_exception('Invalid sort direction in the sort parameter, allowed values: ' .
4791 implode(', ', $allowedsortdirections) . '.');
4795 $sort = implode(',', $sorts);
4798 $ctxfields = context_helper
::get_preload_record_columns_sql('ctx');
4800 $coursefields = 'c.' . join(',', $basefields);
4802 // Ask the favourites service to give us the join SQL for favourited courses,
4803 // so we can include favourite information in the query.
4804 $usercontext = \context_user
::instance($userid);
4805 $favservice = \core_favourites\service_factory
::get_service_for_user_context($usercontext);
4806 list($favsql, $favparams) = $favservice->get_join_sql_by_type('core_course', 'courses', 'fav', 'ul.courseid');
4808 $sql = "SELECT $coursefields, $ctxfields
4811 ON ctx.contextlevel = :contextlevel
4812 AND ctx.instanceid = c.id
4813 JOIN {user_lastaccess} ul
4814 ON ul.courseid = c.id
4816 LEFT JOIN {enrol} eg ON eg.courseid = c.id AND eg.status = :statusenrolg AND eg.enrol = :guestenrol
4817 WHERE ul.userid = :userid
4818 AND c.visible = :visible
4819 AND (eg.id IS NOT NULL
4820 OR EXISTS (SELECT e.id
4822 JOIN {user_enrolments} ue ON ue.enrolid = e.id
4823 WHERE e.courseid = c.id
4824 AND e.status = :statusenrol
4825 AND ue.status = :status
4826 AND ue.userid = :userid2
4827 AND ue.timestart < :now1
4828 AND (ue.timeend = 0 OR ue.timeend > :now2)
4832 $now = round(time(), -2); // Improves db caching.
4833 $params = ['userid' => $userid, 'contextlevel' => CONTEXT_COURSE
, 'visible' => 1, 'status' => ENROL_USER_ACTIVE
,
4834 'statusenrol' => ENROL_INSTANCE_ENABLED
, 'guestenrol' => 'guest', 'now1' => $now, 'now2' => $now,
4835 'userid2' => $userid, 'statusenrolg' => ENROL_INSTANCE_ENABLED
] +
$favparams;
4837 $recentcourses = $DB->get_records_sql($sql, $params, $offset, $limit);
4839 // Filter courses if last access field is hidden.
4840 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
4842 if ($userid != $USER->id
&& isset($hiddenfields['lastaccess'])) {
4843 $recentcourses = array_filter($recentcourses, function($course) {
4844 context_helper
::preload_from_record($course);
4845 $context = context_course
::instance($course->id
, IGNORE_MISSING
);
4846 // If last access was a hidden field, a user requesting info about another user would need permission to view hidden
4848 return has_capability('moodle/course:viewhiddenuserfields', $context);
4852 return $recentcourses;
4856 * Calculate the course start date and offset for the given user ids.
4858 * If the course is a fixed date course then the course start date will be returned.
4859 * If the course is a relative date course then the course date will be calculated and
4860 * and offset provided.
4862 * The dates are returned as an array with the index being the user id. The array
4863 * contains the start date and start offset values for the user.
4865 * If the user is not enrolled in the course then the course start date will be returned.
4867 * If we have a course which starts on 1563244000 and 2 users, id 123 and 456, where the
4868 * former is enrolled in the course at 1563244693 and the latter is not enrolled then the
4869 * return value would look like:
4872 * 'start' => 1563244693,
4873 * 'startoffset' => 693
4876 * 'start' => 1563244000,
4877 * 'startoffset' => 0
4881 * @param stdClass $course The course to fetch dates for.
4882 * @param array $userids The list of user ids to get dates for.
4885 function course_get_course_dates_for_user_ids(stdClass
$course, array $userids): array {
4886 if (empty($course->relativedatesmode
)) {
4887 // This course isn't set to relative dates so we can early return with the course
4889 return array_reduce($userids, function($carry, $userid) use ($course) {
4891 'start' => $course->startdate
,
4898 // We're dealing with a relative dates course now so we need to calculate some dates.
4899 $cache = cache
::make('core', 'course_user_dates');
4901 $uncacheduserids = [];
4903 // Try fetching the values from the cache so that we don't need to do a DB request.
4904 foreach ($userids as $userid) {
4905 $cachekey = "{$course->id}_{$userid}";
4906 $cachedvalue = $cache->get($cachekey);
4908 if ($cachedvalue === false) {
4909 // Looks like we haven't seen this user for this course before so we'll have
4911 $uncacheduserids[] = $userid;
4913 [$start, $startoffset] = $cachedvalue;
4916 'startoffset' => $startoffset
4921 if (!empty($uncacheduserids)) {
4922 // Load the enrolments for any users we haven't seen yet. Set the "onlyactive" param
4923 // to false because it filters out users with enrolment start times in the future which
4925 $enrolments = enrol_get_course_users($course->id
, false, $uncacheduserids);
4927 foreach ($uncacheduserids as $userid) {
4928 // Find the user enrolment that has the earliest start date.
4929 $enrolment = array_reduce(array_values($enrolments), function($carry, $enrolment) use ($userid) {
4930 // Only consider enrolments for this user if the user enrolment is active and the
4931 // enrolment method is enabled.
4933 $enrolment->uestatus
== ENROL_USER_ACTIVE
&&
4934 $enrolment->estatus
== ENROL_INSTANCE_ENABLED
&&
4935 $enrolment->id
== $userid
4937 if (is_null($carry)) {
4938 // Haven't found an enrolment yet for this user so use the one we just found.
4939 $carry = $enrolment;
4941 // We've already found an enrolment for this user so let's use which ever one
4942 // has the earliest start time.
4943 $carry = $carry->uetimestart
< $enrolment->uetimestart ?
$carry : $enrolment;
4951 // The course is in relative dates mode so we calculate the student's start
4952 // date based on their enrolment start date.
4953 $start = $course->startdate
> $enrolment->uetimestart ?
$course->startdate
: $enrolment->uetimestart
;
4954 $startoffset = $start - $course->startdate
;
4956 // The user is not enrolled in the course so default back to the course start date.
4957 $start = $course->startdate
;
4963 'startoffset' => $startoffset
4966 $cachekey = "{$course->id}_{$userid}";
4967 $cache->set($cachekey, [$start, $startoffset]);
4975 * Calculate the course start date and offset for the given user id.
4977 * If the course is a fixed date course then the course start date will be returned.
4978 * If the course is a relative date course then the course date will be calculated and
4979 * and offset provided.
4981 * The return array contains the start date and start offset values for the user.
4983 * If the user is not enrolled in the course then the course start date will be returned.
4985 * If we have a course which starts on 1563244000. If a user's enrolment starts on 1563244693
4986 * then the return would be:
4988 * 'start' => 1563244693,
4989 * 'startoffset' => 693
4992 * If the use was not enrolled then the return would be:
4994 * 'start' => 1563244000,
4995 * 'startoffset' => 0
4998 * @param stdClass $course The course to fetch dates for.
4999 * @param int $userid The user id to get dates for.
5002 function course_get_course_dates_for_user_id(stdClass
$course, int $userid): array {
5003 return (course_get_course_dates_for_user_ids($course, [$userid]))[$userid];
5007 * Renders the course copy form for the modal on the course management screen.
5009 * @param array $args
5010 * @return string $o Form HTML.
5012 function course_output_fragment_new_base_form($args) {
5014 $serialiseddata = json_decode($args['jsonformdata'], true);
5016 if (!empty($serialiseddata)) {
5017 parse_str($serialiseddata, $formdata);
5020 $context = context_course
::instance($args['courseid']);
5021 $copycaps = \core_course\management\helper
::get_course_copy_capabilities();
5022 require_all_capabilities($copycaps, $context);
5024 $course = get_course($args['courseid']);
5025 $mform = new \core_backup\output\
copy_form(
5027 array('course' => $course, 'returnto' => '', 'returnurl' => ''),
5028 'post', '', ['class' => 'ignoredirty'], true, $formdata);
5030 if (!empty($serialiseddata)) {
5031 // If we were passed non-empty form data we want the mform to call validation functions and show errors.
5032 $mform->is_validated();
5037 $o = ob_get_contents();
5044 * Get the current course image for the given course.
5046 * @param \stdClass $course
5047 * @return null|stored_file
5049 function course_get_courseimage(\stdClass
$course): ?stored_file
{
5050 $courseinlist = new core_course_list_element($course);
5051 foreach ($courseinlist->get_course_overviewfiles() as $file) {
5052 if ($file->is_valid_image()) {
5060 * Get course specific data for configuring a communication instance.
5062 * @param integer $courseid The course id.
5063 * @return array Returns course data, context and heading.
5065 function course_get_communication_instance_data(int $courseid): array {
5066 // Do some checks and prepare instance specific data.
5067 $course = get_course($courseid);
5068 require_login($course);
5069 $context = context_course
::instance($course->id
);
5070 require_capability('moodle/course:configurecoursecommunication', $context);
5072 $heading = $course->fullname
;
5073 $returnurl = new moodle_url('/course/view.php', ['id' => $courseid]);
5075 return [$course, $context, $heading, $returnurl];
5079 * Update a course using communication configuration data.
5081 * @param stdClass $data The data to update the course with.
5083 function course_update_communication_instance_data(stdClass
$data): void
{
5084 $data->id
= $data->instanceid
; // For correct use in update_course.
5085 update_course($data);
5089 * Trigger course section viewed event.
5091 * @param context_course $context course context object
5092 * @param int $sectionid section number
5093 * @since Moodle 4.4.
5095 function course_section_view(context_course
$context, int $sectionid) {
5098 'objectid' => $sectionid,
5099 'context' => $context,
5101 $event = \core\event\section_viewed
::create($eventdata);
5104 user_accesstime_log($context->instanceid
);