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 require_once($CFG->libdir
.'/completionlib.php');
28 require_once($CFG->libdir
.'/filelib.php');
29 require_once($CFG->libdir
.'/datalib.php');
30 require_once($CFG->dirroot
.'/course/format/lib.php');
32 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
33 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
36 * Number of courses to display when summaries are included.
38 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
40 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
42 // Max courses in log dropdown before switching to optional.
43 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
44 // Max users in log dropdown before switching to optional.
45 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
46 define('FRONTPAGENEWS', '0');
47 define('FRONTPAGECATEGORYNAMES', '2');
48 define('FRONTPAGECATEGORYCOMBO', '4');
49 define('FRONTPAGEENROLLEDCOURSELIST', '5');
50 define('FRONTPAGEALLCOURSELIST', '6');
51 define('FRONTPAGECOURSESEARCH', '7');
52 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
53 define('EXCELROWS', 65535);
54 define('FIRSTUSEDEXCELROW', 3);
56 define('MOD_CLASS_ACTIVITY', 0);
57 define('MOD_CLASS_RESOURCE', 1);
59 define('COURSE_TIMELINE_ALLINCLUDINGHIDDEN', 'allincludinghidden');
60 define('COURSE_TIMELINE_ALL', 'all');
61 define('COURSE_TIMELINE_PAST', 'past');
62 define('COURSE_TIMELINE_INPROGRESS', 'inprogress');
63 define('COURSE_TIMELINE_FUTURE', 'future');
64 define('COURSE_FAVOURITES', 'favourites');
65 define('COURSE_TIMELINE_HIDDEN', 'hidden');
66 define('COURSE_CUSTOMFIELD', 'customfield');
67 define('COURSE_DB_QUERY_LIMIT', 1000);
68 /** Searching for all courses that have no value for the specified custom field. */
69 define('COURSE_CUSTOMFIELD_EMPTY', -1);
71 // Course activity chooser footer default display option.
72 define('COURSE_CHOOSER_FOOTER_NONE', 'hidden');
74 // Download course content options.
75 define('DOWNLOAD_COURSE_CONTENT_DISABLED', 0);
76 define('DOWNLOAD_COURSE_CONTENT_ENABLED', 1);
77 define('DOWNLOAD_COURSE_CONTENT_SITE_DEFAULT', 2);
79 function make_log_url($module, $url) {
82 if (strpos($url, 'report/') === 0) {
83 // there is only one report type, course reports are deprecated
93 if (strpos($url, '../') === 0) {
94 $url = ltrim($url, '.');
96 $url = "/course/$url";
100 $url = "/calendar/$url";
104 $url = "/$module/$url";
117 $url = "/message/$url";
120 $url = "/notes/$url";
129 $url = "/grade/$url";
132 $url = "/mod/$module/$url";
136 //now let's sanitise urls - there might be some ugly nasties:-(
137 $parts = explode('?', $url);
138 $script = array_shift($parts);
139 if (strpos($script, 'http') === 0) {
140 $script = clean_param($script, PARAM_URL
);
142 $script = clean_param($script, PARAM_PATH
);
147 $query = implode('', $parts);
148 $query = str_replace('&', '&', $query); // both & and & are stored in db :-|
149 $parts = explode('&', $query);
150 $eq = urlencode('=');
151 foreach ($parts as $key=>$part) {
152 $part = urlencode(urldecode($part));
153 $part = str_replace($eq, '=', $part);
154 $parts[$key] = $part;
156 $query = '?'.implode('&', $parts);
159 return $script.$query;
163 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
164 $modname="", $modid=0, $modaction="", $groupid=0) {
167 // It is assumed that $date is the GMT time of midnight for that day,
168 // and so the next 86400 seconds worth of logs are printed.
170 /// Setup for group handling.
172 // TODO: I don't understand group/context/etc. enough to be able to do
173 // something interesting with it here
174 // What is the context of a remote course?
176 /// If the group mode is separate, and this user does not have editing privileges,
177 /// then only the user's group can be viewed.
178 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
179 // $groupid = get_current_group($course->id);
181 /// If this course doesn't have groups, no groupid can be specified.
182 //else if (!$course->groupmode) {
191 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
193 LEFT JOIN {user} u ON l.userid = u.id
197 $where .= "l.hostid = :hostid";
198 $params['hostid'] = $hostid;
200 // TODO: Is 1 really a magic number referring to the sitename?
201 if ($course != SITEID ||
$modid != 0) {
202 $where .= " AND l.course=:courseid";
203 $params['courseid'] = $course;
207 $where .= " AND l.module = :modname";
208 $params['modname'] = $modname;
211 if ('site_errors' === $modid) {
212 $where .= " AND ( l.action='error' OR l.action='infected' )";
214 //TODO: This assumes that modids are the same across sites... probably
216 $where .= " AND l.cmid = :modid";
217 $params['modid'] = $modid;
221 $firstletter = substr($modaction, 0, 1);
222 if ($firstletter == '-') {
223 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
224 $params['modaction'] = '%'.substr($modaction, 1).'%';
226 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
227 $params['modaction'] = '%'.$modaction.'%';
232 $where .= " AND l.userid = :user";
233 $params['user'] = $user;
237 $enddate = $date +
86400;
238 $where .= " AND l.time > :date AND l.time < :enddate";
239 $params['date'] = $date;
240 $params['enddate'] = $enddate;
244 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
245 if(!empty($result['totalcount'])) {
246 $where .= " ORDER BY $order";
247 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
249 $result['logs'] = array();
255 * Checks the integrity of the course data.
257 * In summary - compares course_sections.sequence and course_modules.section.
259 * More detailed, checks that:
260 * - course_sections.sequence contains each module id not more than once in the course
261 * - for each moduleid from course_sections.sequence the field course_modules.section
262 * refers to the same section id (this means course_sections.sequence is more
263 * important if they are different)
264 * - ($fullcheck only) each module in the course is present in one of
265 * course_sections.sequence
266 * - ($fullcheck only) removes non-existing course modules from section sequences
268 * If there are any mismatches, the changes are made and records are updated in DB.
270 * Course cache is NOT rebuilt if there are any errors!
272 * This function is used each time when course cache is being rebuilt with $fullcheck = false
273 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
275 * @param int $courseid id of the course
276 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
277 * the list of enabled course modules in the course. Retrieved from DB if not specified.
278 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
279 * @param array $sections records from course_sections table for this course.
280 * Retrieved from DB if not specified
281 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
282 * course modules from sequences. Only to be used in site maintenance mode when we are
283 * sure that another user is not in the middle of the process of moving/removing a module.
284 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
285 * @return array array of messages with found problems. Empty output means everything is ok
287 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
290 if ($sections === null) {
291 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
294 // Retrieve all records from course_modules regardless of module type visibility.
295 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
297 if ($rawmods === null) {
298 $rawmods = get_course_mods($courseid);
300 if (!$fullcheck && (empty($sections) ||
empty($rawmods))) {
301 // If either of the arrays is empty, no modules are displayed anyway.
304 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
306 // First make sure that each module id appears in section sequences only once.
307 // If it appears in several section sequences the last section wins.
308 // If it appears twice in one section sequence, the first occurence wins.
309 $modsection = array();
310 foreach ($sections as $sectionid => $section) {
311 $sections[$sectionid]->newsequence
= $section->sequence
;
312 if (!empty($section->sequence
)) {
313 $sequence = explode(",", $section->sequence
);
314 $sequenceunique = array_unique($sequence);
315 if (count($sequenceunique) != count($sequence)) {
316 // Some course module id appears in this section sequence more than once.
317 ksort($sequenceunique); // Preserve initial order of modules.
318 $sequence = array_values($sequenceunique);
319 $sections[$sectionid]->newsequence
= join(',', $sequence);
320 $messages[] = $debuggingprefix.'Sequence for course section ['.
321 $sectionid.'] is "'.$sections[$sectionid]->sequence
.'", must be "'.$sections[$sectionid]->newsequence
.'"';
323 foreach ($sequence as $cmid) {
324 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
325 // Some course module id appears to be in more than one section's sequences.
326 $wrongsectionid = $modsection[$cmid];
327 $sections[$wrongsectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence
. ','), ',');
328 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
329 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
331 $modsection[$cmid] = $sectionid;
336 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
338 foreach ($rawmods as $cmid => $mod) {
339 if (!isset($modsection[$cmid])) {
340 // This is a module that is not mentioned in course_section.sequence at all.
341 // Add it to the section $mod->section or to the last available section.
342 if ($mod->section
&& isset($sections[$mod->section
])) {
343 $modsection[$cmid] = $mod->section
;
345 $firstsection = reset($sections);
346 $modsection[$cmid] = $firstsection->id
;
348 $sections[$modsection[$cmid]]->newsequence
= trim($sections[$modsection[$cmid]]->newsequence
.','.$cmid, ',');
349 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
350 $modsection[$cmid].']';
353 foreach ($modsection as $cmid => $sectionid) {
354 if (!isset($rawmods[$cmid])) {
355 // Section $sectionid refers to module id that does not exist.
356 $sections[$sectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence
.','), ',');
357 $messages[] = $debuggingprefix.'Course module ['.$cmid.
358 '] does not exist but is present in the sequence of section ['.$sectionid.']';
363 // Update changed sections.
364 if (!$checkonly && !empty($messages)) {
365 foreach ($sections as $sectionid => $section) {
366 if ($section->newsequence
!== $section->sequence
) {
367 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence
));
372 // Now make sure that all modules point to the correct sections.
373 foreach ($rawmods as $cmid => $mod) {
374 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section
) {
376 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
378 $messages[] = $debuggingprefix.'Course module ['.$cmid.
379 '] points to section ['.$mod->section
.'] instead of ['.$modsection[$cmid].']';
387 * For a given course, returns an array of course activity objects
388 * Each item in the array contains he following properties:
390 function get_array_of_activities($courseid) {
391 // cm - course module id
392 // mod - name of the module (eg forum)
393 // section - the number of the section (eg week or topic)
394 // name - the name of the instance
395 // visible - is the instance visible or not
396 // groupingid - grouping id
397 // extra - contains extra string to include in any link
400 $course = $DB->get_record('course', array('id'=>$courseid));
402 if (empty($course)) {
403 throw new moodle_exception('courseidnotfound');
408 $rawmods = get_course_mods($courseid);
409 if (empty($rawmods)) {
410 return $mod; // always return array
412 $courseformat = course_get_format($course);
414 if ($sections = $DB->get_records('course_sections', array('course' => $courseid),
415 'section ASC', 'id,section,sequence,visible')) {
416 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
417 if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
418 debugging(join('<br>', $errormessages));
419 $rawmods = get_course_mods($courseid);
420 $sections = $DB->get_records('course_sections', array('course' => $courseid),
421 'section ASC', 'id,section,sequence,visible');
423 // Build array of activities.
424 foreach ($sections as $section) {
425 if (!empty($section->sequence
)) {
426 $sequence = explode(",", $section->sequence
);
427 foreach ($sequence as $seq) {
428 if (empty($rawmods[$seq])) {
431 // Adjust visibleoncoursepage, value in DB may not respect format availability.
432 $rawmods[$seq]->visibleoncoursepage
= (!$rawmods[$seq]->visible
433 ||
$rawmods[$seq]->visibleoncoursepage
434 ||
empty($CFG->allowstealth
)
435 ||
!$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ?
1 : 0;
437 // Create an object that will be cached.
438 $mod[$seq] = new stdClass();
439 $mod[$seq]->id
= $rawmods[$seq]->instance
;
440 $mod[$seq]->cm
= $rawmods[$seq]->id
;
441 $mod[$seq]->mod
= $rawmods[$seq]->modname
;
443 // Oh dear. Inconsistent names left here for backward compatibility.
444 $mod[$seq]->section
= $section->section
;
445 $mod[$seq]->sectionid
= $rawmods[$seq]->section
;
447 $mod[$seq]->module
= $rawmods[$seq]->module
;
448 $mod[$seq]->added
= $rawmods[$seq]->added
;
449 $mod[$seq]->score
= $rawmods[$seq]->score
;
450 $mod[$seq]->idnumber
= $rawmods[$seq]->idnumber
;
451 $mod[$seq]->visible
= $rawmods[$seq]->visible
;
452 $mod[$seq]->visibleoncoursepage
= $rawmods[$seq]->visibleoncoursepage
;
453 $mod[$seq]->visibleold
= $rawmods[$seq]->visibleold
;
454 $mod[$seq]->groupmode
= $rawmods[$seq]->groupmode
;
455 $mod[$seq]->groupingid
= $rawmods[$seq]->groupingid
;
456 $mod[$seq]->indent
= $rawmods[$seq]->indent
;
457 $mod[$seq]->completion
= $rawmods[$seq]->completion
;
458 $mod[$seq]->extra
= "";
459 $mod[$seq]->completiongradeitemnumber
=
460 $rawmods[$seq]->completiongradeitemnumber
;
461 $mod[$seq]->completionview
= $rawmods[$seq]->completionview
;
462 $mod[$seq]->completionexpected
= $rawmods[$seq]->completionexpected
;
463 $mod[$seq]->showdescription
= $rawmods[$seq]->showdescription
;
464 $mod[$seq]->availability
= $rawmods[$seq]->availability
;
465 $mod[$seq]->deletioninprogress
= $rawmods[$seq]->deletioninprogress
;
467 $modname = $mod[$seq]->mod
;
468 $functionname = $modname."_get_coursemodule_info";
470 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
474 include_once("$CFG->dirroot/mod/$modname/lib.php");
476 if ($hasfunction = function_exists($functionname)) {
477 if ($info = $functionname($rawmods[$seq])) {
478 if (!empty($info->icon
)) {
479 $mod[$seq]->icon
= $info->icon
;
481 if (!empty($info->iconcomponent
)) {
482 $mod[$seq]->iconcomponent
= $info->iconcomponent
;
484 if (!empty($info->name
)) {
485 $mod[$seq]->name
= $info->name
;
487 if ($info instanceof cached_cm_info
) {
488 // When using cached_cm_info you can include three new fields
489 // that aren't available for legacy code
490 if (!empty($info->content
)) {
491 $mod[$seq]->content
= $info->content
;
493 if (!empty($info->extraclasses
)) {
494 $mod[$seq]->extraclasses
= $info->extraclasses
;
496 if (!empty($info->iconurl
)) {
497 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
498 $url = new moodle_url($info->iconurl
);
499 $mod[$seq]->iconurl
= $url->out(false);
501 if (!empty($info->onclick
)) {
502 $mod[$seq]->onclick
= $info->onclick
;
504 if (!empty($info->customdata
)) {
505 $mod[$seq]->customdata
= $info->customdata
;
508 // When using a stdclass, the (horrible) deprecated ->extra field
509 // is available for BC
510 if (!empty($info->extra
)) {
511 $mod[$seq]->extra
= $info->extra
;
516 // When there is no modname_get_coursemodule_info function,
517 // but showdescriptions is enabled, then we use the 'intro'
518 // and 'introformat' fields in the module table
519 if (!$hasfunction && $rawmods[$seq]->showdescription
) {
520 if ($modvalues = $DB->get_record($rawmods[$seq]->modname
,
521 array('id' => $rawmods[$seq]->instance
), 'name, intro, introformat')) {
522 // Set content from intro and introformat. Filters are disabled
523 // because we filter it with format_text at display time
524 $mod[$seq]->content
= format_module_intro($rawmods[$seq]->modname
,
525 $modvalues, $rawmods[$seq]->id
, false);
527 // To save making another query just below, put name in here
528 $mod[$seq]->name
= $modvalues->name
;
531 if (!isset($mod[$seq]->name
)) {
532 $mod[$seq]->name
= $DB->get_field($rawmods[$seq]->modname
, "name", array("id"=>$rawmods[$seq]->instance
));
535 // Minimise the database size by unsetting default options when they are
536 // 'empty'. This list corresponds to code in the cm_info constructor.
537 foreach (array('idnumber', 'groupmode', 'groupingid',
538 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
539 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
540 'completionexpected', 'score', 'showdescription', 'deletioninprogress') as $property) {
541 if (property_exists($mod[$seq], $property) &&
542 empty($mod[$seq]->{$property})) {
543 unset($mod[$seq]->{$property});
546 // Special case: this value is usually set to null, but may be 0
547 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
548 is_null($mod[$seq]->completiongradeitemnumber
)) {
549 unset($mod[$seq]->completiongradeitemnumber
);
559 * Returns the localised human-readable names of all used modules
561 * @param bool $plural if true returns the plural forms of the names
562 * @return array where key is the module name (component name without 'mod_') and
563 * the value is the human-readable string. Array sorted alphabetically by value
565 function get_module_types_names($plural = false) {
566 static $modnames = null;
568 if ($modnames === null) {
569 $modnames = array(0 => array(), 1 => array());
570 if ($allmods = $DB->get_records("modules")) {
571 foreach ($allmods as $mod) {
572 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible
) {
573 $modnames[0][$mod->name
] = get_string("modulename", "$mod->name", null, true);
574 $modnames[1][$mod->name
] = get_string("modulenameplural", "$mod->name", null, true);
579 return $modnames[(int)$plural];
583 * Set highlighted section. Only one section can be highlighted at the time.
585 * @param int $courseid course id
586 * @param int $marker highlight section with this number, 0 means remove higlightin
589 function course_set_marker($courseid, $marker) {
591 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
592 if ($COURSE && $COURSE->id
== $courseid) {
593 $COURSE->marker
= $marker;
595 if (class_exists('format_base')) {
596 format_base
::reset_course_cache($courseid);
598 course_modinfo
::clear_instance_cache($courseid);
602 * For a given course section, marks it visible or hidden,
603 * and does the same for every activity in that section
605 * @param int $courseid course id
606 * @param int $sectionnumber The section number to adjust
607 * @param int $visibility The new visibility
608 * @return array A list of resources which were hidden in the section
610 function set_section_visible($courseid, $sectionnumber, $visibility) {
613 $resourcestotoggle = array();
614 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
615 course_update_section($courseid, $section, array('visible' => $visibility));
617 // Determine which modules are visible for AJAX update
618 $modules = !empty($section->sequence
) ?
explode(',', $section->sequence
) : array();
619 if (!empty($modules)) {
620 list($insql, $params) = $DB->get_in_or_equal($modules);
621 $select = 'id ' . $insql . ' AND visible = ?';
622 array_push($params, $visibility);
624 $select .= ' AND visibleold = 1';
626 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
629 return $resourcestotoggle;
633 * Return the course category context for the category with id $categoryid, except
634 * that if $categoryid is 0, return the system context.
636 * @param integer $categoryid a category id or 0.
637 * @return context the corresponding context
639 function get_category_or_system_context($categoryid) {
641 return context_coursecat
::instance($categoryid, IGNORE_MISSING
);
643 return context_system
::instance();
648 * Print the buttons relating to course requests.
650 * @param context $context current page context.
652 function print_course_request_buttons($context) {
653 global $CFG, $DB, $OUTPUT;
654 if (empty($CFG->enablecourserequests
)) {
657 if (course_request
::can_request($context)) {
658 // Print a button to request a new course.
660 if ($context instanceof context_coursecat
) {
661 $params['category'] = $context->instanceid
;
663 echo $OUTPUT->single_button(new moodle_url('/course/request.php', $params),
664 get_string('requestcourse'), 'get');
666 /// Print a button to manage pending requests
667 if (has_capability('moodle/site:approvecourse', $context)) {
668 $disabled = !$DB->record_exists('course_request', array());
669 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
674 * Does the user have permission to edit things in this category?
676 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
677 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
679 function can_edit_in_category($categoryid = 0) {
680 $context = get_category_or_system_context($categoryid);
681 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
684 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
686 function add_course_module($mod) {
689 $mod->added
= time();
692 $cmid = $DB->insert_record("course_modules", $mod);
693 rebuild_course_cache($mod->course
, true);
698 * Creates a course section and adds it to the specified position
700 * @param int|stdClass $courseorid course id or course object
701 * @param int $position position to add to, 0 means to the end. If position is greater than
702 * number of existing secitons, the section is added to the end. This will become sectionnum of the
703 * new section. All existing sections at this or bigger position will be shifted down.
704 * @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
705 * @return stdClass created section object
707 function course_create_section($courseorid, $position = 0, $skipcheck = false) {
709 $courseid = is_object($courseorid) ?
$courseorid->id
: $courseorid;
711 // Find the last sectionnum among existing sections.
713 $lastsection = $position - 1;
715 $lastsection = (int)$DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', [$courseid]);
718 // First add section to the end.
719 $cw = new stdClass();
720 $cw->course
= $courseid;
721 $cw->section
= $lastsection +
1;
723 $cw->summaryformat
= FORMAT_HTML
;
727 $cw->availability
= null;
728 $cw->timemodified
= time();
729 $cw->id
= $DB->insert_record("course_sections", $cw);
731 // Now move it to the specified position.
732 if ($position > 0 && $position <= $lastsection) {
733 $course = is_object($courseorid) ?
$courseorid : get_course($courseorid);
734 move_section_to($course, $cw->section
, $position, true);
735 $cw->section
= $position;
738 core\event\course_section_created
::create_from_section($cw)->trigger();
740 rebuild_course_cache($courseid, true);
745 * Creates missing course section(s) and rebuilds course cache
747 * @param int|stdClass $courseorid course id or course object
748 * @param int|array $sections list of relative section numbers to create
749 * @return bool if there were any sections created
751 function course_create_sections_if_missing($courseorid, $sections) {
752 if (!is_array($sections)) {
753 $sections = array($sections);
755 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
756 if ($newsections = array_diff($sections, $existing)) {
757 foreach ($newsections as $sectionnum) {
758 course_create_section($courseorid, $sectionnum, true);
766 * Adds an existing module to the section
768 * Updates both tables {course_sections} and {course_modules}
770 * Note: This function does not use modinfo PROVIDED that the section you are
771 * adding the module to already exists. If the section does not exist, it will
772 * build modinfo if necessary and create the section.
774 * @param int|stdClass $courseorid course id or course object
775 * @param int $cmid id of the module already existing in course_modules table
776 * @param int $sectionnum relative number of the section (field course_sections.section)
777 * If section does not exist it will be created
778 * @param int|stdClass $beforemod id or object with field id corresponding to the module
779 * before which the module needs to be included. Null for inserting in the
781 * @return int The course_sections ID where the module is inserted
783 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
785 if (is_object($beforemod)) {
786 $beforemod = $beforemod->id
;
788 if (is_object($courseorid)) {
789 $courseid = $courseorid->id
;
791 $courseid = $courseorid;
793 // Do not try to use modinfo here, there is no guarantee it is valid!
794 $section = $DB->get_record('course_sections',
795 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING
);
797 // This function call requires modinfo.
798 course_create_sections_if_missing($courseorid, $sectionnum);
799 $section = $DB->get_record('course_sections',
800 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST
);
803 $modarray = explode(",", trim($section->sequence
));
804 if (empty($section->sequence
)) {
805 $newsequence = "$cmid";
806 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
807 $insertarray = array($cmid, $beforemod);
808 array_splice($modarray, $key[0], 1, $insertarray);
809 $newsequence = implode(",", $modarray);
811 $newsequence = "$section->sequence,$cmid";
813 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id
));
814 $DB->set_field('course_modules', 'section', $section->id
, array('id' => $cmid));
815 if (is_object($courseorid)) {
816 rebuild_course_cache($courseorid->id
, true);
818 rebuild_course_cache($courseorid, true);
820 return $section->id
; // Return course_sections ID that was used.
824 * Change the group mode of a course module.
826 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
827 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
829 * @param int $id course module ID.
830 * @param int $groupmode the new groupmode value.
831 * @return bool True if the $groupmode was updated.
833 function set_coursemodule_groupmode($id, $groupmode) {
835 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST
);
836 if ($cm->groupmode
!= $groupmode) {
837 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id
));
838 rebuild_course_cache($cm->course
, true);
840 return ($cm->groupmode
!= $groupmode);
843 function set_coursemodule_idnumber($id, $idnumber) {
845 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST
);
846 if ($cm->idnumber
!= $idnumber) {
847 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id
));
848 rebuild_course_cache($cm->course
, true);
850 return ($cm->idnumber
!= $idnumber);
854 * Set the visibility of a module and inherent properties.
856 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
857 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
859 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
860 * has been moved to {@link set_section_visible()} which was the only place from which
861 * the parameter was used.
863 * @param int $id of the module
864 * @param int $visible state of the module
865 * @param int $visibleoncoursepage state of the module on the course page
866 * @return bool false when the module was not found, true otherwise
868 function set_coursemodule_visible($id, $visible, $visibleoncoursepage = 1) {
870 require_once($CFG->libdir
.'/gradelib.php');
871 require_once($CFG->dirroot
.'/calendar/lib.php');
873 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
877 // Create events and propagate visibility to associated grade items if the value has changed.
878 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
879 if ($cm->visible
== $visible && $cm->visibleoncoursepage
== $visibleoncoursepage) {
883 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module
))) {
886 if (($cm->visible
!= $visible) &&
887 ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename)))) {
888 foreach($events as $event) {
890 $event = new calendar_event($event);
891 $event->toggle_visibility(true);
893 $event = new calendar_event($event);
894 $event->toggle_visibility(false);
899 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
900 // affect visibleold to allow for an original visibility restore. See set_section_visible().
901 $cminfo = new stdClass();
903 $cminfo->visible
= $visible;
904 $cminfo->visibleoncoursepage
= $visibleoncoursepage;
905 $cminfo->visibleold
= $visible;
906 $DB->update_record('course_modules', $cminfo);
908 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
909 // Note that this must be done after updating the row in course_modules, in case
910 // the modules grade_item_update function needs to access $cm->visible.
911 if ($cm->visible
!= $visible &&
912 plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY
) &&
913 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
914 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
915 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
916 } else if ($cm->visible
!= $visible) {
917 $grade_items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance
, 'courseid'=>$cm->course
));
919 foreach ($grade_items as $grade_item) {
920 $grade_item->set_hidden(!$visible);
925 rebuild_course_cache($cm->course
, true);
930 * Changes the course module name
932 * @param int $id course module id
933 * @param string $name new value for a name
934 * @return bool whether a change was made
936 function set_coursemodule_name($id, $name) {
938 require_once($CFG->libdir
. '/gradelib.php');
940 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
942 $module = new \
stdClass();
943 $module->id
= $cm->instance
;
945 // Escape strings as they would be by mform.
946 if (!empty($CFG->formatstringstriptags
)) {
947 $module->name
= clean_param($name, PARAM_TEXT
);
949 $module->name
= clean_param($name, PARAM_CLEANHTML
);
951 if ($module->name
=== $cm->name ||
strval($module->name
) === '') {
954 if (\core_text
::strlen($module->name
) > 255) {
955 throw new \
moodle_exception('maximumchars', 'moodle', '', 255);
958 $module->timemodified
= time();
959 $DB->update_record($cm->modname
, $module);
960 $cm->name
= $module->name
;
961 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
962 rebuild_course_cache($cm->course
, true);
964 // Attempt to update the grade item if relevant.
965 $grademodule = $DB->get_record($cm->modname
, array('id' => $cm->instance
));
966 $grademodule->cmidnumber
= $cm->idnumber
;
967 $grademodule->modname
= $cm->modname
;
968 grade_update_mod_grades($grademodule);
970 // Update calendar events with the new name.
971 course_module_update_calendar_events($cm->modname
, $grademodule, $cm);
977 * This function will handle the whole deletion process of a module. This includes calling
978 * the modules delete_instance function, deleting files, events, grades, conditional data,
979 * the data in the course_module and course_sections table and adding a module deletion
982 * @param int $cmid the course module id
983 * @param bool $async whether or not to try to delete the module using an adhoc task. Async also depends on a plugin hook.
984 * @throws moodle_exception
987 function course_delete_module($cmid, $async = false) {
988 // Check the 'course_module_background_deletion_recommended' hook first.
989 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
990 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
991 // It's up to plugins to handle things like whether or not they are enabled.
992 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
993 foreach ($pluginsfunction as $plugintype => $plugins) {
994 foreach ($plugins as $pluginfunction) {
995 if ($pluginfunction()) {
996 return course_module_flag_for_async_deletion($cmid);
1004 require_once($CFG->libdir
.'/gradelib.php');
1005 require_once($CFG->libdir
.'/questionlib.php');
1006 require_once($CFG->dirroot
.'/blog/lib.php');
1007 require_once($CFG->dirroot
.'/calendar/lib.php');
1009 // Get the course module.
1010 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1014 // Get the module context.
1015 $modcontext = context_module
::instance($cm->id
);
1017 // Get the course module name.
1018 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1020 // Get the file location of the delete_instance function for this module.
1021 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1023 // Include the file required to call the delete_instance function for this module.
1024 if (file_exists($modlib)) {
1025 require_once($modlib);
1027 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1028 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1031 $deleteinstancefunction = $modulename . '_delete_instance';
1033 // Ensure the delete_instance function exists for this module.
1034 if (!function_exists($deleteinstancefunction)) {
1035 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1036 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1039 // Allow plugins to use this course module before we completely delete it.
1040 if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
1041 foreach ($pluginsfunction as $plugintype => $plugins) {
1042 foreach ($plugins as $pluginfunction) {
1043 $pluginfunction($cm);
1048 question_delete_activity($cm);
1050 // Call the delete_instance function, if it returns false throw an exception.
1051 if (!$deleteinstancefunction($cm->instance
)) {
1052 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1053 "Cannot delete the module $modulename (instance).");
1056 // Remove all module files in case modules forget to do that.
1057 $fs = get_file_storage();
1058 $fs->delete_area_files($modcontext->id
);
1060 // Delete events from calendar.
1061 if ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename))) {
1062 $coursecontext = context_course
::instance($cm->course
);
1063 foreach($events as $event) {
1064 $event->context
= $coursecontext;
1065 $calendarevent = calendar_event
::load($event);
1066 $calendarevent->delete();
1070 // Delete grade items, outcome items and grades attached to modules.
1071 if ($grade_items = grade_item
::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1072 'iteminstance' => $cm->instance
, 'courseid' => $cm->course
))) {
1073 foreach ($grade_items as $grade_item) {
1074 $grade_item->delete('moddelete');
1078 // Delete associated blogs and blog tag instances.
1079 blog_remove_associations_for_module($modcontext->id
);
1081 // Delete completion and availability data; it is better to do this even if the
1082 // features are not turned on, in case they were turned on previously (these will be
1083 // very quick on an empty table).
1084 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id
));
1085 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id
,
1086 'course' => $cm->course
,
1087 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY
));
1089 // Delete all tag instances associated with the instance of this module.
1090 core_tag_tag
::delete_instances('mod_' . $modulename, null, $modcontext->id
);
1091 core_tag_tag
::remove_all_item_tags('core', 'course_modules', $cm->id
);
1093 // Notify the competency subsystem.
1094 \core_competency\api
::hook_course_module_deleted($cm);
1096 // Delete the context.
1097 context_helper
::delete_instance(CONTEXT_MODULE
, $cm->id
);
1099 // Delete the module from the course_modules table.
1100 $DB->delete_records('course_modules', array('id' => $cm->id
));
1102 // Delete module from that section.
1103 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
1104 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1105 "Cannot delete the module $modulename (instance) from section.");
1108 // Trigger event for course module delete action.
1109 $event = \core\event\course_module_deleted
::create(array(
1110 'courseid' => $cm->course
,
1111 'context' => $modcontext,
1112 'objectid' => $cm->id
,
1114 'modulename' => $modulename,
1115 'instanceid' => $cm->instance
,
1118 $event->add_record_snapshot('course_modules', $cm);
1120 rebuild_course_cache($cm->course
, true);
1124 * Schedule a course module for deletion in the background using an adhoc task.
1126 * This method should not be called directly. Instead, please use course_delete_module($cmid, true), to denote async deletion.
1127 * The real deletion of the module is handled by the task, which calls 'course_delete_module($cmid)'.
1129 * @param int $cmid the course module id.
1130 * @return bool whether the module was successfully scheduled for deletion.
1131 * @throws \moodle_exception
1133 function course_module_flag_for_async_deletion($cmid) {
1134 global $CFG, $DB, $USER;
1135 require_once($CFG->libdir
.'/gradelib.php');
1136 require_once($CFG->libdir
.'/questionlib.php');
1137 require_once($CFG->dirroot
.'/blog/lib.php');
1138 require_once($CFG->dirroot
.'/calendar/lib.php');
1140 // Get the course module.
1141 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1145 // We need to be reasonably certain the deletion is going to succeed before we background the process.
1146 // Make the necessary delete_instance checks, etc. before proceeding further. Throw exceptions if required.
1148 // Get the course module name.
1149 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1151 // Get the file location of the delete_instance function for this module.
1152 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1154 // Include the file required to call the delete_instance function for this module.
1155 if (file_exists($modlib)) {
1156 require_once($modlib);
1158 throw new \
moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1159 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1162 $deleteinstancefunction = $modulename . '_delete_instance';
1164 // Ensure the delete_instance function exists for this module.
1165 if (!function_exists($deleteinstancefunction)) {
1166 throw new \
moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1167 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1170 // We are going to defer the deletion as we can't be sure how long the module's pre_delete code will run for.
1171 $cm->deletioninprogress
= '1';
1172 $DB->update_record('course_modules', $cm);
1174 // Create an adhoc task for the deletion of the course module. The task takes an array of course modules for removal.
1175 $removaltask = new \core_course\task\
course_delete_modules();
1176 $removaltask->set_custom_data(array(
1177 'cms' => array($cm),
1178 'userid' => $USER->id
,
1179 'realuserid' => \core\session\manager
::get_realuser()->id
1182 // Queue the task for the next run.
1183 \core\task\manager
::queue_adhoc_task($removaltask);
1185 // Reset the course cache to hide the module.
1186 rebuild_course_cache($cm->course
, true);
1190 * Checks whether the given course has any course modules scheduled for adhoc deletion.
1192 * @param int $courseid the id of the course.
1193 * @param bool $onlygradable whether to check only gradable modules or all modules.
1194 * @return bool true if the course contains any modules pending deletion, false otherwise.
1196 function course_modules_pending_deletion(int $courseid, bool $onlygradable = false) : bool {
1197 if (empty($courseid)) {
1201 if ($onlygradable) {
1202 // Fetch modules with grade items.
1203 if (!$coursegradeitems = grade_item
::fetch_all(['itemtype' => 'mod', 'courseid' => $courseid])) {
1204 // Return early when there is none.
1209 $modinfo = get_fast_modinfo($courseid);
1210 foreach ($modinfo->get_cms() as $module) {
1211 if ($module->deletioninprogress
== '1') {
1212 if ($onlygradable) {
1213 // Check if the module being deleted is in the list of course modules with grade items.
1214 foreach ($coursegradeitems as $coursegradeitem) {
1215 if ($coursegradeitem->itemmodule
== $module->modname
&& $coursegradeitem->iteminstance
== $module->instance
) {
1216 // The module being deleted is within the gradable modules.
1229 * Checks whether the course module, as defined by modulename and instanceid, is scheduled for deletion within the given course.
1231 * @param int $courseid the course id.
1232 * @param string $modulename the module name. E.g. 'assign', 'book', etc.
1233 * @param int $instanceid the module instance id.
1234 * @return bool true if the course module is pending deletion, false otherwise.
1236 function course_module_instance_pending_deletion($courseid, $modulename, $instanceid) {
1237 if (empty($courseid) ||
empty($modulename) ||
empty($instanceid)) {
1240 $modinfo = get_fast_modinfo($courseid);
1241 $instances = $modinfo->get_instances_of($modulename);
1242 return isset($instances[$instanceid]) && $instances[$instanceid]->deletioninprogress
;
1245 function delete_mod_from_section($modid, $sectionid) {
1248 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1250 $modarray = explode(",", $section->sequence
);
1252 if ($key = array_keys ($modarray, $modid)) {
1253 array_splice($modarray, $key[0], 1);
1254 $newsequence = implode(",", $modarray);
1255 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id
));
1256 rebuild_course_cache($section->course
, true);
1267 * This function updates the calendar events from the information stored in the module table and the course
1270 * @param string $modulename Module name
1271 * @param stdClass $instance Module object. Either the $instance or the $cm must be supplied.
1272 * @param stdClass $cm Course module object. Either the $instance or the $cm must be supplied.
1273 * @return bool Returns true if calendar events are updated.
1274 * @since Moodle 3.3.4
1276 function course_module_update_calendar_events($modulename, $instance = null, $cm = null) {
1279 if (isset($instance) ||
isset($cm)) {
1281 if (!isset($instance)) {
1282 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1285 $cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
);
1288 course_module_calendar_event_update_process($instance, $cm);
1296 * Update all instances through out the site or in a course.
1298 * @param string $modulename Module type to update.
1299 * @param integer $courseid Course id to update events. 0 for the whole site.
1300 * @return bool Returns True if the update was successful.
1301 * @since Moodle 3.3.4
1303 function course_module_bulk_update_calendar_events($modulename, $courseid = 0) {
1308 if (!$instances = $DB->get_records($modulename, array('course' => $courseid))) {
1312 if (!$instances = $DB->get_records($modulename)) {
1317 foreach ($instances as $instance) {
1318 if ($cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
)) {
1319 course_module_calendar_event_update_process($instance, $cm);
1326 * Calendar events for a module instance are updated.
1328 * @param stdClass $instance Module instance object.
1329 * @param stdClass $cm Course Module object.
1330 * @since Moodle 3.3.4
1332 function course_module_calendar_event_update_process($instance, $cm) {
1333 // We need to call *_refresh_events() first because some modules delete 'old' events at the end of the code which
1334 // will remove the completion events.
1335 $refresheventsfunction = $cm->modname
. '_refresh_events';
1336 if (function_exists($refresheventsfunction)) {
1337 call_user_func($refresheventsfunction, $cm->course
, $instance, $cm);
1339 $completionexpected = (!empty($cm->completionexpected
)) ?
$cm->completionexpected
: null;
1340 \core_completion\api
::update_completion_date_event($cm->id
, $cm->modname
, $instance, $completionexpected);
1344 * Moves a section within a course, from a position to another.
1345 * Be very careful: $section and $destination refer to section number,
1348 * @param object $course
1349 * @param int $section Section number (not id!!!)
1350 * @param int $destination
1351 * @param bool $ignorenumsections
1352 * @return boolean Result
1354 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1355 /// Moves a whole course section up and down within the course
1358 if (!$destination && $destination != 0) {
1362 // compartibility with course formats using field 'numsections'
1363 $courseformatoptions = course_get_format($course)->get_format_options();
1364 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1365 ($destination > $courseformatoptions['numsections'])) ||
($destination < 1)) {
1369 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1370 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id
),
1371 'section ASC, id ASC', 'id, section')) {
1375 $movedsections = reorder_sections($sections, $section, $destination);
1377 // Update all sections. Do this in 2 steps to avoid breaking database
1378 // uniqueness constraint
1379 $transaction = $DB->start_delegated_transaction();
1380 foreach ($movedsections as $id => $position) {
1381 if ($sections[$id] !== $position) {
1382 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1385 foreach ($movedsections as $id => $position) {
1386 if ($sections[$id] !== $position) {
1387 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1391 // If we move the highlighted section itself, then just highlight the destination.
1392 // Adjust the higlighted section location if we move something over it either direction.
1393 if ($section == $course->marker
) {
1394 course_set_marker($course->id
, $destination);
1395 } elseif ($section > $course->marker
&& $course->marker
>= $destination) {
1396 course_set_marker($course->id
, $course->marker+
1);
1397 } elseif ($section < $course->marker
&& $course->marker
<= $destination) {
1398 course_set_marker($course->id
, $course->marker
-1);
1401 $transaction->allow_commit();
1402 rebuild_course_cache($course->id
, true);
1407 * This method will delete a course section and may delete all modules inside it.
1409 * No permissions are checked here, use {@link course_can_delete_section()} to
1410 * check if section can actually be deleted.
1412 * @param int|stdClass $course
1413 * @param int|stdClass|section_info $section
1414 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1415 * @param bool $async whether or not to try to delete the section using an adhoc task. Async also depends on a plugin hook.
1416 * @return bool whether section was deleted
1418 function course_delete_section($course, $section, $forcedeleteifnotempty = true, $async = false) {
1421 // Prepare variables.
1422 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1423 $sectionnum = (is_object($section)) ?
$section->section
: (int)$section;
1424 $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1426 // No section exists, can't proceed.
1430 // Check the 'course_module_background_deletion_recommended' hook first.
1431 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1432 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1433 // It's up to plugins to handle things like whether or not they are enabled.
1434 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1435 foreach ($pluginsfunction as $plugintype => $plugins) {
1436 foreach ($plugins as $pluginfunction) {
1437 if ($pluginfunction()) {
1438 return course_delete_section_async($section, $forcedeleteifnotempty);
1444 $format = course_get_format($course);
1445 $sectionname = $format->get_section_name($section);
1448 $result = $format->delete_section($section, $forcedeleteifnotempty);
1450 // Trigger an event for course section deletion.
1452 $context = context_course
::instance($courseid);
1453 $event = \core\event\course_section_deleted
::create(
1455 'objectid' => $section->id
,
1456 'courseid' => $courseid,
1457 'context' => $context,
1459 'sectionnum' => $section->section
,
1460 'sectionname' => $sectionname,
1464 $event->add_record_snapshot('course_sections', $section);
1471 * Course section deletion, using an adhoc task for deletion of the modules it contains.
1472 * 1. Schedule all modules within the section for adhoc removal.
1473 * 2. Move all modules to course section 0.
1474 * 3. Delete the resulting empty section.
1476 * @param \stdClass $section the section to schedule for deletion.
1477 * @param bool $forcedeleteifnotempty whether to force section deletion if it contains modules.
1478 * @return bool true if the section was scheduled for deletion, false otherwise.
1480 function course_delete_section_async($section, $forcedeleteifnotempty = true) {
1483 // Objects only, and only valid ones.
1484 if (!is_object($section) ||
empty($section->id
)) {
1488 // Does the object currently exist in the DB for removal (check for stale objects).
1489 $section = $DB->get_record('course_sections', array('id' => $section->id
));
1490 if (!$section ||
!$section->section
) {
1491 // No section exists, or the section is 0. Can't proceed.
1495 // Check whether the section can be removed.
1496 if (!$forcedeleteifnotempty && (!empty($section->sequence
) ||
!empty($section->summary
))) {
1500 $format = course_get_format($section->course
);
1501 $sectionname = $format->get_section_name($section);
1503 // Flag those modules having no existing deletion flag. Some modules may have been scheduled for deletion manually, and we don't
1504 // want to create additional adhoc deletion tasks for these. Moving them to section 0 will suffice.
1505 $affectedmods = $DB->get_records_select('course_modules', 'course = ? AND section = ? AND deletioninprogress <> ?',
1506 [$section->course
, $section->id
, 1], '', 'id');
1507 $DB->set_field('course_modules', 'deletioninprogress', '1', ['course' => $section->course
, 'section' => $section->id
]);
1509 // Move all modules to section 0.
1510 $modules = $DB->get_records('course_modules', ['section' => $section->id
], '');
1511 $sectionzero = $DB->get_record('course_sections', ['course' => $section->course
, 'section' => '0']);
1512 foreach ($modules as $mod) {
1513 moveto_module($mod, $sectionzero);
1516 // Create and queue an adhoc task for the deletion of the modules.
1517 $removaltask = new \core_course\task\
course_delete_modules();
1519 'cms' => $affectedmods,
1520 'userid' => $USER->id
,
1521 'realuserid' => \core\session\manager
::get_realuser()->id
1523 $removaltask->set_custom_data($data);
1524 \core\task\manager
::queue_adhoc_task($removaltask);
1526 // Delete the now empty section, passing in only the section number, which forces the function to fetch a new object.
1527 // The refresh is needed because the section->sequence is now stale.
1528 $result = $format->delete_section($section->section
, $forcedeleteifnotempty);
1530 // Trigger an event for course section deletion.
1532 $context = \context_course
::instance($section->course
);
1533 $event = \core\event\course_section_deleted
::create(
1535 'objectid' => $section->id
,
1536 'courseid' => $section->course
,
1537 'context' => $context,
1539 'sectionnum' => $section->section
,
1540 'sectionname' => $sectionname,
1544 $event->add_record_snapshot('course_sections', $section);
1547 rebuild_course_cache($section->course
, true);
1553 * Updates the course section
1555 * This function does not check permissions or clean values - this has to be done prior to calling it.
1557 * @param int|stdClass $course
1558 * @param stdClass $section record from course_sections table - it will be updated with the new values
1559 * @param array|stdClass $data
1561 function course_update_section($course, $section, $data) {
1564 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1566 // Some fields can not be updated using this method.
1567 $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1568 $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible
);
1569 if (array_key_exists('name', $data) && \core_text
::strlen($data['name']) > 255) {
1570 throw new moodle_exception('maximumchars', 'moodle', '', 255);
1573 // Update record in the DB and course format options.
1574 $data['id'] = $section->id
;
1575 $data['timemodified'] = time();
1576 $DB->update_record('course_sections', $data);
1577 rebuild_course_cache($courseid, true);
1578 course_get_format($courseid)->update_section_format_options($data);
1580 // Update fields of the $section object.
1581 foreach ($data as $key => $value) {
1582 if (property_exists($section, $key)) {
1583 $section->$key = $value;
1587 // Trigger an event for course section update.
1588 $event = \core\event\course_section_updated
::create(
1590 'objectid' => $section->id
,
1591 'courseid' => $courseid,
1592 'context' => context_course
::instance($courseid),
1593 'other' => array('sectionnum' => $section->section
)
1598 // If section visibility was changed, hide the modules in this section too.
1599 if ($changevisibility && !empty($section->sequence
)) {
1600 $modules = explode(',', $section->sequence
);
1601 foreach ($modules as $moduleid) {
1602 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1603 if ($data['visible']) {
1604 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1605 set_coursemodule_visible($moduleid, $cm->visibleold
, $cm->visibleoncoursepage
);
1607 // We hide the section, so we hide the module but we store the original state in visibleold.
1608 set_coursemodule_visible($moduleid, 0, $cm->visibleoncoursepage
);
1609 $DB->set_field('course_modules', 'visibleold', $cm->visible
, array('id' => $moduleid));
1611 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1618 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1620 * @param int|stdClass $course
1621 * @param int|stdClass|section_info $section
1624 function course_can_delete_section($course, $section) {
1625 if (is_object($section)) {
1626 $section = $section->section
;
1629 // Not possible to delete 0-section.
1632 // Course format should allow to delete sections.
1633 if (!course_get_format($course)->can_delete_section($section)) {
1636 // Make sure user has capability to update course and move sections.
1637 $context = context_course
::instance(is_object($course) ?
$course->id
: $course);
1638 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1641 // Make sure user has capability to delete each activity in this section.
1642 $modinfo = get_fast_modinfo($course);
1643 if (!empty($modinfo->sections
[$section])) {
1644 foreach ($modinfo->sections
[$section] as $cmid) {
1645 if (!has_capability('moodle/course:manageactivities', context_module
::instance($cmid))) {
1654 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1655 * an original position number and a target position number, rebuilds the array so that the
1656 * move is made without any duplication of section positions.
1657 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1658 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1660 * @param array $sections
1661 * @param int $origin_position
1662 * @param int $target_position
1665 function reorder_sections($sections, $origin_position, $target_position) {
1666 if (!is_array($sections)) {
1670 // We can't move section position 0
1671 if ($origin_position < 1) {
1672 echo "We can't move section position 0";
1676 // Locate origin section in sections array
1677 if (!$origin_key = array_search($origin_position, $sections)) {
1678 echo "searched position not in sections array";
1679 return false; // searched position not in sections array
1682 // Extract origin section
1683 $origin_section = $sections[$origin_key];
1684 unset($sections[$origin_key]);
1686 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1688 $append_array = array();
1689 foreach ($sections as $id => $position) {
1691 $append_array[$id] = $position;
1692 unset($sections[$id]);
1694 if ($position == $target_position) {
1695 if ($target_position < $origin_position) {
1696 $append_array[$id] = $position;
1697 unset($sections[$id]);
1703 // Append moved section
1704 $sections[$origin_key] = $origin_section;
1706 // Append rest of array (if applicable)
1707 if (!empty($append_array)) {
1708 foreach ($append_array as $id => $position) {
1709 $sections[$id] = $position;
1713 // Renumber positions
1715 foreach ($sections as $id => $p) {
1716 $sections[$id] = $position;
1725 * Move the module object $mod to the specified $section
1726 * If $beforemod exists then that is the module
1727 * before which $modid should be inserted
1729 * @param stdClass|cm_info $mod
1730 * @param stdClass|section_info $section
1731 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1732 * before which the module needs to be included. Null for inserting in the
1733 * end of the section
1734 * @return int new value for module visibility (0 or 1)
1736 function moveto_module($mod, $section, $beforemod=NULL) {
1737 global $OUTPUT, $DB;
1739 // Current module visibility state - return value of this function.
1740 $modvisible = $mod->visible
;
1742 // Remove original module from original section.
1743 if (! delete_mod_from_section($mod->id
, $mod->section
)) {
1744 echo $OUTPUT->notification("Could not delete module from existing section");
1747 // If moving to a hidden section then hide module.
1748 if ($mod->section
!= $section->id
) {
1749 if (!$section->visible
&& $mod->visible
) {
1750 // Module was visible but must become hidden after moving to hidden section.
1752 set_coursemodule_visible($mod->id
, 0);
1753 // Set visibleold to 1 so module will be visible when section is made visible.
1754 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id
));
1756 if ($section->visible
&& !$mod->visible
) {
1757 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1758 set_coursemodule_visible($mod->id
, $mod->visibleold
);
1759 $modvisible = $mod->visibleold
;
1763 // Add the module into the new section.
1764 course_add_cm_to_section($section->course
, $mod->id
, $section->section
, $beforemod);
1769 * Returns the list of all editing actions that current user can perform on the module
1771 * @param cm_info $mod The module to produce editing buttons for
1772 * @param int $indent The current indenting (default -1 means no move left-right actions)
1773 * @param int $sr The section to link back to (used for creating the links)
1774 * @return array array of action_link or pix_icon objects
1776 function course_get_cm_edit_actions(cm_info
$mod, $indent = -1, $sr = null) {
1777 global $COURSE, $SITE, $CFG;
1781 $coursecontext = context_course
::instance($mod->course
);
1782 $modcontext = context_module
::instance($mod->id
);
1783 $courseformat = course_get_format($mod->get_course());
1785 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1786 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1788 // No permission to edit anything.
1789 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1793 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1796 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1797 'editsettings', 'duplicate', 'modhide', 'makeavailable', 'makeunavailable', 'modshow'), 'moodle');
1798 $str->assign
= get_string('assignroles', 'role');
1799 $str->groupsnone
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1800 $str->groupsseparate
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1801 $str->groupsvisible
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1804 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1807 $baseurl->param('sr', $sr);
1812 if ($hasmanageactivities) {
1813 $actions['update'] = new action_menu_link_secondary(
1814 new moodle_url($baseurl, array('update' => $mod->id
)),
1815 new pix_icon('t/edit', '', 'moodle', array('class' => 'iconsmall')),
1817 array('class' => 'editing_update', 'data-action' => 'update')
1822 if ($hasmanageactivities && $indent >= 0) {
1823 $indentlimits = new stdClass();
1824 $indentlimits->min
= 0;
1825 $indentlimits->max
= 16;
1826 if (right_to_left()) { // Exchange arrows on RTL
1827 $rightarrow = 't/left';
1828 $leftarrow = 't/right';
1830 $rightarrow = 't/right';
1831 $leftarrow = 't/left';
1834 if ($indent >= $indentlimits->max
) {
1835 $enabledclass = 'hidden';
1839 $actions['moveright'] = new action_menu_link_secondary(
1840 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '1')),
1841 new pix_icon($rightarrow, '', 'moodle', array('class' => 'iconsmall')),
1843 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright',
1844 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1847 if ($indent <= $indentlimits->min
) {
1848 $enabledclass = 'hidden';
1852 $actions['moveleft'] = new action_menu_link_secondary(
1853 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '-1')),
1854 new pix_icon($leftarrow, '', 'moodle', array('class' => 'iconsmall')),
1856 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft',
1857 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1862 // Hide/Show/Available/Unavailable.
1863 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1864 $allowstealth = !empty($CFG->allowstealth
) && $courseformat->allow_stealth_module_visibility($mod, $mod->get_section_info());
1866 $sectionvisible = $mod->get_section_info()->visible
;
1867 // The module on the course page may be in one of the following states:
1868 // - Available and displayed on the course page ($displayedoncoursepage);
1869 // - Not available and not displayed on the course page ($unavailable);
1870 // - Available but not displayed on the course page ($stealth) - this can also be a visible activity in a hidden section.
1871 $displayedoncoursepage = $mod->visible
&& $mod->visibleoncoursepage
&& $sectionvisible;
1872 $unavailable = !$mod->visible
;
1873 $stealth = $mod->visible
&& (!$mod->visibleoncoursepage ||
!$sectionvisible);
1874 if ($displayedoncoursepage) {
1875 $actions['hide'] = new action_menu_link_secondary(
1876 new moodle_url($baseurl, array('hide' => $mod->id
)),
1877 new pix_icon('t/hide', '', 'moodle', array('class' => 'iconsmall')),
1879 array('class' => 'editing_hide', 'data-action' => 'hide')
1881 } else if (!$displayedoncoursepage && $sectionvisible) {
1882 // Offer to "show" only if the section is visible.
1883 $actions['show'] = new action_menu_link_secondary(
1884 new moodle_url($baseurl, array('show' => $mod->id
)),
1885 new pix_icon('t/show', '', 'moodle', array('class' => 'iconsmall')),
1887 array('class' => 'editing_show', 'data-action' => 'show')
1892 // When making the "stealth" module unavailable we perform the same action as hiding the visible module.
1893 $actions['hide'] = new action_menu_link_secondary(
1894 new moodle_url($baseurl, array('hide' => $mod->id
)),
1895 new pix_icon('t/unblock', '', 'moodle', array('class' => 'iconsmall')),
1896 $str->makeunavailable
,
1897 array('class' => 'editing_makeunavailable', 'data-action' => 'hide', 'data-sectionreturn' => $sr)
1899 } else if ($unavailable && (!$sectionvisible ||
$allowstealth) && $mod->has_view()) {
1900 // Allow to make visually hidden module available in gradebook and other reports by making it a "stealth" module.
1901 // When the section is hidden it is an equivalent of "showing" the module.
1902 // Activities without the link (i.e. labels) can not be made available but hidden on course page.
1903 $action = $sectionvisible ?
'stealth' : 'show';
1904 $actions[$action] = new action_menu_link_secondary(
1905 new moodle_url($baseurl, array($action => $mod->id
)),
1906 new pix_icon('t/block', '', 'moodle', array('class' => 'iconsmall')),
1907 $str->makeavailable
,
1908 array('class' => 'editing_makeavailable', 'data-action' => $action, 'data-sectionreturn' => $sr)
1913 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1914 if (has_all_capabilities($dupecaps, $coursecontext) &&
1915 plugin_supports('mod', $mod->modname
, FEATURE_BACKUP_MOODLE2
) &&
1916 course_allowed_module($mod->get_course(), $mod->modname
)) {
1917 $actions['duplicate'] = new action_menu_link_secondary(
1918 new moodle_url($baseurl, array('duplicate' => $mod->id
)),
1919 new pix_icon('t/copy', '', 'moodle', array('class' => 'iconsmall')),
1921 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sectionreturn' => $sr)
1926 if ($hasmanageactivities && !$mod->coursegroupmodeforce
) {
1927 if (plugin_supports('mod', $mod->modname
, FEATURE_GROUPS
, false)) {
1928 if ($mod->effectivegroupmode
== SEPARATEGROUPS
) {
1929 $nextgroupmode = VISIBLEGROUPS
;
1930 $grouptitle = $str->groupsseparate
;
1931 $actionname = 'groupsseparate';
1932 $nextactionname = 'groupsvisible';
1933 $groupimage = 'i/groups';
1934 } else if ($mod->effectivegroupmode
== VISIBLEGROUPS
) {
1935 $nextgroupmode = NOGROUPS
;
1936 $grouptitle = $str->groupsvisible
;
1937 $actionname = 'groupsvisible';
1938 $nextactionname = 'groupsnone';
1939 $groupimage = 'i/groupv';
1941 $nextgroupmode = SEPARATEGROUPS
;
1942 $grouptitle = $str->groupsnone
;
1943 $actionname = 'groupsnone';
1944 $nextactionname = 'groupsseparate';
1945 $groupimage = 'i/groupn';
1948 $actions[$actionname] = new action_menu_link_primary(
1949 new moodle_url($baseurl, array('id' => $mod->id
, 'groupmode' => $nextgroupmode)),
1950 new pix_icon($groupimage, '', 'moodle', array('class' => 'iconsmall')),
1952 array('class' => 'editing_'. $actionname, 'data-action' => $nextactionname,
1953 'aria-live' => 'assertive', 'data-sectionreturn' => $sr)
1956 $actions['nogroupsupport'] = new action_menu_filler();
1961 if (has_capability('moodle/role:assign', $modcontext)){
1962 $actions['assign'] = new action_menu_link_secondary(
1963 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id
)),
1964 new pix_icon('t/assignroles', '', 'moodle', array('class' => 'iconsmall')),
1966 array('class' => 'editing_assign', 'data-action' => 'assignroles', 'data-sectionreturn' => $sr)
1971 if ($hasmanageactivities) {
1972 $actions['delete'] = new action_menu_link_secondary(
1973 new moodle_url($baseurl, array('delete' => $mod->id
)),
1974 new pix_icon('t/delete', '', 'moodle', array('class' => 'iconsmall')),
1976 array('class' => 'editing_delete', 'data-action' => 'delete', 'data-sectionreturn' => $sr)
1984 * Returns the move action.
1986 * @param cm_info $mod The module to produce a move button for
1987 * @param int $sr The section to link back to (used for creating the links)
1988 * @return The markup for the move action, or an empty string if not available.
1990 function course_get_cm_move(cm_info
$mod, $sr = null) {
1996 $modcontext = context_module
::instance($mod->id
);
1997 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2000 $str = get_strings(array('move'));
2003 if (!isset($baseurl)) {
2004 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2007 $baseurl->param('sr', $sr);
2011 if ($hasmanageactivities) {
2012 $pixicon = 'i/dragdrop';
2014 if (!course_ajax_enabled($mod->get_course())) {
2015 // Override for course frontpage until we get drag/drop working there.
2016 $pixicon = 't/move';
2020 'class' => 'editing_move',
2021 'data-action' => 'move',
2022 'data-sectionreturn' => $sr,
2023 'title' => $str->move
,
2024 'aria-label' => $str->move
,
2026 return html_writer
::link(
2027 new moodle_url($baseurl, ['copy' => $mod->id
]),
2028 $OUTPUT->pix_icon($pixicon, '', 'moodle', ['class' => 'iconsmall']),
2036 * given a course object with shortname & fullname, this function will
2037 * truncate the the number of chars allowed and add ... if it was too long
2039 function course_format_name ($course,$max=100) {
2041 $context = context_course
::instance($course->id
);
2042 $shortname = format_string($course->shortname
, true, array('context' => $context));
2043 $fullname = format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
2044 $str = $shortname.': '. $fullname;
2045 if (core_text
::strlen($str) <= $max) {
2049 return core_text
::substr($str,0,$max-3).'...';
2054 * Is the user allowed to add this type of module to this course?
2055 * @param object $course the course settings. Only $course->id is used.
2056 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2057 * @param \stdClass $user the user to check, defaults to the global user if not provided.
2058 * @return bool whether the current user is allowed to add this type of module to this course.
2060 function course_allowed_module($course, $modname, \stdClass
$user = null) {
2062 $user = $user ??
$USER;
2063 if (is_numeric($modname)) {
2064 throw new coding_exception('Function course_allowed_module no longer
2065 supports numeric module ids. Please update your code to pass the module name.');
2068 $capability = 'mod/' . $modname . ':addinstance';
2069 if (!get_capability_info($capability)) {
2070 // Debug warning that the capability does not exist, but no more than once per page.
2071 static $warned = array();
2072 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
2073 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM
) {
2074 debugging('The module ' . $modname . ' does not define the standard capability ' .
2075 $capability , DEBUG_DEVELOPER
);
2076 $warned[$modname] = 1;
2079 // If the capability does not exist, the module can always be added.
2083 $coursecontext = context_course
::instance($course->id
);
2084 return has_capability($capability, $coursecontext, $user);
2088 * Efficiently moves many courses around while maintaining
2089 * sortorder in order.
2091 * @param array $courseids is an array of course ids
2092 * @param int $categoryid
2093 * @return bool success
2095 function move_courses($courseids, $categoryid) {
2098 if (empty($courseids)) {
2103 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2107 $courseids = array_reverse($courseids);
2108 $newparent = context_coursecat
::instance($category->id
);
2111 list($where, $params) = $DB->get_in_or_equal($courseids);
2112 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2113 foreach ($dbcourses as $dbcourse) {
2114 $course = new stdClass();
2115 $course->id
= $dbcourse->id
;
2116 $course->timemodified
= time();
2117 $course->category
= $category->id
;
2118 $course->sortorder
= $category->sortorder +
get_max_courses_in_category() - $i++
;
2119 if ($category->visible
== 0) {
2120 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2121 // to previous state if somebody unhides the category.
2122 $course->visible
= 0;
2125 $DB->update_record('course', $course);
2127 // Update context, so it can be passed to event.
2128 $context = context_course
::instance($course->id
);
2129 $context->update_moved($newparent);
2131 // Trigger a course updated event.
2132 $event = \core\event\course_updated
::create(array(
2133 'objectid' => $course->id
,
2134 'context' => context_course
::instance($course->id
),
2135 'other' => array('shortname' => $dbcourse->shortname
,
2136 'fullname' => $dbcourse->fullname
,
2137 'updatedfields' => array('category' => $category->id
))
2139 $event->set_legacy_logdata(array($course->id
, 'course', 'move', 'edit.php?id=' . $course->id
, $course->id
));
2142 fix_course_sortorder();
2143 cache_helper
::purge_by_event('changesincourse');
2149 * Returns the display name of the given section that the course prefers
2151 * Implementation of this function is provided by course format
2152 * @see format_base::get_section_name()
2154 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2155 * @param int|stdClass $section Section object from database or just field course_sections.section
2156 * @return string Display name that the course format prefers, e.g. "Week 2"
2158 function get_section_name($courseorid, $section) {
2159 return course_get_format($courseorid)->get_section_name($section);
2163 * Tells if current course format uses sections
2165 * @param string $format Course format ID e.g. 'weeks' $course->format
2168 function course_format_uses_sections($format) {
2169 $course = new stdClass();
2170 $course->format
= $format;
2171 return course_get_format($course)->uses_sections();
2175 * Returns the information about the ajax support in the given source format
2177 * The returned object's property (boolean)capable indicates that
2178 * the course format supports Moodle course ajax features.
2180 * @param string $format
2183 function course_format_ajax_support($format) {
2184 $course = new stdClass();
2185 $course->format
= $format;
2186 return course_get_format($course)->supports_ajax();
2190 * Can the current user delete this course?
2191 * Course creators have exception,
2192 * 1 day after the creation they can sill delete the course.
2193 * @param int $courseid
2196 function can_delete_course($courseid) {
2199 $context = context_course
::instance($courseid);
2201 if (has_capability('moodle/course:delete', $context)) {
2205 // hack: now try to find out if creator created this course recently (1 day)
2206 if (!has_capability('moodle/course:create', $context)) {
2210 $since = time() - 60*60*24;
2211 $course = get_course($courseid);
2213 if ($course->timecreated
< $since) {
2214 return false; // Return if the course was not created in last 24 hours.
2217 $logmanger = get_log_manager();
2218 $readers = $logmanger->get_readers('\core\log\sql_reader');
2219 $reader = reset($readers);
2221 if (empty($reader)) {
2222 return false; // No log reader found.
2226 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2227 $params = array('userid' => $USER->id
, 'since' => $since, 'courseid' => $course->id
, 'eventname' => '\core\event\course_created');
2229 return (bool)$reader->get_events_select_count($select, $params);
2233 * Save the Your name for 'Some role' strings.
2235 * @param integer $courseid the id of this course.
2236 * @param array $data the data that came from the course settings form.
2238 function save_local_role_names($courseid, $data) {
2240 $context = context_course
::instance($courseid);
2242 foreach ($data as $fieldname => $value) {
2243 if (strpos($fieldname, 'role_') !== 0) {
2246 list($ignored, $roleid) = explode('_', $fieldname);
2248 // make up our mind whether we want to delete, update or insert
2250 $DB->delete_records('role_names', array('contextid' => $context->id
, 'roleid' => $roleid));
2252 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id
, 'roleid' => $roleid))) {
2253 $rolename->name
= $value;
2254 $DB->update_record('role_names', $rolename);
2257 $rolename = new stdClass
;
2258 $rolename->contextid
= $context->id
;
2259 $rolename->roleid
= $roleid;
2260 $rolename->name
= $value;
2261 $DB->insert_record('role_names', $rolename);
2263 // This will ensure the course contacts cache is purged..
2264 core_course_category
::role_assignment_changed($roleid, $context);
2269 * Returns options to use in course overviewfiles filemanager
2271 * @param null|stdClass|core_course_list_element|int $course either object that has 'id' property or just the course id;
2272 * may be empty if course does not exist yet (course create form)
2273 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2274 * or null if overviewfiles are disabled
2276 function course_overviewfiles_options($course) {
2278 if (empty($CFG->courseoverviewfileslimit
)) {
2281 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext
), -1, PREG_SPLIT_NO_EMPTY
);
2282 if (in_array('*', $accepted_types) ||
empty($accepted_types)) {
2283 $accepted_types = '*';
2285 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2286 // Make sure extensions are prefixed with dot unless they are valid typegroups
2287 foreach ($accepted_types as $i => $type) {
2288 if (substr($type, 0, 1) !== '.') {
2289 require_once($CFG->libdir
. '/filelib.php');
2290 if (!count(file_get_typegroup('extension', $type))) {
2291 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2292 $accepted_types[$i] = '.'. $type;
2297 if (!empty($corrected)) {
2298 set_config('courseoverviewfilesext', join(',', $accepted_types));
2302 'maxfiles' => $CFG->courseoverviewfileslimit
,
2303 'maxbytes' => $CFG->maxbytes
,
2305 'accepted_types' => $accepted_types
2307 if (!empty($course->id
)) {
2308 $options['context'] = context_course
::instance($course->id
);
2309 } else if (is_int($course) && $course > 0) {
2310 $options['context'] = context_course
::instance($course);
2316 * Create a course and either return a $course object
2318 * Please note this functions does not verify any access control,
2319 * the calling code is responsible for all validation (usually it is the form definition).
2321 * @param array $editoroptions course description editor options
2322 * @param object $data - all the data needed for an entry in the 'course' table
2323 * @return object new course instance
2325 function create_course($data, $editoroptions = NULL) {
2328 //check the categoryid - must be given for all new courses
2329 $category = $DB->get_record('course_categories', array('id'=>$data->category
), '*', MUST_EXIST
);
2331 // Check if the shortname already exists.
2332 if (!empty($data->shortname
)) {
2333 if ($DB->record_exists('course', array('shortname' => $data->shortname
))) {
2334 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2338 // Check if the idnumber already exists.
2339 if (!empty($data->idnumber
)) {
2340 if ($DB->record_exists('course', array('idnumber' => $data->idnumber
))) {
2341 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2345 if (empty($CFG->enablecourserelativedates
)) {
2346 // Make sure we're not setting the relative dates mode when the setting is disabled.
2347 unset($data->relativedatesmode
);
2350 if ($errorcode = course_validate_dates((array)$data)) {
2351 throw new moodle_exception($errorcode);
2354 // Check if timecreated is given.
2355 $data->timecreated
= !empty($data->timecreated
) ?
$data->timecreated
: time();
2356 $data->timemodified
= $data->timecreated
;
2358 // place at beginning of any category
2359 $data->sortorder
= 0;
2361 if ($editoroptions) {
2362 // summary text is updated later, we need context to store the files first
2363 $data->summary
= '';
2364 $data->summary_format
= FORMAT_HTML
;
2367 if (!isset($data->visible
)) {
2368 // data not from form, add missing visibility info
2369 $data->visible
= $category->visible
;
2371 $data->visibleold
= $data->visible
;
2373 $newcourseid = $DB->insert_record('course', $data);
2374 $context = context_course
::instance($newcourseid, MUST_EXIST
);
2376 if ($editoroptions) {
2377 // Save the files used in the summary editor and store
2378 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2379 $DB->set_field('course', 'summary', $data->summary
, array('id'=>$newcourseid));
2380 $DB->set_field('course', 'summaryformat', $data->summary_format
, array('id'=>$newcourseid));
2382 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2383 // Save the course overviewfiles
2384 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2387 // update course format options
2388 course_get_format($newcourseid)->update_course_format_options($data);
2390 $course = course_get_format($newcourseid)->get_course();
2392 fix_course_sortorder();
2393 // purge appropriate caches in case fix_course_sortorder() did not change anything
2394 cache_helper
::purge_by_event('changesincourse');
2396 // Trigger a course created event.
2397 $event = \core\event\course_created
::create(array(
2398 'objectid' => $course->id
,
2399 'context' => context_course
::instance($course->id
),
2400 'other' => array('shortname' => $course->shortname
,
2401 'fullname' => $course->fullname
)
2407 blocks_add_default_course_blocks($course);
2409 // Create default section and initial sections if specified (unless they've already been created earlier).
2410 // We do not want to call course_create_sections_if_missing() because to avoid creating course cache.
2411 $numsections = isset($data->numsections
) ?
$data->numsections
: 0;
2412 $existingsections = $DB->get_fieldset_sql('SELECT section from {course_sections} WHERE course = ?', [$newcourseid]);
2413 $newsections = array_diff(range(0, $numsections), $existingsections);
2414 foreach ($newsections as $sectionnum) {
2415 course_create_section($newcourseid, $sectionnum, true);
2418 // Save any custom role names.
2419 save_local_role_names($course->id
, (array)$data);
2421 // set up enrolments
2422 enrol_course_updated(true, $course, $data);
2424 // Update course tags.
2425 if (isset($data->tags
)) {
2426 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2429 // Save custom fields if there are any of them in the form.
2430 $handler = core_course\customfield\course_handler
::create();
2431 // Make sure to set the handler's parent context first.
2432 $coursecatcontext = context_coursecat
::instance($category->id
);
2433 $handler->set_parent_context($coursecatcontext);
2434 // Save the custom field data.
2435 $data->id
= $course->id
;
2436 $handler->instance_form_save($data, true);
2444 * Please note this functions does not verify any access control,
2445 * the calling code is responsible for all validation (usually it is the form definition).
2447 * @param object $data - all the data needed for an entry in the 'course' table
2448 * @param array $editoroptions course description editor options
2451 function update_course($data, $editoroptions = NULL) {
2454 // Prevent changes on front page course.
2455 if ($data->id
== SITEID
) {
2456 throw new moodle_exception('invalidcourse', 'error');
2459 $oldcourse = course_get_format($data->id
)->get_course();
2460 $context = context_course
::instance($oldcourse->id
);
2462 // Make sure we're not changing whatever the course's relativedatesmode setting is.
2463 unset($data->relativedatesmode
);
2465 // Capture the updated fields for the log data.
2466 $updatedfields = [];
2467 foreach (get_object_vars($oldcourse) as $field => $value) {
2468 if ($field == 'summary_editor') {
2469 if (($data->$field)['text'] !== $value['text']) {
2470 // The summary might be very long, we don't wan't to fill up the log record with the full text.
2471 $updatedfields[$field] = '(updated)';
2473 } else if ($field == 'tags' && isset($data->tags
)) {
2474 // Tags might not have the same array keys, just check the values.
2475 if (array_values($data->$field) !== array_values($value)) {
2476 $updatedfields[$field] = $data->$field;
2479 if (isset($data->$field) && $data->$field != $value) {
2480 $updatedfields[$field] = $data->$field;
2485 $data->timemodified
= time();
2487 if ($editoroptions) {
2488 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2490 if ($overviewfilesoptions = course_overviewfiles_options($data->id
)) {
2491 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2494 // Check we don't have a duplicate shortname.
2495 if (!empty($data->shortname
) && $oldcourse->shortname
!= $data->shortname
) {
2496 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname
, $data->id
))) {
2497 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2501 // Check we don't have a duplicate idnumber.
2502 if (!empty($data->idnumber
) && $oldcourse->idnumber
!= $data->idnumber
) {
2503 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber
, $data->id
))) {
2504 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2508 if ($errorcode = course_validate_dates((array)$data)) {
2509 throw new moodle_exception($errorcode);
2512 if (!isset($data->category
) or empty($data->category
)) {
2513 // prevent nulls and 0 in category field
2514 unset($data->category
);
2516 $changesincoursecat = $movecat = (isset($data->category
) and $oldcourse->category
!= $data->category
);
2518 if (!isset($data->visible
)) {
2519 // data not from form, add missing visibility info
2520 $data->visible
= $oldcourse->visible
;
2523 if ($data->visible
!= $oldcourse->visible
) {
2524 // reset the visibleold flag when manually hiding/unhiding course
2525 $data->visibleold
= $data->visible
;
2526 $changesincoursecat = true;
2529 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category
));
2530 if (empty($newcategory->visible
)) {
2531 // make sure when moving into hidden category the course is hidden automatically
2537 // Set newsitems to 0 if format does not support announcements.
2538 if (isset($data->format
)) {
2539 $newcourseformat = course_get_format((object)['format' => $data->format
]);
2540 if (!$newcourseformat->supports_news()) {
2541 $data->newsitems
= 0;
2545 // Update custom fields if there are any of them in the form.
2546 $handler = core_course\customfield\course_handler
::create();
2547 $handler->instance_form_save($data);
2549 // Update with the new data
2550 $DB->update_record('course', $data);
2551 // make sure the modinfo cache is reset
2552 rebuild_course_cache($data->id
);
2554 // Purge course image cache in case if course image has been updated.
2555 \cache
::make('core', 'course_image')->delete($data->id
);
2557 // update course format options with full course data
2558 course_get_format($data->id
)->update_course_format_options($data, $oldcourse);
2560 $course = $DB->get_record('course', array('id'=>$data->id
));
2563 $newparent = context_coursecat
::instance($course->category
);
2564 $context->update_moved($newparent);
2566 $fixcoursesortorder = $movecat ||
(isset($data->sortorder
) && ($oldcourse->sortorder
!= $data->sortorder
));
2567 if ($fixcoursesortorder) {
2568 fix_course_sortorder();
2571 // purge appropriate caches in case fix_course_sortorder() did not change anything
2572 cache_helper
::purge_by_event('changesincourse');
2573 if ($changesincoursecat) {
2574 cache_helper
::purge_by_event('changesincoursecat');
2577 // Test for and remove blocks which aren't appropriate anymore
2578 blocks_remove_inappropriate($course);
2580 // Save any custom role names.
2581 save_local_role_names($course->id
, $data);
2583 // update enrol settings
2584 enrol_course_updated(false, $course, $data);
2586 // Update course tags.
2587 if (isset($data->tags
)) {
2588 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2591 // Trigger a course updated event.
2592 $event = \core\event\course_updated
::create(array(
2593 'objectid' => $course->id
,
2594 'context' => context_course
::instance($course->id
),
2595 'other' => array('shortname' => $course->shortname
,
2596 'fullname' => $course->fullname
,
2597 'updatedfields' => $updatedfields)
2600 $event->set_legacy_logdata(array($course->id
, 'course', 'update', 'edit.php?id=' . $course->id
, $course->id
));
2603 if ($oldcourse->format
!== $course->format
) {
2604 // Remove all options stored for the previous format
2605 // We assume that new course format migrated everything it needed watching trigger
2606 // 'course_updated' and in method format_XXX::update_course_format_options()
2607 $DB->delete_records('course_format_options',
2608 array('courseid' => $course->id
, 'format' => $oldcourse->format
));
2613 * Calculate the average number of enrolled participants per course.
2615 * This is intended for statistics purposes during the site registration. Only visible courses are taken into account.
2616 * Front page enrolments are excluded.
2618 * @param bool $onlyactive Consider only active enrolments in enabled plugins and obey the enrolment time restrictions.
2619 * @param int $lastloginsince If specified, count only users who logged in after this timestamp.
2622 function average_number_of_participants(bool $onlyactive = false, int $lastloginsince = null): float {
2629 $sql = "SELECT DISTINCT ue.userid, e.courseid
2630 FROM {user_enrolments} ue
2631 JOIN {enrol} e ON e.id = ue.enrolid
2632 JOIN {course} c ON c.id = e.courseid ";
2634 if ($onlyactive ||
$lastloginsince) {
2635 $sql .= "JOIN {user} u ON u.id = ue.userid ";
2638 $sql .= "WHERE e.courseid <> :siteid
2639 AND c.visible = 1 ";
2642 $sql .= "AND ue.status = :active
2643 AND e.status = :enabled
2644 AND ue.timestart < :now1
2645 AND (ue.timeend = 0 OR ue.timeend > :now2) ";
2647 // Same as in the enrollib - the rounding should help caching in the database.
2648 $now = round(time(), -2);
2651 'active' => ENROL_USER_ACTIVE
,
2652 'enabled' => ENROL_INSTANCE_ENABLED
,
2658 if ($lastloginsince) {
2659 $sql .= "AND u.lastlogin > :lastlogin ";
2660 $params['lastlogin'] = $lastloginsince;
2663 $sql = "SELECT COUNT(*)
2666 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2668 // Get the number of visible courses (exclude the front page).
2669 $coursetotal = $DB->count_records('course', ['visible' => 1]);
2670 $coursetotal = $coursetotal - 1;
2672 if (empty($coursetotal)) {
2673 $participantaverage = 0;
2676 $participantaverage = $enrolmenttotal / $coursetotal;
2679 return $participantaverage;
2683 * Average number of course modules
2686 function average_number_of_courses_modules() {
2689 //count total of visible course module (except front page)
2690 $sql = 'SELECT COUNT(*) FROM (
2691 SELECT cm.course, cm.module
2692 FROM {course} c, {course_modules} cm
2693 WHERE c.id = cm.course
2696 AND c.visible = 1) total';
2697 $params = array('siteid' => $SITE->id
);
2698 $moduletotal = $DB->count_records_sql($sql, $params);
2701 //count total of visible courses (minus front page)
2702 $coursetotal = $DB->count_records('course', array('visible' => 1));
2703 $coursetotal = $coursetotal - 1 ;
2705 //average of course module
2706 if (empty($coursetotal)) {
2707 $coursemoduleaverage = 0;
2709 $coursemoduleaverage = $moduletotal / $coursetotal;
2712 return $coursemoduleaverage;
2716 * This class pertains to course requests and contains methods associated with
2717 * create, approving, and removing course requests.
2719 * Please note we do not allow embedded images here because there is no context
2720 * to store them with proper access control.
2722 * @copyright 2009 Sam Hemelryk
2723 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2726 * @property-read int $id
2727 * @property-read string $fullname
2728 * @property-read string $shortname
2729 * @property-read string $summary
2730 * @property-read int $summaryformat
2731 * @property-read int $summarytrust
2732 * @property-read string $reason
2733 * @property-read int $requester
2735 class course_request
{
2738 * This is the stdClass that stores the properties for the course request
2739 * and is externally accessed through the __get magic method
2742 protected $properties;
2745 * An array of options for the summary editor used by course request forms.
2746 * This is initially set by {@link summary_editor_options()}
2750 protected static $summaryeditoroptions;
2753 * Static function to prepare the summary editor for working with a course
2757 * @param null|stdClass $data Optional, an object containing the default values
2758 * for the form, these may be modified when preparing the
2759 * editor so this should be called before creating the form
2760 * @return stdClass An object that can be used to set the default values for
2763 public static function prepare($data=null) {
2764 if ($data === null) {
2765 $data = new stdClass
;
2767 $data = file_prepare_standard_editor($data, 'summary', self
::summary_editor_options());
2772 * Static function to create a new course request when passed an array of properties
2775 * This function also handles saving any files that may have been used in the editor
2778 * @param stdClass $data
2779 * @return course_request The newly created course request
2781 public static function create($data) {
2782 global $USER, $DB, $CFG;
2783 $data->requester
= $USER->id
;
2785 // Setting the default category if none set.
2786 if (empty($data->category
) ||
!empty($CFG->lockrequestcategory
)) {
2787 $data->category
= $CFG->defaultrequestcategory
;
2790 // Summary is a required field so copy the text over
2791 $data->summary
= $data->summary_editor
['text'];
2792 $data->summaryformat
= $data->summary_editor
['format'];
2794 $data->id
= $DB->insert_record('course_request', $data);
2796 // Create a new course_request object and return it
2797 $request = new course_request($data);
2799 // Notify the admin if required.
2800 if ($users = get_users_from_config($CFG->courserequestnotify
, 'moodle/site:approvecourse')) {
2803 $a->link
= "$CFG->wwwroot/course/pending.php";
2804 $a->user
= fullname($USER);
2805 $subject = get_string('courserequest');
2806 $message = get_string('courserequestnotifyemail', 'admin', $a);
2807 foreach ($users as $user) {
2808 $request->notify($user, $USER, 'courserequested', $subject, $message);
2816 * Returns an array of options to use with a summary editor
2818 * @uses course_request::$summaryeditoroptions
2819 * @return array An array of options to use with the editor
2821 public static function summary_editor_options() {
2823 if (self
::$summaryeditoroptions === null) {
2824 self
::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2826 return self
::$summaryeditoroptions;
2830 * Loads the properties for this course request object. Id is required and if
2831 * only id is provided then we load the rest of the properties from the database
2833 * @param stdClass|int $properties Either an object containing properties
2834 * or the course_request id to load
2836 public function __construct($properties) {
2838 if (empty($properties->id
)) {
2839 if (empty($properties)) {
2840 throw new coding_exception('You must provide a course request id when creating a course_request object');
2843 $properties = new stdClass
;
2844 $properties->id
= (int)$id;
2847 if (empty($properties->requester
)) {
2848 if (!($this->properties
= $DB->get_record('course_request', array('id' => $properties->id
)))) {
2849 print_error('unknowncourserequest');
2852 $this->properties
= $properties;
2854 $this->properties
->collision
= null;
2858 * Returns the requested property
2860 * @param string $key
2863 public function __get($key) {
2864 return $this->properties
->$key;
2868 * Override this to ensure empty($request->blah) calls return a reliable answer...
2870 * This is required because we define the __get method
2873 * @return bool True is it not empty, false otherwise
2875 public function __isset($key) {
2876 return (!empty($this->properties
->$key));
2880 * Returns the user who requested this course
2882 * Uses a static var to cache the results and cut down the number of db queries
2884 * @staticvar array $requesters An array of cached users
2885 * @return stdClass The user who requested the course
2887 public function get_requester() {
2889 static $requesters= array();
2890 if (!array_key_exists($this->properties
->requester
, $requesters)) {
2891 $requesters[$this->properties
->requester
] = $DB->get_record('user', array('id'=>$this->properties
->requester
));
2893 return $requesters[$this->properties
->requester
];
2897 * Checks that the shortname used by the course does not conflict with any other
2898 * courses that exist
2900 * @param string|null $shortnamemark The string to append to the requests shortname
2901 * should a conflict be found
2902 * @return bool true is there is a conflict, false otherwise
2904 public function check_shortname_collision($shortnamemark = '[*]') {
2907 if ($this->properties
->collision
!== null) {
2908 return $this->properties
->collision
;
2911 if (empty($this->properties
->shortname
)) {
2912 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER
);
2913 $this->properties
->collision
= false;
2914 } else if ($DB->record_exists('course', array('shortname' => $this->properties
->shortname
))) {
2915 if (!empty($shortnamemark)) {
2916 $this->properties
->shortname
.= ' '.$shortnamemark;
2918 $this->properties
->collision
= true;
2920 $this->properties
->collision
= false;
2922 return $this->properties
->collision
;
2926 * Checks user capability to approve a requested course
2928 * If course was requested without category for some reason (might happen if $CFG->defaultrequestcategory is
2929 * misconfigured), we check capabilities 'moodle/site:approvecourse' and 'moodle/course:changecategory'.
2933 public function can_approve() {
2936 if ($this->properties
->category
) {
2937 $category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
);
2938 } else if ($CFG->defaultrequestcategory
) {
2939 $category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
);
2942 return has_capability('moodle/site:approvecourse', $category->get_context());
2945 // We can not determine the context where the course should be created. The approver should have
2946 // both capabilities to approve courses and change course category in the system context.
2947 return has_all_capabilities(['moodle/site:approvecourse', 'moodle/course:changecategory'], context_system
::instance());
2951 * Returns the category where this course request should be created
2953 * Note that we don't check here that user has a capability to view
2954 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2955 * 'moodle/course:changecategory'
2957 * @return core_course_category
2959 public function get_category() {
2961 if ($this->properties
->category
&& ($category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
))) {
2963 } else if ($CFG->defaultrequestcategory
&&
2964 ($category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
))) {
2967 return core_course_category
::get_default();
2972 * This function approves the request turning it into a course
2974 * This function converts the course request into a course, at the same time
2975 * transferring any files used in the summary to the new course and then removing
2976 * the course request and the files associated with it.
2978 * @return int The id of the course that was created from this request
2980 public function approve() {
2981 global $CFG, $DB, $USER;
2983 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
2985 $user = $DB->get_record('user', array('id' => $this->properties
->requester
, 'deleted'=>0), '*', MUST_EXIST
);
2987 $courseconfig = get_config('moodlecourse');
2989 // Transfer appropriate settings
2990 $data = clone($this->properties
);
2992 unset($data->reason
);
2993 unset($data->requester
);
2996 $category = $this->get_category();
2997 $data->category
= $category->id
;
2998 // Set misc settings
2999 $data->requested
= 1;
3001 // Apply course default settings
3002 $data->format
= $courseconfig->format
;
3003 $data->newsitems
= $courseconfig->newsitems
;
3004 $data->showgrades
= $courseconfig->showgrades
;
3005 $data->showreports
= $courseconfig->showreports
;
3006 $data->maxbytes
= $courseconfig->maxbytes
;
3007 $data->groupmode
= $courseconfig->groupmode
;
3008 $data->groupmodeforce
= $courseconfig->groupmodeforce
;
3009 $data->visible
= $courseconfig->visible
;
3010 $data->visibleold
= $data->visible
;
3011 $data->lang
= $courseconfig->lang
;
3012 $data->enablecompletion
= $courseconfig->enablecompletion
;
3013 $data->numsections
= $courseconfig->numsections
;
3014 $data->startdate
= usergetmidnight(time());
3015 if ($courseconfig->courseenddateenabled
) {
3016 $data->enddate
= usergetmidnight(time()) +
$courseconfig->courseduration
;
3019 list($data->fullname
, $data->shortname
) = restore_dbops
::calculate_course_names(0, $data->fullname
, $data->shortname
);
3021 $course = create_course($data);
3022 $context = context_course
::instance($course->id
, MUST_EXIST
);
3024 // add enrol instances
3025 if (!$DB->record_exists('enrol', array('courseid'=>$course->id
, 'enrol'=>'manual'))) {
3026 if ($manual = enrol_get_plugin('manual')) {
3027 $manual->add_default_instance($course);
3031 // enrol the requester as teacher if necessary
3032 if (!empty($CFG->creatornewroleid
) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3033 enrol_try_internal_enrol($course->id
, $user->id
, $CFG->creatornewroleid
);
3038 $a = new stdClass();
3039 $a->name
= format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
3040 $a->url
= $CFG->wwwroot
.'/course/view.php?id=' . $course->id
;
3041 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a), $course->id
);
3047 * Reject a course request
3049 * This function rejects a course request, emailing the requesting user the
3050 * provided notice and then removing the request from the database
3052 * @param string $notice The message to display to the user
3054 public function reject($notice) {
3056 $user = $DB->get_record('user', array('id' => $this->properties
->requester
), '*', MUST_EXIST
);
3057 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3062 * Deletes the course request and any associated files
3064 public function delete() {
3066 $DB->delete_records('course_request', array('id' => $this->properties
->id
));
3070 * Send a message from one user to another using events_trigger
3072 * @param object $touser
3073 * @param object $fromuser
3074 * @param string $name
3075 * @param string $subject
3076 * @param string $message
3077 * @param int|null $courseid
3079 protected function notify($touser, $fromuser, $name, $subject, $message, $courseid = null) {
3080 $eventdata = new \core\message\
message();
3081 $eventdata->courseid
= empty($courseid) ? SITEID
: $courseid;
3082 $eventdata->component
= 'moodle';
3083 $eventdata->name
= $name;
3084 $eventdata->userfrom
= $fromuser;
3085 $eventdata->userto
= $touser;
3086 $eventdata->subject
= $subject;
3087 $eventdata->fullmessage
= $message;
3088 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
3089 $eventdata->fullmessagehtml
= '';
3090 $eventdata->smallmessage
= '';
3091 $eventdata->notification
= 1;
3092 message_send($eventdata);
3096 * Checks if current user can request a course in this context
3098 * @param context $context
3101 public static function can_request(context
$context) {
3103 if (empty($CFG->enablecourserequests
)) {
3106 if (has_capability('moodle/course:create', $context)) {
3110 if ($context instanceof context_system
) {
3111 $defaultcontext = context_coursecat
::instance($CFG->defaultrequestcategory
, IGNORE_MISSING
);
3112 return $defaultcontext &&
3113 has_capability('moodle/course:request', $defaultcontext);
3114 } else if ($context instanceof context_coursecat
) {
3115 if (!$CFG->lockrequestcategory ||
$CFG->defaultrequestcategory
== $context->instanceid
) {
3116 return has_capability('moodle/course:request', $context);
3124 * Return a list of page types
3125 * @param string $pagetype current page type
3126 * @param context $parentcontext Block's parent context
3127 * @param context $currentcontext Current context of block
3128 * @return array array of page types
3130 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3131 if ($pagetype === 'course-index' ||
$pagetype === 'course-index-category') {
3132 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3133 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3134 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3136 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) ||
$coursecontext->instanceid
== SITEID
)) {
3137 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3138 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3140 // Otherwise consider it a page inside a course even if $currentcontext is null
3141 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3142 'course-*' => get_string('page-course-x', 'pagetype'),
3143 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3150 * Determine whether course ajax should be enabled for the specified course
3152 * @param stdClass $course The course to test against
3153 * @return boolean Whether course ajax is enabled or note
3155 function course_ajax_enabled($course) {
3156 global $CFG, $PAGE, $SITE;
3158 // The user must be editing for AJAX to be included
3159 if (!$PAGE->user_is_editing()) {
3163 // Check that the theme suports
3164 if (!$PAGE->theme
->enablecourseajax
) {
3168 // Check that the course format supports ajax functionality
3169 // The site 'format' doesn't have information on course format support
3170 if ($SITE->id
!== $course->id
) {
3171 $courseformatajaxsupport = course_format_ajax_support($course->format
);
3172 if (!$courseformatajaxsupport->capable
) {
3177 // All conditions have been met so course ajax should be enabled
3182 * Include the relevant javascript and language strings for the resource
3183 * toolbox YUI module
3185 * @param integer $id The ID of the course being applied to
3186 * @param array $usedmodules An array containing the names of the modules in use on the page
3187 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3188 * @param stdClass $config An object containing configuration parameters for ajax modules including:
3189 * * resourceurl The URL to post changes to for resource changes
3190 * * sectionurl The URL to post changes to for section changes
3191 * * pageparams Additional parameters to pass through in the post
3194 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3195 global $CFG, $PAGE, $SITE;
3197 // Ensure that ajax should be included
3198 if (!course_ajax_enabled($course)) {
3203 $config = new stdClass();
3206 // The URL to use for resource changes
3207 if (!isset($config->resourceurl
)) {
3208 $config->resourceurl
= '/course/rest.php';
3211 // The URL to use for section changes
3212 if (!isset($config->sectionurl
)) {
3213 $config->sectionurl
= '/course/rest.php';
3216 // Any additional parameters which need to be included on page submission
3217 if (!isset($config->pageparams
)) {
3218 $config->pageparams
= array();
3221 // Include course dragdrop
3222 if (course_format_uses_sections($course->format
)) {
3223 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3225 'courseid' => $course->id
,
3226 'ajaxurl' => $config->sectionurl
,
3227 'config' => $config,
3230 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3232 'courseid' => $course->id
,
3233 'ajaxurl' => $config->resourceurl
,
3234 'config' => $config,
3238 // Require various strings for the command toolbox
3239 $PAGE->requires
->strings_for_js(array(
3242 'deletechecktypename',
3244 'edittitleinstructions',
3252 'clicktochangeinbrackets',
3257 'movecoursesection',
3260 'emptydragdropregion',
3266 // Include section-specific strings for formats which support sections.
3267 if (course_format_uses_sections($course->format
)) {
3268 $PAGE->requires
->strings_for_js(array(
3271 ), 'format_' . $course->format
);
3274 // For confirming resource deletion we need the name of the module in question
3275 foreach ($usedmodules as $module => $modname) {
3276 $PAGE->requires
->string_for_js('pluginname', $module);
3279 // Load drag and drop upload AJAX.
3280 require_once($CFG->dirroot
.'/course/dnduploadlib.php');
3281 dndupload_add_to_course($course, $enabledmodules);
3283 $PAGE->requires
->js_call_amd('core_course/actions', 'initCoursePage', array($course->format
));
3289 * Returns the sorted list of available course formats, filtered by enabled if necessary
3291 * @param bool $enabledonly return only formats that are enabled
3292 * @return array array of sorted format names
3294 function get_sorted_course_formats($enabledonly = false) {
3296 $formats = core_component
::get_plugin_list('format');
3298 if (!empty($CFG->format_plugins_sortorder
)) {
3299 $order = explode(',', $CFG->format_plugins_sortorder
);
3300 $order = array_merge(array_intersect($order, array_keys($formats)),
3301 array_diff(array_keys($formats), $order));
3303 $order = array_keys($formats);
3305 if (!$enabledonly) {
3308 $sortedformats = array();
3309 foreach ($order as $formatname) {
3310 if (!get_config('format_'.$formatname, 'disabled')) {
3311 $sortedformats[] = $formatname;
3314 return $sortedformats;
3318 * The URL to use for the specified course (with section)
3320 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3321 * @param int|stdClass $section Section object from database or just field course_sections.section
3322 * if omitted the course view page is returned
3323 * @param array $options options for view URL. At the moment core uses:
3324 * 'navigation' (bool) if true and section has no separate page, the function returns null
3325 * 'sr' (int) used by multipage formats to specify to which section to return
3326 * @return moodle_url The url of course
3328 function course_get_url($courseorid, $section = null, $options = array()) {
3329 return course_get_format($courseorid)->get_view_url($section, $options);
3336 * - capability checks and other checks
3337 * - create the module from the module info
3339 * @param object $module
3340 * @return object the created module info
3341 * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3343 function create_module($moduleinfo) {
3346 require_once($CFG->dirroot
. '/course/modlib.php');
3348 // Check manadatory attributs.
3349 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3350 if (plugin_supports('mod', $moduleinfo->modulename
, FEATURE_MOD_INTRO
, true)) {
3351 $mandatoryfields[] = 'introeditor';
3353 foreach($mandatoryfields as $mandatoryfield) {
3354 if (!isset($moduleinfo->{$mandatoryfield})) {
3355 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3359 // Some additional checks (capability / existing instances).
3360 $course = $DB->get_record('course', array('id'=>$moduleinfo->course
), '*', MUST_EXIST
);
3361 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename
, $moduleinfo->section
);
3364 $moduleinfo->module
= $module->id
;
3365 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3374 * - capability and other checks
3375 * - update the module
3377 * @param object $module
3378 * @return object the updated module info
3379 * @throws moodle_exception if current user is not allowed to update the module
3381 function update_module($moduleinfo) {
3384 require_once($CFG->dirroot
. '/course/modlib.php');
3386 // Check the course module exists.
3387 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule
, 0, false, MUST_EXIST
);
3389 // Check the course exists.
3390 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
3392 // Some checks (capaibility / existing instances).
3393 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3395 // Retrieve few information needed by update_moduleinfo.
3396 $moduleinfo->modulename
= $cm->modname
;
3397 if (!isset($moduleinfo->scale
)) {
3398 $moduleinfo->scale
= 0;
3400 $moduleinfo->type
= 'mod';
3402 // Update the module.
3403 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3409 * Duplicate a module on the course for ajax.
3411 * @see mod_duplicate_module()
3412 * @param object $course The course
3413 * @param object $cm The course module to duplicate
3414 * @param int $sr The section to link back to (used for creating the links)
3415 * @throws moodle_exception if the plugin doesn't support duplication
3416 * @return Object containing:
3417 * - fullcontent: The HTML markup for the created CM
3418 * - cmid: The CMID of the newly created CM
3419 * - redirect: Whether to trigger a redirect following this change
3421 function mod_duplicate_activity($course, $cm, $sr = null) {
3424 $newcm = duplicate_module($course, $cm);
3426 $resp = new stdClass();
3428 $courserenderer = $PAGE->get_renderer('core', 'course');
3429 $completioninfo = new completion_info($course);
3430 $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3431 $newcm, null, array());
3433 $resp->fullcontent
= $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3434 $resp->cmid
= $newcm->id
;
3436 // Trigger a redirect.
3437 $resp->redirect
= true;
3443 * Api to duplicate a module.
3445 * @param object $course course object.
3446 * @param object $cm course module object to be duplicated.
3450 * @throws coding_exception
3451 * @throws moodle_exception
3452 * @throws restore_controller_exception
3454 * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3456 function duplicate_module($course, $cm) {
3457 global $CFG, $DB, $USER;
3458 require_once($CFG->dirroot
. '/backup/util/includes/backup_includes.php');
3459 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
3460 require_once($CFG->libdir
. '/filelib.php');
3462 $a = new stdClass();
3463 $a->modtype
= get_string('modulename', $cm->modname
);
3464 $a->modname
= format_string($cm->name
);
3466 if (!plugin_supports('mod', $cm->modname
, FEATURE_BACKUP_MOODLE2
)) {
3467 throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3470 // Backup the activity.
3472 $bc = new backup_controller(backup
::TYPE_1ACTIVITY
, $cm->id
, backup
::FORMAT_MOODLE
,
3473 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
);
3475 $backupid = $bc->get_backupid();
3476 $backupbasepath = $bc->get_plan()->get_basepath();
3478 $bc->execute_plan();
3482 // Restore the backup immediately.
3484 $rc = new restore_controller($backupid, $course->id
,
3485 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
, backup
::TARGET_CURRENT_ADDING
);
3487 // Make sure that the restore_general_groups setting is always enabled when duplicating an activity.
3488 $plan = $rc->get_plan();
3489 $groupsetting = $plan->get_setting('groups');
3490 if (empty($groupsetting->get_value())) {
3491 $groupsetting->set_value(true);
3494 $cmcontext = context_module
::instance($cm->id
);
3495 if (!$rc->execute_precheck()) {
3496 $precheckresults = $rc->get_precheck_results();
3497 if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3498 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3499 fulldelete($backupbasepath);
3504 $rc->execute_plan();
3506 // Now a bit hacky part follows - we try to get the cmid of the newly
3507 // restored copy of the module.
3509 $tasks = $rc->get_plan()->get_tasks();
3510 foreach ($tasks as $task) {
3511 if (is_subclass_of($task, 'restore_activity_task')) {
3512 if ($task->get_old_contextid() == $cmcontext->id
) {
3513 $newcmid = $task->get_moduleid();
3521 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3522 fulldelete($backupbasepath);
3525 // If we know the cmid of the new course module, let us move it
3526 // right below the original one. otherwise it will stay at the
3527 // end of the section.
3529 // Proceed with activity renaming before everything else. We don't use APIs here to avoid
3530 // triggering a lot of create/update duplicated events.
3531 $newcm = get_coursemodule_from_id($cm->modname
, $newcmid, $cm->course
);
3532 // Add ' (copy)' to duplicates. Note we don't cleanup or validate lengths here. It comes
3533 // from original name that was valid, so the copy should be too.
3534 $newname = get_string('duplicatedmodule', 'moodle', $newcm->name
);
3535 $DB->set_field($cm->modname
, 'name', $newname, ['id' => $newcm->instance
]);
3537 $section = $DB->get_record('course_sections', array('id' => $cm->section
, 'course' => $cm->course
));
3538 $modarray = explode(",", trim($section->sequence
));
3539 $cmindex = array_search($cm->id
, $modarray);
3540 if ($cmindex !== false && $cmindex < count($modarray) - 1) {
3541 moveto_module($newcm, $section, $modarray[$cmindex +
1]);
3544 // Update calendar events with the duplicated module.
3545 // The following line is to be removed in MDL-58906.
3546 course_module_update_calendar_events($newcm->modname
, null, $newcm);
3548 // Trigger course module created event. We can trigger the event only if we know the newcmid.
3549 $newcm = get_fast_modinfo($cm->course
)->get_cm($newcmid);
3550 $event = \core\event\course_module_created
::create_from_cm($newcm);
3554 return isset($newcm) ?
$newcm : null;
3558 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3559 * Sorts by descending order of time.
3561 * @param stdClass $a First object
3562 * @param stdClass $b Second object
3563 * @return int 0,1,-1 representing the order
3565 function compare_activities_by_time_desc($a, $b) {
3566 // Make sure the activities actually have a timestamp property.
3567 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3570 // We treat instances without timestamp as if they have a timestamp of 0.
3571 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3574 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3577 if ($a->timestamp
== $b->timestamp
) {
3580 return ($a->timestamp
> $b->timestamp
) ?
-1 : 1;
3584 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3585 * Sorts by ascending order of time.
3587 * @param stdClass $a First object
3588 * @param stdClass $b Second object
3589 * @return int 0,1,-1 representing the order
3591 function compare_activities_by_time_asc($a, $b) {
3592 // Make sure the activities actually have a timestamp property.
3593 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3596 // We treat instances without timestamp as if they have a timestamp of 0.
3597 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3600 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3603 if ($a->timestamp
== $b->timestamp
) {
3606 return ($a->timestamp
< $b->timestamp
) ?
-1 : 1;
3610 * Changes the visibility of a course.
3612 * @param int $courseid The course to change.
3613 * @param bool $show True to make it visible, false otherwise.
3616 function course_change_visibility($courseid, $show = true) {
3617 $course = new stdClass
;
3618 $course->id
= $courseid;
3619 $course->visible
= ($show) ?
'1' : '0';
3620 $course->visibleold
= $course->visible
;
3621 update_course($course);
3626 * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3628 * @param stdClass|core_course_list_element $course
3629 * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3632 function course_change_sortorder_by_one($course, $up) {
3634 $params = array($course->sortorder
, $course->category
);
3636 $select = 'sortorder < ? AND category = ?';
3637 $sort = 'sortorder DESC';
3639 $select = 'sortorder > ? AND category = ?';
3640 $sort = 'sortorder ASC';
3642 fix_course_sortorder();
3643 $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3645 $swapcourse = reset($swapcourse);
3646 $DB->set_field('course', 'sortorder', $swapcourse->sortorder
, array('id' => $course->id
));
3647 $DB->set_field('course', 'sortorder', $course->sortorder
, array('id' => $swapcourse->id
));
3648 // Finally reorder courses.
3649 fix_course_sortorder();
3650 cache_helper
::purge_by_event('changesincourse');
3657 * Changes the sort order of courses in a category so that the first course appears after the second.
3659 * @param int|stdClass $courseorid The course to focus on.
3660 * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3663 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3666 if (!is_object($courseorid)) {
3667 $course = get_course($courseorid);
3669 $course = $courseorid;
3672 if ((int)$moveaftercourseid === 0) {
3673 // We've moving the course to the start of the queue.
3674 $sql = 'SELECT sortorder
3676 WHERE category = :categoryid
3677 ORDER BY sortorder';
3679 'categoryid' => $course->category
3681 $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE
);
3683 $sql = 'UPDATE {course}
3684 SET sortorder = sortorder + 1
3685 WHERE category = :categoryid
3688 'categoryid' => $course->category
,
3689 'id' => $course->id
,
3691 $DB->execute($sql, $params);
3692 $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id
));
3693 } else if ($course->id
=== $moveaftercourseid) {
3694 // They're the same - moronic.
3695 debugging("Invalid move after course given.", DEBUG_DEVELOPER
);
3698 // Moving this course after the given course. It could be before it could be after.
3699 $moveaftercourse = get_course($moveaftercourseid);
3700 if ($course->category
!== $moveaftercourse->category
) {
3701 debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER
);
3704 // Increment all courses in the same category that are ordered after the moveafter course.
3705 // This makes a space for the course we're moving.
3706 $sql = 'UPDATE {course}
3707 SET sortorder = sortorder + 1
3708 WHERE category = :categoryid
3709 AND sortorder > :sortorder';
3711 'categoryid' => $moveaftercourse->category
,
3712 'sortorder' => $moveaftercourse->sortorder
3714 $DB->execute($sql, $params);
3715 $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder +
1, array('id' => $course->id
));
3717 fix_course_sortorder();
3718 cache_helper
::purge_by_event('changesincourse');
3723 * Trigger course viewed event. This API function is used when course view actions happens,
3724 * usually in course/view.php but also in external functions.
3726 * @param stdClass $context course context object
3727 * @param int $sectionnumber section number
3730 function course_view($context, $sectionnumber = 0) {
3732 $eventdata = array('context' => $context);
3734 if (!empty($sectionnumber)) {
3735 $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3738 $event = \core\event\course_viewed
::create($eventdata);
3741 user_accesstime_log($context->instanceid
);
3745 * Returns courses tagged with a specified tag.
3747 * @param core_tag_tag $tag
3748 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3749 * are displayed on the page and the per-page limit may be bigger
3750 * @param int $fromctx context id where the link was displayed, may be used by callbacks
3751 * to display items in the same context first
3752 * @param int $ctx context id where to search for records
3753 * @param bool $rec search in subcontexts as well
3754 * @param int $page 0-based number of page being displayed
3755 * @return \core_tag\output\tagindex
3757 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3760 $perpage = $exclusivemode ?
$CFG->coursesperpage
: 5;
3761 $displayoptions = array(
3762 'limit' => $perpage,
3763 'offset' => $page * $perpage,
3764 'viewmoreurl' => null,
3767 $courserenderer = $PAGE->get_renderer('core', 'course');
3768 $totalcount = core_course_category
::search_courses_count(array('tagid' => $tag->id
, 'ctx' => $ctx, 'rec' => $rec));
3769 $content = $courserenderer->tagged_courses($tag->id
, $exclusivemode, $ctx, $rec, $displayoptions);
3770 $totalpages = ceil($totalcount / $perpage);
3772 return new core_tag\output\tagindex
($tag, 'core', 'course', $content,
3773 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3777 * Implements callback inplace_editable() allowing to edit values in-place
3779 * @param string $itemtype
3780 * @param int $itemid
3781 * @param mixed $newvalue
3782 * @return \core\output\inplace_editable
3784 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3785 if ($itemtype === 'activityname') {
3786 return \core_course\output\course_module_name
::update($itemid, $newvalue);
3791 * This function calculates the minimum and maximum cutoff values for the timestart of
3794 * It will return an array with two values, the first being the minimum cutoff value and
3795 * the second being the maximum cutoff value. Either or both values can be null, which
3796 * indicates there is no minimum or maximum, respectively.
3798 * If a cutoff is required then the function must return an array containing the cutoff
3799 * timestamp and error string to display to the user if the cutoff value is violated.
3801 * A minimum and maximum cutoff return value will look like:
3803 * [1505704373, 'The date must be after this date'],
3804 * [1506741172, 'The date must be before this date']
3807 * @param calendar_event $event The calendar event to get the time range for
3808 * @param stdClass $course The course object to get the range from
3809 * @return array Returns an array with min and max date.
3811 function core_course_core_calendar_get_valid_event_timestart_range(\calendar_event
$event, $course) {
3815 if ($course->startdate
) {
3818 get_string('errorbeforecoursestart', 'calendar')
3822 return [$mindate, $maxdate];
3826 * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3828 * This is a callback used by the tag area core/course_modules to search for course modules
3829 * tagged with a specific tag.
3831 * @param core_tag_tag $tag
3832 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3833 * are displayed on the page and the per-page limit may be bigger
3834 * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3835 * to display items in the same context first
3836 * @param int $contextid context id where to search for records
3837 * @param bool $recursivecontext search in subcontexts as well
3838 * @param int $page 0-based number of page being displayed
3839 * @return \core_tag\output\tagindex
3841 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3842 $recursivecontext = 1, $page = 0) {
3844 $perpage = $exclusivemode ?
20 : 5;
3846 // Build select query.
3847 $ctxselect = context_helper
::get_preload_record_columns_sql('ctx');
3848 $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3849 FROM {course_modules} cm
3850 JOIN {tag_instance} tt ON cm.id = tt.itemid
3851 JOIN {course} c ON cm.course = c.id
3852 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3853 WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3854 AND cm.deletioninprogress = 0
3855 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3857 $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id
, 'component' => 'core',
3858 'coursemodulecontextlevel' => CONTEXT_MODULE
);
3860 $context = context
::instance_by_id($contextid);
3861 $query .= $recursivecontext ?
' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3862 $params['contextid'] = $context->id
;
3863 $params['path'] = $context->path
.'/%';
3866 $query .= ' ORDER BY';
3867 if ($fromcontextid) {
3868 // In order-clause specify that modules from inside "fromctx" context should be returned first.
3869 $fromcontext = context
::instance_by_id($fromcontextid);
3870 $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3871 $params['fromcontextid'] = $fromcontext->id
;
3872 $params['frompath'] = $fromcontext->path
.'/%';
3874 $query .= ' c.sortorder, cm.id';
3875 $totalpages = $page +
1;
3877 // Use core_tag_index_builder to build and filter the list of items.
3878 // Request one item more than we need so we know if next page exists.
3879 $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage +
1);
3880 while ($item = $builder->has_item_that_needs_access_check()) {
3881 context_helper
::preload_from_record($item);
3882 $courseid = $item->courseid
;
3883 if (!$builder->can_access_course($courseid)) {
3884 $builder->set_accessible($item, false);
3887 $modinfo = get_fast_modinfo($builder->get_course($courseid));
3888 // Set accessibility of this item and all other items in the same course.
3889 $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3890 if ($taggeditem->courseid
== $courseid) {
3891 $cm = $modinfo->get_cm($taggeditem->cmid
);
3892 $builder->set_accessible($taggeditem, $cm->uservisible
);
3897 $items = $builder->get_items();
3898 if (count($items) > $perpage) {
3899 $totalpages = $page +
2; // We don't need exact page count, just indicate that the next page exists.
3903 // Build the display contents.
3905 $tagfeed = new core_tag\output\tagfeed
();
3906 foreach ($items as $item) {
3907 context_helper
::preload_from_record($item);
3908 $course = $builder->get_course($item->courseid
);
3909 $modinfo = get_fast_modinfo($course);
3910 $cm = $modinfo->get_cm($item->cmid
);
3911 $courseurl = course_get_url($item->courseid
, $cm->sectionnum
);
3912 $cmname = $cm->get_formatted_name();
3913 if (!$exclusivemode) {
3914 $cmname = shorten_text($cmname, 100);
3916 $cmname = html_writer
::link($cm->url?
:$courseurl, $cmname);
3917 $coursename = format_string($course->fullname
, true,
3918 array('context' => context_course
::instance($item->courseid
)));
3919 $coursename = html_writer
::link($courseurl, $coursename);
3920 $icon = html_writer
::empty_tag('img', array('src' => $cm->get_icon_url()));
3921 $tagfeed->add($icon, $cmname, $coursename);
3924 $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3925 $tagfeed->export_for_template($OUTPUT));
3927 return new core_tag\output\tagindex
($tag, 'core', 'course_modules', $content,
3928 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3933 * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3934 * This function also handles the frontpage course.
3936 * @param stdClass $context context object (it can be a course context or the system context for frontpage settings)
3937 * @param stdClass $course the course where the settings are being rendered
3938 * @return stdClass the navigation options in a course and their availability status
3941 function course_get_user_navigation_options($context, $course = null) {
3944 $isloggedin = isloggedin();
3945 $isguestuser = isguestuser();
3946 $isfrontpage = $context->contextlevel
== CONTEXT_SYSTEM
;
3949 $sitecontext = $context;
3951 $sitecontext = context_system
::instance();
3954 // Sets defaults for all options.
3955 $options = (object) [
3958 'calendar' => false,
3959 'competencies' => false,
3962 'participants' => false,
3967 $options->blogs
= !empty($CFG->enableblogs
) &&
3968 ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL ||
3969 ($CFG->bloglevel
== BLOG_SITE_LEVEL
and ($isloggedin and !$isguestuser)))
3970 && has_capability('moodle/blog:view', $sitecontext);
3972 $options->notes
= !empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
3974 // Frontpage settings?
3976 // We are on the front page, so make sure we use the proper capability (site:viewparticipants).
3977 $options->participants
= course_can_view_participants($sitecontext);
3978 $options->badges
= !empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $sitecontext);
3979 $options->tags
= !empty($CFG->usetags
) && $isloggedin;
3980 $options->search
= !empty($CFG->enableglobalsearch
) && has_capability('moodle/search:query', $sitecontext);
3981 $options->calendar
= $isloggedin;
3983 // We are in a course, so make sure we use the proper capability (course:viewparticipants).
3984 $options->participants
= course_can_view_participants($context);
3985 $options->badges
= !empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
3986 has_capability('moodle/badges:viewbadges', $context);
3987 // Add view grade report is permitted.
3990 if (has_capability('moodle/grade:viewall', $context)) {
3992 } else if (!empty($course->showgrades
)) {
3993 $reports = core_component
::get_plugin_list('gradereport');
3994 if (is_array($reports) && count($reports) > 0) { // Get all installed reports.
3995 arsort($reports); // User is last, we want to test it first.
3996 foreach ($reports as $plugin => $plugindir) {
3997 if (has_capability('gradereport/'.$plugin.':view', $context)) {
3998 // Stop when the first visible plugin is found.
4005 $options->grades
= $grades;
4008 if (\core_competency\api
::is_enabled()) {
4009 $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
4010 $options->competencies
= has_any_capability($capabilities, $context);
4016 * Return an object with the list of administration options in a course that are available or not for the current user.
4017 * This function also handles the frontpage settings.
4019 * @param stdClass $course course object (for frontpage it should be a clone of $SITE)
4020 * @param stdClass $context context object (course context)
4021 * @return stdClass the administration options in a course and their availability status
4024 function course_get_user_administration_options($course, $context) {
4026 $isfrontpage = $course->id
== SITEID
;
4027 $completionenabled = $CFG->enablecompletion
&& $course->enablecompletion
;
4028 $hascompletiontabs = count(core_completion\manager
::get_available_completion_tabs($course, $context)) > 0;
4029 $options = new stdClass
;
4030 $options->update
= has_capability('moodle/course:update', $context);
4031 $options->editcompletion
= $CFG->enablecompletion
&&
4032 $course->enablecompletion
&&
4033 ($options->update ||
$hascompletiontabs);
4034 $options->filters
= has_capability('moodle/filter:manage', $context) &&
4035 count(filter_get_available_in_context($context)) > 0;
4036 $options->reports
= has_capability('moodle/site:viewreports', $context);
4037 $options->backup
= has_capability('moodle/backup:backupcourse', $context);
4038 $options->restore
= has_capability('moodle/restore:restorecourse', $context);
4039 $options->copy
= \core_course\management\helper
::can_copy_course($course->id
);
4040 $options->files
= ($course->legacyfiles
== 2 && has_capability('moodle/course:managefiles', $context));
4042 if (!$isfrontpage) {
4043 $options->tags
= has_capability('moodle/course:tag', $context);
4044 $options->gradebook
= has_capability('moodle/grade:manage', $context);
4045 $options->outcomes
= !empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $context);
4046 $options->badges
= !empty($CFG->enablebadges
);
4047 $options->import
= has_capability('moodle/restore:restoretargetimport', $context);
4048 $options->reset
= has_capability('moodle/course:reset', $context);
4049 $options->roles
= has_capability('moodle/role:switchroles', $context);
4051 // Set default options to false.
4052 $listofoptions = array('tags', 'gradebook', 'outcomes', 'badges', 'import', 'publish', 'reset', 'roles', 'grades');
4054 foreach ($listofoptions as $option) {
4055 $options->$option = false;
4063 * Validates course start and end dates.
4065 * Checks that the end course date is not greater than the start course date.
4067 * $coursedata['startdate'] or $coursedata['enddate'] may not be set, it depends on the form and user input.
4069 * @param array $coursedata May contain startdate and enddate timestamps, depends on the user input.
4070 * @return mixed False if everything alright, error codes otherwise.
4072 function course_validate_dates($coursedata) {
4074 // If both start and end dates are set end date should be later than the start date.
4075 if (!empty($coursedata['startdate']) && !empty($coursedata['enddate']) &&
4076 ($coursedata['enddate'] < $coursedata['startdate'])) {
4077 return 'enddatebeforestartdate';
4080 // If start date is not set end date can not be set.
4081 if (empty($coursedata['startdate']) && !empty($coursedata['enddate'])) {
4082 return 'nostartdatenoenddate';
4089 * Check for course updates in the given context level instances (only modules supported right Now)
4091 * @param stdClass $course course object
4092 * @param array $tocheck instances to check for updates
4093 * @param array $filter check only for updates in these areas
4094 * @return array list of warnings and instances with updates information
4097 function course_check_updates($course, $tocheck, $filter = array()) {
4100 $instances = array();
4101 $warnings = array();
4102 $modulescallbacksupport = array();
4103 $modinfo = get_fast_modinfo($course);
4105 $supportedplugins = get_plugin_list_with_function('mod', 'check_updates_since');
4108 foreach ($tocheck as $instance) {
4109 if ($instance['contextlevel'] == 'module') {
4110 // Check module visibility.
4112 $cm = $modinfo->get_cm($instance['id']);
4113 } catch (Exception
$e) {
4114 $warnings[] = array(
4116 'itemid' => $instance['id'],
4117 'warningcode' => 'cmidnotincourse',
4118 'message' => 'This module id does not belong to this course.'
4123 if (!$cm->uservisible
) {
4124 $warnings[] = array(
4126 'itemid' => $instance['id'],
4127 'warningcode' => 'nonuservisible',
4128 'message' => 'You don\'t have access to this module.'
4132 if (empty($supportedplugins['mod_' . $cm->modname
])) {
4133 $warnings[] = array(
4135 'itemid' => $instance['id'],
4136 'warningcode' => 'missingcallback',
4137 'message' => 'This module does not implement the check_updates_since callback: ' . $instance['contextlevel'],
4141 // Retrieve the module instance.
4142 $instances[] = array(
4143 'contextlevel' => $instance['contextlevel'],
4144 'id' => $instance['id'],
4145 'updates' => call_user_func($cm->modname
. '_check_updates_since', $cm, $instance['since'], $filter)
4149 $warnings[] = array(
4150 'item' => 'contextlevel',
4151 'itemid' => $instance['id'],
4152 'warningcode' => 'contextlevelnotsupported',
4153 'message' => 'Context level not yet supported ' . $instance['contextlevel'],
4157 return array($instances, $warnings);
4161 * This function classifies a course as past, in progress or future.
4163 * This function may incur a DB hit to calculate course completion.
4164 * @param stdClass $course Course record
4165 * @param stdClass $user User record (optional - defaults to $USER).
4166 * @param completion_info $completioninfo Completion record for the user (optional - will be fetched if required).
4167 * @return string (one of COURSE_TIMELINE_FUTURE, COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_PAST)
4169 function course_classify_for_timeline($course, $user = null, $completioninfo = null) {
4172 if ($user == null) {
4178 if (!empty($course->enddate
) && (course_classify_end_date($course) < $today)) {
4179 return COURSE_TIMELINE_PAST
;
4182 if ($completioninfo == null) {
4183 $completioninfo = new completion_info($course);
4186 // Course was completed.
4187 if ($completioninfo->is_enabled() && $completioninfo->is_course_complete($user->id
)) {
4188 return COURSE_TIMELINE_PAST
;
4191 // Start date not reached.
4192 if (!empty($course->startdate
) && (course_classify_start_date($course) > $today)) {
4193 return COURSE_TIMELINE_FUTURE
;
4196 // Everything else is in progress.
4197 return COURSE_TIMELINE_INPROGRESS
;
4201 * This function calculates the end 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 enddate.
4207 function course_classify_end_date($course) {
4209 $coursegraceperiodafter = (empty($CFG->coursegraceperiodafter
)) ?
0 : $CFG->coursegraceperiodafter
;
4210 $enddate = (new \
DateTimeImmutable())->setTimestamp($course->enddate
)->modify("+{$coursegraceperiodafter} days");
4211 return $enddate->getTimestamp();
4215 * This function calculates the start date to use for display classification purposes,
4216 * incorporating the grace period, if any.
4218 * @param stdClass $course The course record.
4219 * @return int The new startdate.
4221 function course_classify_start_date($course) {
4223 $coursegraceperiodbefore = (empty($CFG->coursegraceperiodbefore
)) ?
0 : $CFG->coursegraceperiodbefore
;
4224 $startdate = (new \
DateTimeImmutable())->setTimestamp($course->startdate
)->modify("-{$coursegraceperiodbefore} days");
4225 return $startdate->getTimestamp();
4229 * Group a list of courses into either past, future, or in progress.
4231 * The return value will be an array indexed by the COURSE_TIMELINE_* constants
4232 * with each value being an array of courses in that group.
4235 * COURSE_TIMELINE_PAST => [... list of past courses ...],
4236 * COURSE_TIMELINE_FUTURE => [],
4237 * COURSE_TIMELINE_INPROGRESS => []
4240 * @param array $courses List of courses to be grouped.
4243 function course_classify_courses_for_timeline(array $courses) {
4244 return array_reduce($courses, function($carry, $course) {
4245 $classification = course_classify_for_timeline($course);
4246 array_push($carry[$classification], $course);
4250 COURSE_TIMELINE_PAST
=> [],
4251 COURSE_TIMELINE_FUTURE
=> [],
4252 COURSE_TIMELINE_INPROGRESS
=> []
4257 * Get the list of enrolled courses for the current user.
4259 * This function returns a Generator. The courses will be loaded from the database
4260 * in chunks rather than a single query.
4262 * @param int $limit Restrict result set to this amount
4263 * @param int $offset Skip this number of records from the start of the result set
4264 * @param string|null $sort SQL string for sorting
4265 * @param string|null $fields SQL string for fields to be returned
4266 * @param int $dbquerylimit The number of records to load per DB request
4267 * @param array $includecourses courses ids to be restricted
4268 * @param array $hiddencourses courses ids to be excluded
4271 function course_get_enrolled_courses_for_logged_in_user(
4274 string $sort = null,
4275 string $fields = null,
4276 int $dbquerylimit = COURSE_DB_QUERY_LIMIT
,
4277 array $includecourses = [],
4278 array $hiddencourses = []
4281 $haslimit = !empty($limit);
4283 $querylimit = (!$haslimit ||
$limit > $dbquerylimit) ?
$dbquerylimit : $limit;
4285 while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, $includecourses, false, $offset, $hiddencourses)) {
4286 yield from
$courses;
4288 $recordsloaded +
= $querylimit;
4290 if (count($courses) < $querylimit) {
4293 if ($haslimit && $recordsloaded >= $limit) {
4297 $offset +
= $querylimit;
4302 * Search the given $courses for any that match the given $classification up to the specified
4305 * This function will return the subset of courses that match the classification as well as the
4306 * number of courses it had to process to build that subset.
4308 * It is recommended that for larger sets of courses this function is given a Generator that loads
4309 * the courses from the database in chunks.
4311 * @param array|Traversable $courses List of courses to process
4312 * @param string $classification One of the COURSE_TIMELINE_* constants
4313 * @param int $limit Limit the number of results to this amount
4314 * @return array First value is the filtered courses, second value is the number of courses processed
4316 function course_filter_courses_by_timeline_classification(
4318 string $classification,
4322 if (!in_array($classification,
4323 [COURSE_TIMELINE_ALLINCLUDINGHIDDEN
, COURSE_TIMELINE_ALL
, COURSE_TIMELINE_PAST
, COURSE_TIMELINE_INPROGRESS
,
4324 COURSE_TIMELINE_FUTURE
, COURSE_TIMELINE_HIDDEN
])) {
4325 $message = 'Classification must be one of COURSE_TIMELINE_ALLINCLUDINGHIDDEN, COURSE_TIMELINE_ALL, COURSE_TIMELINE_PAST, '
4326 . 'COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_FUTURE';
4327 throw new moodle_exception($message);
4330 $filteredcourses = [];
4331 $numberofcoursesprocessed = 0;
4334 foreach ($courses as $course) {
4335 $numberofcoursesprocessed++
;
4336 $pref = get_user_preferences('block_myoverview_hidden_course_' . $course->id
, 0);
4338 // Added as of MDL-63457 toggle viewability for each user.
4339 if ($classification == COURSE_TIMELINE_ALLINCLUDINGHIDDEN ||
($classification == COURSE_TIMELINE_HIDDEN
&& $pref) ||
4340 (($classification == COURSE_TIMELINE_ALL ||
$classification == course_classify_for_timeline($course)) && !$pref)) {
4341 $filteredcourses[] = $course;
4345 if ($limit && $filtermatches >= $limit) {
4346 // We've found the number of requested courses. No need to continue searching.
4351 // Return the number of filtered courses as well as the number of courses that were searched
4352 // in order to find the matching courses. This allows the calling code to do some kind of
4354 return [$filteredcourses, $numberofcoursesprocessed];
4358 * Search the given $courses for any that match the given $classification up to the specified
4361 * This function will return the subset of courses that are favourites as well as the
4362 * number of courses it had to process to build that subset.
4364 * It is recommended that for larger sets of courses this function is given a Generator that loads
4365 * the courses from the database in chunks.
4367 * @param array|Traversable $courses List of courses to process
4368 * @param array $favouritecourseids Array of favourite courses.
4369 * @param int $limit Limit the number of results to this amount
4370 * @return array First value is the filtered courses, second value is the number of courses processed
4372 function course_filter_courses_by_favourites(
4374 $favouritecourseids,
4378 $filteredcourses = [];
4379 $numberofcoursesprocessed = 0;
4382 foreach ($courses as $course) {
4383 $numberofcoursesprocessed++
;
4385 if (in_array($course->id
, $favouritecourseids)) {
4386 $filteredcourses[] = $course;
4390 if ($limit && $filtermatches >= $limit) {
4391 // We've found the number of requested courses. No need to continue searching.
4396 // Return the number of filtered courses as well as the number of courses that were searched
4397 // in order to find the matching courses. This allows the calling code to do some kind of
4399 return [$filteredcourses, $numberofcoursesprocessed];
4403 * Search the given $courses for any that have a $customfieldname value that matches the given
4404 * $customfieldvalue, up to the specified $limit.
4406 * This function will return the subset of courses that matches the value as well as the
4407 * number of courses it had to process to build that subset.
4409 * It is recommended that for larger sets of courses this function is given a Generator that loads
4410 * the courses from the database in chunks.
4412 * @param array|Traversable $courses List of courses to process
4413 * @param string $customfieldname the shortname of the custom field to match against
4414 * @param string $customfieldvalue the value this custom field needs to match
4415 * @param int $limit Limit the number of results to this amount
4416 * @return array First value is the filtered courses, second value is the number of courses processed
4418 function course_filter_courses_by_customfield(
4430 // Prepare the list of courses to search through.
4432 foreach ($courses as $course) {
4433 $coursesbyid[$course->id
] = $course;
4435 if (!$coursesbyid) {
4438 list($csql, $params) = $DB->get_in_or_equal(array_keys($coursesbyid), SQL_PARAMS_NAMED
);
4440 // Get the id of the custom field.
4443 FROM {customfield_field} f
4444 JOIN {customfield_category} cat ON cat.id = f.categoryid
4445 WHERE f.shortname = ?
4446 AND cat.component = 'core_course'
4447 AND cat.area = 'course'
4449 $fieldid = $DB->get_field_sql($sql, [$customfieldname]);
4454 // Get a list of courseids that match that custom field value.
4455 if ($customfieldvalue == COURSE_CUSTOMFIELD_EMPTY
) {
4456 $comparevalue = $DB->sql_compare_text('cd.value');
4460 LEFT JOIN {customfield_data} cd ON cd.instanceid = c.id AND cd.fieldid = :fieldid
4462 AND (cd.value IS NULL OR $comparevalue = '' OR $comparevalue = '0')
4464 $params['fieldid'] = $fieldid;
4465 $matchcourseids = $DB->get_fieldset_sql($sql, $params);
4467 $comparevalue = $DB->sql_compare_text('value');
4468 $select = "fieldid = :fieldid AND $comparevalue = :customfieldvalue AND instanceid $csql";
4469 $params['fieldid'] = $fieldid;
4470 $params['customfieldvalue'] = $customfieldvalue;
4471 $matchcourseids = $DB->get_fieldset_select('customfield_data', 'instanceid', $select, $params);
4474 // Prepare the list of courses to return.
4475 $filteredcourses = [];
4476 $numberofcoursesprocessed = 0;
4479 foreach ($coursesbyid as $course) {
4480 $numberofcoursesprocessed++
;
4482 if (in_array($course->id
, $matchcourseids)) {
4483 $filteredcourses[] = $course;
4487 if ($limit && $filtermatches >= $limit) {
4488 // We've found the number of requested courses. No need to continue searching.
4493 // Return the number of filtered courses as well as the number of courses that were searched
4494 // in order to find the matching courses. This allows the calling code to do some kind of
4496 return [$filteredcourses, $numberofcoursesprocessed];
4500 * Check module updates since a given time.
4501 * This function checks for updates in the module config, file areas, completion, grades, comments and ratings.
4503 * @param cm_info $cm course module data
4504 * @param int $from the time to check
4505 * @param array $fileareas additional file ares to check
4506 * @param array $filter if we need to filter and return only selected updates
4507 * @return stdClass object with the different updates
4510 function course_check_module_updates_since($cm, $from, $fileareas = array(), $filter = array()) {
4511 global $DB, $CFG, $USER;
4513 $context = $cm->context
;
4514 $mod = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
4516 $updates = new stdClass();
4517 $course = get_course($cm->course
);
4518 $component = 'mod_' . $cm->modname
;
4520 // Check changes in the module configuration.
4521 if (isset($mod->timemodified
) and (empty($filter) or in_array('configuration', $filter))) {
4522 $updates->configuration
= (object) array('updated' => false);
4523 if ($updates->configuration
->updated
= $mod->timemodified
> $from) {
4524 $updates->configuration
->timeupdated
= $mod->timemodified
;
4528 // Check for updates in files.
4529 if (plugin_supports('mod', $cm->modname
, FEATURE_MOD_INTRO
)) {
4530 $fileareas[] = 'intro';
4532 if (!empty($fileareas) and (empty($filter) or in_array('fileareas', $filter))) {
4533 $fs = get_file_storage();
4534 $files = $fs->get_area_files($context->id
, $component, $fileareas, false, "filearea, timemodified DESC", false, $from);
4535 foreach ($fileareas as $filearea) {
4536 $updates->{$filearea . 'files'} = (object) array('updated' => false);
4538 foreach ($files as $file) {
4539 $updates->{$file->get_filearea() . 'files'}->updated
= true;
4540 $updates->{$file->get_filearea() . 'files'}->itemids
[] = $file->get_id();
4544 // Check completion.
4545 $supportcompletion = plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_HAS_RULES
);
4546 $supportcompletion = $supportcompletion or plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_TRACKS_VIEWS
);
4547 if ($supportcompletion and (empty($filter) or in_array('completion', $filter))) {
4548 $updates->completion
= (object) array('updated' => false);
4549 $completion = new completion_info($course);
4550 // Use wholecourse to cache all the modules the first time.
4551 $completiondata = $completion->get_data($cm, true);
4552 if ($updates->completion
->updated
= !empty($completiondata->timemodified
) && $completiondata->timemodified
> $from) {
4553 $updates->completion
->timemodified
= $completiondata->timemodified
;
4558 $supportgrades = plugin_supports('mod', $cm->modname
, FEATURE_GRADE_HAS_GRADE
);
4559 $supportgrades = $supportgrades or plugin_supports('mod', $cm->modname
, FEATURE_GRADE_OUTCOMES
);
4560 if ($supportgrades and (empty($filter) or (in_array('gradeitems', $filter) or in_array('outcomes', $filter)))) {
4561 require_once($CFG->libdir
. '/gradelib.php');
4562 $grades = grade_get_grades($course->id
, 'mod', $cm->modname
, $mod->id
, $USER->id
);
4564 if (empty($filter) or in_array('gradeitems', $filter)) {
4565 $updates->gradeitems
= (object) array('updated' => false);
4566 foreach ($grades->items
as $gradeitem) {
4567 foreach ($gradeitem->grades
as $grade) {
4568 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4569 $updates->gradeitems
->updated
= true;
4570 $updates->gradeitems
->itemids
[] = $gradeitem->id
;
4576 if (empty($filter) or in_array('outcomes', $filter)) {
4577 $updates->outcomes
= (object) array('updated' => false);
4578 foreach ($grades->outcomes
as $outcome) {
4579 foreach ($outcome->grades
as $grade) {
4580 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4581 $updates->outcomes
->updated
= true;
4582 $updates->outcomes
->itemids
[] = $outcome->id
;
4590 if (plugin_supports('mod', $cm->modname
, FEATURE_COMMENT
) and (empty($filter) or in_array('comments', $filter))) {
4591 $updates->comments
= (object) array('updated' => false);
4592 require_once($CFG->dirroot
. '/comment/lib.php');
4593 require_once($CFG->dirroot
. '/comment/locallib.php');
4594 $manager = new comment_manager();
4595 $comments = $manager->get_component_comments_since($course, $context, $component, $from, $cm);
4596 if (!empty($comments)) {
4597 $updates->comments
->updated
= true;
4598 $updates->comments
->itemids
= array_keys($comments);
4603 if (plugin_supports('mod', $cm->modname
, FEATURE_RATE
) and (empty($filter) or in_array('ratings', $filter))) {
4604 $updates->ratings
= (object) array('updated' => false);
4605 require_once($CFG->dirroot
. '/rating/lib.php');
4606 $manager = new rating_manager();
4607 $ratings = $manager->get_component_ratings_since($context, $component, $from);
4608 if (!empty($ratings)) {
4609 $updates->ratings
->updated
= true;
4610 $updates->ratings
->itemids
= array_keys($ratings);
4618 * Returns true if the user can view the participant page, false otherwise,
4620 * @param context $context The context we are checking.
4623 function course_can_view_participants($context) {
4624 $viewparticipantscap = 'moodle/course:viewparticipants';
4625 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4626 $viewparticipantscap = 'moodle/site:viewparticipants';
4629 return has_any_capability([$viewparticipantscap, 'moodle/course:enrolreview'], $context);
4633 * Checks if a user can view the participant page, if not throws an exception.
4635 * @param context $context The context we are checking.
4636 * @throws required_capability_exception
4638 function course_require_view_participants($context) {
4639 if (!course_can_view_participants($context)) {
4640 $viewparticipantscap = 'moodle/course:viewparticipants';
4641 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4642 $viewparticipantscap = 'moodle/site:viewparticipants';
4644 throw new required_capability_exception($context, $viewparticipantscap, 'nopermissions', '');
4649 * Return whether the user can download from the specified backup file area in the given context.
4651 * @param string $filearea the backup file area. E.g. 'course', 'backup' or 'automated'.
4652 * @param \context $context
4653 * @param stdClass $user the user object. If not provided, the current user will be checked.
4654 * @return bool true if the user is allowed to download in the context, false otherwise.
4656 function can_download_from_backup_filearea($filearea, \context
$context, stdClass
$user = null) {
4657 $candownload = false;
4658 switch ($filearea) {
4661 $candownload = has_capability('moodle/backup:downloadfile', $context, $user);
4664 // Given the automated backups may contain userinfo, we restrict access such that only users who are able to
4665 // restore with userinfo are able to download the file. Users can't create these backups, so checking 'backup:userinfo'
4666 // doesn't make sense here.
4667 $candownload = has_capability('moodle/backup:downloadfile', $context, $user) &&
4668 has_capability('moodle/restore:userinfo', $context, $user);
4674 return $candownload;
4678 * Get a list of hidden courses
4680 * @param int|object|null $user User override to get the filter from. Defaults to current user
4681 * @return array $ids List of hidden courses
4682 * @throws coding_exception
4684 function get_hidden_courses_on_timeline($user = null) {
4691 $preferences = get_user_preferences(null, null, $user);
4693 foreach ($preferences as $key => $value) {
4694 if (preg_match('/block_myoverview_hidden_course_(\d)+/', $key)) {
4695 $id = preg_split('/block_myoverview_hidden_course_/', $key);
4704 * Returns a list of the most recently courses accessed by a user
4706 * @param int $userid User id from which the courses will be obtained
4707 * @param int $limit Restrict result set to this amount
4708 * @param int $offset Skip this number of records from the start of the result set
4709 * @param string|null $sort SQL string for sorting
4712 function course_get_recent_courses(int $userid = null, int $limit = 0, int $offset = 0, string $sort = null) {
4714 global $CFG, $USER, $DB;
4716 if (empty($userid)) {
4717 $userid = $USER->id
;
4720 $basefields = array('id', 'idnumber', 'summary', 'summaryformat', 'startdate', 'enddate', 'category',
4721 'shortname', 'fullname', 'timeaccess', 'component', 'visible');
4723 $sort = trim($sort);
4725 $sort = 'timeaccess DESC';
4727 $rawsorts = explode(',', $sort);
4729 foreach ($rawsorts as $rawsort) {
4730 $rawsort = trim($rawsort);
4731 $sorts[] = trim($rawsort);
4733 $sort = implode(',', $sorts);
4736 $orderby = "ORDER BY $sort";
4738 $ctxfields = context_helper
::get_preload_record_columns_sql('ctx');
4740 $coursefields = 'c.' .join(',', $basefields);
4742 // Ask the favourites service to give us the join SQL for favourited courses,
4743 // so we can include favourite information in the query.
4744 $usercontext = \context_user
::instance($userid);
4745 $favservice = \core_favourites\service_factory
::get_service_for_user_context($usercontext);
4746 list($favsql, $favparams) = $favservice->get_join_sql_by_type('core_course', 'courses', 'fav', 'ul.courseid');
4748 $sql = "SELECT $coursefields, $ctxfields
4751 ON ctx.contextlevel = :contextlevel
4752 AND ctx.instanceid = c.id
4753 JOIN {user_lastaccess} ul
4754 ON ul.courseid = c.id
4756 LEFT JOIN {enrol} eg ON eg.courseid = c.id AND eg.status = :statusenrolg AND eg.enrol = :guestenrol
4757 WHERE ul.userid = :userid
4758 AND c.visible = :visible
4759 AND (eg.id IS NOT NULL
4760 OR EXISTS (SELECT e.id
4762 JOIN {user_enrolments} ue ON ue.enrolid = e.id
4763 WHERE e.courseid = c.id
4764 AND e.status = :statusenrol
4765 AND ue.status = :status
4766 AND ue.userid = :userid2
4767 AND ue.timestart < :now1
4768 AND (ue.timeend = 0 OR ue.timeend > :now2)
4772 $now = round(time(), -2); // Improves db caching.
4773 $params = ['userid' => $userid, 'contextlevel' => CONTEXT_COURSE
, 'visible' => 1, 'status' => ENROL_USER_ACTIVE
,
4774 'statusenrol' => ENROL_INSTANCE_ENABLED
, 'guestenrol' => 'guest', 'now1' => $now, 'now2' => $now,
4775 'userid2' => $userid, 'statusenrolg' => ENROL_INSTANCE_ENABLED
] +
$favparams;
4777 $recentcourses = $DB->get_records_sql($sql, $params, $offset, $limit);
4779 // Filter courses if last access field is hidden.
4780 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
4782 if ($userid != $USER->id
&& isset($hiddenfields['lastaccess'])) {
4783 $recentcourses = array_filter($recentcourses, function($course) {
4784 context_helper
::preload_from_record($course);
4785 $context = context_course
::instance($course->id
, IGNORE_MISSING
);
4786 // If last access was a hidden field, a user requesting info about another user would need permission to view hidden
4788 return has_capability('moodle/course:viewhiddenuserfields', $context);
4792 return $recentcourses;
4796 * Calculate the course start date and offset for the given user ids.
4798 * If the course is a fixed date course then the course start date will be returned.
4799 * If the course is a relative date course then the course date will be calculated and
4800 * and offset provided.
4802 * The dates are returned as an array with the index being the user id. The array
4803 * contains the start date and start offset values for the user.
4805 * If the user is not enrolled in the course then the course start date will be returned.
4807 * If we have a course which starts on 1563244000 and 2 users, id 123 and 456, where the
4808 * former is enrolled in the course at 1563244693 and the latter is not enrolled then the
4809 * return value would look like:
4812 * 'start' => 1563244693,
4813 * 'startoffset' => 693
4816 * 'start' => 1563244000,
4817 * 'startoffset' => 0
4821 * @param stdClass $course The course to fetch dates for.
4822 * @param array $userids The list of user ids to get dates for.
4825 function course_get_course_dates_for_user_ids(stdClass
$course, array $userids): array {
4826 if (empty($course->relativedatesmode
)) {
4827 // This course isn't set to relative dates so we can early return with the course
4829 return array_reduce($userids, function($carry, $userid) use ($course) {
4831 'start' => $course->startdate
,
4838 // We're dealing with a relative dates course now so we need to calculate some dates.
4839 $cache = cache
::make('core', 'course_user_dates');
4841 $uncacheduserids = [];
4843 // Try fetching the values from the cache so that we don't need to do a DB request.
4844 foreach ($userids as $userid) {
4845 $cachekey = "{$course->id}_{$userid}";
4846 $cachedvalue = $cache->get($cachekey);
4848 if ($cachedvalue === false) {
4849 // Looks like we haven't seen this user for this course before so we'll have
4851 $uncacheduserids[] = $userid;
4853 [$start, $startoffset] = $cachedvalue;
4856 'startoffset' => $startoffset
4861 if (!empty($uncacheduserids)) {
4862 // Load the enrolments for any users we haven't seen yet. Set the "onlyactive" param
4863 // to false because it filters out users with enrolment start times in the future which
4865 $enrolments = enrol_get_course_users($course->id
, false, $uncacheduserids);
4867 foreach ($uncacheduserids as $userid) {
4868 // Find the user enrolment that has the earliest start date.
4869 $enrolment = array_reduce(array_values($enrolments), function($carry, $enrolment) use ($userid) {
4870 // Only consider enrolments for this user if the user enrolment is active and the
4871 // enrolment method is enabled.
4873 $enrolment->uestatus
== ENROL_USER_ACTIVE
&&
4874 $enrolment->estatus
== ENROL_INSTANCE_ENABLED
&&
4875 $enrolment->id
== $userid
4877 if (is_null($carry)) {
4878 // Haven't found an enrolment yet for this user so use the one we just found.
4879 $carry = $enrolment;
4881 // We've already found an enrolment for this user so let's use which ever one
4882 // has the earliest start time.
4883 $carry = $carry->uetimestart
< $enrolment->uetimestart ?
$carry : $enrolment;
4891 // The course is in relative dates mode so we calculate the student's start
4892 // date based on their enrolment start date.
4893 $start = $course->startdate
> $enrolment->uetimestart ?
$course->startdate
: $enrolment->uetimestart
;
4894 $startoffset = $start - $course->startdate
;
4896 // The user is not enrolled in the course so default back to the course start date.
4897 $start = $course->startdate
;
4903 'startoffset' => $startoffset
4906 $cachekey = "{$course->id}_{$userid}";
4907 $cache->set($cachekey, [$start, $startoffset]);
4915 * Calculate the course start date and offset for the given user id.
4917 * If the course is a fixed date course then the course start date will be returned.
4918 * If the course is a relative date course then the course date will be calculated and
4919 * and offset provided.
4921 * The return array contains the start date and start offset values for the user.
4923 * If the user is not enrolled in the course then the course start date will be returned.
4925 * If we have a course which starts on 1563244000. If a user's enrolment starts on 1563244693
4926 * then the return would be:
4928 * 'start' => 1563244693,
4929 * 'startoffset' => 693
4932 * If the use was not enrolled then the return would be:
4934 * 'start' => 1563244000,
4935 * 'startoffset' => 0
4938 * @param stdClass $course The course to fetch dates for.
4939 * @param int $userid The user id to get dates for.
4942 function course_get_course_dates_for_user_id(stdClass
$course, int $userid): array {
4943 return (course_get_course_dates_for_user_ids($course, [$userid]))[$userid];
4947 * Renders the course copy form for the modal on the course management screen.
4949 * @param array $args
4950 * @return string $o Form HTML.
4952 function course_output_fragment_new_base_form($args) {
4954 $serialiseddata = json_decode($args['jsonformdata'], true);
4956 if (!empty($serialiseddata)) {
4957 parse_str($serialiseddata, $formdata);
4960 $context = context_course
::instance($args['courseid']);
4961 $copycaps = \core_course\management\helper
::get_course_copy_capabilities();
4962 require_all_capabilities($copycaps, $context);
4964 $course = get_course($args['courseid']);
4965 $mform = new \core_backup\output\
copy_form(
4967 array('course' => $course, 'returnto' => '', 'returnurl' => ''),
4968 'post', '', ['class' => 'ignoredirty'], true, $formdata);
4970 if (!empty($serialiseddata)) {
4971 // If we were passed non-empty form data we want the mform to call validation functions and show errors.
4972 $mform->is_validated();
4977 $o = ob_get_contents();