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->dirroot
.'/course/format/lib.php');
31 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
32 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
35 * Number of courses to display when summaries are included.
37 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
39 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
41 // Max courses in log dropdown before switching to optional.
42 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
43 // Max users in log dropdown before switching to optional.
44 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
45 define('FRONTPAGENEWS', '0');
46 define('FRONTPAGECATEGORYNAMES', '2');
47 define('FRONTPAGECATEGORYCOMBO', '4');
48 define('FRONTPAGEENROLLEDCOURSELIST', '5');
49 define('FRONTPAGEALLCOURSELIST', '6');
50 define('FRONTPAGECOURSESEARCH', '7');
51 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 define('COURSE_TIMELINE_PAST', 'past');
59 define('COURSE_TIMELINE_INPROGRESS', 'inprogress');
60 define('COURSE_TIMELINE_FUTURE', 'future');
62 function make_log_url($module, $url) {
65 if (strpos($url, 'report/') === 0) {
66 // there is only one report type, course reports are deprecated
76 if (strpos($url, '../') === 0) {
77 $url = ltrim($url, '.');
79 $url = "/course/$url";
83 $url = "/calendar/$url";
87 $url = "/$module/$url";
100 $url = "/message/$url";
103 $url = "/notes/$url";
112 $url = "/grade/$url";
115 $url = "/mod/$module/$url";
119 //now let's sanitise urls - there might be some ugly nasties:-(
120 $parts = explode('?', $url);
121 $script = array_shift($parts);
122 if (strpos($script, 'http') === 0) {
123 $script = clean_param($script, PARAM_URL
);
125 $script = clean_param($script, PARAM_PATH
);
130 $query = implode('', $parts);
131 $query = str_replace('&', '&', $query); // both & and & are stored in db :-|
132 $parts = explode('&', $query);
133 $eq = urlencode('=');
134 foreach ($parts as $key=>$part) {
135 $part = urlencode(urldecode($part));
136 $part = str_replace($eq, '=', $part);
137 $parts[$key] = $part;
139 $query = '?'.implode('&', $parts);
142 return $script.$query;
146 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
147 $modname="", $modid=0, $modaction="", $groupid=0) {
150 // It is assumed that $date is the GMT time of midnight for that day,
151 // and so the next 86400 seconds worth of logs are printed.
153 /// Setup for group handling.
155 // TODO: I don't understand group/context/etc. enough to be able to do
156 // something interesting with it here
157 // What is the context of a remote course?
159 /// If the group mode is separate, and this user does not have editing privileges,
160 /// then only the user's group can be viewed.
161 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
162 // $groupid = get_current_group($course->id);
164 /// If this course doesn't have groups, no groupid can be specified.
165 //else if (!$course->groupmode) {
174 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
176 LEFT JOIN {user} u ON l.userid = u.id
180 $where .= "l.hostid = :hostid";
181 $params['hostid'] = $hostid;
183 // TODO: Is 1 really a magic number referring to the sitename?
184 if ($course != SITEID ||
$modid != 0) {
185 $where .= " AND l.course=:courseid";
186 $params['courseid'] = $course;
190 $where .= " AND l.module = :modname";
191 $params['modname'] = $modname;
194 if ('site_errors' === $modid) {
195 $where .= " AND ( l.action='error' OR l.action='infected' )";
197 //TODO: This assumes that modids are the same across sites... probably
199 $where .= " AND l.cmid = :modid";
200 $params['modid'] = $modid;
204 $firstletter = substr($modaction, 0, 1);
205 if ($firstletter == '-') {
206 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
207 $params['modaction'] = '%'.substr($modaction, 1).'%';
209 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
210 $params['modaction'] = '%'.$modaction.'%';
215 $where .= " AND l.userid = :user";
216 $params['user'] = $user;
220 $enddate = $date +
86400;
221 $where .= " AND l.time > :date AND l.time < :enddate";
222 $params['date'] = $date;
223 $params['enddate'] = $enddate;
227 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
228 if(!empty($result['totalcount'])) {
229 $where .= " ORDER BY $order";
230 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
232 $result['logs'] = array();
238 * Checks the integrity of the course data.
240 * In summary - compares course_sections.sequence and course_modules.section.
242 * More detailed, checks that:
243 * - course_sections.sequence contains each module id not more than once in the course
244 * - for each moduleid from course_sections.sequence the field course_modules.section
245 * refers to the same section id (this means course_sections.sequence is more
246 * important if they are different)
247 * - ($fullcheck only) each module in the course is present in one of
248 * course_sections.sequence
249 * - ($fullcheck only) removes non-existing course modules from section sequences
251 * If there are any mismatches, the changes are made and records are updated in DB.
253 * Course cache is NOT rebuilt if there are any errors!
255 * This function is used each time when course cache is being rebuilt with $fullcheck = false
256 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
258 * @param int $courseid id of the course
259 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
260 * the list of enabled course modules in the course. Retrieved from DB if not specified.
261 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
262 * @param array $sections records from course_sections table for this course.
263 * Retrieved from DB if not specified
264 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
265 * course modules from sequences. Only to be used in site maintenance mode when we are
266 * sure that another user is not in the middle of the process of moving/removing a module.
267 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
268 * @return array array of messages with found problems. Empty output means everything is ok
270 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
273 if ($sections === null) {
274 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
277 // Retrieve all records from course_modules regardless of module type visibility.
278 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
280 if ($rawmods === null) {
281 $rawmods = get_course_mods($courseid);
283 if (!$fullcheck && (empty($sections) ||
empty($rawmods))) {
284 // If either of the arrays is empty, no modules are displayed anyway.
287 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
289 // First make sure that each module id appears in section sequences only once.
290 // If it appears in several section sequences the last section wins.
291 // If it appears twice in one section sequence, the first occurence wins.
292 $modsection = array();
293 foreach ($sections as $sectionid => $section) {
294 $sections[$sectionid]->newsequence
= $section->sequence
;
295 if (!empty($section->sequence
)) {
296 $sequence = explode(",", $section->sequence
);
297 $sequenceunique = array_unique($sequence);
298 if (count($sequenceunique) != count($sequence)) {
299 // Some course module id appears in this section sequence more than once.
300 ksort($sequenceunique); // Preserve initial order of modules.
301 $sequence = array_values($sequenceunique);
302 $sections[$sectionid]->newsequence
= join(',', $sequence);
303 $messages[] = $debuggingprefix.'Sequence for course section ['.
304 $sectionid.'] is "'.$sections[$sectionid]->sequence
.'", must be "'.$sections[$sectionid]->newsequence
.'"';
306 foreach ($sequence as $cmid) {
307 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
308 // Some course module id appears to be in more than one section's sequences.
309 $wrongsectionid = $modsection[$cmid];
310 $sections[$wrongsectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence
. ','), ',');
311 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
312 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
314 $modsection[$cmid] = $sectionid;
319 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
321 foreach ($rawmods as $cmid => $mod) {
322 if (!isset($modsection[$cmid])) {
323 // This is a module that is not mentioned in course_section.sequence at all.
324 // Add it to the section $mod->section or to the last available section.
325 if ($mod->section
&& isset($sections[$mod->section
])) {
326 $modsection[$cmid] = $mod->section
;
328 $firstsection = reset($sections);
329 $modsection[$cmid] = $firstsection->id
;
331 $sections[$modsection[$cmid]]->newsequence
= trim($sections[$modsection[$cmid]]->newsequence
.','.$cmid, ',');
332 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
333 $modsection[$cmid].']';
336 foreach ($modsection as $cmid => $sectionid) {
337 if (!isset($rawmods[$cmid])) {
338 // Section $sectionid refers to module id that does not exist.
339 $sections[$sectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence
.','), ',');
340 $messages[] = $debuggingprefix.'Course module ['.$cmid.
341 '] does not exist but is present in the sequence of section ['.$sectionid.']';
346 // Update changed sections.
347 if (!$checkonly && !empty($messages)) {
348 foreach ($sections as $sectionid => $section) {
349 if ($section->newsequence
!== $section->sequence
) {
350 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence
));
355 // Now make sure that all modules point to the correct sections.
356 foreach ($rawmods as $cmid => $mod) {
357 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section
) {
359 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
361 $messages[] = $debuggingprefix.'Course module ['.$cmid.
362 '] points to section ['.$mod->section
.'] instead of ['.$modsection[$cmid].']';
370 * For a given course, returns an array of course activity objects
371 * Each item in the array contains he following properties:
373 function get_array_of_activities($courseid) {
374 // cm - course module id
375 // mod - name of the module (eg forum)
376 // section - the number of the section (eg week or topic)
377 // name - the name of the instance
378 // visible - is the instance visible or not
379 // groupingid - grouping id
380 // extra - contains extra string to include in any link
383 $course = $DB->get_record('course', array('id'=>$courseid));
385 if (empty($course)) {
386 throw new moodle_exception('courseidnotfound');
391 $rawmods = get_course_mods($courseid);
392 if (empty($rawmods)) {
393 return $mod; // always return array
395 $courseformat = course_get_format($course);
397 if ($sections = $DB->get_records('course_sections', array('course' => $courseid),
398 'section ASC', 'id,section,sequence,visible')) {
399 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
400 if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
401 debugging(join('<br>', $errormessages));
402 $rawmods = get_course_mods($courseid);
403 $sections = $DB->get_records('course_sections', array('course' => $courseid),
404 'section ASC', 'id,section,sequence,visible');
406 // Build array of activities.
407 foreach ($sections as $section) {
408 if (!empty($section->sequence
)) {
409 $sequence = explode(",", $section->sequence
);
410 foreach ($sequence as $seq) {
411 if (empty($rawmods[$seq])) {
414 // Adjust visibleoncoursepage, value in DB may not respect format availability.
415 $rawmods[$seq]->visibleoncoursepage
= (!$rawmods[$seq]->visible
416 ||
$rawmods[$seq]->visibleoncoursepage
417 ||
empty($CFG->allowstealth
)
418 ||
!$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ?
1 : 0;
420 // Create an object that will be cached.
421 $mod[$seq] = new stdClass();
422 $mod[$seq]->id
= $rawmods[$seq]->instance
;
423 $mod[$seq]->cm
= $rawmods[$seq]->id
;
424 $mod[$seq]->mod
= $rawmods[$seq]->modname
;
426 // Oh dear. Inconsistent names left here for backward compatibility.
427 $mod[$seq]->section
= $section->section
;
428 $mod[$seq]->sectionid
= $rawmods[$seq]->section
;
430 $mod[$seq]->module
= $rawmods[$seq]->module
;
431 $mod[$seq]->added
= $rawmods[$seq]->added
;
432 $mod[$seq]->score
= $rawmods[$seq]->score
;
433 $mod[$seq]->idnumber
= $rawmods[$seq]->idnumber
;
434 $mod[$seq]->visible
= $rawmods[$seq]->visible
;
435 $mod[$seq]->visibleoncoursepage
= $rawmods[$seq]->visibleoncoursepage
;
436 $mod[$seq]->visibleold
= $rawmods[$seq]->visibleold
;
437 $mod[$seq]->groupmode
= $rawmods[$seq]->groupmode
;
438 $mod[$seq]->groupingid
= $rawmods[$seq]->groupingid
;
439 $mod[$seq]->indent
= $rawmods[$seq]->indent
;
440 $mod[$seq]->completion
= $rawmods[$seq]->completion
;
441 $mod[$seq]->extra
= "";
442 $mod[$seq]->completiongradeitemnumber
=
443 $rawmods[$seq]->completiongradeitemnumber
;
444 $mod[$seq]->completionview
= $rawmods[$seq]->completionview
;
445 $mod[$seq]->completionexpected
= $rawmods[$seq]->completionexpected
;
446 $mod[$seq]->showdescription
= $rawmods[$seq]->showdescription
;
447 $mod[$seq]->availability
= $rawmods[$seq]->availability
;
448 $mod[$seq]->deletioninprogress
= $rawmods[$seq]->deletioninprogress
;
450 $modname = $mod[$seq]->mod
;
451 $functionname = $modname."_get_coursemodule_info";
453 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
457 include_once("$CFG->dirroot/mod/$modname/lib.php");
459 if ($hasfunction = function_exists($functionname)) {
460 if ($info = $functionname($rawmods[$seq])) {
461 if (!empty($info->icon
)) {
462 $mod[$seq]->icon
= $info->icon
;
464 if (!empty($info->iconcomponent
)) {
465 $mod[$seq]->iconcomponent
= $info->iconcomponent
;
467 if (!empty($info->name
)) {
468 $mod[$seq]->name
= $info->name
;
470 if ($info instanceof cached_cm_info
) {
471 // When using cached_cm_info you can include three new fields
472 // that aren't available for legacy code
473 if (!empty($info->content
)) {
474 $mod[$seq]->content
= $info->content
;
476 if (!empty($info->extraclasses
)) {
477 $mod[$seq]->extraclasses
= $info->extraclasses
;
479 if (!empty($info->iconurl
)) {
480 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
481 $url = new moodle_url($info->iconurl
);
482 $mod[$seq]->iconurl
= $url->out(false);
484 if (!empty($info->onclick
)) {
485 $mod[$seq]->onclick
= $info->onclick
;
487 if (!empty($info->customdata
)) {
488 $mod[$seq]->customdata
= $info->customdata
;
491 // When using a stdclass, the (horrible) deprecated ->extra field
492 // is available for BC
493 if (!empty($info->extra
)) {
494 $mod[$seq]->extra
= $info->extra
;
499 // When there is no modname_get_coursemodule_info function,
500 // but showdescriptions is enabled, then we use the 'intro'
501 // and 'introformat' fields in the module table
502 if (!$hasfunction && $rawmods[$seq]->showdescription
) {
503 if ($modvalues = $DB->get_record($rawmods[$seq]->modname
,
504 array('id' => $rawmods[$seq]->instance
), 'name, intro, introformat')) {
505 // Set content from intro and introformat. Filters are disabled
506 // because we filter it with format_text at display time
507 $mod[$seq]->content
= format_module_intro($rawmods[$seq]->modname
,
508 $modvalues, $rawmods[$seq]->id
, false);
510 // To save making another query just below, put name in here
511 $mod[$seq]->name
= $modvalues->name
;
514 if (!isset($mod[$seq]->name
)) {
515 $mod[$seq]->name
= $DB->get_field($rawmods[$seq]->modname
, "name", array("id"=>$rawmods[$seq]->instance
));
518 // Minimise the database size by unsetting default options when they are
519 // 'empty'. This list corresponds to code in the cm_info constructor.
520 foreach (array('idnumber', 'groupmode', 'groupingid',
521 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
522 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
523 'completionexpected', 'score', 'showdescription', 'deletioninprogress') as $property) {
524 if (property_exists($mod[$seq], $property) &&
525 empty($mod[$seq]->{$property})) {
526 unset($mod[$seq]->{$property});
529 // Special case: this value is usually set to null, but may be 0
530 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
531 is_null($mod[$seq]->completiongradeitemnumber
)) {
532 unset($mod[$seq]->completiongradeitemnumber
);
542 * Returns the localised human-readable names of all used modules
544 * @param bool $plural if true returns the plural forms of the names
545 * @return array where key is the module name (component name without 'mod_') and
546 * the value is the human-readable string. Array sorted alphabetically by value
548 function get_module_types_names($plural = false) {
549 static $modnames = null;
551 if ($modnames === null) {
552 $modnames = array(0 => array(), 1 => array());
553 if ($allmods = $DB->get_records("modules")) {
554 foreach ($allmods as $mod) {
555 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible
) {
556 $modnames[0][$mod->name
] = get_string("modulename", "$mod->name");
557 $modnames[1][$mod->name
] = get_string("modulenameplural", "$mod->name");
560 core_collator
::asort($modnames[0]);
561 core_collator
::asort($modnames[1]);
564 return $modnames[(int)$plural];
568 * Set highlighted section. Only one section can be highlighted at the time.
570 * @param int $courseid course id
571 * @param int $marker highlight section with this number, 0 means remove higlightin
574 function course_set_marker($courseid, $marker) {
576 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
577 if ($COURSE && $COURSE->id
== $courseid) {
578 $COURSE->marker
= $marker;
580 if (class_exists('format_base')) {
581 format_base
::reset_course_cache($courseid);
583 course_modinfo
::clear_instance_cache($courseid);
587 * For a given course section, marks it visible or hidden,
588 * and does the same for every activity in that section
590 * @param int $courseid course id
591 * @param int $sectionnumber The section number to adjust
592 * @param int $visibility The new visibility
593 * @return array A list of resources which were hidden in the section
595 function set_section_visible($courseid, $sectionnumber, $visibility) {
598 $resourcestotoggle = array();
599 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
600 course_update_section($courseid, $section, array('visible' => $visibility));
602 // Determine which modules are visible for AJAX update
603 $modules = !empty($section->sequence
) ?
explode(',', $section->sequence
) : array();
604 if (!empty($modules)) {
605 list($insql, $params) = $DB->get_in_or_equal($modules);
606 $select = 'id ' . $insql . ' AND visible = ?';
607 array_push($params, $visibility);
609 $select .= ' AND visibleold = 1';
611 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
614 return $resourcestotoggle;
618 * Retrieve all metadata for the requested modules
620 * @param object $course The Course
621 * @param array $modnames An array containing the list of modules and their
623 * @param int $sectionreturn The section to return to
624 * @return array A list of stdClass objects containing metadata about each
627 function get_module_metadata($course, $modnames, $sectionreturn = null) {
630 // get_module_metadata will be called once per section on the page and courses may show
631 // different modules to one another
632 static $modlist = array();
633 if (!isset($modlist[$course->id
])) {
634 $modlist[$course->id
] = array();
638 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id
, 'sesskey' => sesskey()));
639 if ($sectionreturn !== null) {
640 $urlbase->param('sr', $sectionreturn);
642 foreach($modnames as $modname => $modnamestr) {
643 if (!course_allowed_module($course, $modname)) {
646 if (isset($modlist[$course->id
][$modname])) {
647 // This module is already cached
648 $return +
= $modlist[$course->id
][$modname];
651 $modlist[$course->id
][$modname] = array();
653 // Create an object for a default representation of this module type in the activity chooser. It will be used
654 // if module does not implement callback get_shortcuts() and it will also be passed to the callback if it exists.
655 $defaultmodule = new stdClass();
656 $defaultmodule->title
= $modnamestr;
657 $defaultmodule->name
= $modname;
658 $defaultmodule->link
= new moodle_url($urlbase, array('add' => $modname));
659 $defaultmodule->icon
= $OUTPUT->pix_icon('icon', '', $defaultmodule->name
, array('class' => 'icon'));
660 $sm = get_string_manager();
661 if ($sm->string_exists('modulename_help', $modname)) {
662 $defaultmodule->help
= get_string('modulename_help', $modname);
663 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs.
664 $link = get_string('modulename_link', $modname);
665 $linktext = get_string('morehelp');
666 $defaultmodule->help
.= html_writer
::tag('div',
667 $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
670 $defaultmodule->archetype
= plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
672 // Each module can implement callback modulename_get_shortcuts() in its lib.php and return the list
673 // of elements to be added to activity chooser.
674 $items = component_callback($modname, 'get_shortcuts', array($defaultmodule), null);
675 if ($items !== null) {
676 foreach ($items as $item) {
677 // Add all items to the return array. All items must have different links, use them as a key in the return array.
678 if (!isset($item->archetype
)) {
679 $item->archetype
= $defaultmodule->archetype
;
681 if (!isset($item->icon
)) {
682 $item->icon
= $defaultmodule->icon
;
684 // If plugin returned the only one item with the same link as default item - cache it as $modname,
685 // otherwise append the link url to the module name.
686 $item->name
= (count($items) == 1 &&
687 $item->link
->out() === $defaultmodule->link
->out()) ?
$modname : $modname . ':' . $item->link
;
689 // If the module provides the helptext property, append it to the help text to match the look and feel
690 // of the default course modules.
691 if (isset($item->help
) && isset($item->helplink
)) {
692 $linktext = get_string('morehelp');
693 $item->help
.= html_writer
::tag('div',
694 $OUTPUT->doc_link($item->helplink
, $linktext, true), array('class' => 'helpdoclink'));
696 $modlist[$course->id
][$modname][$item->name
] = $item;
698 $return +
= $modlist[$course->id
][$modname];
699 // If get_shortcuts() callback is defined, the default module action is not added.
700 // It is a responsibility of the callback to add it to the return value unless it is not needed.
704 // The callback get_shortcuts() was not found, use the default item for the activity chooser.
705 $modlist[$course->id
][$modname][$modname] = $defaultmodule;
706 $return[$modname] = $defaultmodule;
709 core_collator
::asort_objects_by_property($return, 'title');
714 * Return the course category context for the category with id $categoryid, except
715 * that if $categoryid is 0, return the system context.
717 * @param integer $categoryid a category id or 0.
718 * @return context the corresponding context
720 function get_category_or_system_context($categoryid) {
722 return context_coursecat
::instance($categoryid, IGNORE_MISSING
);
724 return context_system
::instance();
729 * Returns full course categories trees to be used in html_writer::select()
731 * Calls {@link core_course_category::make_categories_list()} to build the tree and
732 * adds whitespace to denote nesting
734 * @return array array mapping course category id to the display name
736 function make_categories_options() {
737 $cats = core_course_category
::make_categories_list('', 0, ' / ');
738 foreach ($cats as $key => $value) {
739 // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
740 $cats[$key] = str_repeat(' ', substr_count($value, ' / ')). $value;
746 * Print the buttons relating to course requests.
748 * @param object $context current page context.
750 function print_course_request_buttons($context) {
751 global $CFG, $DB, $OUTPUT;
752 if (empty($CFG->enablecourserequests
)) {
755 if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
756 /// Print a button to request a new course
757 echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
759 /// Print a button to manage pending requests
760 if ($context->contextlevel
== CONTEXT_SYSTEM
&& has_capability('moodle/site:approvecourse', $context)) {
761 $disabled = !$DB->record_exists('course_request', array());
762 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
767 * Does the user have permission to edit things in this category?
769 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
770 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
772 function can_edit_in_category($categoryid = 0) {
773 $context = get_category_or_system_context($categoryid);
774 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
777 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
779 function add_course_module($mod) {
782 $mod->added
= time();
785 $cmid = $DB->insert_record("course_modules", $mod);
786 rebuild_course_cache($mod->course
, true);
791 * Creates a course section and adds it to the specified position
793 * @param int|stdClass $courseorid course id or course object
794 * @param int $position position to add to, 0 means to the end. If position is greater than
795 * number of existing secitons, the section is added to the end. This will become sectionnum of the
796 * new section. All existing sections at this or bigger position will be shifted down.
797 * @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
798 * @return stdClass created section object
800 function course_create_section($courseorid, $position = 0, $skipcheck = false) {
802 $courseid = is_object($courseorid) ?
$courseorid->id
: $courseorid;
804 // Find the last sectionnum among existing sections.
806 $lastsection = $position - 1;
808 $lastsection = (int)$DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', [$courseid]);
811 // First add section to the end.
812 $cw = new stdClass();
813 $cw->course
= $courseid;
814 $cw->section
= $lastsection +
1;
816 $cw->summaryformat
= FORMAT_HTML
;
820 $cw->availability
= null;
821 $cw->timemodified
= time();
822 $cw->id
= $DB->insert_record("course_sections", $cw);
824 // Now move it to the specified position.
825 if ($position > 0 && $position <= $lastsection) {
826 $course = is_object($courseorid) ?
$courseorid : get_course($courseorid);
827 move_section_to($course, $cw->section
, $position, true);
828 $cw->section
= $position;
831 core\event\course_section_created
::create_from_section($cw)->trigger();
833 rebuild_course_cache($courseid, true);
838 * Creates missing course section(s) and rebuilds course cache
840 * @param int|stdClass $courseorid course id or course object
841 * @param int|array $sections list of relative section numbers to create
842 * @return bool if there were any sections created
844 function course_create_sections_if_missing($courseorid, $sections) {
845 if (!is_array($sections)) {
846 $sections = array($sections);
848 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
849 if ($newsections = array_diff($sections, $existing)) {
850 foreach ($newsections as $sectionnum) {
851 course_create_section($courseorid, $sectionnum, true);
859 * Adds an existing module to the section
861 * Updates both tables {course_sections} and {course_modules}
863 * Note: This function does not use modinfo PROVIDED that the section you are
864 * adding the module to already exists. If the section does not exist, it will
865 * build modinfo if necessary and create the section.
867 * @param int|stdClass $courseorid course id or course object
868 * @param int $cmid id of the module already existing in course_modules table
869 * @param int $sectionnum relative number of the section (field course_sections.section)
870 * If section does not exist it will be created
871 * @param int|stdClass $beforemod id or object with field id corresponding to the module
872 * before which the module needs to be included. Null for inserting in the
874 * @return int The course_sections ID where the module is inserted
876 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
878 if (is_object($beforemod)) {
879 $beforemod = $beforemod->id
;
881 if (is_object($courseorid)) {
882 $courseid = $courseorid->id
;
884 $courseid = $courseorid;
886 // Do not try to use modinfo here, there is no guarantee it is valid!
887 $section = $DB->get_record('course_sections',
888 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING
);
890 // This function call requires modinfo.
891 course_create_sections_if_missing($courseorid, $sectionnum);
892 $section = $DB->get_record('course_sections',
893 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST
);
896 $modarray = explode(",", trim($section->sequence
));
897 if (empty($section->sequence
)) {
898 $newsequence = "$cmid";
899 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
900 $insertarray = array($cmid, $beforemod);
901 array_splice($modarray, $key[0], 1, $insertarray);
902 $newsequence = implode(",", $modarray);
904 $newsequence = "$section->sequence,$cmid";
906 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id
));
907 $DB->set_field('course_modules', 'section', $section->id
, array('id' => $cmid));
908 if (is_object($courseorid)) {
909 rebuild_course_cache($courseorid->id
, true);
911 rebuild_course_cache($courseorid, true);
913 return $section->id
; // Return course_sections ID that was used.
917 * Change the group mode of a course module.
919 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
920 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
922 * @param int $id course module ID.
923 * @param int $groupmode the new groupmode value.
924 * @return bool True if the $groupmode was updated.
926 function set_coursemodule_groupmode($id, $groupmode) {
928 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST
);
929 if ($cm->groupmode
!= $groupmode) {
930 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id
));
931 rebuild_course_cache($cm->course
, true);
933 return ($cm->groupmode
!= $groupmode);
936 function set_coursemodule_idnumber($id, $idnumber) {
938 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST
);
939 if ($cm->idnumber
!= $idnumber) {
940 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id
));
941 rebuild_course_cache($cm->course
, true);
943 return ($cm->idnumber
!= $idnumber);
947 * Set the visibility of a module and inherent properties.
949 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
950 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
952 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
953 * has been moved to {@link set_section_visible()} which was the only place from which
954 * the parameter was used.
956 * @param int $id of the module
957 * @param int $visible state of the module
958 * @param int $visibleoncoursepage state of the module on the course page
959 * @return bool false when the module was not found, true otherwise
961 function set_coursemodule_visible($id, $visible, $visibleoncoursepage = 1) {
963 require_once($CFG->libdir
.'/gradelib.php');
964 require_once($CFG->dirroot
.'/calendar/lib.php');
966 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
970 // Create events and propagate visibility to associated grade items if the value has changed.
971 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
972 if ($cm->visible
== $visible && $cm->visibleoncoursepage
== $visibleoncoursepage) {
976 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module
))) {
979 if (($cm->visible
!= $visible) &&
980 ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename)))) {
981 foreach($events as $event) {
983 $event = new calendar_event($event);
984 $event->toggle_visibility(true);
986 $event = new calendar_event($event);
987 $event->toggle_visibility(false);
992 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
993 // affect visibleold to allow for an original visibility restore. See set_section_visible().
994 $cminfo = new stdClass();
996 $cminfo->visible
= $visible;
997 $cminfo->visibleoncoursepage
= $visibleoncoursepage;
998 $cminfo->visibleold
= $visible;
999 $DB->update_record('course_modules', $cminfo);
1001 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1002 // Note that this must be done after updating the row in course_modules, in case
1003 // the modules grade_item_update function needs to access $cm->visible.
1004 if ($cm->visible
!= $visible &&
1005 plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY
) &&
1006 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1007 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1008 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1009 } else if ($cm->visible
!= $visible) {
1010 $grade_items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance
, 'courseid'=>$cm->course
));
1012 foreach ($grade_items as $grade_item) {
1013 $grade_item->set_hidden(!$visible);
1018 rebuild_course_cache($cm->course
, true);
1023 * Changes the course module name
1025 * @param int $id course module id
1026 * @param string $name new value for a name
1027 * @return bool whether a change was made
1029 function set_coursemodule_name($id, $name) {
1031 require_once($CFG->libdir
. '/gradelib.php');
1033 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
1035 $module = new \
stdClass();
1036 $module->id
= $cm->instance
;
1038 // Escape strings as they would be by mform.
1039 if (!empty($CFG->formatstringstriptags
)) {
1040 $module->name
= clean_param($name, PARAM_TEXT
);
1042 $module->name
= clean_param($name, PARAM_CLEANHTML
);
1044 if ($module->name
=== $cm->name ||
strval($module->name
) === '') {
1047 if (\core_text
::strlen($module->name
) > 255) {
1048 throw new \
moodle_exception('maximumchars', 'moodle', '', 255);
1051 $module->timemodified
= time();
1052 $DB->update_record($cm->modname
, $module);
1053 $cm->name
= $module->name
;
1054 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1055 rebuild_course_cache($cm->course
, true);
1057 // Attempt to update the grade item if relevant.
1058 $grademodule = $DB->get_record($cm->modname
, array('id' => $cm->instance
));
1059 $grademodule->cmidnumber
= $cm->idnumber
;
1060 $grademodule->modname
= $cm->modname
;
1061 grade_update_mod_grades($grademodule);
1063 // Update calendar events with the new name.
1064 course_module_update_calendar_events($cm->modname
, $grademodule, $cm);
1070 * This function will handle the whole deletion process of a module. This includes calling
1071 * the modules delete_instance function, deleting files, events, grades, conditional data,
1072 * the data in the course_module and course_sections table and adding a module deletion
1075 * @param int $cmid the course module id
1076 * @param bool $async whether or not to try to delete the module using an adhoc task. Async also depends on a plugin hook.
1077 * @throws moodle_exception
1080 function course_delete_module($cmid, $async = false) {
1081 // Check the 'course_module_background_deletion_recommended' hook first.
1082 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1083 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1084 // It's up to plugins to handle things like whether or not they are enabled.
1085 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1086 foreach ($pluginsfunction as $plugintype => $plugins) {
1087 foreach ($plugins as $pluginfunction) {
1088 if ($pluginfunction()) {
1089 return course_module_flag_for_async_deletion($cmid);
1097 require_once($CFG->libdir
.'/gradelib.php');
1098 require_once($CFG->libdir
.'/questionlib.php');
1099 require_once($CFG->dirroot
.'/blog/lib.php');
1100 require_once($CFG->dirroot
.'/calendar/lib.php');
1102 // Get the course module.
1103 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1107 // Get the module context.
1108 $modcontext = context_module
::instance($cm->id
);
1110 // Get the course module name.
1111 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1113 // Get the file location of the delete_instance function for this module.
1114 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1116 // Include the file required to call the delete_instance function for this module.
1117 if (file_exists($modlib)) {
1118 require_once($modlib);
1120 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1121 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1124 $deleteinstancefunction = $modulename . '_delete_instance';
1126 // Ensure the delete_instance function exists for this module.
1127 if (!function_exists($deleteinstancefunction)) {
1128 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1129 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1132 // Allow plugins to use this course module before we completely delete it.
1133 if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
1134 foreach ($pluginsfunction as $plugintype => $plugins) {
1135 foreach ($plugins as $pluginfunction) {
1136 $pluginfunction($cm);
1141 // Delete activity context questions and question categories.
1142 question_delete_activity($cm);
1144 // Call the delete_instance function, if it returns false throw an exception.
1145 if (!$deleteinstancefunction($cm->instance
)) {
1146 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1147 "Cannot delete the module $modulename (instance).");
1150 // Remove all module files in case modules forget to do that.
1151 $fs = get_file_storage();
1152 $fs->delete_area_files($modcontext->id
);
1154 // Delete events from calendar.
1155 if ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename))) {
1156 $coursecontext = context_course
::instance($cm->course
);
1157 foreach($events as $event) {
1158 $event->context
= $coursecontext;
1159 $calendarevent = calendar_event
::load($event);
1160 $calendarevent->delete();
1164 // Delete grade items, outcome items and grades attached to modules.
1165 if ($grade_items = grade_item
::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1166 'iteminstance' => $cm->instance
, 'courseid' => $cm->course
))) {
1167 foreach ($grade_items as $grade_item) {
1168 $grade_item->delete('moddelete');
1172 // Delete associated blogs and blog tag instances.
1173 blog_remove_associations_for_module($modcontext->id
);
1175 // Delete completion and availability data; it is better to do this even if the
1176 // features are not turned on, in case they were turned on previously (these will be
1177 // very quick on an empty table).
1178 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id
));
1179 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id
,
1180 'course' => $cm->course
,
1181 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY
));
1183 // Delete all tag instances associated with the instance of this module.
1184 core_tag_tag
::delete_instances('mod_' . $modulename, null, $modcontext->id
);
1185 core_tag_tag
::remove_all_item_tags('core', 'course_modules', $cm->id
);
1187 // Notify the competency subsystem.
1188 \core_competency\api
::hook_course_module_deleted($cm);
1190 // Delete the context.
1191 context_helper
::delete_instance(CONTEXT_MODULE
, $cm->id
);
1193 // Delete the module from the course_modules table.
1194 $DB->delete_records('course_modules', array('id' => $cm->id
));
1196 // Delete module from that section.
1197 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
1198 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1199 "Cannot delete the module $modulename (instance) from section.");
1202 // Trigger event for course module delete action.
1203 $event = \core\event\course_module_deleted
::create(array(
1204 'courseid' => $cm->course
,
1205 'context' => $modcontext,
1206 'objectid' => $cm->id
,
1208 'modulename' => $modulename,
1209 'instanceid' => $cm->instance
,
1212 $event->add_record_snapshot('course_modules', $cm);
1214 rebuild_course_cache($cm->course
, true);
1218 * Schedule a course module for deletion in the background using an adhoc task.
1220 * This method should not be called directly. Instead, please use course_delete_module($cmid, true), to denote async deletion.
1221 * The real deletion of the module is handled by the task, which calls 'course_delete_module($cmid)'.
1223 * @param int $cmid the course module id.
1224 * @return bool whether the module was successfully scheduled for deletion.
1225 * @throws \moodle_exception
1227 function course_module_flag_for_async_deletion($cmid) {
1228 global $CFG, $DB, $USER;
1229 require_once($CFG->libdir
.'/gradelib.php');
1230 require_once($CFG->libdir
.'/questionlib.php');
1231 require_once($CFG->dirroot
.'/blog/lib.php');
1232 require_once($CFG->dirroot
.'/calendar/lib.php');
1234 // Get the course module.
1235 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1239 // We need to be reasonably certain the deletion is going to succeed before we background the process.
1240 // Make the necessary delete_instance checks, etc. before proceeding further. Throw exceptions if required.
1242 // Get the course module name.
1243 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1245 // Get the file location of the delete_instance function for this module.
1246 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1248 // Include the file required to call the delete_instance function for this module.
1249 if (file_exists($modlib)) {
1250 require_once($modlib);
1252 throw new \
moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1253 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1256 $deleteinstancefunction = $modulename . '_delete_instance';
1258 // Ensure the delete_instance function exists for this module.
1259 if (!function_exists($deleteinstancefunction)) {
1260 throw new \
moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1261 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1264 // We are going to defer the deletion as we can't be sure how long the module's pre_delete code will run for.
1265 $cm->deletioninprogress
= '1';
1266 $DB->update_record('course_modules', $cm);
1268 // Create an adhoc task for the deletion of the course module. The task takes an array of course modules for removal.
1269 $removaltask = new \core_course\task\
course_delete_modules();
1270 $removaltask->set_custom_data(array(
1271 'cms' => array($cm),
1272 'userid' => $USER->id
,
1273 'realuserid' => \core\session\manager
::get_realuser()->id
1276 // Queue the task for the next run.
1277 \core\task\manager
::queue_adhoc_task($removaltask);
1279 // Reset the course cache to hide the module.
1280 rebuild_course_cache($cm->course
, true);
1284 * Checks whether the given course has any course modules scheduled for adhoc deletion.
1286 * @param int $courseid the id of the course.
1287 * @return bool true if the course contains any modules pending deletion, false otherwise.
1289 function course_modules_pending_deletion($courseid) {
1290 if (empty($courseid)) {
1293 $modinfo = get_fast_modinfo($courseid);
1294 foreach ($modinfo->get_cms() as $module) {
1295 if ($module->deletioninprogress
== '1') {
1303 * Checks whether the course module, as defined by modulename and instanceid, is scheduled for deletion within the given course.
1305 * @param int $courseid the course id.
1306 * @param string $modulename the module name. E.g. 'assign', 'book', etc.
1307 * @param int $instanceid the module instance id.
1308 * @return bool true if the course module is pending deletion, false otherwise.
1310 function course_module_instance_pending_deletion($courseid, $modulename, $instanceid) {
1311 if (empty($courseid) ||
empty($modulename) ||
empty($instanceid)) {
1314 $modinfo = get_fast_modinfo($courseid);
1315 $instances = $modinfo->get_instances_of($modulename);
1316 return isset($instances[$instanceid]) && $instances[$instanceid]->deletioninprogress
;
1319 function delete_mod_from_section($modid, $sectionid) {
1322 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1324 $modarray = explode(",", $section->sequence
);
1326 if ($key = array_keys ($modarray, $modid)) {
1327 array_splice($modarray, $key[0], 1);
1328 $newsequence = implode(",", $modarray);
1329 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id
));
1330 rebuild_course_cache($section->course
, true);
1341 * This function updates the calendar events from the information stored in the module table and the course
1344 * @param string $modulename Module name
1345 * @param stdClass $instance Module object. Either the $instance or the $cm must be supplied.
1346 * @param stdClass $cm Course module object. Either the $instance or the $cm must be supplied.
1347 * @return bool Returns true if calendar events are updated.
1348 * @since Moodle 3.3.4
1350 function course_module_update_calendar_events($modulename, $instance = null, $cm = null) {
1353 if (isset($instance) ||
isset($cm)) {
1355 if (!isset($instance)) {
1356 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1359 $cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
);
1362 course_module_calendar_event_update_process($instance, $cm);
1370 * Update all instances through out the site or in a course.
1372 * @param string $modulename Module type to update.
1373 * @param integer $courseid Course id to update events. 0 for the whole site.
1374 * @return bool Returns True if the update was successful.
1375 * @since Moodle 3.3.4
1377 function course_module_bulk_update_calendar_events($modulename, $courseid = 0) {
1382 if (!$instances = $DB->get_records($modulename, array('course' => $courseid))) {
1386 if (!$instances = $DB->get_records($modulename)) {
1391 foreach ($instances as $instance) {
1392 if ($cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
)) {
1393 course_module_calendar_event_update_process($instance, $cm);
1400 * Calendar events for a module instance are updated.
1402 * @param stdClass $instance Module instance object.
1403 * @param stdClass $cm Course Module object.
1404 * @since Moodle 3.3.4
1406 function course_module_calendar_event_update_process($instance, $cm) {
1407 // We need to call *_refresh_events() first because some modules delete 'old' events at the end of the code which
1408 // will remove the completion events.
1409 $refresheventsfunction = $cm->modname
. '_refresh_events';
1410 if (function_exists($refresheventsfunction)) {
1411 call_user_func($refresheventsfunction, $cm->course
, $instance, $cm);
1413 $completionexpected = (!empty($cm->completionexpected
)) ?
$cm->completionexpected
: null;
1414 \core_completion\api
::update_completion_date_event($cm->id
, $cm->modname
, $instance, $completionexpected);
1418 * Moves a section within a course, from a position to another.
1419 * Be very careful: $section and $destination refer to section number,
1422 * @param object $course
1423 * @param int $section Section number (not id!!!)
1424 * @param int $destination
1425 * @param bool $ignorenumsections
1426 * @return boolean Result
1428 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1429 /// Moves a whole course section up and down within the course
1432 if (!$destination && $destination != 0) {
1436 // compartibility with course formats using field 'numsections'
1437 $courseformatoptions = course_get_format($course)->get_format_options();
1438 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1439 ($destination > $courseformatoptions['numsections'])) ||
($destination < 1)) {
1443 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1444 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id
),
1445 'section ASC, id ASC', 'id, section')) {
1449 $movedsections = reorder_sections($sections, $section, $destination);
1451 // Update all sections. Do this in 2 steps to avoid breaking database
1452 // uniqueness constraint
1453 $transaction = $DB->start_delegated_transaction();
1454 foreach ($movedsections as $id => $position) {
1455 if ($sections[$id] !== $position) {
1456 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1459 foreach ($movedsections as $id => $position) {
1460 if ($sections[$id] !== $position) {
1461 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1465 // If we move the highlighted section itself, then just highlight the destination.
1466 // Adjust the higlighted section location if we move something over it either direction.
1467 if ($section == $course->marker
) {
1468 course_set_marker($course->id
, $destination);
1469 } elseif ($section > $course->marker
&& $course->marker
>= $destination) {
1470 course_set_marker($course->id
, $course->marker+
1);
1471 } elseif ($section < $course->marker
&& $course->marker
<= $destination) {
1472 course_set_marker($course->id
, $course->marker
-1);
1475 $transaction->allow_commit();
1476 rebuild_course_cache($course->id
, true);
1481 * This method will delete a course section and may delete all modules inside it.
1483 * No permissions are checked here, use {@link course_can_delete_section()} to
1484 * check if section can actually be deleted.
1486 * @param int|stdClass $course
1487 * @param int|stdClass|section_info $section
1488 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1489 * @param bool $async whether or not to try to delete the section using an adhoc task. Async also depends on a plugin hook.
1490 * @return bool whether section was deleted
1492 function course_delete_section($course, $section, $forcedeleteifnotempty = true, $async = false) {
1495 // Prepare variables.
1496 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1497 $sectionnum = (is_object($section)) ?
$section->section
: (int)$section;
1498 $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1500 // No section exists, can't proceed.
1504 // Check the 'course_module_background_deletion_recommended' hook first.
1505 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1506 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1507 // It's up to plugins to handle things like whether or not they are enabled.
1508 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1509 foreach ($pluginsfunction as $plugintype => $plugins) {
1510 foreach ($plugins as $pluginfunction) {
1511 if ($pluginfunction()) {
1512 return course_delete_section_async($section, $forcedeleteifnotempty);
1518 $format = course_get_format($course);
1519 $sectionname = $format->get_section_name($section);
1522 $result = $format->delete_section($section, $forcedeleteifnotempty);
1524 // Trigger an event for course section deletion.
1526 $context = context_course
::instance($courseid);
1527 $event = \core\event\course_section_deleted
::create(
1529 'objectid' => $section->id
,
1530 'courseid' => $courseid,
1531 'context' => $context,
1533 'sectionnum' => $section->section
,
1534 'sectionname' => $sectionname,
1538 $event->add_record_snapshot('course_sections', $section);
1545 * Course section deletion, using an adhoc task for deletion of the modules it contains.
1546 * 1. Schedule all modules within the section for adhoc removal.
1547 * 2. Move all modules to course section 0.
1548 * 3. Delete the resulting empty section.
1550 * @param \stdClass $section the section to schedule for deletion.
1551 * @param bool $forcedeleteifnotempty whether to force section deletion if it contains modules.
1552 * @return bool true if the section was scheduled for deletion, false otherwise.
1554 function course_delete_section_async($section, $forcedeleteifnotempty = true) {
1557 // Objects only, and only valid ones.
1558 if (!is_object($section) ||
empty($section->id
)) {
1562 // Does the object currently exist in the DB for removal (check for stale objects).
1563 $section = $DB->get_record('course_sections', array('id' => $section->id
));
1564 if (!$section ||
!$section->section
) {
1565 // No section exists, or the section is 0. Can't proceed.
1569 // Check whether the section can be removed.
1570 if (!$forcedeleteifnotempty && (!empty($section->sequence
) ||
!empty($section->summary
))) {
1574 $format = course_get_format($section->course
);
1575 $sectionname = $format->get_section_name($section);
1577 // Flag those modules having no existing deletion flag. Some modules may have been scheduled for deletion manually, and we don't
1578 // want to create additional adhoc deletion tasks for these. Moving them to section 0 will suffice.
1579 $affectedmods = $DB->get_records_select('course_modules', 'course = ? AND section = ? AND deletioninprogress <> ?',
1580 [$section->course
, $section->id
, 1], '', 'id');
1581 $DB->set_field('course_modules', 'deletioninprogress', '1', ['course' => $section->course
, 'section' => $section->id
]);
1583 // Move all modules to section 0.
1584 $modules = $DB->get_records('course_modules', ['section' => $section->id
], '');
1585 $sectionzero = $DB->get_record('course_sections', ['course' => $section->course
, 'section' => '0']);
1586 foreach ($modules as $mod) {
1587 moveto_module($mod, $sectionzero);
1590 // Create and queue an adhoc task for the deletion of the modules.
1591 $removaltask = new \core_course\task\
course_delete_modules();
1593 'cms' => $affectedmods,
1594 'userid' => $USER->id
,
1595 'realuserid' => \core\session\manager
::get_realuser()->id
1597 $removaltask->set_custom_data($data);
1598 \core\task\manager
::queue_adhoc_task($removaltask);
1600 // Delete the now empty section, passing in only the section number, which forces the function to fetch a new object.
1601 // The refresh is needed because the section->sequence is now stale.
1602 $result = $format->delete_section($section->section
, $forcedeleteifnotempty);
1604 // Trigger an event for course section deletion.
1606 $context = \context_course
::instance($section->course
);
1607 $event = \core\event\course_section_deleted
::create(
1609 'objectid' => $section->id
,
1610 'courseid' => $section->course
,
1611 'context' => $context,
1613 'sectionnum' => $section->section
,
1614 'sectionname' => $sectionname,
1618 $event->add_record_snapshot('course_sections', $section);
1621 rebuild_course_cache($section->course
, true);
1627 * Updates the course section
1629 * This function does not check permissions or clean values - this has to be done prior to calling it.
1631 * @param int|stdClass $course
1632 * @param stdClass $section record from course_sections table - it will be updated with the new values
1633 * @param array|stdClass $data
1635 function course_update_section($course, $section, $data) {
1638 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1640 // Some fields can not be updated using this method.
1641 $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1642 $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible
);
1643 if (array_key_exists('name', $data) && \core_text
::strlen($data['name']) > 255) {
1644 throw new moodle_exception('maximumchars', 'moodle', '', 255);
1647 // Update record in the DB and course format options.
1648 $data['id'] = $section->id
;
1649 $data['timemodified'] = time();
1650 $DB->update_record('course_sections', $data);
1651 rebuild_course_cache($courseid, true);
1652 course_get_format($courseid)->update_section_format_options($data);
1654 // Update fields of the $section object.
1655 foreach ($data as $key => $value) {
1656 if (property_exists($section, $key)) {
1657 $section->$key = $value;
1661 // Trigger an event for course section update.
1662 $event = \core\event\course_section_updated
::create(
1664 'objectid' => $section->id
,
1665 'courseid' => $courseid,
1666 'context' => context_course
::instance($courseid),
1667 'other' => array('sectionnum' => $section->section
)
1672 // If section visibility was changed, hide the modules in this section too.
1673 if ($changevisibility && !empty($section->sequence
)) {
1674 $modules = explode(',', $section->sequence
);
1675 foreach ($modules as $moduleid) {
1676 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1677 if ($data['visible']) {
1678 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1679 set_coursemodule_visible($moduleid, $cm->visibleold
, $cm->visibleoncoursepage
);
1681 // We hide the section, so we hide the module but we store the original state in visibleold.
1682 set_coursemodule_visible($moduleid, 0, $cm->visibleoncoursepage
);
1683 $DB->set_field('course_modules', 'visibleold', $cm->visible
, array('id' => $moduleid));
1685 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1692 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1694 * @param int|stdClass $course
1695 * @param int|stdClass|section_info $section
1698 function course_can_delete_section($course, $section) {
1699 if (is_object($section)) {
1700 $section = $section->section
;
1703 // Not possible to delete 0-section.
1706 // Course format should allow to delete sections.
1707 if (!course_get_format($course)->can_delete_section($section)) {
1710 // Make sure user has capability to update course and move sections.
1711 $context = context_course
::instance(is_object($course) ?
$course->id
: $course);
1712 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1715 // Make sure user has capability to delete each activity in this section.
1716 $modinfo = get_fast_modinfo($course);
1717 if (!empty($modinfo->sections
[$section])) {
1718 foreach ($modinfo->sections
[$section] as $cmid) {
1719 if (!has_capability('moodle/course:manageactivities', context_module
::instance($cmid))) {
1728 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1729 * an original position number and a target position number, rebuilds the array so that the
1730 * move is made without any duplication of section positions.
1731 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1732 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1734 * @param array $sections
1735 * @param int $origin_position
1736 * @param int $target_position
1739 function reorder_sections($sections, $origin_position, $target_position) {
1740 if (!is_array($sections)) {
1744 // We can't move section position 0
1745 if ($origin_position < 1) {
1746 echo "We can't move section position 0";
1750 // Locate origin section in sections array
1751 if (!$origin_key = array_search($origin_position, $sections)) {
1752 echo "searched position not in sections array";
1753 return false; // searched position not in sections array
1756 // Extract origin section
1757 $origin_section = $sections[$origin_key];
1758 unset($sections[$origin_key]);
1760 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1762 $append_array = array();
1763 foreach ($sections as $id => $position) {
1765 $append_array[$id] = $position;
1766 unset($sections[$id]);
1768 if ($position == $target_position) {
1769 if ($target_position < $origin_position) {
1770 $append_array[$id] = $position;
1771 unset($sections[$id]);
1777 // Append moved section
1778 $sections[$origin_key] = $origin_section;
1780 // Append rest of array (if applicable)
1781 if (!empty($append_array)) {
1782 foreach ($append_array as $id => $position) {
1783 $sections[$id] = $position;
1787 // Renumber positions
1789 foreach ($sections as $id => $p) {
1790 $sections[$id] = $position;
1799 * Move the module object $mod to the specified $section
1800 * If $beforemod exists then that is the module
1801 * before which $modid should be inserted
1803 * @param stdClass|cm_info $mod
1804 * @param stdClass|section_info $section
1805 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1806 * before which the module needs to be included. Null for inserting in the
1807 * end of the section
1808 * @return int new value for module visibility (0 or 1)
1810 function moveto_module($mod, $section, $beforemod=NULL) {
1811 global $OUTPUT, $DB;
1813 // Current module visibility state - return value of this function.
1814 $modvisible = $mod->visible
;
1816 // Remove original module from original section.
1817 if (! delete_mod_from_section($mod->id
, $mod->section
)) {
1818 echo $OUTPUT->notification("Could not delete module from existing section");
1821 // If moving to a hidden section then hide module.
1822 if ($mod->section
!= $section->id
) {
1823 if (!$section->visible
&& $mod->visible
) {
1824 // Module was visible but must become hidden after moving to hidden section.
1826 set_coursemodule_visible($mod->id
, 0);
1827 // Set visibleold to 1 so module will be visible when section is made visible.
1828 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id
));
1830 if ($section->visible
&& !$mod->visible
) {
1831 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1832 set_coursemodule_visible($mod->id
, $mod->visibleold
);
1833 $modvisible = $mod->visibleold
;
1837 // Add the module into the new section.
1838 course_add_cm_to_section($section->course
, $mod->id
, $section->section
, $beforemod);
1843 * Returns the list of all editing actions that current user can perform on the module
1845 * @param cm_info $mod The module to produce editing buttons for
1846 * @param int $indent The current indenting (default -1 means no move left-right actions)
1847 * @param int $sr The section to link back to (used for creating the links)
1848 * @return array array of action_link or pix_icon objects
1850 function course_get_cm_edit_actions(cm_info
$mod, $indent = -1, $sr = null) {
1851 global $COURSE, $SITE, $CFG;
1855 $coursecontext = context_course
::instance($mod->course
);
1856 $modcontext = context_module
::instance($mod->id
);
1857 $courseformat = course_get_format($mod->get_course());
1859 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1860 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1862 // No permission to edit anything.
1863 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1867 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1870 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1871 'editsettings', 'duplicate', 'modhide', 'makeavailable', 'makeunavailable', 'modshow'), 'moodle');
1872 $str->assign
= get_string('assignroles', 'role');
1873 $str->groupsnone
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1874 $str->groupsseparate
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1875 $str->groupsvisible
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1878 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1881 $baseurl->param('sr', $sr);
1886 if ($hasmanageactivities) {
1887 $actions['update'] = new action_menu_link_secondary(
1888 new moodle_url($baseurl, array('update' => $mod->id
)),
1889 new pix_icon('t/edit', $str->editsettings
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1891 array('class' => 'editing_update', 'data-action' => 'update')
1896 if ($hasmanageactivities && $indent >= 0) {
1897 $indentlimits = new stdClass();
1898 $indentlimits->min
= 0;
1899 $indentlimits->max
= 16;
1900 if (right_to_left()) { // Exchange arrows on RTL
1901 $rightarrow = 't/left';
1902 $leftarrow = 't/right';
1904 $rightarrow = 't/right';
1905 $leftarrow = 't/left';
1908 if ($indent >= $indentlimits->max
) {
1909 $enabledclass = 'hidden';
1913 $actions['moveright'] = new action_menu_link_secondary(
1914 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '1')),
1915 new pix_icon($rightarrow, $str->moveright
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1917 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright',
1918 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1921 if ($indent <= $indentlimits->min
) {
1922 $enabledclass = 'hidden';
1926 $actions['moveleft'] = new action_menu_link_secondary(
1927 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '-1')),
1928 new pix_icon($leftarrow, $str->moveleft
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1930 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft',
1931 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1936 // Hide/Show/Available/Unavailable.
1937 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1938 $allowstealth = !empty($CFG->allowstealth
) && $courseformat->allow_stealth_module_visibility($mod, $mod->get_section_info());
1940 $sectionvisible = $mod->get_section_info()->visible
;
1941 // The module on the course page may be in one of the following states:
1942 // - Available and displayed on the course page ($displayedoncoursepage);
1943 // - Not available and not displayed on the course page ($unavailable);
1944 // - Available but not displayed on the course page ($stealth) - this can also be a visible activity in a hidden section.
1945 $displayedoncoursepage = $mod->visible
&& $mod->visibleoncoursepage
&& $sectionvisible;
1946 $unavailable = !$mod->visible
;
1947 $stealth = $mod->visible
&& (!$mod->visibleoncoursepage ||
!$sectionvisible);
1948 if ($displayedoncoursepage) {
1949 $actions['hide'] = new action_menu_link_secondary(
1950 new moodle_url($baseurl, array('hide' => $mod->id
)),
1951 new pix_icon('t/hide', $str->modhide
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1953 array('class' => 'editing_hide', 'data-action' => 'hide')
1955 } else if (!$displayedoncoursepage && $sectionvisible) {
1956 // Offer to "show" only if the section is visible.
1957 $actions['show'] = new action_menu_link_secondary(
1958 new moodle_url($baseurl, array('show' => $mod->id
)),
1959 new pix_icon('t/show', $str->modshow
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1961 array('class' => 'editing_show', 'data-action' => 'show')
1966 // When making the "stealth" module unavailable we perform the same action as hiding the visible module.
1967 $actions['hide'] = new action_menu_link_secondary(
1968 new moodle_url($baseurl, array('hide' => $mod->id
)),
1969 new pix_icon('t/unblock', $str->makeunavailable
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1970 $str->makeunavailable
,
1971 array('class' => 'editing_makeunavailable', 'data-action' => 'hide', 'data-sectionreturn' => $sr)
1973 } else if ($unavailable && (!$sectionvisible ||
$allowstealth) && $mod->has_view()) {
1974 // Allow to make visually hidden module available in gradebook and other reports by making it a "stealth" module.
1975 // When the section is hidden it is an equivalent of "showing" the module.
1976 // Activities without the link (i.e. labels) can not be made available but hidden on course page.
1977 $action = $sectionvisible ?
'stealth' : 'show';
1978 $actions[$action] = new action_menu_link_secondary(
1979 new moodle_url($baseurl, array($action => $mod->id
)),
1980 new pix_icon('t/block', $str->makeavailable
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1981 $str->makeavailable
,
1982 array('class' => 'editing_makeavailable', 'data-action' => $action, 'data-sectionreturn' => $sr)
1987 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1988 if (has_all_capabilities($dupecaps, $coursecontext) &&
1989 plugin_supports('mod', $mod->modname
, FEATURE_BACKUP_MOODLE2
) &&
1990 course_allowed_module($mod->get_course(), $mod->modname
)) {
1991 $actions['duplicate'] = new action_menu_link_secondary(
1992 new moodle_url($baseurl, array('duplicate' => $mod->id
)),
1993 new pix_icon('t/copy', $str->duplicate
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1995 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sectionreturn' => $sr)
2000 if ($hasmanageactivities && !$mod->coursegroupmodeforce
) {
2001 if (plugin_supports('mod', $mod->modname
, FEATURE_GROUPS
, 0)) {
2002 if ($mod->effectivegroupmode
== SEPARATEGROUPS
) {
2003 $nextgroupmode = VISIBLEGROUPS
;
2004 $grouptitle = $str->groupsseparate
;
2005 $actionname = 'groupsseparate';
2006 $nextactionname = 'groupsvisible';
2007 $groupimage = 'i/groups';
2008 } else if ($mod->effectivegroupmode
== VISIBLEGROUPS
) {
2009 $nextgroupmode = NOGROUPS
;
2010 $grouptitle = $str->groupsvisible
;
2011 $actionname = 'groupsvisible';
2012 $nextactionname = 'groupsnone';
2013 $groupimage = 'i/groupv';
2015 $nextgroupmode = SEPARATEGROUPS
;
2016 $grouptitle = $str->groupsnone
;
2017 $actionname = 'groupsnone';
2018 $nextactionname = 'groupsseparate';
2019 $groupimage = 'i/groupn';
2022 $actions[$actionname] = new action_menu_link_primary(
2023 new moodle_url($baseurl, array('id' => $mod->id
, 'groupmode' => $nextgroupmode)),
2024 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
2026 array('class' => 'editing_'. $actionname, 'data-action' => $nextactionname,
2027 'aria-live' => 'assertive', 'data-sectionreturn' => $sr)
2030 $actions['nogroupsupport'] = new action_menu_filler();
2035 if (has_capability('moodle/role:assign', $modcontext)){
2036 $actions['assign'] = new action_menu_link_secondary(
2037 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id
)),
2038 new pix_icon('t/assignroles', $str->assign
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2040 array('class' => 'editing_assign', 'data-action' => 'assignroles', 'data-sectionreturn' => $sr)
2045 if ($hasmanageactivities) {
2046 $actions['delete'] = new action_menu_link_secondary(
2047 new moodle_url($baseurl, array('delete' => $mod->id
)),
2048 new pix_icon('t/delete', $str->delete
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2050 array('class' => 'editing_delete', 'data-action' => 'delete', 'data-sectionreturn' => $sr)
2058 * Returns the move action.
2060 * @param cm_info $mod The module to produce a move button for
2061 * @param int $sr The section to link back to (used for creating the links)
2062 * @return The markup for the move action, or an empty string if not available.
2064 function course_get_cm_move(cm_info
$mod, $sr = null) {
2070 $modcontext = context_module
::instance($mod->id
);
2071 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2074 $str = get_strings(array('move'));
2077 if (!isset($baseurl)) {
2078 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2081 $baseurl->param('sr', $sr);
2085 if ($hasmanageactivities) {
2086 $pixicon = 'i/dragdrop';
2088 if (!course_ajax_enabled($mod->get_course())) {
2089 // Override for course frontpage until we get drag/drop working there.
2090 $pixicon = 't/move';
2093 return html_writer
::link(
2094 new moodle_url($baseurl, array('copy' => $mod->id
)),
2095 $OUTPUT->pix_icon($pixicon, $str->move
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2096 array('class' => 'editing_move', 'data-action' => 'move', 'data-sectionreturn' => $sr)
2103 * given a course object with shortname & fullname, this function will
2104 * truncate the the number of chars allowed and add ... if it was too long
2106 function course_format_name ($course,$max=100) {
2108 $context = context_course
::instance($course->id
);
2109 $shortname = format_string($course->shortname
, true, array('context' => $context));
2110 $fullname = format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
2111 $str = $shortname.': '. $fullname;
2112 if (core_text
::strlen($str) <= $max) {
2116 return core_text
::substr($str,0,$max-3).'...';
2121 * Is the user allowed to add this type of module to this course?
2122 * @param object $course the course settings. Only $course->id is used.
2123 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2124 * @return bool whether the current user is allowed to add this type of module to this course.
2126 function course_allowed_module($course, $modname) {
2127 if (is_numeric($modname)) {
2128 throw new coding_exception('Function course_allowed_module no longer
2129 supports numeric module ids. Please update your code to pass the module name.');
2132 $capability = 'mod/' . $modname . ':addinstance';
2133 if (!get_capability_info($capability)) {
2134 // Debug warning that the capability does not exist, but no more than once per page.
2135 static $warned = array();
2136 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
2137 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM
) {
2138 debugging('The module ' . $modname . ' does not define the standard capability ' .
2139 $capability , DEBUG_DEVELOPER
);
2140 $warned[$modname] = 1;
2143 // If the capability does not exist, the module can always be added.
2147 $coursecontext = context_course
::instance($course->id
);
2148 return has_capability($capability, $coursecontext);
2152 * Efficiently moves many courses around while maintaining
2153 * sortorder in order.
2155 * @param array $courseids is an array of course ids
2156 * @param int $categoryid
2157 * @return bool success
2159 function move_courses($courseids, $categoryid) {
2162 if (empty($courseids)) {
2167 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2171 $courseids = array_reverse($courseids);
2172 $newparent = context_coursecat
::instance($category->id
);
2175 list($where, $params) = $DB->get_in_or_equal($courseids);
2176 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2177 foreach ($dbcourses as $dbcourse) {
2178 $course = new stdClass();
2179 $course->id
= $dbcourse->id
;
2180 $course->category
= $category->id
;
2181 $course->sortorder
= $category->sortorder + MAX_COURSES_IN_CATEGORY
- $i++
;
2182 if ($category->visible
== 0) {
2183 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2184 // to previous state if somebody unhides the category.
2185 $course->visible
= 0;
2188 $DB->update_record('course', $course);
2190 // Update context, so it can be passed to event.
2191 $context = context_course
::instance($course->id
);
2192 $context->update_moved($newparent);
2194 // Trigger a course updated event.
2195 $event = \core\event\course_updated
::create(array(
2196 'objectid' => $course->id
,
2197 'context' => context_course
::instance($course->id
),
2198 'other' => array('shortname' => $dbcourse->shortname
,
2199 'fullname' => $dbcourse->fullname
)
2201 $event->set_legacy_logdata(array($course->id
, 'course', 'move', 'edit.php?id=' . $course->id
, $course->id
));
2204 fix_course_sortorder();
2205 cache_helper
::purge_by_event('changesincourse');
2211 * Returns the display name of the given section that the course prefers
2213 * Implementation of this function is provided by course format
2214 * @see format_base::get_section_name()
2216 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2217 * @param int|stdClass $section Section object from database or just field course_sections.section
2218 * @return string Display name that the course format prefers, e.g. "Week 2"
2220 function get_section_name($courseorid, $section) {
2221 return course_get_format($courseorid)->get_section_name($section);
2225 * Tells if current course format uses sections
2227 * @param string $format Course format ID e.g. 'weeks' $course->format
2230 function course_format_uses_sections($format) {
2231 $course = new stdClass();
2232 $course->format
= $format;
2233 return course_get_format($course)->uses_sections();
2237 * Returns the information about the ajax support in the given source format
2239 * The returned object's property (boolean)capable indicates that
2240 * the course format supports Moodle course ajax features.
2242 * @param string $format
2245 function course_format_ajax_support($format) {
2246 $course = new stdClass();
2247 $course->format
= $format;
2248 return course_get_format($course)->supports_ajax();
2252 * Can the current user delete this course?
2253 * Course creators have exception,
2254 * 1 day after the creation they can sill delete the course.
2255 * @param int $courseid
2258 function can_delete_course($courseid) {
2261 $context = context_course
::instance($courseid);
2263 if (has_capability('moodle/course:delete', $context)) {
2267 // hack: now try to find out if creator created this course recently (1 day)
2268 if (!has_capability('moodle/course:create', $context)) {
2272 $since = time() - 60*60*24;
2273 $course = get_course($courseid);
2275 if ($course->timecreated
< $since) {
2276 return false; // Return if the course was not created in last 24 hours.
2279 $logmanger = get_log_manager();
2280 $readers = $logmanger->get_readers('\core\log\sql_reader');
2281 $reader = reset($readers);
2283 if (empty($reader)) {
2284 return false; // No log reader found.
2288 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2289 $params = array('userid' => $USER->id
, 'since' => $since, 'courseid' => $course->id
, 'eventname' => '\core\event\course_created');
2291 return (bool)$reader->get_events_select_count($select, $params);
2295 * Save the Your name for 'Some role' strings.
2297 * @param integer $courseid the id of this course.
2298 * @param array $data the data that came from the course settings form.
2300 function save_local_role_names($courseid, $data) {
2302 $context = context_course
::instance($courseid);
2304 foreach ($data as $fieldname => $value) {
2305 if (strpos($fieldname, 'role_') !== 0) {
2308 list($ignored, $roleid) = explode('_', $fieldname);
2310 // make up our mind whether we want to delete, update or insert
2312 $DB->delete_records('role_names', array('contextid' => $context->id
, 'roleid' => $roleid));
2314 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id
, 'roleid' => $roleid))) {
2315 $rolename->name
= $value;
2316 $DB->update_record('role_names', $rolename);
2319 $rolename = new stdClass
;
2320 $rolename->contextid
= $context->id
;
2321 $rolename->roleid
= $roleid;
2322 $rolename->name
= $value;
2323 $DB->insert_record('role_names', $rolename);
2325 // This will ensure the course contacts cache is purged..
2326 core_course_category
::role_assignment_changed($roleid, $context);
2331 * Returns options to use in course overviewfiles filemanager
2333 * @param null|stdClass|core_course_list_element|int $course either object that has 'id' property or just the course id;
2334 * may be empty if course does not exist yet (course create form)
2335 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2336 * or null if overviewfiles are disabled
2338 function course_overviewfiles_options($course) {
2340 if (empty($CFG->courseoverviewfileslimit
)) {
2343 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext
), -1, PREG_SPLIT_NO_EMPTY
);
2344 if (in_array('*', $accepted_types) ||
empty($accepted_types)) {
2345 $accepted_types = '*';
2347 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2348 // Make sure extensions are prefixed with dot unless they are valid typegroups
2349 foreach ($accepted_types as $i => $type) {
2350 if (substr($type, 0, 1) !== '.') {
2351 require_once($CFG->libdir
. '/filelib.php');
2352 if (!count(file_get_typegroup('extension', $type))) {
2353 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2354 $accepted_types[$i] = '.'. $type;
2359 if (!empty($corrected)) {
2360 set_config('courseoverviewfilesext', join(',', $accepted_types));
2364 'maxfiles' => $CFG->courseoverviewfileslimit
,
2365 'maxbytes' => $CFG->maxbytes
,
2367 'accepted_types' => $accepted_types
2369 if (!empty($course->id
)) {
2370 $options['context'] = context_course
::instance($course->id
);
2371 } else if (is_int($course) && $course > 0) {
2372 $options['context'] = context_course
::instance($course);
2378 * Create a course and either return a $course object
2380 * Please note this functions does not verify any access control,
2381 * the calling code is responsible for all validation (usually it is the form definition).
2383 * @param array $editoroptions course description editor options
2384 * @param object $data - all the data needed for an entry in the 'course' table
2385 * @return object new course instance
2387 function create_course($data, $editoroptions = NULL) {
2390 //check the categoryid - must be given for all new courses
2391 $category = $DB->get_record('course_categories', array('id'=>$data->category
), '*', MUST_EXIST
);
2393 // Check if the shortname already exists.
2394 if (!empty($data->shortname
)) {
2395 if ($DB->record_exists('course', array('shortname' => $data->shortname
))) {
2396 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2400 // Check if the idnumber already exists.
2401 if (!empty($data->idnumber
)) {
2402 if ($DB->record_exists('course', array('idnumber' => $data->idnumber
))) {
2403 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2407 if ($errorcode = course_validate_dates((array)$data)) {
2408 throw new moodle_exception($errorcode);
2411 // Check if timecreated is given.
2412 $data->timecreated
= !empty($data->timecreated
) ?
$data->timecreated
: time();
2413 $data->timemodified
= $data->timecreated
;
2415 // place at beginning of any category
2416 $data->sortorder
= 0;
2418 if ($editoroptions) {
2419 // summary text is updated later, we need context to store the files first
2420 $data->summary
= '';
2421 $data->summary_format
= FORMAT_HTML
;
2424 if (!isset($data->visible
)) {
2425 // data not from form, add missing visibility info
2426 $data->visible
= $category->visible
;
2428 $data->visibleold
= $data->visible
;
2430 $newcourseid = $DB->insert_record('course', $data);
2431 $context = context_course
::instance($newcourseid, MUST_EXIST
);
2433 if ($editoroptions) {
2434 // Save the files used in the summary editor and store
2435 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2436 $DB->set_field('course', 'summary', $data->summary
, array('id'=>$newcourseid));
2437 $DB->set_field('course', 'summaryformat', $data->summary_format
, array('id'=>$newcourseid));
2439 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2440 // Save the course overviewfiles
2441 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2444 // update course format options
2445 course_get_format($newcourseid)->update_course_format_options($data);
2447 $course = course_get_format($newcourseid)->get_course();
2449 fix_course_sortorder();
2450 // purge appropriate caches in case fix_course_sortorder() did not change anything
2451 cache_helper
::purge_by_event('changesincourse');
2453 // new context created - better mark it as dirty
2454 $context->mark_dirty();
2456 // Trigger a course created event.
2457 $event = \core\event\course_created
::create(array(
2458 'objectid' => $course->id
,
2459 'context' => context_course
::instance($course->id
),
2460 'other' => array('shortname' => $course->shortname
,
2461 'fullname' => $course->fullname
)
2467 blocks_add_default_course_blocks($course);
2469 // Create default section and initial sections if specified (unless they've already been created earlier).
2470 // We do not want to call course_create_sections_if_missing() because to avoid creating course cache.
2471 $numsections = isset($data->numsections
) ?
$data->numsections
: 0;
2472 $existingsections = $DB->get_fieldset_sql('SELECT section from {course_sections} WHERE course = ?', [$newcourseid]);
2473 $newsections = array_diff(range(0, $numsections), $existingsections);
2474 foreach ($newsections as $sectionnum) {
2475 course_create_section($newcourseid, $sectionnum, true);
2478 // Save any custom role names.
2479 save_local_role_names($course->id
, (array)$data);
2481 // set up enrolments
2482 enrol_course_updated(true, $course, $data);
2484 // Update course tags.
2485 if (isset($data->tags
)) {
2486 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2495 * Please note this functions does not verify any access control,
2496 * the calling code is responsible for all validation (usually it is the form definition).
2498 * @param object $data - all the data needed for an entry in the 'course' table
2499 * @param array $editoroptions course description editor options
2502 function update_course($data, $editoroptions = NULL) {
2505 $data->timemodified
= time();
2507 // Prevent changes on front page course.
2508 if ($data->id
== SITEID
) {
2509 throw new moodle_exception('invalidcourse', 'error');
2512 $oldcourse = course_get_format($data->id
)->get_course();
2513 $context = context_course
::instance($oldcourse->id
);
2515 if ($editoroptions) {
2516 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2518 if ($overviewfilesoptions = course_overviewfiles_options($data->id
)) {
2519 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2522 // Check we don't have a duplicate shortname.
2523 if (!empty($data->shortname
) && $oldcourse->shortname
!= $data->shortname
) {
2524 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname
, $data->id
))) {
2525 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2529 // Check we don't have a duplicate idnumber.
2530 if (!empty($data->idnumber
) && $oldcourse->idnumber
!= $data->idnumber
) {
2531 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber
, $data->id
))) {
2532 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2536 if ($errorcode = course_validate_dates((array)$data)) {
2537 throw new moodle_exception($errorcode);
2540 if (!isset($data->category
) or empty($data->category
)) {
2541 // prevent nulls and 0 in category field
2542 unset($data->category
);
2544 $changesincoursecat = $movecat = (isset($data->category
) and $oldcourse->category
!= $data->category
);
2546 if (!isset($data->visible
)) {
2547 // data not from form, add missing visibility info
2548 $data->visible
= $oldcourse->visible
;
2551 if ($data->visible
!= $oldcourse->visible
) {
2552 // reset the visibleold flag when manually hiding/unhiding course
2553 $data->visibleold
= $data->visible
;
2554 $changesincoursecat = true;
2557 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category
));
2558 if (empty($newcategory->visible
)) {
2559 // make sure when moving into hidden category the course is hidden automatically
2565 // Set newsitems to 0 if format does not support announcements.
2566 if (isset($data->format
)) {
2567 $newcourseformat = course_get_format((object)['format' => $data->format
]);
2568 if (!$newcourseformat->supports_news()) {
2569 $data->newsitems
= 0;
2573 // Update with the new data
2574 $DB->update_record('course', $data);
2575 // make sure the modinfo cache is reset
2576 rebuild_course_cache($data->id
);
2578 // update course format options with full course data
2579 course_get_format($data->id
)->update_course_format_options($data, $oldcourse);
2581 $course = $DB->get_record('course', array('id'=>$data->id
));
2584 $newparent = context_coursecat
::instance($course->category
);
2585 $context->update_moved($newparent);
2587 $fixcoursesortorder = $movecat ||
(isset($data->sortorder
) && ($oldcourse->sortorder
!= $data->sortorder
));
2588 if ($fixcoursesortorder) {
2589 fix_course_sortorder();
2592 // purge appropriate caches in case fix_course_sortorder() did not change anything
2593 cache_helper
::purge_by_event('changesincourse');
2594 if ($changesincoursecat) {
2595 cache_helper
::purge_by_event('changesincoursecat');
2598 // Test for and remove blocks which aren't appropriate anymore
2599 blocks_remove_inappropriate($course);
2601 // Save any custom role names.
2602 save_local_role_names($course->id
, $data);
2604 // update enrol settings
2605 enrol_course_updated(false, $course, $data);
2607 // Update course tags.
2608 if (isset($data->tags
)) {
2609 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2612 // Trigger a course updated event.
2613 $event = \core\event\course_updated
::create(array(
2614 'objectid' => $course->id
,
2615 'context' => context_course
::instance($course->id
),
2616 'other' => array('shortname' => $course->shortname
,
2617 'fullname' => $course->fullname
)
2620 $event->set_legacy_logdata(array($course->id
, 'course', 'update', 'edit.php?id=' . $course->id
, $course->id
));
2623 if ($oldcourse->format
!== $course->format
) {
2624 // Remove all options stored for the previous format
2625 // We assume that new course format migrated everything it needed watching trigger
2626 // 'course_updated' and in method format_XXX::update_course_format_options()
2627 $DB->delete_records('course_format_options',
2628 array('courseid' => $course->id
, 'format' => $oldcourse->format
));
2633 * Average number of participants
2636 function average_number_of_participants() {
2639 //count total of enrolments for visible course (except front page)
2640 $sql = 'SELECT COUNT(*) FROM (
2641 SELECT DISTINCT ue.userid, e.courseid
2642 FROM {user_enrolments} ue, {enrol} e, {course} c
2643 WHERE ue.enrolid = e.id
2644 AND e.courseid <> :siteid
2645 AND c.id = e.courseid
2646 AND c.visible = 1) total';
2647 $params = array('siteid' => $SITE->id
);
2648 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2651 //count total of visible courses (minus front page)
2652 $coursetotal = $DB->count_records('course', array('visible' => 1));
2653 $coursetotal = $coursetotal - 1 ;
2655 //average of enrolment
2656 if (empty($coursetotal)) {
2657 $participantaverage = 0;
2659 $participantaverage = $enrolmenttotal / $coursetotal;
2662 return $participantaverage;
2666 * Average number of course modules
2669 function average_number_of_courses_modules() {
2672 //count total of visible course module (except front page)
2673 $sql = 'SELECT COUNT(*) FROM (
2674 SELECT cm.course, cm.module
2675 FROM {course} c, {course_modules} cm
2676 WHERE c.id = cm.course
2679 AND c.visible = 1) total';
2680 $params = array('siteid' => $SITE->id
);
2681 $moduletotal = $DB->count_records_sql($sql, $params);
2684 //count total of visible courses (minus front page)
2685 $coursetotal = $DB->count_records('course', array('visible' => 1));
2686 $coursetotal = $coursetotal - 1 ;
2688 //average of course module
2689 if (empty($coursetotal)) {
2690 $coursemoduleaverage = 0;
2692 $coursemoduleaverage = $moduletotal / $coursetotal;
2695 return $coursemoduleaverage;
2699 * This class pertains to course requests and contains methods associated with
2700 * create, approving, and removing course requests.
2702 * Please note we do not allow embedded images here because there is no context
2703 * to store them with proper access control.
2705 * @copyright 2009 Sam Hemelryk
2706 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2709 * @property-read int $id
2710 * @property-read string $fullname
2711 * @property-read string $shortname
2712 * @property-read string $summary
2713 * @property-read int $summaryformat
2714 * @property-read int $summarytrust
2715 * @property-read string $reason
2716 * @property-read int $requester
2718 class course_request
{
2721 * This is the stdClass that stores the properties for the course request
2722 * and is externally accessed through the __get magic method
2725 protected $properties;
2728 * An array of options for the summary editor used by course request forms.
2729 * This is initially set by {@link summary_editor_options()}
2733 protected static $summaryeditoroptions;
2736 * Static function to prepare the summary editor for working with a course
2740 * @param null|stdClass $data Optional, an object containing the default values
2741 * for the form, these may be modified when preparing the
2742 * editor so this should be called before creating the form
2743 * @return stdClass An object that can be used to set the default values for
2746 public static function prepare($data=null) {
2747 if ($data === null) {
2748 $data = new stdClass
;
2750 $data = file_prepare_standard_editor($data, 'summary', self
::summary_editor_options());
2755 * Static function to create a new course request when passed an array of properties
2758 * This function also handles saving any files that may have been used in the editor
2761 * @param stdClass $data
2762 * @return course_request The newly created course request
2764 public static function create($data) {
2765 global $USER, $DB, $CFG;
2766 $data->requester
= $USER->id
;
2768 // Setting the default category if none set.
2769 if (empty($data->category
) ||
empty($CFG->requestcategoryselection
)) {
2770 $data->category
= $CFG->defaultrequestcategory
;
2773 // Summary is a required field so copy the text over
2774 $data->summary
= $data->summary_editor
['text'];
2775 $data->summaryformat
= $data->summary_editor
['format'];
2777 $data->id
= $DB->insert_record('course_request', $data);
2779 // Create a new course_request object and return it
2780 $request = new course_request($data);
2782 // Notify the admin if required.
2783 if ($users = get_users_from_config($CFG->courserequestnotify
, 'moodle/site:approvecourse')) {
2786 $a->link
= "$CFG->wwwroot/course/pending.php";
2787 $a->user
= fullname($USER);
2788 $subject = get_string('courserequest');
2789 $message = get_string('courserequestnotifyemail', 'admin', $a);
2790 foreach ($users as $user) {
2791 $request->notify($user, $USER, 'courserequested', $subject, $message);
2799 * Returns an array of options to use with a summary editor
2801 * @uses course_request::$summaryeditoroptions
2802 * @return array An array of options to use with the editor
2804 public static function summary_editor_options() {
2806 if (self
::$summaryeditoroptions === null) {
2807 self
::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2809 return self
::$summaryeditoroptions;
2813 * Loads the properties for this course request object. Id is required and if
2814 * only id is provided then we load the rest of the properties from the database
2816 * @param stdClass|int $properties Either an object containing properties
2817 * or the course_request id to load
2819 public function __construct($properties) {
2821 if (empty($properties->id
)) {
2822 if (empty($properties)) {
2823 throw new coding_exception('You must provide a course request id when creating a course_request object');
2826 $properties = new stdClass
;
2827 $properties->id
= (int)$id;
2830 if (empty($properties->requester
)) {
2831 if (!($this->properties
= $DB->get_record('course_request', array('id' => $properties->id
)))) {
2832 print_error('unknowncourserequest');
2835 $this->properties
= $properties;
2837 $this->properties
->collision
= null;
2841 * Returns the requested property
2843 * @param string $key
2846 public function __get($key) {
2847 return $this->properties
->$key;
2851 * Override this to ensure empty($request->blah) calls return a reliable answer...
2853 * This is required because we define the __get method
2856 * @return bool True is it not empty, false otherwise
2858 public function __isset($key) {
2859 return (!empty($this->properties
->$key));
2863 * Returns the user who requested this course
2865 * Uses a static var to cache the results and cut down the number of db queries
2867 * @staticvar array $requesters An array of cached users
2868 * @return stdClass The user who requested the course
2870 public function get_requester() {
2872 static $requesters= array();
2873 if (!array_key_exists($this->properties
->requester
, $requesters)) {
2874 $requesters[$this->properties
->requester
] = $DB->get_record('user', array('id'=>$this->properties
->requester
));
2876 return $requesters[$this->properties
->requester
];
2880 * Checks that the shortname used by the course does not conflict with any other
2881 * courses that exist
2883 * @param string|null $shortnamemark The string to append to the requests shortname
2884 * should a conflict be found
2885 * @return bool true is there is a conflict, false otherwise
2887 public function check_shortname_collision($shortnamemark = '[*]') {
2890 if ($this->properties
->collision
!== null) {
2891 return $this->properties
->collision
;
2894 if (empty($this->properties
->shortname
)) {
2895 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER
);
2896 $this->properties
->collision
= false;
2897 } else if ($DB->record_exists('course', array('shortname' => $this->properties
->shortname
))) {
2898 if (!empty($shortnamemark)) {
2899 $this->properties
->shortname
.= ' '.$shortnamemark;
2901 $this->properties
->collision
= true;
2903 $this->properties
->collision
= false;
2905 return $this->properties
->collision
;
2909 * Returns the category where this course request should be created
2911 * Note that we don't check here that user has a capability to view
2912 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2913 * 'moodle/course:changecategory'
2915 * @return core_course_category
2917 public function get_category() {
2919 // If the category is not set, if the current user does not have the rights to change the category, or if the
2920 // category does not exist, we set the default category to the course to be approved.
2921 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2922 if (empty($this->properties
->category
) ||
!has_capability('moodle/course:changecategory', context_system
::instance()) ||
2923 (!$category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
, true))) {
2924 $category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
, true);
2927 $category = core_course_category
::get_default();
2933 * This function approves the request turning it into a course
2935 * This function converts the course request into a course, at the same time
2936 * transferring any files used in the summary to the new course and then removing
2937 * the course request and the files associated with it.
2939 * @return int The id of the course that was created from this request
2941 public function approve() {
2942 global $CFG, $DB, $USER;
2944 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
2946 $user = $DB->get_record('user', array('id' => $this->properties
->requester
, 'deleted'=>0), '*', MUST_EXIST
);
2948 $courseconfig = get_config('moodlecourse');
2950 // Transfer appropriate settings
2951 $data = clone($this->properties
);
2953 unset($data->reason
);
2954 unset($data->requester
);
2957 $category = $this->get_category();
2958 $data->category
= $category->id
;
2959 // Set misc settings
2960 $data->requested
= 1;
2962 // Apply course default settings
2963 $data->format
= $courseconfig->format
;
2964 $data->newsitems
= $courseconfig->newsitems
;
2965 $data->showgrades
= $courseconfig->showgrades
;
2966 $data->showreports
= $courseconfig->showreports
;
2967 $data->maxbytes
= $courseconfig->maxbytes
;
2968 $data->groupmode
= $courseconfig->groupmode
;
2969 $data->groupmodeforce
= $courseconfig->groupmodeforce
;
2970 $data->visible
= $courseconfig->visible
;
2971 $data->visibleold
= $data->visible
;
2972 $data->lang
= $courseconfig->lang
;
2973 $data->enablecompletion
= $courseconfig->enablecompletion
;
2974 $data->numsections
= $courseconfig->numsections
;
2975 $data->startdate
= usergetmidnight(time());
2976 if ($courseconfig->courseenddateenabled
) {
2977 $data->enddate
= usergetmidnight(time()) +
$courseconfig->courseduration
;
2980 list($data->fullname
, $data->shortname
) = restore_dbops
::calculate_course_names(0, $data->fullname
, $data->shortname
);
2982 $course = create_course($data);
2983 $context = context_course
::instance($course->id
, MUST_EXIST
);
2985 // add enrol instances
2986 if (!$DB->record_exists('enrol', array('courseid'=>$course->id
, 'enrol'=>'manual'))) {
2987 if ($manual = enrol_get_plugin('manual')) {
2988 $manual->add_default_instance($course);
2992 // enrol the requester as teacher if necessary
2993 if (!empty($CFG->creatornewroleid
) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2994 enrol_try_internal_enrol($course->id
, $user->id
, $CFG->creatornewroleid
);
2999 $a = new stdClass();
3000 $a->name
= format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
3001 $a->url
= $CFG->wwwroot
.'/course/view.php?id=' . $course->id
;
3002 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a), $course->id
);
3008 * Reject a course request
3010 * This function rejects a course request, emailing the requesting user the
3011 * provided notice and then removing the request from the database
3013 * @param string $notice The message to display to the user
3015 public function reject($notice) {
3017 $user = $DB->get_record('user', array('id' => $this->properties
->requester
), '*', MUST_EXIST
);
3018 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3023 * Deletes the course request and any associated files
3025 public function delete() {
3027 $DB->delete_records('course_request', array('id' => $this->properties
->id
));
3031 * Send a message from one user to another using events_trigger
3033 * @param object $touser
3034 * @param object $fromuser
3035 * @param string $name
3036 * @param string $subject
3037 * @param string $message
3038 * @param int|null $courseid
3040 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message, $courseid = null) {
3041 $eventdata = new \core\message\
message();
3042 $eventdata->courseid
= empty($courseid) ? SITEID
: $courseid;
3043 $eventdata->component
= 'moodle';
3044 $eventdata->name
= $name;
3045 $eventdata->userfrom
= $fromuser;
3046 $eventdata->userto
= $touser;
3047 $eventdata->subject
= $subject;
3048 $eventdata->fullmessage
= $message;
3049 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
3050 $eventdata->fullmessagehtml
= '';
3051 $eventdata->smallmessage
= '';
3052 $eventdata->notification
= 1;
3053 message_send($eventdata);
3058 * Return a list of page types
3059 * @param string $pagetype current page type
3060 * @param context $parentcontext Block's parent context
3061 * @param context $currentcontext Current context of block
3062 * @return array array of page types
3064 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3065 if ($pagetype === 'course-index' ||
$pagetype === 'course-index-category') {
3066 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3067 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3068 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3070 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) ||
$coursecontext->instanceid
== SITEID
)) {
3071 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3072 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3074 // Otherwise consider it a page inside a course even if $currentcontext is null
3075 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3076 'course-*' => get_string('page-course-x', 'pagetype'),
3077 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3084 * Determine whether course ajax should be enabled for the specified course
3086 * @param stdClass $course The course to test against
3087 * @return boolean Whether course ajax is enabled or note
3089 function course_ajax_enabled($course) {
3090 global $CFG, $PAGE, $SITE;
3092 // The user must be editing for AJAX to be included
3093 if (!$PAGE->user_is_editing()) {
3097 // Check that the theme suports
3098 if (!$PAGE->theme
->enablecourseajax
) {
3102 // Check that the course format supports ajax functionality
3103 // The site 'format' doesn't have information on course format support
3104 if ($SITE->id
!== $course->id
) {
3105 $courseformatajaxsupport = course_format_ajax_support($course->format
);
3106 if (!$courseformatajaxsupport->capable
) {
3111 // All conditions have been met so course ajax should be enabled
3116 * Include the relevant javascript and language strings for the resource
3117 * toolbox YUI module
3119 * @param integer $id The ID of the course being applied to
3120 * @param array $usedmodules An array containing the names of the modules in use on the page
3121 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3122 * @param stdClass $config An object containing configuration parameters for ajax modules including:
3123 * * resourceurl The URL to post changes to for resource changes
3124 * * sectionurl The URL to post changes to for section changes
3125 * * pageparams Additional parameters to pass through in the post
3128 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3129 global $CFG, $PAGE, $SITE;
3131 // Ensure that ajax should be included
3132 if (!course_ajax_enabled($course)) {
3137 $config = new stdClass();
3140 // The URL to use for resource changes
3141 if (!isset($config->resourceurl
)) {
3142 $config->resourceurl
= '/course/rest.php';
3145 // The URL to use for section changes
3146 if (!isset($config->sectionurl
)) {
3147 $config->sectionurl
= '/course/rest.php';
3150 // Any additional parameters which need to be included on page submission
3151 if (!isset($config->pageparams
)) {
3152 $config->pageparams
= array();
3155 // Include course dragdrop
3156 if (course_format_uses_sections($course->format
)) {
3157 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3159 'courseid' => $course->id
,
3160 'ajaxurl' => $config->sectionurl
,
3161 'config' => $config,
3164 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3166 'courseid' => $course->id
,
3167 'ajaxurl' => $config->resourceurl
,
3168 'config' => $config,
3172 // Require various strings for the command toolbox
3173 $PAGE->requires
->strings_for_js(array(
3176 'deletechecktypename',
3178 'edittitleinstructions',
3186 'clicktochangeinbrackets',
3191 'movecoursesection',
3194 'emptydragdropregion',
3200 // Include section-specific strings for formats which support sections.
3201 if (course_format_uses_sections($course->format
)) {
3202 $PAGE->requires
->strings_for_js(array(
3205 ), 'format_' . $course->format
);
3208 // For confirming resource deletion we need the name of the module in question
3209 foreach ($usedmodules as $module => $modname) {
3210 $PAGE->requires
->string_for_js('pluginname', $module);
3213 // Load drag and drop upload AJAX.
3214 require_once($CFG->dirroot
.'/course/dnduploadlib.php');
3215 dndupload_add_to_course($course, $enabledmodules);
3217 $PAGE->requires
->js_call_amd('core_course/actions', 'initCoursePage', array($course->format
));
3223 * Returns the sorted list of available course formats, filtered by enabled if necessary
3225 * @param bool $enabledonly return only formats that are enabled
3226 * @return array array of sorted format names
3228 function get_sorted_course_formats($enabledonly = false) {
3230 $formats = core_component
::get_plugin_list('format');
3232 if (!empty($CFG->format_plugins_sortorder
)) {
3233 $order = explode(',', $CFG->format_plugins_sortorder
);
3234 $order = array_merge(array_intersect($order, array_keys($formats)),
3235 array_diff(array_keys($formats), $order));
3237 $order = array_keys($formats);
3239 if (!$enabledonly) {
3242 $sortedformats = array();
3243 foreach ($order as $formatname) {
3244 if (!get_config('format_'.$formatname, 'disabled')) {
3245 $sortedformats[] = $formatname;
3248 return $sortedformats;
3252 * The URL to use for the specified course (with section)
3254 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3255 * @param int|stdClass $section Section object from database or just field course_sections.section
3256 * if omitted the course view page is returned
3257 * @param array $options options for view URL. At the moment core uses:
3258 * 'navigation' (bool) if true and section has no separate page, the function returns null
3259 * 'sr' (int) used by multipage formats to specify to which section to return
3260 * @return moodle_url The url of course
3262 function course_get_url($courseorid, $section = null, $options = array()) {
3263 return course_get_format($courseorid)->get_view_url($section, $options);
3270 * - capability checks and other checks
3271 * - create the module from the module info
3273 * @param object $module
3274 * @return object the created module info
3275 * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3277 function create_module($moduleinfo) {
3280 require_once($CFG->dirroot
. '/course/modlib.php');
3282 // Check manadatory attributs.
3283 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3284 if (plugin_supports('mod', $moduleinfo->modulename
, FEATURE_MOD_INTRO
, true)) {
3285 $mandatoryfields[] = 'introeditor';
3287 foreach($mandatoryfields as $mandatoryfield) {
3288 if (!isset($moduleinfo->{$mandatoryfield})) {
3289 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3293 // Some additional checks (capability / existing instances).
3294 $course = $DB->get_record('course', array('id'=>$moduleinfo->course
), '*', MUST_EXIST
);
3295 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename
, $moduleinfo->section
);
3298 $moduleinfo->module
= $module->id
;
3299 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3308 * - capability and other checks
3309 * - update the module
3311 * @param object $module
3312 * @return object the updated module info
3313 * @throws moodle_exception if current user is not allowed to update the module
3315 function update_module($moduleinfo) {
3318 require_once($CFG->dirroot
. '/course/modlib.php');
3320 // Check the course module exists.
3321 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule
, 0, false, MUST_EXIST
);
3323 // Check the course exists.
3324 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
3326 // Some checks (capaibility / existing instances).
3327 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3329 // Retrieve few information needed by update_moduleinfo.
3330 $moduleinfo->modulename
= $cm->modname
;
3331 if (!isset($moduleinfo->scale
)) {
3332 $moduleinfo->scale
= 0;
3334 $moduleinfo->type
= 'mod';
3336 // Update the module.
3337 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3343 * Duplicate a module on the course for ajax.
3345 * @see mod_duplicate_module()
3346 * @param object $course The course
3347 * @param object $cm The course module to duplicate
3348 * @param int $sr The section to link back to (used for creating the links)
3349 * @throws moodle_exception if the plugin doesn't support duplication
3350 * @return Object containing:
3351 * - fullcontent: The HTML markup for the created CM
3352 * - cmid: The CMID of the newly created CM
3353 * - redirect: Whether to trigger a redirect following this change
3355 function mod_duplicate_activity($course, $cm, $sr = null) {
3358 $newcm = duplicate_module($course, $cm);
3360 $resp = new stdClass();
3362 $courserenderer = $PAGE->get_renderer('core', 'course');
3363 $completioninfo = new completion_info($course);
3364 $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3365 $newcm, null, array());
3367 $resp->fullcontent
= $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3368 $resp->cmid
= $newcm->id
;
3370 // Trigger a redirect.
3371 $resp->redirect
= true;
3377 * Api to duplicate a module.
3379 * @param object $course course object.
3380 * @param object $cm course module object to be duplicated.
3384 * @throws coding_exception
3385 * @throws moodle_exception
3386 * @throws restore_controller_exception
3388 * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3390 function duplicate_module($course, $cm) {
3391 global $CFG, $DB, $USER;
3392 require_once($CFG->dirroot
. '/backup/util/includes/backup_includes.php');
3393 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
3394 require_once($CFG->libdir
. '/filelib.php');
3396 $a = new stdClass();
3397 $a->modtype
= get_string('modulename', $cm->modname
);
3398 $a->modname
= format_string($cm->name
);
3400 if (!plugin_supports('mod', $cm->modname
, FEATURE_BACKUP_MOODLE2
)) {
3401 throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3404 // Backup the activity.
3406 $bc = new backup_controller(backup
::TYPE_1ACTIVITY
, $cm->id
, backup
::FORMAT_MOODLE
,
3407 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
);
3409 $backupid = $bc->get_backupid();
3410 $backupbasepath = $bc->get_plan()->get_basepath();
3412 $bc->execute_plan();
3416 // Restore the backup immediately.
3418 $rc = new restore_controller($backupid, $course->id
,
3419 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
, backup
::TARGET_CURRENT_ADDING
);
3421 $cmcontext = context_module
::instance($cm->id
);
3422 if (!$rc->execute_precheck()) {
3423 $precheckresults = $rc->get_precheck_results();
3424 if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3425 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3426 fulldelete($backupbasepath);
3431 $rc->execute_plan();
3433 // Now a bit hacky part follows - we try to get the cmid of the newly
3434 // restored copy of the module.
3436 $tasks = $rc->get_plan()->get_tasks();
3437 foreach ($tasks as $task) {
3438 if (is_subclass_of($task, 'restore_activity_task')) {
3439 if ($task->get_old_contextid() == $cmcontext->id
) {
3440 $newcmid = $task->get_moduleid();
3448 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3449 fulldelete($backupbasepath);
3452 // If we know the cmid of the new course module, let us move it
3453 // right below the original one. otherwise it will stay at the
3454 // end of the section.
3456 $section = $DB->get_record('course_sections', array('id' => $cm->section
, 'course' => $cm->course
));
3457 $modarray = explode(",", trim($section->sequence
));
3458 $cmindex = array_search($cm->id
, $modarray);
3459 if ($cmindex !== false && $cmindex < count($modarray) - 1) {
3460 $newcm = get_coursemodule_from_id($cm->modname
, $newcmid, $cm->course
);
3461 moveto_module($newcm, $section, $modarray[$cmindex +
1]);
3464 // Update calendar events with the duplicated module.
3465 // The following line is to be removed in MDL-58906.
3466 course_module_update_calendar_events($newcm->modname
, null, $newcm);
3468 // Trigger course module created event. We can trigger the event only if we know the newcmid.
3469 $newcm = get_fast_modinfo($cm->course
)->get_cm($newcmid);
3470 $event = \core\event\course_module_created
::create_from_cm($newcm);
3474 return isset($newcm) ?
$newcm : null;
3478 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3479 * Sorts by descending order of time.
3481 * @param stdClass $a First object
3482 * @param stdClass $b Second object
3483 * @return int 0,1,-1 representing the order
3485 function compare_activities_by_time_desc($a, $b) {
3486 // Make sure the activities actually have a timestamp property.
3487 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3490 // We treat instances without timestamp as if they have a timestamp of 0.
3491 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3494 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3497 if ($a->timestamp
== $b->timestamp
) {
3500 return ($a->timestamp
> $b->timestamp
) ?
-1 : 1;
3504 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3505 * Sorts by ascending order of time.
3507 * @param stdClass $a First object
3508 * @param stdClass $b Second object
3509 * @return int 0,1,-1 representing the order
3511 function compare_activities_by_time_asc($a, $b) {
3512 // Make sure the activities actually have a timestamp property.
3513 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3516 // We treat instances without timestamp as if they have a timestamp of 0.
3517 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3520 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3523 if ($a->timestamp
== $b->timestamp
) {
3526 return ($a->timestamp
< $b->timestamp
) ?
-1 : 1;
3530 * Changes the visibility of a course.
3532 * @param int $courseid The course to change.
3533 * @param bool $show True to make it visible, false otherwise.
3536 function course_change_visibility($courseid, $show = true) {
3537 $course = new stdClass
;
3538 $course->id
= $courseid;
3539 $course->visible
= ($show) ?
'1' : '0';
3540 $course->visibleold
= $course->visible
;
3541 update_course($course);
3546 * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3548 * @param stdClass|core_course_list_element $course
3549 * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3552 function course_change_sortorder_by_one($course, $up) {
3554 $params = array($course->sortorder
, $course->category
);
3556 $select = 'sortorder < ? AND category = ?';
3557 $sort = 'sortorder DESC';
3559 $select = 'sortorder > ? AND category = ?';
3560 $sort = 'sortorder ASC';
3562 fix_course_sortorder();
3563 $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3565 $swapcourse = reset($swapcourse);
3566 $DB->set_field('course', 'sortorder', $swapcourse->sortorder
, array('id' => $course->id
));
3567 $DB->set_field('course', 'sortorder', $course->sortorder
, array('id' => $swapcourse->id
));
3568 // Finally reorder courses.
3569 fix_course_sortorder();
3570 cache_helper
::purge_by_event('changesincourse');
3577 * Changes the sort order of courses in a category so that the first course appears after the second.
3579 * @param int|stdClass $courseorid The course to focus on.
3580 * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3583 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3586 if (!is_object($courseorid)) {
3587 $course = get_course($courseorid);
3589 $course = $courseorid;
3592 if ((int)$moveaftercourseid === 0) {
3593 // We've moving the course to the start of the queue.
3594 $sql = 'SELECT sortorder
3596 WHERE category = :categoryid
3597 ORDER BY sortorder';
3599 'categoryid' => $course->category
3601 $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE
);
3603 $sql = 'UPDATE {course}
3604 SET sortorder = sortorder + 1
3605 WHERE category = :categoryid
3608 'categoryid' => $course->category
,
3609 'id' => $course->id
,
3611 $DB->execute($sql, $params);
3612 $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id
));
3613 } else if ($course->id
=== $moveaftercourseid) {
3614 // They're the same - moronic.
3615 debugging("Invalid move after course given.", DEBUG_DEVELOPER
);
3618 // Moving this course after the given course. It could be before it could be after.
3619 $moveaftercourse = get_course($moveaftercourseid);
3620 if ($course->category
!== $moveaftercourse->category
) {
3621 debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER
);
3624 // Increment all courses in the same category that are ordered after the moveafter course.
3625 // This makes a space for the course we're moving.
3626 $sql = 'UPDATE {course}
3627 SET sortorder = sortorder + 1
3628 WHERE category = :categoryid
3629 AND sortorder > :sortorder';
3631 'categoryid' => $moveaftercourse->category
,
3632 'sortorder' => $moveaftercourse->sortorder
3634 $DB->execute($sql, $params);
3635 $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder +
1, array('id' => $course->id
));
3637 fix_course_sortorder();
3638 cache_helper
::purge_by_event('changesincourse');
3643 * Trigger course viewed event. This API function is used when course view actions happens,
3644 * usually in course/view.php but also in external functions.
3646 * @param stdClass $context course context object
3647 * @param int $sectionnumber section number
3650 function course_view($context, $sectionnumber = 0) {
3652 $eventdata = array('context' => $context);
3654 if (!empty($sectionnumber)) {
3655 $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3658 $event = \core\event\course_viewed
::create($eventdata);
3663 * Returns courses tagged with a specified tag.
3665 * @param core_tag_tag $tag
3666 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3667 * are displayed on the page and the per-page limit may be bigger
3668 * @param int $fromctx context id where the link was displayed, may be used by callbacks
3669 * to display items in the same context first
3670 * @param int $ctx context id where to search for records
3671 * @param bool $rec search in subcontexts as well
3672 * @param int $page 0-based number of page being displayed
3673 * @return \core_tag\output\tagindex
3675 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3678 $perpage = $exclusivemode ?
$CFG->coursesperpage
: 5;
3679 $displayoptions = array(
3680 'limit' => $perpage,
3681 'offset' => $page * $perpage,
3682 'viewmoreurl' => null,
3685 $courserenderer = $PAGE->get_renderer('core', 'course');
3686 $totalcount = core_course_category
::search_courses_count(array('tagid' => $tag->id
, 'ctx' => $ctx, 'rec' => $rec));
3687 $content = $courserenderer->tagged_courses($tag->id
, $exclusivemode, $ctx, $rec, $displayoptions);
3688 $totalpages = ceil($totalcount / $perpage);
3690 return new core_tag\output\tagindex
($tag, 'core', 'course', $content,
3691 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3695 * Implements callback inplace_editable() allowing to edit values in-place
3697 * @param string $itemtype
3698 * @param int $itemid
3699 * @param mixed $newvalue
3700 * @return \core\output\inplace_editable
3702 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3703 if ($itemtype === 'activityname') {
3704 return \core_course\output\course_module_name
::update($itemid, $newvalue);
3709 * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3711 * This is a callback used by the tag area core/course_modules to search for course modules
3712 * tagged with a specific tag.
3714 * @param core_tag_tag $tag
3715 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3716 * are displayed on the page and the per-page limit may be bigger
3717 * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3718 * to display items in the same context first
3719 * @param int $contextid context id where to search for records
3720 * @param bool $recursivecontext search in subcontexts as well
3721 * @param int $page 0-based number of page being displayed
3722 * @return \core_tag\output\tagindex
3724 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3725 $recursivecontext = 1, $page = 0) {
3727 $perpage = $exclusivemode ?
20 : 5;
3729 // Build select query.
3730 $ctxselect = context_helper
::get_preload_record_columns_sql('ctx');
3731 $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3732 FROM {course_modules} cm
3733 JOIN {tag_instance} tt ON cm.id = tt.itemid
3734 JOIN {course} c ON cm.course = c.id
3735 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3736 WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3737 AND cm.deletioninprogress = 0
3738 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3740 $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id
, 'component' => 'core',
3741 'coursemodulecontextlevel' => CONTEXT_MODULE
);
3743 $context = context
::instance_by_id($contextid);
3744 $query .= $recursivecontext ?
' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3745 $params['contextid'] = $context->id
;
3746 $params['path'] = $context->path
.'/%';
3749 $query .= ' ORDER BY';
3750 if ($fromcontextid) {
3751 // In order-clause specify that modules from inside "fromctx" context should be returned first.
3752 $fromcontext = context
::instance_by_id($fromcontextid);
3753 $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3754 $params['fromcontextid'] = $fromcontext->id
;
3755 $params['frompath'] = $fromcontext->path
.'/%';
3757 $query .= ' c.sortorder, cm.id';
3758 $totalpages = $page +
1;
3760 // Use core_tag_index_builder to build and filter the list of items.
3761 // Request one item more than we need so we know if next page exists.
3762 $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage +
1);
3763 while ($item = $builder->has_item_that_needs_access_check()) {
3764 context_helper
::preload_from_record($item);
3765 $courseid = $item->courseid
;
3766 if (!$builder->can_access_course($courseid)) {
3767 $builder->set_accessible($item, false);
3770 $modinfo = get_fast_modinfo($builder->get_course($courseid));
3771 // Set accessibility of this item and all other items in the same course.
3772 $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3773 if ($taggeditem->courseid
== $courseid) {
3774 $cm = $modinfo->get_cm($taggeditem->cmid
);
3775 $builder->set_accessible($taggeditem, $cm->uservisible
);
3780 $items = $builder->get_items();
3781 if (count($items) > $perpage) {
3782 $totalpages = $page +
2; // We don't need exact page count, just indicate that the next page exists.
3786 // Build the display contents.
3788 $tagfeed = new core_tag\output\tagfeed
();
3789 foreach ($items as $item) {
3790 context_helper
::preload_from_record($item);
3791 $course = $builder->get_course($item->courseid
);
3792 $modinfo = get_fast_modinfo($course);
3793 $cm = $modinfo->get_cm($item->cmid
);
3794 $courseurl = course_get_url($item->courseid
, $cm->sectionnum
);
3795 $cmname = $cm->get_formatted_name();
3796 if (!$exclusivemode) {
3797 $cmname = shorten_text($cmname, 100);
3799 $cmname = html_writer
::link($cm->url?
:$courseurl, $cmname);
3800 $coursename = format_string($course->fullname
, true,
3801 array('context' => context_course
::instance($item->courseid
)));
3802 $coursename = html_writer
::link($courseurl, $coursename);
3803 $icon = html_writer
::empty_tag('img', array('src' => $cm->get_icon_url()));
3804 $tagfeed->add($icon, $cmname, $coursename);
3807 $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3808 $tagfeed->export_for_template($OUTPUT));
3810 return new core_tag\output\tagindex
($tag, 'core', 'course_modules', $content,
3811 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3816 * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3817 * This function also handles the frontpage course.
3819 * @param stdClass $context context object (it can be a course context or the system context for frontpage settings)
3820 * @param stdClass $course the course where the settings are being rendered
3821 * @return stdClass the navigation options in a course and their availability status
3824 function course_get_user_navigation_options($context, $course = null) {
3827 $isloggedin = isloggedin();
3828 $isguestuser = isguestuser();
3829 $isfrontpage = $context->contextlevel
== CONTEXT_SYSTEM
;
3832 $sitecontext = $context;
3834 $sitecontext = context_system
::instance();
3837 // Sets defaults for all options.
3838 $options = (object) [
3841 'calendar' => false,
3842 'competencies' => false,
3845 'participants' => false,
3850 $options->blogs
= !empty($CFG->enableblogs
) &&
3851 ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL ||
3852 ($CFG->bloglevel
== BLOG_SITE_LEVEL
and ($isloggedin and !$isguestuser)))
3853 && has_capability('moodle/blog:view', $sitecontext);
3855 $options->notes
= !empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
3857 // Frontpage settings?
3859 // We are on the front page, so make sure we use the proper capability (site:viewparticipants).
3860 $options->participants
= course_can_view_participants($sitecontext);
3861 $options->badges
= !empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $sitecontext);
3862 $options->tags
= !empty($CFG->usetags
) && $isloggedin;
3863 $options->search
= !empty($CFG->enableglobalsearch
) && has_capability('moodle/search:query', $sitecontext);
3864 $options->calendar
= $isloggedin;
3866 // We are in a course, so make sure we use the proper capability (course:viewparticipants).
3867 $options->participants
= course_can_view_participants($context);
3868 $options->badges
= !empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
3869 has_capability('moodle/badges:viewbadges', $context);
3870 // Add view grade report is permitted.
3873 if (has_capability('moodle/grade:viewall', $context)) {
3875 } else if (!empty($course->showgrades
)) {
3876 $reports = core_component
::get_plugin_list('gradereport');
3877 if (is_array($reports) && count($reports) > 0) { // Get all installed reports.
3878 arsort($reports); // User is last, we want to test it first.
3879 foreach ($reports as $plugin => $plugindir) {
3880 if (has_capability('gradereport/'.$plugin.':view', $context)) {
3881 // Stop when the first visible plugin is found.
3888 $options->grades
= $grades;
3891 if (\core_competency\api
::is_enabled()) {
3892 $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
3893 $options->competencies
= has_any_capability($capabilities, $context);
3899 * Return an object with the list of administration options in a course that are available or not for the current user.
3900 * This function also handles the frontpage settings.
3902 * @param stdClass $course course object (for frontpage it should be a clone of $SITE)
3903 * @param stdClass $context context object (course context)
3904 * @return stdClass the administration options in a course and their availability status
3907 function course_get_user_administration_options($course, $context) {
3909 $isfrontpage = $course->id
== SITEID
;
3910 $completionenabled = $CFG->enablecompletion
&& $course->enablecompletion
;
3911 $hascompletiontabs = count(core_completion\manager
::get_available_completion_tabs($course, $context)) > 0;
3913 $options = new stdClass
;
3914 $options->update
= has_capability('moodle/course:update', $context);
3915 $options->editcompletion
= $CFG->enablecompletion
&&
3916 $course->enablecompletion
&&
3917 ($options->update ||
$hascompletiontabs);
3918 $options->filters
= has_capability('moodle/filter:manage', $context) &&
3919 count(filter_get_available_in_context($context)) > 0;
3920 $options->reports
= has_capability('moodle/site:viewreports', $context);
3921 $options->backup
= has_capability('moodle/backup:backupcourse', $context);
3922 $options->restore
= has_capability('moodle/restore:restorecourse', $context);
3923 $options->files
= ($course->legacyfiles
== 2 && has_capability('moodle/course:managefiles', $context));
3925 if (!$isfrontpage) {
3926 $options->tags
= has_capability('moodle/course:tag', $context);
3927 $options->gradebook
= has_capability('moodle/grade:manage', $context);
3928 $options->outcomes
= !empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $context);
3929 $options->badges
= !empty($CFG->enablebadges
);
3930 $options->import
= has_capability('moodle/restore:restoretargetimport', $context);
3931 $options->publish
= has_capability('moodle/course:publish', $context);
3932 $options->reset
= has_capability('moodle/course:reset', $context);
3933 $options->roles
= has_capability('moodle/role:switchroles', $context);
3935 // Set default options to false.
3936 $listofoptions = array('tags', 'gradebook', 'outcomes', 'badges', 'import', 'publish', 'reset', 'roles', 'grades');
3938 foreach ($listofoptions as $option) {
3939 $options->$option = false;
3947 * Validates course start and end dates.
3949 * Checks that the end course date is not greater than the start course date.
3951 * $coursedata['startdate'] or $coursedata['enddate'] may not be set, it depends on the form and user input.
3953 * @param array $coursedata May contain startdate and enddate timestamps, depends on the user input.
3954 * @return mixed False if everything alright, error codes otherwise.
3956 function course_validate_dates($coursedata) {
3958 // If both start and end dates are set end date should be later than the start date.
3959 if (!empty($coursedata['startdate']) && !empty($coursedata['enddate']) &&
3960 ($coursedata['enddate'] < $coursedata['startdate'])) {
3961 return 'enddatebeforestartdate';
3964 // If start date is not set end date can not be set.
3965 if (empty($coursedata['startdate']) && !empty($coursedata['enddate'])) {
3966 return 'nostartdatenoenddate';
3973 * Check for course updates in the given context level instances (only modules supported right Now)
3975 * @param stdClass $course course object
3976 * @param array $tocheck instances to check for updates
3977 * @param array $filter check only for updates in these areas
3978 * @return array list of warnings and instances with updates information
3981 function course_check_updates($course, $tocheck, $filter = array()) {
3984 $instances = array();
3985 $warnings = array();
3986 $modulescallbacksupport = array();
3987 $modinfo = get_fast_modinfo($course);
3989 $supportedplugins = get_plugin_list_with_function('mod', 'check_updates_since');
3992 foreach ($tocheck as $instance) {
3993 if ($instance['contextlevel'] == 'module') {
3994 // Check module visibility.
3996 $cm = $modinfo->get_cm($instance['id']);
3997 } catch (Exception
$e) {
3998 $warnings[] = array(
4000 'itemid' => $instance['id'],
4001 'warningcode' => 'cmidnotincourse',
4002 'message' => 'This module id does not belong to this course.'
4007 if (!$cm->uservisible
) {
4008 $warnings[] = array(
4010 'itemid' => $instance['id'],
4011 'warningcode' => 'nonuservisible',
4012 'message' => 'You don\'t have access to this module.'
4016 if (empty($supportedplugins['mod_' . $cm->modname
])) {
4017 $warnings[] = array(
4019 'itemid' => $instance['id'],
4020 'warningcode' => 'missingcallback',
4021 'message' => 'This module does not implement the check_updates_since callback: ' . $instance['contextlevel'],
4025 // Retrieve the module instance.
4026 $instances[] = array(
4027 'contextlevel' => $instance['contextlevel'],
4028 'id' => $instance['id'],
4029 'updates' => call_user_func($cm->modname
. '_check_updates_since', $cm, $instance['since'], $filter)
4033 $warnings[] = array(
4034 'item' => 'contextlevel',
4035 'itemid' => $instance['id'],
4036 'warningcode' => 'contextlevelnotsupported',
4037 'message' => 'Context level not yet supported ' . $instance['contextlevel'],
4041 return array($instances, $warnings);
4045 * This function classifies a course as past, in progress or future.
4047 * This function may incur a DB hit to calculate course completion.
4048 * @param stdClass $course Course record
4049 * @param stdClass $user User record (optional - defaults to $USER).
4050 * @param completion_info $completioninfo Completion record for the user (optional - will be fetched if required).
4051 * @return string (one of COURSE_TIMELINE_FUTURE, COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_PAST)
4053 function course_classify_for_timeline($course, $user = null, $completioninfo = null) {
4056 if ($user == null) {
4062 if (!empty($course->enddate
) && $course->enddate
< $today) {
4063 return COURSE_TIMELINE_PAST
;
4066 if ($completioninfo == null) {
4067 $completioninfo = new completion_info($course);
4070 // Course was completed.
4071 if ($completioninfo->is_enabled() && $completioninfo->is_course_complete($user->id
)) {
4072 return COURSE_TIMELINE_PAST
;
4075 // Start date not reached.
4076 if (!empty($course->startdate
) && $course->startdate
> $today) {
4077 return COURSE_TIMELINE_FUTURE
;
4080 // Everything else is in progress.
4081 return COURSE_TIMELINE_INPROGRESS
;
4085 * Check module updates since a given time.
4086 * This function checks for updates in the module config, file areas, completion, grades, comments and ratings.
4088 * @param cm_info $cm course module data
4089 * @param int $from the time to check
4090 * @param array $fileareas additional file ares to check
4091 * @param array $filter if we need to filter and return only selected updates
4092 * @return stdClass object with the different updates
4095 function course_check_module_updates_since($cm, $from, $fileareas = array(), $filter = array()) {
4096 global $DB, $CFG, $USER;
4098 $context = $cm->context
;
4099 $mod = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
4101 $updates = new stdClass();
4102 $course = get_course($cm->course
);
4103 $component = 'mod_' . $cm->modname
;
4105 // Check changes in the module configuration.
4106 if (isset($mod->timemodified
) and (empty($filter) or in_array('configuration', $filter))) {
4107 $updates->configuration
= (object) array('updated' => false);
4108 if ($updates->configuration
->updated
= $mod->timemodified
> $from) {
4109 $updates->configuration
->timeupdated
= $mod->timemodified
;
4113 // Check for updates in files.
4114 if (plugin_supports('mod', $cm->modname
, FEATURE_MOD_INTRO
)) {
4115 $fileareas[] = 'intro';
4117 if (!empty($fileareas) and (empty($filter) or in_array('fileareas', $filter))) {
4118 $fs = get_file_storage();
4119 $files = $fs->get_area_files($context->id
, $component, $fileareas, false, "filearea, timemodified DESC", false, $from);
4120 foreach ($fileareas as $filearea) {
4121 $updates->{$filearea . 'files'} = (object) array('updated' => false);
4123 foreach ($files as $file) {
4124 $updates->{$file->get_filearea() . 'files'}->updated
= true;
4125 $updates->{$file->get_filearea() . 'files'}->itemids
[] = $file->get_id();
4129 // Check completion.
4130 $supportcompletion = plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_HAS_RULES
);
4131 $supportcompletion = $supportcompletion or plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_TRACKS_VIEWS
);
4132 if ($supportcompletion and (empty($filter) or in_array('completion', $filter))) {
4133 $updates->completion
= (object) array('updated' => false);
4134 $completion = new completion_info($course);
4135 // Use wholecourse to cache all the modules the first time.
4136 $completiondata = $completion->get_data($cm, true);
4137 if ($updates->completion
->updated
= !empty($completiondata->timemodified
) && $completiondata->timemodified
> $from) {
4138 $updates->completion
->timemodified
= $completiondata->timemodified
;
4143 $supportgrades = plugin_supports('mod', $cm->modname
, FEATURE_GRADE_HAS_GRADE
);
4144 $supportgrades = $supportgrades or plugin_supports('mod', $cm->modname
, FEATURE_GRADE_OUTCOMES
);
4145 if ($supportgrades and (empty($filter) or (in_array('gradeitems', $filter) or in_array('outcomes', $filter)))) {
4146 require_once($CFG->libdir
. '/gradelib.php');
4147 $grades = grade_get_grades($course->id
, 'mod', $cm->modname
, $mod->id
, $USER->id
);
4149 if (empty($filter) or in_array('gradeitems', $filter)) {
4150 $updates->gradeitems
= (object) array('updated' => false);
4151 foreach ($grades->items
as $gradeitem) {
4152 foreach ($gradeitem->grades
as $grade) {
4153 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4154 $updates->gradeitems
->updated
= true;
4155 $updates->gradeitems
->itemids
[] = $gradeitem->id
;
4161 if (empty($filter) or in_array('outcomes', $filter)) {
4162 $updates->outcomes
= (object) array('updated' => false);
4163 foreach ($grades->outcomes
as $outcome) {
4164 foreach ($outcome->grades
as $grade) {
4165 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4166 $updates->outcomes
->updated
= true;
4167 $updates->outcomes
->itemids
[] = $outcome->id
;
4175 if (plugin_supports('mod', $cm->modname
, FEATURE_COMMENT
) and (empty($filter) or in_array('comments', $filter))) {
4176 $updates->comments
= (object) array('updated' => false);
4177 require_once($CFG->dirroot
. '/comment/lib.php');
4178 require_once($CFG->dirroot
. '/comment/locallib.php');
4179 $manager = new comment_manager();
4180 $comments = $manager->get_component_comments_since($course, $context, $component, $from, $cm);
4181 if (!empty($comments)) {
4182 $updates->comments
->updated
= true;
4183 $updates->comments
->itemids
= array_keys($comments);
4188 if (plugin_supports('mod', $cm->modname
, FEATURE_RATE
) and (empty($filter) or in_array('ratings', $filter))) {
4189 $updates->ratings
= (object) array('updated' => false);
4190 require_once($CFG->dirroot
. '/rating/lib.php');
4191 $manager = new rating_manager();
4192 $ratings = $manager->get_component_ratings_since($context, $component, $from);
4193 if (!empty($ratings)) {
4194 $updates->ratings
->updated
= true;
4195 $updates->ratings
->itemids
= array_keys($ratings);
4203 * Returns true if the user can view the participant page, false otherwise,
4205 * @param context $context The context we are checking.
4208 function course_can_view_participants($context) {
4209 $viewparticipantscap = 'moodle/course:viewparticipants';
4210 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4211 $viewparticipantscap = 'moodle/site:viewparticipants';
4214 return has_any_capability([$viewparticipantscap, 'moodle/course:enrolreview'], $context);
4218 * Checks if a user can view the participant page, if not throws an exception.
4220 * @param context $context The context we are checking.
4221 * @throws required_capability_exception
4223 function course_require_view_participants($context) {
4224 if (!course_can_view_participants($context)) {
4225 $viewparticipantscap = 'moodle/course:viewparticipants';
4226 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4227 $viewparticipantscap = 'moodle/site:viewparticipants';
4229 throw new required_capability_exception($context, $viewparticipantscap, 'nopermissions', '');
4234 * Return whether the user can download from the specified backup file area in the given context.
4236 * @param string $filearea the backup file area. E.g. 'course', 'backup' or 'automated'.
4237 * @param \context $context
4238 * @param stdClass $user the user object. If not provided, the current user will be checked.
4239 * @return bool true if the user is allowed to download in the context, false otherwise.
4241 function can_download_from_backup_filearea($filearea, \context
$context, stdClass
$user = null) {
4242 $candownload = false;
4243 switch ($filearea) {
4246 $candownload = has_capability('moodle/backup:downloadfile', $context, $user);
4249 // Given the automated backups may contain userinfo, we restrict access such that only users who are able to
4250 // restore with userinfo are able to download the file. Users can't create these backups, so checking 'backup:userinfo'
4251 // doesn't make sense here.
4252 $candownload = has_capability('moodle/backup:downloadfile', $context, $user) &&
4253 has_capability('moodle/restore:userinfo', $context, $user);
4259 return $candownload;