2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Library of useful functions
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 * @package core_course
25 defined('MOODLE_INTERNAL') ||
die;
27 require_once($CFG->libdir
.'/completionlib.php');
28 require_once($CFG->libdir
.'/filelib.php');
29 require_once($CFG->libdir
.'/datalib.php');
30 require_once($CFG->dirroot
.'/course/format/lib.php');
32 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
33 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
36 * Number of courses to display when summaries are included.
38 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
40 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
42 // Max courses in log dropdown before switching to optional.
43 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
44 // Max users in log dropdown before switching to optional.
45 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
46 define('FRONTPAGENEWS', '0');
47 define('FRONTPAGECATEGORYNAMES', '2');
48 define('FRONTPAGECATEGORYCOMBO', '4');
49 define('FRONTPAGEENROLLEDCOURSELIST', '5');
50 define('FRONTPAGEALLCOURSELIST', '6');
51 define('FRONTPAGECOURSESEARCH', '7');
52 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
53 define('EXCELROWS', 65535);
54 define('FIRSTUSEDEXCELROW', 3);
56 define('MOD_CLASS_ACTIVITY', 0);
57 define('MOD_CLASS_RESOURCE', 1);
59 define('COURSE_TIMELINE_ALL', 'all');
60 define('COURSE_TIMELINE_PAST', 'past');
61 define('COURSE_TIMELINE_INPROGRESS', 'inprogress');
62 define('COURSE_TIMELINE_FUTURE', 'future');
63 define('COURSE_FAVOURITES', 'favourites');
64 define('COURSE_TIMELINE_HIDDEN', 'hidden');
65 define('COURSE_DB_QUERY_LIMIT', 1000);
67 function make_log_url($module, $url) {
70 if (strpos($url, 'report/') === 0) {
71 // there is only one report type, course reports are deprecated
81 if (strpos($url, '../') === 0) {
82 $url = ltrim($url, '.');
84 $url = "/course/$url";
88 $url = "/calendar/$url";
92 $url = "/$module/$url";
105 $url = "/message/$url";
108 $url = "/notes/$url";
117 $url = "/grade/$url";
120 $url = "/mod/$module/$url";
124 //now let's sanitise urls - there might be some ugly nasties:-(
125 $parts = explode('?', $url);
126 $script = array_shift($parts);
127 if (strpos($script, 'http') === 0) {
128 $script = clean_param($script, PARAM_URL
);
130 $script = clean_param($script, PARAM_PATH
);
135 $query = implode('', $parts);
136 $query = str_replace('&', '&', $query); // both & and & are stored in db :-|
137 $parts = explode('&', $query);
138 $eq = urlencode('=');
139 foreach ($parts as $key=>$part) {
140 $part = urlencode(urldecode($part));
141 $part = str_replace($eq, '=', $part);
142 $parts[$key] = $part;
144 $query = '?'.implode('&', $parts);
147 return $script.$query;
151 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
152 $modname="", $modid=0, $modaction="", $groupid=0) {
155 // It is assumed that $date is the GMT time of midnight for that day,
156 // and so the next 86400 seconds worth of logs are printed.
158 /// Setup for group handling.
160 // TODO: I don't understand group/context/etc. enough to be able to do
161 // something interesting with it here
162 // What is the context of a remote course?
164 /// If the group mode is separate, and this user does not have editing privileges,
165 /// then only the user's group can be viewed.
166 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
167 // $groupid = get_current_group($course->id);
169 /// If this course doesn't have groups, no groupid can be specified.
170 //else if (!$course->groupmode) {
179 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
181 LEFT JOIN {user} u ON l.userid = u.id
185 $where .= "l.hostid = :hostid";
186 $params['hostid'] = $hostid;
188 // TODO: Is 1 really a magic number referring to the sitename?
189 if ($course != SITEID ||
$modid != 0) {
190 $where .= " AND l.course=:courseid";
191 $params['courseid'] = $course;
195 $where .= " AND l.module = :modname";
196 $params['modname'] = $modname;
199 if ('site_errors' === $modid) {
200 $where .= " AND ( l.action='error' OR l.action='infected' )";
202 //TODO: This assumes that modids are the same across sites... probably
204 $where .= " AND l.cmid = :modid";
205 $params['modid'] = $modid;
209 $firstletter = substr($modaction, 0, 1);
210 if ($firstletter == '-') {
211 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
212 $params['modaction'] = '%'.substr($modaction, 1).'%';
214 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
215 $params['modaction'] = '%'.$modaction.'%';
220 $where .= " AND l.userid = :user";
221 $params['user'] = $user;
225 $enddate = $date +
86400;
226 $where .= " AND l.time > :date AND l.time < :enddate";
227 $params['date'] = $date;
228 $params['enddate'] = $enddate;
232 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
233 if(!empty($result['totalcount'])) {
234 $where .= " ORDER BY $order";
235 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
237 $result['logs'] = array();
243 * Checks the integrity of the course data.
245 * In summary - compares course_sections.sequence and course_modules.section.
247 * More detailed, checks that:
248 * - course_sections.sequence contains each module id not more than once in the course
249 * - for each moduleid from course_sections.sequence the field course_modules.section
250 * refers to the same section id (this means course_sections.sequence is more
251 * important if they are different)
252 * - ($fullcheck only) each module in the course is present in one of
253 * course_sections.sequence
254 * - ($fullcheck only) removes non-existing course modules from section sequences
256 * If there are any mismatches, the changes are made and records are updated in DB.
258 * Course cache is NOT rebuilt if there are any errors!
260 * This function is used each time when course cache is being rebuilt with $fullcheck = false
261 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
263 * @param int $courseid id of the course
264 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
265 * the list of enabled course modules in the course. Retrieved from DB if not specified.
266 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
267 * @param array $sections records from course_sections table for this course.
268 * Retrieved from DB if not specified
269 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
270 * course modules from sequences. Only to be used in site maintenance mode when we are
271 * sure that another user is not in the middle of the process of moving/removing a module.
272 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
273 * @return array array of messages with found problems. Empty output means everything is ok
275 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
278 if ($sections === null) {
279 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
282 // Retrieve all records from course_modules regardless of module type visibility.
283 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
285 if ($rawmods === null) {
286 $rawmods = get_course_mods($courseid);
288 if (!$fullcheck && (empty($sections) ||
empty($rawmods))) {
289 // If either of the arrays is empty, no modules are displayed anyway.
292 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
294 // First make sure that each module id appears in section sequences only once.
295 // If it appears in several section sequences the last section wins.
296 // If it appears twice in one section sequence, the first occurence wins.
297 $modsection = array();
298 foreach ($sections as $sectionid => $section) {
299 $sections[$sectionid]->newsequence
= $section->sequence
;
300 if (!empty($section->sequence
)) {
301 $sequence = explode(",", $section->sequence
);
302 $sequenceunique = array_unique($sequence);
303 if (count($sequenceunique) != count($sequence)) {
304 // Some course module id appears in this section sequence more than once.
305 ksort($sequenceunique); // Preserve initial order of modules.
306 $sequence = array_values($sequenceunique);
307 $sections[$sectionid]->newsequence
= join(',', $sequence);
308 $messages[] = $debuggingprefix.'Sequence for course section ['.
309 $sectionid.'] is "'.$sections[$sectionid]->sequence
.'", must be "'.$sections[$sectionid]->newsequence
.'"';
311 foreach ($sequence as $cmid) {
312 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
313 // Some course module id appears to be in more than one section's sequences.
314 $wrongsectionid = $modsection[$cmid];
315 $sections[$wrongsectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence
. ','), ',');
316 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
317 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
319 $modsection[$cmid] = $sectionid;
324 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
326 foreach ($rawmods as $cmid => $mod) {
327 if (!isset($modsection[$cmid])) {
328 // This is a module that is not mentioned in course_section.sequence at all.
329 // Add it to the section $mod->section or to the last available section.
330 if ($mod->section
&& isset($sections[$mod->section
])) {
331 $modsection[$cmid] = $mod->section
;
333 $firstsection = reset($sections);
334 $modsection[$cmid] = $firstsection->id
;
336 $sections[$modsection[$cmid]]->newsequence
= trim($sections[$modsection[$cmid]]->newsequence
.','.$cmid, ',');
337 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
338 $modsection[$cmid].']';
341 foreach ($modsection as $cmid => $sectionid) {
342 if (!isset($rawmods[$cmid])) {
343 // Section $sectionid refers to module id that does not exist.
344 $sections[$sectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence
.','), ',');
345 $messages[] = $debuggingprefix.'Course module ['.$cmid.
346 '] does not exist but is present in the sequence of section ['.$sectionid.']';
351 // Update changed sections.
352 if (!$checkonly && !empty($messages)) {
353 foreach ($sections as $sectionid => $section) {
354 if ($section->newsequence
!== $section->sequence
) {
355 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence
));
360 // Now make sure that all modules point to the correct sections.
361 foreach ($rawmods as $cmid => $mod) {
362 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section
) {
364 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
366 $messages[] = $debuggingprefix.'Course module ['.$cmid.
367 '] points to section ['.$mod->section
.'] instead of ['.$modsection[$cmid].']';
375 * For a given course, returns an array of course activity objects
376 * Each item in the array contains he following properties:
378 function get_array_of_activities($courseid) {
379 // cm - course module id
380 // mod - name of the module (eg forum)
381 // section - the number of the section (eg week or topic)
382 // name - the name of the instance
383 // visible - is the instance visible or not
384 // groupingid - grouping id
385 // extra - contains extra string to include in any link
388 $course = $DB->get_record('course', array('id'=>$courseid));
390 if (empty($course)) {
391 throw new moodle_exception('courseidnotfound');
396 $rawmods = get_course_mods($courseid);
397 if (empty($rawmods)) {
398 return $mod; // always return array
400 $courseformat = course_get_format($course);
402 if ($sections = $DB->get_records('course_sections', array('course' => $courseid),
403 'section ASC', 'id,section,sequence,visible')) {
404 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
405 if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
406 debugging(join('<br>', $errormessages));
407 $rawmods = get_course_mods($courseid);
408 $sections = $DB->get_records('course_sections', array('course' => $courseid),
409 'section ASC', 'id,section,sequence,visible');
411 // Build array of activities.
412 foreach ($sections as $section) {
413 if (!empty($section->sequence
)) {
414 $sequence = explode(",", $section->sequence
);
415 foreach ($sequence as $seq) {
416 if (empty($rawmods[$seq])) {
419 // Adjust visibleoncoursepage, value in DB may not respect format availability.
420 $rawmods[$seq]->visibleoncoursepage
= (!$rawmods[$seq]->visible
421 ||
$rawmods[$seq]->visibleoncoursepage
422 ||
empty($CFG->allowstealth
)
423 ||
!$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ?
1 : 0;
425 // Create an object that will be cached.
426 $mod[$seq] = new stdClass();
427 $mod[$seq]->id
= $rawmods[$seq]->instance
;
428 $mod[$seq]->cm
= $rawmods[$seq]->id
;
429 $mod[$seq]->mod
= $rawmods[$seq]->modname
;
431 // Oh dear. Inconsistent names left here for backward compatibility.
432 $mod[$seq]->section
= $section->section
;
433 $mod[$seq]->sectionid
= $rawmods[$seq]->section
;
435 $mod[$seq]->module
= $rawmods[$seq]->module
;
436 $mod[$seq]->added
= $rawmods[$seq]->added
;
437 $mod[$seq]->score
= $rawmods[$seq]->score
;
438 $mod[$seq]->idnumber
= $rawmods[$seq]->idnumber
;
439 $mod[$seq]->visible
= $rawmods[$seq]->visible
;
440 $mod[$seq]->visibleoncoursepage
= $rawmods[$seq]->visibleoncoursepage
;
441 $mod[$seq]->visibleold
= $rawmods[$seq]->visibleold
;
442 $mod[$seq]->groupmode
= $rawmods[$seq]->groupmode
;
443 $mod[$seq]->groupingid
= $rawmods[$seq]->groupingid
;
444 $mod[$seq]->indent
= $rawmods[$seq]->indent
;
445 $mod[$seq]->completion
= $rawmods[$seq]->completion
;
446 $mod[$seq]->extra
= "";
447 $mod[$seq]->completiongradeitemnumber
=
448 $rawmods[$seq]->completiongradeitemnumber
;
449 $mod[$seq]->completionview
= $rawmods[$seq]->completionview
;
450 $mod[$seq]->completionexpected
= $rawmods[$seq]->completionexpected
;
451 $mod[$seq]->showdescription
= $rawmods[$seq]->showdescription
;
452 $mod[$seq]->availability
= $rawmods[$seq]->availability
;
453 $mod[$seq]->deletioninprogress
= $rawmods[$seq]->deletioninprogress
;
455 $modname = $mod[$seq]->mod
;
456 $functionname = $modname."_get_coursemodule_info";
458 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
462 include_once("$CFG->dirroot/mod/$modname/lib.php");
464 if ($hasfunction = function_exists($functionname)) {
465 if ($info = $functionname($rawmods[$seq])) {
466 if (!empty($info->icon
)) {
467 $mod[$seq]->icon
= $info->icon
;
469 if (!empty($info->iconcomponent
)) {
470 $mod[$seq]->iconcomponent
= $info->iconcomponent
;
472 if (!empty($info->name
)) {
473 $mod[$seq]->name
= $info->name
;
475 if ($info instanceof cached_cm_info
) {
476 // When using cached_cm_info you can include three new fields
477 // that aren't available for legacy code
478 if (!empty($info->content
)) {
479 $mod[$seq]->content
= $info->content
;
481 if (!empty($info->extraclasses
)) {
482 $mod[$seq]->extraclasses
= $info->extraclasses
;
484 if (!empty($info->iconurl
)) {
485 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
486 $url = new moodle_url($info->iconurl
);
487 $mod[$seq]->iconurl
= $url->out(false);
489 if (!empty($info->onclick
)) {
490 $mod[$seq]->onclick
= $info->onclick
;
492 if (!empty($info->customdata
)) {
493 $mod[$seq]->customdata
= $info->customdata
;
496 // When using a stdclass, the (horrible) deprecated ->extra field
497 // is available for BC
498 if (!empty($info->extra
)) {
499 $mod[$seq]->extra
= $info->extra
;
504 // When there is no modname_get_coursemodule_info function,
505 // but showdescriptions is enabled, then we use the 'intro'
506 // and 'introformat' fields in the module table
507 if (!$hasfunction && $rawmods[$seq]->showdescription
) {
508 if ($modvalues = $DB->get_record($rawmods[$seq]->modname
,
509 array('id' => $rawmods[$seq]->instance
), 'name, intro, introformat')) {
510 // Set content from intro and introformat. Filters are disabled
511 // because we filter it with format_text at display time
512 $mod[$seq]->content
= format_module_intro($rawmods[$seq]->modname
,
513 $modvalues, $rawmods[$seq]->id
, false);
515 // To save making another query just below, put name in here
516 $mod[$seq]->name
= $modvalues->name
;
519 if (!isset($mod[$seq]->name
)) {
520 $mod[$seq]->name
= $DB->get_field($rawmods[$seq]->modname
, "name", array("id"=>$rawmods[$seq]->instance
));
523 // Minimise the database size by unsetting default options when they are
524 // 'empty'. This list corresponds to code in the cm_info constructor.
525 foreach (array('idnumber', 'groupmode', 'groupingid',
526 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
527 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
528 'completionexpected', 'score', 'showdescription', 'deletioninprogress') as $property) {
529 if (property_exists($mod[$seq], $property) &&
530 empty($mod[$seq]->{$property})) {
531 unset($mod[$seq]->{$property});
534 // Special case: this value is usually set to null, but may be 0
535 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
536 is_null($mod[$seq]->completiongradeitemnumber
)) {
537 unset($mod[$seq]->completiongradeitemnumber
);
547 * Returns the localised human-readable names of all used modules
549 * @param bool $plural if true returns the plural forms of the names
550 * @return array where key is the module name (component name without 'mod_') and
551 * the value is the human-readable string. Array sorted alphabetically by value
553 function get_module_types_names($plural = false) {
554 static $modnames = null;
556 if ($modnames === null) {
557 $modnames = array(0 => array(), 1 => array());
558 if ($allmods = $DB->get_records("modules")) {
559 foreach ($allmods as $mod) {
560 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible
) {
561 $modnames[0][$mod->name
] = get_string("modulename", "$mod->name");
562 $modnames[1][$mod->name
] = get_string("modulenameplural", "$mod->name");
565 core_collator
::asort($modnames[0]);
566 core_collator
::asort($modnames[1]);
569 return $modnames[(int)$plural];
573 * Set highlighted section. Only one section can be highlighted at the time.
575 * @param int $courseid course id
576 * @param int $marker highlight section with this number, 0 means remove higlightin
579 function course_set_marker($courseid, $marker) {
581 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
582 if ($COURSE && $COURSE->id
== $courseid) {
583 $COURSE->marker
= $marker;
585 if (class_exists('format_base')) {
586 format_base
::reset_course_cache($courseid);
588 course_modinfo
::clear_instance_cache($courseid);
592 * For a given course section, marks it visible or hidden,
593 * and does the same for every activity in that section
595 * @param int $courseid course id
596 * @param int $sectionnumber The section number to adjust
597 * @param int $visibility The new visibility
598 * @return array A list of resources which were hidden in the section
600 function set_section_visible($courseid, $sectionnumber, $visibility) {
603 $resourcestotoggle = array();
604 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
605 course_update_section($courseid, $section, array('visible' => $visibility));
607 // Determine which modules are visible for AJAX update
608 $modules = !empty($section->sequence
) ?
explode(',', $section->sequence
) : array();
609 if (!empty($modules)) {
610 list($insql, $params) = $DB->get_in_or_equal($modules);
611 $select = 'id ' . $insql . ' AND visible = ?';
612 array_push($params, $visibility);
614 $select .= ' AND visibleold = 1';
616 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
619 return $resourcestotoggle;
623 * Retrieve all metadata for the requested modules
625 * @param object $course The Course
626 * @param array $modnames An array containing the list of modules and their
628 * @param int $sectionreturn The section to return to
629 * @return array A list of stdClass objects containing metadata about each
632 function get_module_metadata($course, $modnames, $sectionreturn = null) {
635 // get_module_metadata will be called once per section on the page and courses may show
636 // different modules to one another
637 static $modlist = array();
638 if (!isset($modlist[$course->id
])) {
639 $modlist[$course->id
] = array();
643 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id
, 'sesskey' => sesskey()));
644 if ($sectionreturn !== null) {
645 $urlbase->param('sr', $sectionreturn);
647 foreach($modnames as $modname => $modnamestr) {
648 if (!course_allowed_module($course, $modname)) {
651 if (isset($modlist[$course->id
][$modname])) {
652 // This module is already cached
653 $return +
= $modlist[$course->id
][$modname];
656 $modlist[$course->id
][$modname] = array();
658 // Create an object for a default representation of this module type in the activity chooser. It will be used
659 // if module does not implement callback get_shortcuts() and it will also be passed to the callback if it exists.
660 $defaultmodule = new stdClass();
661 $defaultmodule->title
= $modnamestr;
662 $defaultmodule->name
= $modname;
663 $defaultmodule->link
= new moodle_url($urlbase, array('add' => $modname));
664 $defaultmodule->icon
= $OUTPUT->pix_icon('icon', '', $defaultmodule->name
, array('class' => 'icon'));
665 $sm = get_string_manager();
666 if ($sm->string_exists('modulename_help', $modname)) {
667 $defaultmodule->help
= get_string('modulename_help', $modname);
668 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs.
669 $link = get_string('modulename_link', $modname);
670 $linktext = get_string('morehelp');
671 $defaultmodule->help
.= html_writer
::tag('div',
672 $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
675 $defaultmodule->archetype
= plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
677 // Each module can implement callback modulename_get_shortcuts() in its lib.php and return the list
678 // of elements to be added to activity chooser.
679 $items = component_callback($modname, 'get_shortcuts', array($defaultmodule), null);
680 if ($items !== null) {
681 foreach ($items as $item) {
682 // Add all items to the return array. All items must have different links, use them as a key in the return array.
683 if (!isset($item->archetype
)) {
684 $item->archetype
= $defaultmodule->archetype
;
686 if (!isset($item->icon
)) {
687 $item->icon
= $defaultmodule->icon
;
689 // If plugin returned the only one item with the same link as default item - cache it as $modname,
690 // otherwise append the link url to the module name.
691 $item->name
= (count($items) == 1 &&
692 $item->link
->out() === $defaultmodule->link
->out()) ?
$modname : $modname . ':' . $item->link
;
694 // If the module provides the helptext property, append it to the help text to match the look and feel
695 // of the default course modules.
696 if (isset($item->help
) && isset($item->helplink
)) {
697 $linktext = get_string('morehelp');
698 $item->help
.= html_writer
::tag('div',
699 $OUTPUT->doc_link($item->helplink
, $linktext, true), array('class' => 'helpdoclink'));
701 $modlist[$course->id
][$modname][$item->name
] = $item;
703 $return +
= $modlist[$course->id
][$modname];
704 // If get_shortcuts() callback is defined, the default module action is not added.
705 // It is a responsibility of the callback to add it to the return value unless it is not needed.
709 // The callback get_shortcuts() was not found, use the default item for the activity chooser.
710 $modlist[$course->id
][$modname][$modname] = $defaultmodule;
711 $return[$modname] = $defaultmodule;
714 core_collator
::asort_objects_by_property($return, 'title');
719 * Return the course category context for the category with id $categoryid, except
720 * that if $categoryid is 0, return the system context.
722 * @param integer $categoryid a category id or 0.
723 * @return context the corresponding context
725 function get_category_or_system_context($categoryid) {
727 return context_coursecat
::instance($categoryid, IGNORE_MISSING
);
729 return context_system
::instance();
734 * Returns full course categories trees to be used in html_writer::select()
736 * Calls {@link core_course_category::make_categories_list()} to build the tree and
737 * adds whitespace to denote nesting
739 * @return array array mapping course category id to the display name
741 function make_categories_options() {
742 $cats = core_course_category
::make_categories_list('', 0, ' / ');
743 foreach ($cats as $key => $value) {
744 // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
745 $cats[$key] = str_repeat(' ', substr_count($value, ' / ')). $value;
751 * Print the buttons relating to course requests.
753 * @param object $context current page context.
755 function print_course_request_buttons($context) {
756 global $CFG, $DB, $OUTPUT;
757 if (empty($CFG->enablecourserequests
)) {
760 if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
761 /// Print a button to request a new course
762 echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
764 /// Print a button to manage pending requests
765 if (has_capability('moodle/site:approvecourse', $context)) {
766 $disabled = !$DB->record_exists('course_request', array());
767 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
772 * Does the user have permission to edit things in this category?
774 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
775 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
777 function can_edit_in_category($categoryid = 0) {
778 $context = get_category_or_system_context($categoryid);
779 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
782 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
784 function add_course_module($mod) {
787 $mod->added
= time();
790 $cmid = $DB->insert_record("course_modules", $mod);
791 rebuild_course_cache($mod->course
, true);
796 * Creates a course section and adds it to the specified position
798 * @param int|stdClass $courseorid course id or course object
799 * @param int $position position to add to, 0 means to the end. If position is greater than
800 * number of existing secitons, the section is added to the end. This will become sectionnum of the
801 * new section. All existing sections at this or bigger position will be shifted down.
802 * @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
803 * @return stdClass created section object
805 function course_create_section($courseorid, $position = 0, $skipcheck = false) {
807 $courseid = is_object($courseorid) ?
$courseorid->id
: $courseorid;
809 // Find the last sectionnum among existing sections.
811 $lastsection = $position - 1;
813 $lastsection = (int)$DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', [$courseid]);
816 // First add section to the end.
817 $cw = new stdClass();
818 $cw->course
= $courseid;
819 $cw->section
= $lastsection +
1;
821 $cw->summaryformat
= FORMAT_HTML
;
825 $cw->availability
= null;
826 $cw->timemodified
= time();
827 $cw->id
= $DB->insert_record("course_sections", $cw);
829 // Now move it to the specified position.
830 if ($position > 0 && $position <= $lastsection) {
831 $course = is_object($courseorid) ?
$courseorid : get_course($courseorid);
832 move_section_to($course, $cw->section
, $position, true);
833 $cw->section
= $position;
836 core\event\course_section_created
::create_from_section($cw)->trigger();
838 rebuild_course_cache($courseid, true);
843 * Creates missing course section(s) and rebuilds course cache
845 * @param int|stdClass $courseorid course id or course object
846 * @param int|array $sections list of relative section numbers to create
847 * @return bool if there were any sections created
849 function course_create_sections_if_missing($courseorid, $sections) {
850 if (!is_array($sections)) {
851 $sections = array($sections);
853 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
854 if ($newsections = array_diff($sections, $existing)) {
855 foreach ($newsections as $sectionnum) {
856 course_create_section($courseorid, $sectionnum, true);
864 * Adds an existing module to the section
866 * Updates both tables {course_sections} and {course_modules}
868 * Note: This function does not use modinfo PROVIDED that the section you are
869 * adding the module to already exists. If the section does not exist, it will
870 * build modinfo if necessary and create the section.
872 * @param int|stdClass $courseorid course id or course object
873 * @param int $cmid id of the module already existing in course_modules table
874 * @param int $sectionnum relative number of the section (field course_sections.section)
875 * If section does not exist it will be created
876 * @param int|stdClass $beforemod id or object with field id corresponding to the module
877 * before which the module needs to be included. Null for inserting in the
879 * @return int The course_sections ID where the module is inserted
881 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
883 if (is_object($beforemod)) {
884 $beforemod = $beforemod->id
;
886 if (is_object($courseorid)) {
887 $courseid = $courseorid->id
;
889 $courseid = $courseorid;
891 // Do not try to use modinfo here, there is no guarantee it is valid!
892 $section = $DB->get_record('course_sections',
893 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING
);
895 // This function call requires modinfo.
896 course_create_sections_if_missing($courseorid, $sectionnum);
897 $section = $DB->get_record('course_sections',
898 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST
);
901 $modarray = explode(",", trim($section->sequence
));
902 if (empty($section->sequence
)) {
903 $newsequence = "$cmid";
904 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
905 $insertarray = array($cmid, $beforemod);
906 array_splice($modarray, $key[0], 1, $insertarray);
907 $newsequence = implode(",", $modarray);
909 $newsequence = "$section->sequence,$cmid";
911 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id
));
912 $DB->set_field('course_modules', 'section', $section->id
, array('id' => $cmid));
913 if (is_object($courseorid)) {
914 rebuild_course_cache($courseorid->id
, true);
916 rebuild_course_cache($courseorid, true);
918 return $section->id
; // Return course_sections ID that was used.
922 * Change the group mode of a course module.
924 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
925 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
927 * @param int $id course module ID.
928 * @param int $groupmode the new groupmode value.
929 * @return bool True if the $groupmode was updated.
931 function set_coursemodule_groupmode($id, $groupmode) {
933 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST
);
934 if ($cm->groupmode
!= $groupmode) {
935 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id
));
936 rebuild_course_cache($cm->course
, true);
938 return ($cm->groupmode
!= $groupmode);
941 function set_coursemodule_idnumber($id, $idnumber) {
943 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST
);
944 if ($cm->idnumber
!= $idnumber) {
945 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id
));
946 rebuild_course_cache($cm->course
, true);
948 return ($cm->idnumber
!= $idnumber);
952 * Set the visibility of a module and inherent properties.
954 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
955 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
957 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
958 * has been moved to {@link set_section_visible()} which was the only place from which
959 * the parameter was used.
961 * @param int $id of the module
962 * @param int $visible state of the module
963 * @param int $visibleoncoursepage state of the module on the course page
964 * @return bool false when the module was not found, true otherwise
966 function set_coursemodule_visible($id, $visible, $visibleoncoursepage = 1) {
968 require_once($CFG->libdir
.'/gradelib.php');
969 require_once($CFG->dirroot
.'/calendar/lib.php');
971 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
975 // Create events and propagate visibility to associated grade items if the value has changed.
976 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
977 if ($cm->visible
== $visible && $cm->visibleoncoursepage
== $visibleoncoursepage) {
981 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module
))) {
984 if (($cm->visible
!= $visible) &&
985 ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename)))) {
986 foreach($events as $event) {
988 $event = new calendar_event($event);
989 $event->toggle_visibility(true);
991 $event = new calendar_event($event);
992 $event->toggle_visibility(false);
997 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
998 // affect visibleold to allow for an original visibility restore. See set_section_visible().
999 $cminfo = new stdClass();
1001 $cminfo->visible
= $visible;
1002 $cminfo->visibleoncoursepage
= $visibleoncoursepage;
1003 $cminfo->visibleold
= $visible;
1004 $DB->update_record('course_modules', $cminfo);
1006 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1007 // Note that this must be done after updating the row in course_modules, in case
1008 // the modules grade_item_update function needs to access $cm->visible.
1009 if ($cm->visible
!= $visible &&
1010 plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY
) &&
1011 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1012 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1013 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1014 } else if ($cm->visible
!= $visible) {
1015 $grade_items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance
, 'courseid'=>$cm->course
));
1017 foreach ($grade_items as $grade_item) {
1018 $grade_item->set_hidden(!$visible);
1023 rebuild_course_cache($cm->course
, true);
1028 * Changes the course module name
1030 * @param int $id course module id
1031 * @param string $name new value for a name
1032 * @return bool whether a change was made
1034 function set_coursemodule_name($id, $name) {
1036 require_once($CFG->libdir
. '/gradelib.php');
1038 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
1040 $module = new \
stdClass();
1041 $module->id
= $cm->instance
;
1043 // Escape strings as they would be by mform.
1044 if (!empty($CFG->formatstringstriptags
)) {
1045 $module->name
= clean_param($name, PARAM_TEXT
);
1047 $module->name
= clean_param($name, PARAM_CLEANHTML
);
1049 if ($module->name
=== $cm->name ||
strval($module->name
) === '') {
1052 if (\core_text
::strlen($module->name
) > 255) {
1053 throw new \
moodle_exception('maximumchars', 'moodle', '', 255);
1056 $module->timemodified
= time();
1057 $DB->update_record($cm->modname
, $module);
1058 $cm->name
= $module->name
;
1059 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1060 rebuild_course_cache($cm->course
, true);
1062 // Attempt to update the grade item if relevant.
1063 $grademodule = $DB->get_record($cm->modname
, array('id' => $cm->instance
));
1064 $grademodule->cmidnumber
= $cm->idnumber
;
1065 $grademodule->modname
= $cm->modname
;
1066 grade_update_mod_grades($grademodule);
1068 // Update calendar events with the new name.
1069 course_module_update_calendar_events($cm->modname
, $grademodule, $cm);
1075 * This function will handle the whole deletion process of a module. This includes calling
1076 * the modules delete_instance function, deleting files, events, grades, conditional data,
1077 * the data in the course_module and course_sections table and adding a module deletion
1080 * @param int $cmid the course module id
1081 * @param bool $async whether or not to try to delete the module using an adhoc task. Async also depends on a plugin hook.
1082 * @throws moodle_exception
1085 function course_delete_module($cmid, $async = false) {
1086 // Check the 'course_module_background_deletion_recommended' hook first.
1087 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1088 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1089 // It's up to plugins to handle things like whether or not they are enabled.
1090 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1091 foreach ($pluginsfunction as $plugintype => $plugins) {
1092 foreach ($plugins as $pluginfunction) {
1093 if ($pluginfunction()) {
1094 return course_module_flag_for_async_deletion($cmid);
1102 require_once($CFG->libdir
.'/gradelib.php');
1103 require_once($CFG->libdir
.'/questionlib.php');
1104 require_once($CFG->dirroot
.'/blog/lib.php');
1105 require_once($CFG->dirroot
.'/calendar/lib.php');
1107 // Get the course module.
1108 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1112 // Get the module context.
1113 $modcontext = context_module
::instance($cm->id
);
1115 // Get the course module name.
1116 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1118 // Get the file location of the delete_instance function for this module.
1119 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1121 // Include the file required to call the delete_instance function for this module.
1122 if (file_exists($modlib)) {
1123 require_once($modlib);
1125 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1126 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1129 $deleteinstancefunction = $modulename . '_delete_instance';
1131 // Ensure the delete_instance function exists for this module.
1132 if (!function_exists($deleteinstancefunction)) {
1133 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1134 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1137 // Allow plugins to use this course module before we completely delete it.
1138 if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
1139 foreach ($pluginsfunction as $plugintype => $plugins) {
1140 foreach ($plugins as $pluginfunction) {
1141 $pluginfunction($cm);
1146 // Delete activity context questions and question categories.
1147 $showinfo = !defined('AJAX_SCRIPT') || AJAX_SCRIPT
== '0';
1149 question_delete_activity($cm, $showinfo);
1151 // Call the delete_instance function, if it returns false throw an exception.
1152 if (!$deleteinstancefunction($cm->instance
)) {
1153 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1154 "Cannot delete the module $modulename (instance).");
1157 // Remove all module files in case modules forget to do that.
1158 $fs = get_file_storage();
1159 $fs->delete_area_files($modcontext->id
);
1161 // Delete events from calendar.
1162 if ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename))) {
1163 $coursecontext = context_course
::instance($cm->course
);
1164 foreach($events as $event) {
1165 $event->context
= $coursecontext;
1166 $calendarevent = calendar_event
::load($event);
1167 $calendarevent->delete();
1171 // Delete grade items, outcome items and grades attached to modules.
1172 if ($grade_items = grade_item
::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1173 'iteminstance' => $cm->instance
, 'courseid' => $cm->course
))) {
1174 foreach ($grade_items as $grade_item) {
1175 $grade_item->delete('moddelete');
1179 // Delete associated blogs and blog tag instances.
1180 blog_remove_associations_for_module($modcontext->id
);
1182 // Delete completion and availability data; it is better to do this even if the
1183 // features are not turned on, in case they were turned on previously (these will be
1184 // very quick on an empty table).
1185 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id
));
1186 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id
,
1187 'course' => $cm->course
,
1188 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY
));
1190 // Delete all tag instances associated with the instance of this module.
1191 core_tag_tag
::delete_instances('mod_' . $modulename, null, $modcontext->id
);
1192 core_tag_tag
::remove_all_item_tags('core', 'course_modules', $cm->id
);
1194 // Notify the competency subsystem.
1195 \core_competency\api
::hook_course_module_deleted($cm);
1197 // Delete the context.
1198 context_helper
::delete_instance(CONTEXT_MODULE
, $cm->id
);
1200 // Delete the module from the course_modules table.
1201 $DB->delete_records('course_modules', array('id' => $cm->id
));
1203 // Delete module from that section.
1204 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
1205 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1206 "Cannot delete the module $modulename (instance) from section.");
1209 // Trigger event for course module delete action.
1210 $event = \core\event\course_module_deleted
::create(array(
1211 'courseid' => $cm->course
,
1212 'context' => $modcontext,
1213 'objectid' => $cm->id
,
1215 'modulename' => $modulename,
1216 'instanceid' => $cm->instance
,
1219 $event->add_record_snapshot('course_modules', $cm);
1221 rebuild_course_cache($cm->course
, true);
1225 * Schedule a course module for deletion in the background using an adhoc task.
1227 * This method should not be called directly. Instead, please use course_delete_module($cmid, true), to denote async deletion.
1228 * The real deletion of the module is handled by the task, which calls 'course_delete_module($cmid)'.
1230 * @param int $cmid the course module id.
1231 * @return bool whether the module was successfully scheduled for deletion.
1232 * @throws \moodle_exception
1234 function course_module_flag_for_async_deletion($cmid) {
1235 global $CFG, $DB, $USER;
1236 require_once($CFG->libdir
.'/gradelib.php');
1237 require_once($CFG->libdir
.'/questionlib.php');
1238 require_once($CFG->dirroot
.'/blog/lib.php');
1239 require_once($CFG->dirroot
.'/calendar/lib.php');
1241 // Get the course module.
1242 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1246 // We need to be reasonably certain the deletion is going to succeed before we background the process.
1247 // Make the necessary delete_instance checks, etc. before proceeding further. Throw exceptions if required.
1249 // Get the course module name.
1250 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1252 // Get the file location of the delete_instance function for this module.
1253 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1255 // Include the file required to call the delete_instance function for this module.
1256 if (file_exists($modlib)) {
1257 require_once($modlib);
1259 throw new \
moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1260 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1263 $deleteinstancefunction = $modulename . '_delete_instance';
1265 // Ensure the delete_instance function exists for this module.
1266 if (!function_exists($deleteinstancefunction)) {
1267 throw new \
moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1268 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1271 // We are going to defer the deletion as we can't be sure how long the module's pre_delete code will run for.
1272 $cm->deletioninprogress
= '1';
1273 $DB->update_record('course_modules', $cm);
1275 // Create an adhoc task for the deletion of the course module. The task takes an array of course modules for removal.
1276 $removaltask = new \core_course\task\
course_delete_modules();
1277 $removaltask->set_custom_data(array(
1278 'cms' => array($cm),
1279 'userid' => $USER->id
,
1280 'realuserid' => \core\session\manager
::get_realuser()->id
1283 // Queue the task for the next run.
1284 \core\task\manager
::queue_adhoc_task($removaltask);
1286 // Reset the course cache to hide the module.
1287 rebuild_course_cache($cm->course
, true);
1291 * Checks whether the given course has any course modules scheduled for adhoc deletion.
1293 * @param int $courseid the id of the course.
1294 * @param bool $onlygradable whether to check only gradable modules or all modules.
1295 * @return bool true if the course contains any modules pending deletion, false otherwise.
1297 function course_modules_pending_deletion($courseid, bool $onlygradable = false) : bool {
1298 if (empty($courseid)) {
1302 if ($onlygradable) {
1303 // Fetch modules with grade items.
1304 if (!$coursegradeitems = grade_item
::fetch_all(['itemtype' => 'mod', 'courseid' => $courseid])) {
1305 // Return early when there is none.
1310 $modinfo = get_fast_modinfo($courseid);
1311 foreach ($modinfo->get_cms() as $module) {
1312 if ($module->deletioninprogress
== '1') {
1313 if ($onlygradable) {
1314 // Check if the module being deleted is in the list of course modules with grade items.
1315 foreach ($coursegradeitems as $coursegradeitem) {
1316 if ($coursegradeitem->itemmodule
== $module->modname
&& $coursegradeitem->iteminstance
== $module->instance
) {
1317 // The module being deleted is within the gradable modules.
1330 * Checks whether the course module, as defined by modulename and instanceid, is scheduled for deletion within the given course.
1332 * @param int $courseid the course id.
1333 * @param string $modulename the module name. E.g. 'assign', 'book', etc.
1334 * @param int $instanceid the module instance id.
1335 * @return bool true if the course module is pending deletion, false otherwise.
1337 function course_module_instance_pending_deletion($courseid, $modulename, $instanceid) {
1338 if (empty($courseid) ||
empty($modulename) ||
empty($instanceid)) {
1341 $modinfo = get_fast_modinfo($courseid);
1342 $instances = $modinfo->get_instances_of($modulename);
1343 return isset($instances[$instanceid]) && $instances[$instanceid]->deletioninprogress
;
1346 function delete_mod_from_section($modid, $sectionid) {
1349 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1351 $modarray = explode(",", $section->sequence
);
1353 if ($key = array_keys ($modarray, $modid)) {
1354 array_splice($modarray, $key[0], 1);
1355 $newsequence = implode(",", $modarray);
1356 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id
));
1357 rebuild_course_cache($section->course
, true);
1368 * This function updates the calendar events from the information stored in the module table and the course
1371 * @param string $modulename Module name
1372 * @param stdClass $instance Module object. Either the $instance or the $cm must be supplied.
1373 * @param stdClass $cm Course module object. Either the $instance or the $cm must be supplied.
1374 * @return bool Returns true if calendar events are updated.
1375 * @since Moodle 3.3.4
1377 function course_module_update_calendar_events($modulename, $instance = null, $cm = null) {
1380 if (isset($instance) ||
isset($cm)) {
1382 if (!isset($instance)) {
1383 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1386 $cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
);
1389 course_module_calendar_event_update_process($instance, $cm);
1397 * Update all instances through out the site or in a course.
1399 * @param string $modulename Module type to update.
1400 * @param integer $courseid Course id to update events. 0 for the whole site.
1401 * @return bool Returns True if the update was successful.
1402 * @since Moodle 3.3.4
1404 function course_module_bulk_update_calendar_events($modulename, $courseid = 0) {
1409 if (!$instances = $DB->get_records($modulename, array('course' => $courseid))) {
1413 if (!$instances = $DB->get_records($modulename)) {
1418 foreach ($instances as $instance) {
1419 if ($cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
)) {
1420 course_module_calendar_event_update_process($instance, $cm);
1427 * Calendar events for a module instance are updated.
1429 * @param stdClass $instance Module instance object.
1430 * @param stdClass $cm Course Module object.
1431 * @since Moodle 3.3.4
1433 function course_module_calendar_event_update_process($instance, $cm) {
1434 // We need to call *_refresh_events() first because some modules delete 'old' events at the end of the code which
1435 // will remove the completion events.
1436 $refresheventsfunction = $cm->modname
. '_refresh_events';
1437 if (function_exists($refresheventsfunction)) {
1438 call_user_func($refresheventsfunction, $cm->course
, $instance, $cm);
1440 $completionexpected = (!empty($cm->completionexpected
)) ?
$cm->completionexpected
: null;
1441 \core_completion\api
::update_completion_date_event($cm->id
, $cm->modname
, $instance, $completionexpected);
1445 * Moves a section within a course, from a position to another.
1446 * Be very careful: $section and $destination refer to section number,
1449 * @param object $course
1450 * @param int $section Section number (not id!!!)
1451 * @param int $destination
1452 * @param bool $ignorenumsections
1453 * @return boolean Result
1455 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1456 /// Moves a whole course section up and down within the course
1459 if (!$destination && $destination != 0) {
1463 // compartibility with course formats using field 'numsections'
1464 $courseformatoptions = course_get_format($course)->get_format_options();
1465 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1466 ($destination > $courseformatoptions['numsections'])) ||
($destination < 1)) {
1470 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1471 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id
),
1472 'section ASC, id ASC', 'id, section')) {
1476 $movedsections = reorder_sections($sections, $section, $destination);
1478 // Update all sections. Do this in 2 steps to avoid breaking database
1479 // uniqueness constraint
1480 $transaction = $DB->start_delegated_transaction();
1481 foreach ($movedsections as $id => $position) {
1482 if ($sections[$id] !== $position) {
1483 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1486 foreach ($movedsections as $id => $position) {
1487 if ($sections[$id] !== $position) {
1488 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1492 // If we move the highlighted section itself, then just highlight the destination.
1493 // Adjust the higlighted section location if we move something over it either direction.
1494 if ($section == $course->marker
) {
1495 course_set_marker($course->id
, $destination);
1496 } elseif ($section > $course->marker
&& $course->marker
>= $destination) {
1497 course_set_marker($course->id
, $course->marker+
1);
1498 } elseif ($section < $course->marker
&& $course->marker
<= $destination) {
1499 course_set_marker($course->id
, $course->marker
-1);
1502 $transaction->allow_commit();
1503 rebuild_course_cache($course->id
, true);
1508 * This method will delete a course section and may delete all modules inside it.
1510 * No permissions are checked here, use {@link course_can_delete_section()} to
1511 * check if section can actually be deleted.
1513 * @param int|stdClass $course
1514 * @param int|stdClass|section_info $section
1515 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1516 * @param bool $async whether or not to try to delete the section using an adhoc task. Async also depends on a plugin hook.
1517 * @return bool whether section was deleted
1519 function course_delete_section($course, $section, $forcedeleteifnotempty = true, $async = false) {
1522 // Prepare variables.
1523 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1524 $sectionnum = (is_object($section)) ?
$section->section
: (int)$section;
1525 $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1527 // No section exists, can't proceed.
1531 // Check the 'course_module_background_deletion_recommended' hook first.
1532 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1533 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1534 // It's up to plugins to handle things like whether or not they are enabled.
1535 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1536 foreach ($pluginsfunction as $plugintype => $plugins) {
1537 foreach ($plugins as $pluginfunction) {
1538 if ($pluginfunction()) {
1539 return course_delete_section_async($section, $forcedeleteifnotempty);
1545 $format = course_get_format($course);
1546 $sectionname = $format->get_section_name($section);
1549 $result = $format->delete_section($section, $forcedeleteifnotempty);
1551 // Trigger an event for course section deletion.
1553 $context = context_course
::instance($courseid);
1554 $event = \core\event\course_section_deleted
::create(
1556 'objectid' => $section->id
,
1557 'courseid' => $courseid,
1558 'context' => $context,
1560 'sectionnum' => $section->section
,
1561 'sectionname' => $sectionname,
1565 $event->add_record_snapshot('course_sections', $section);
1572 * Course section deletion, using an adhoc task for deletion of the modules it contains.
1573 * 1. Schedule all modules within the section for adhoc removal.
1574 * 2. Move all modules to course section 0.
1575 * 3. Delete the resulting empty section.
1577 * @param \stdClass $section the section to schedule for deletion.
1578 * @param bool $forcedeleteifnotempty whether to force section deletion if it contains modules.
1579 * @return bool true if the section was scheduled for deletion, false otherwise.
1581 function course_delete_section_async($section, $forcedeleteifnotempty = true) {
1584 // Objects only, and only valid ones.
1585 if (!is_object($section) ||
empty($section->id
)) {
1589 // Does the object currently exist in the DB for removal (check for stale objects).
1590 $section = $DB->get_record('course_sections', array('id' => $section->id
));
1591 if (!$section ||
!$section->section
) {
1592 // No section exists, or the section is 0. Can't proceed.
1596 // Check whether the section can be removed.
1597 if (!$forcedeleteifnotempty && (!empty($section->sequence
) ||
!empty($section->summary
))) {
1601 $format = course_get_format($section->course
);
1602 $sectionname = $format->get_section_name($section);
1604 // Flag those modules having no existing deletion flag. Some modules may have been scheduled for deletion manually, and we don't
1605 // want to create additional adhoc deletion tasks for these. Moving them to section 0 will suffice.
1606 $affectedmods = $DB->get_records_select('course_modules', 'course = ? AND section = ? AND deletioninprogress <> ?',
1607 [$section->course
, $section->id
, 1], '', 'id');
1608 $DB->set_field('course_modules', 'deletioninprogress', '1', ['course' => $section->course
, 'section' => $section->id
]);
1610 // Move all modules to section 0.
1611 $modules = $DB->get_records('course_modules', ['section' => $section->id
], '');
1612 $sectionzero = $DB->get_record('course_sections', ['course' => $section->course
, 'section' => '0']);
1613 foreach ($modules as $mod) {
1614 moveto_module($mod, $sectionzero);
1617 // Create and queue an adhoc task for the deletion of the modules.
1618 $removaltask = new \core_course\task\
course_delete_modules();
1620 'cms' => $affectedmods,
1621 'userid' => $USER->id
,
1622 'realuserid' => \core\session\manager
::get_realuser()->id
1624 $removaltask->set_custom_data($data);
1625 \core\task\manager
::queue_adhoc_task($removaltask);
1627 // Delete the now empty section, passing in only the section number, which forces the function to fetch a new object.
1628 // The refresh is needed because the section->sequence is now stale.
1629 $result = $format->delete_section($section->section
, $forcedeleteifnotempty);
1631 // Trigger an event for course section deletion.
1633 $context = \context_course
::instance($section->course
);
1634 $event = \core\event\course_section_deleted
::create(
1636 'objectid' => $section->id
,
1637 'courseid' => $section->course
,
1638 'context' => $context,
1640 'sectionnum' => $section->section
,
1641 'sectionname' => $sectionname,
1645 $event->add_record_snapshot('course_sections', $section);
1648 rebuild_course_cache($section->course
, true);
1654 * Updates the course section
1656 * This function does not check permissions or clean values - this has to be done prior to calling it.
1658 * @param int|stdClass $course
1659 * @param stdClass $section record from course_sections table - it will be updated with the new values
1660 * @param array|stdClass $data
1662 function course_update_section($course, $section, $data) {
1665 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1667 // Some fields can not be updated using this method.
1668 $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1669 $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible
);
1670 if (array_key_exists('name', $data) && \core_text
::strlen($data['name']) > 255) {
1671 throw new moodle_exception('maximumchars', 'moodle', '', 255);
1674 // Update record in the DB and course format options.
1675 $data['id'] = $section->id
;
1676 $data['timemodified'] = time();
1677 $DB->update_record('course_sections', $data);
1678 rebuild_course_cache($courseid, true);
1679 course_get_format($courseid)->update_section_format_options($data);
1681 // Update fields of the $section object.
1682 foreach ($data as $key => $value) {
1683 if (property_exists($section, $key)) {
1684 $section->$key = $value;
1688 // Trigger an event for course section update.
1689 $event = \core\event\course_section_updated
::create(
1691 'objectid' => $section->id
,
1692 'courseid' => $courseid,
1693 'context' => context_course
::instance($courseid),
1694 'other' => array('sectionnum' => $section->section
)
1699 // If section visibility was changed, hide the modules in this section too.
1700 if ($changevisibility && !empty($section->sequence
)) {
1701 $modules = explode(',', $section->sequence
);
1702 foreach ($modules as $moduleid) {
1703 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1704 if ($data['visible']) {
1705 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1706 set_coursemodule_visible($moduleid, $cm->visibleold
, $cm->visibleoncoursepage
);
1708 // We hide the section, so we hide the module but we store the original state in visibleold.
1709 set_coursemodule_visible($moduleid, 0, $cm->visibleoncoursepage
);
1710 $DB->set_field('course_modules', 'visibleold', $cm->visible
, array('id' => $moduleid));
1712 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1719 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1721 * @param int|stdClass $course
1722 * @param int|stdClass|section_info $section
1725 function course_can_delete_section($course, $section) {
1726 if (is_object($section)) {
1727 $section = $section->section
;
1730 // Not possible to delete 0-section.
1733 // Course format should allow to delete sections.
1734 if (!course_get_format($course)->can_delete_section($section)) {
1737 // Make sure user has capability to update course and move sections.
1738 $context = context_course
::instance(is_object($course) ?
$course->id
: $course);
1739 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1742 // Make sure user has capability to delete each activity in this section.
1743 $modinfo = get_fast_modinfo($course);
1744 if (!empty($modinfo->sections
[$section])) {
1745 foreach ($modinfo->sections
[$section] as $cmid) {
1746 if (!has_capability('moodle/course:manageactivities', context_module
::instance($cmid))) {
1755 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1756 * an original position number and a target position number, rebuilds the array so that the
1757 * move is made without any duplication of section positions.
1758 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1759 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1761 * @param array $sections
1762 * @param int $origin_position
1763 * @param int $target_position
1766 function reorder_sections($sections, $origin_position, $target_position) {
1767 if (!is_array($sections)) {
1771 // We can't move section position 0
1772 if ($origin_position < 1) {
1773 echo "We can't move section position 0";
1777 // Locate origin section in sections array
1778 if (!$origin_key = array_search($origin_position, $sections)) {
1779 echo "searched position not in sections array";
1780 return false; // searched position not in sections array
1783 // Extract origin section
1784 $origin_section = $sections[$origin_key];
1785 unset($sections[$origin_key]);
1787 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1789 $append_array = array();
1790 foreach ($sections as $id => $position) {
1792 $append_array[$id] = $position;
1793 unset($sections[$id]);
1795 if ($position == $target_position) {
1796 if ($target_position < $origin_position) {
1797 $append_array[$id] = $position;
1798 unset($sections[$id]);
1804 // Append moved section
1805 $sections[$origin_key] = $origin_section;
1807 // Append rest of array (if applicable)
1808 if (!empty($append_array)) {
1809 foreach ($append_array as $id => $position) {
1810 $sections[$id] = $position;
1814 // Renumber positions
1816 foreach ($sections as $id => $p) {
1817 $sections[$id] = $position;
1826 * Move the module object $mod to the specified $section
1827 * If $beforemod exists then that is the module
1828 * before which $modid should be inserted
1830 * @param stdClass|cm_info $mod
1831 * @param stdClass|section_info $section
1832 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1833 * before which the module needs to be included. Null for inserting in the
1834 * end of the section
1835 * @return int new value for module visibility (0 or 1)
1837 function moveto_module($mod, $section, $beforemod=NULL) {
1838 global $OUTPUT, $DB;
1840 // Current module visibility state - return value of this function.
1841 $modvisible = $mod->visible
;
1843 // Remove original module from original section.
1844 if (! delete_mod_from_section($mod->id
, $mod->section
)) {
1845 echo $OUTPUT->notification("Could not delete module from existing section");
1848 // If moving to a hidden section then hide module.
1849 if ($mod->section
!= $section->id
) {
1850 if (!$section->visible
&& $mod->visible
) {
1851 // Module was visible but must become hidden after moving to hidden section.
1853 set_coursemodule_visible($mod->id
, 0);
1854 // Set visibleold to 1 so module will be visible when section is made visible.
1855 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id
));
1857 if ($section->visible
&& !$mod->visible
) {
1858 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1859 set_coursemodule_visible($mod->id
, $mod->visibleold
);
1860 $modvisible = $mod->visibleold
;
1864 // Add the module into the new section.
1865 course_add_cm_to_section($section->course
, $mod->id
, $section->section
, $beforemod);
1870 * Returns the list of all editing actions that current user can perform on the module
1872 * @param cm_info $mod The module to produce editing buttons for
1873 * @param int $indent The current indenting (default -1 means no move left-right actions)
1874 * @param int $sr The section to link back to (used for creating the links)
1875 * @return array array of action_link or pix_icon objects
1877 function course_get_cm_edit_actions(cm_info
$mod, $indent = -1, $sr = null) {
1878 global $COURSE, $SITE, $CFG;
1882 $coursecontext = context_course
::instance($mod->course
);
1883 $modcontext = context_module
::instance($mod->id
);
1884 $courseformat = course_get_format($mod->get_course());
1886 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1887 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1889 // No permission to edit anything.
1890 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1894 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1897 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1898 'editsettings', 'duplicate', 'modhide', 'makeavailable', 'makeunavailable', 'modshow'), 'moodle');
1899 $str->assign
= get_string('assignroles', 'role');
1900 $str->groupsnone
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1901 $str->groupsseparate
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1902 $str->groupsvisible
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1905 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1908 $baseurl->param('sr', $sr);
1913 if ($hasmanageactivities) {
1914 $actions['update'] = new action_menu_link_secondary(
1915 new moodle_url($baseurl, array('update' => $mod->id
)),
1916 new pix_icon('t/edit', '', 'moodle', array('class' => 'iconsmall')),
1918 array('class' => 'editing_update', 'data-action' => 'update')
1923 if ($hasmanageactivities && $indent >= 0) {
1924 $indentlimits = new stdClass();
1925 $indentlimits->min
= 0;
1926 $indentlimits->max
= 16;
1927 if (right_to_left()) { // Exchange arrows on RTL
1928 $rightarrow = 't/left';
1929 $leftarrow = 't/right';
1931 $rightarrow = 't/right';
1932 $leftarrow = 't/left';
1935 if ($indent >= $indentlimits->max
) {
1936 $enabledclass = 'hidden';
1940 $actions['moveright'] = new action_menu_link_secondary(
1941 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '1')),
1942 new pix_icon($rightarrow, '', 'moodle', array('class' => 'iconsmall')),
1944 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright',
1945 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1948 if ($indent <= $indentlimits->min
) {
1949 $enabledclass = 'hidden';
1953 $actions['moveleft'] = new action_menu_link_secondary(
1954 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '-1')),
1955 new pix_icon($leftarrow, '', 'moodle', array('class' => 'iconsmall')),
1957 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft',
1958 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1963 // Hide/Show/Available/Unavailable.
1964 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1965 $allowstealth = !empty($CFG->allowstealth
) && $courseformat->allow_stealth_module_visibility($mod, $mod->get_section_info());
1967 $sectionvisible = $mod->get_section_info()->visible
;
1968 // The module on the course page may be in one of the following states:
1969 // - Available and displayed on the course page ($displayedoncoursepage);
1970 // - Not available and not displayed on the course page ($unavailable);
1971 // - Available but not displayed on the course page ($stealth) - this can also be a visible activity in a hidden section.
1972 $displayedoncoursepage = $mod->visible
&& $mod->visibleoncoursepage
&& $sectionvisible;
1973 $unavailable = !$mod->visible
;
1974 $stealth = $mod->visible
&& (!$mod->visibleoncoursepage ||
!$sectionvisible);
1975 if ($displayedoncoursepage) {
1976 $actions['hide'] = new action_menu_link_secondary(
1977 new moodle_url($baseurl, array('hide' => $mod->id
)),
1978 new pix_icon('t/hide', '', 'moodle', array('class' => 'iconsmall')),
1980 array('class' => 'editing_hide', 'data-action' => 'hide')
1982 } else if (!$displayedoncoursepage && $sectionvisible) {
1983 // Offer to "show" only if the section is visible.
1984 $actions['show'] = new action_menu_link_secondary(
1985 new moodle_url($baseurl, array('show' => $mod->id
)),
1986 new pix_icon('t/show', '', 'moodle', array('class' => 'iconsmall')),
1988 array('class' => 'editing_show', 'data-action' => 'show')
1993 // When making the "stealth" module unavailable we perform the same action as hiding the visible module.
1994 $actions['hide'] = new action_menu_link_secondary(
1995 new moodle_url($baseurl, array('hide' => $mod->id
)),
1996 new pix_icon('t/unblock', '', 'moodle', array('class' => 'iconsmall')),
1997 $str->makeunavailable
,
1998 array('class' => 'editing_makeunavailable', 'data-action' => 'hide', 'data-sectionreturn' => $sr)
2000 } else if ($unavailable && (!$sectionvisible ||
$allowstealth) && $mod->has_view()) {
2001 // Allow to make visually hidden module available in gradebook and other reports by making it a "stealth" module.
2002 // When the section is hidden it is an equivalent of "showing" the module.
2003 // Activities without the link (i.e. labels) can not be made available but hidden on course page.
2004 $action = $sectionvisible ?
'stealth' : 'show';
2005 $actions[$action] = new action_menu_link_secondary(
2006 new moodle_url($baseurl, array($action => $mod->id
)),
2007 new pix_icon('t/block', '', 'moodle', array('class' => 'iconsmall')),
2008 $str->makeavailable
,
2009 array('class' => 'editing_makeavailable', 'data-action' => $action, 'data-sectionreturn' => $sr)
2014 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2015 if (has_all_capabilities($dupecaps, $coursecontext) &&
2016 plugin_supports('mod', $mod->modname
, FEATURE_BACKUP_MOODLE2
) &&
2017 course_allowed_module($mod->get_course(), $mod->modname
)) {
2018 $actions['duplicate'] = new action_menu_link_secondary(
2019 new moodle_url($baseurl, array('duplicate' => $mod->id
)),
2020 new pix_icon('t/copy', '', 'moodle', array('class' => 'iconsmall')),
2022 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sectionreturn' => $sr)
2027 if ($hasmanageactivities && !$mod->coursegroupmodeforce
) {
2028 if (plugin_supports('mod', $mod->modname
, FEATURE_GROUPS
, false)) {
2029 if ($mod->effectivegroupmode
== SEPARATEGROUPS
) {
2030 $nextgroupmode = VISIBLEGROUPS
;
2031 $grouptitle = $str->groupsseparate
;
2032 $actionname = 'groupsseparate';
2033 $nextactionname = 'groupsvisible';
2034 $groupimage = 'i/groups';
2035 } else if ($mod->effectivegroupmode
== VISIBLEGROUPS
) {
2036 $nextgroupmode = NOGROUPS
;
2037 $grouptitle = $str->groupsvisible
;
2038 $actionname = 'groupsvisible';
2039 $nextactionname = 'groupsnone';
2040 $groupimage = 'i/groupv';
2042 $nextgroupmode = SEPARATEGROUPS
;
2043 $grouptitle = $str->groupsnone
;
2044 $actionname = 'groupsnone';
2045 $nextactionname = 'groupsseparate';
2046 $groupimage = 'i/groupn';
2049 $actions[$actionname] = new action_menu_link_primary(
2050 new moodle_url($baseurl, array('id' => $mod->id
, 'groupmode' => $nextgroupmode)),
2051 new pix_icon($groupimage, '', 'moodle', array('class' => 'iconsmall')),
2053 array('class' => 'editing_'. $actionname, 'data-action' => $nextactionname,
2054 'aria-live' => 'assertive', 'data-sectionreturn' => $sr)
2057 $actions['nogroupsupport'] = new action_menu_filler();
2062 if (has_capability('moodle/role:assign', $modcontext)){
2063 $actions['assign'] = new action_menu_link_secondary(
2064 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id
)),
2065 new pix_icon('t/assignroles', '', 'moodle', array('class' => 'iconsmall')),
2067 array('class' => 'editing_assign', 'data-action' => 'assignroles', 'data-sectionreturn' => $sr)
2072 if ($hasmanageactivities) {
2073 $actions['delete'] = new action_menu_link_secondary(
2074 new moodle_url($baseurl, array('delete' => $mod->id
)),
2075 new pix_icon('t/delete', '', 'moodle', array('class' => 'iconsmall')),
2077 array('class' => 'editing_delete', 'data-action' => 'delete', 'data-sectionreturn' => $sr)
2085 * Returns the move action.
2087 * @param cm_info $mod The module to produce a move button for
2088 * @param int $sr The section to link back to (used for creating the links)
2089 * @return The markup for the move action, or an empty string if not available.
2091 function course_get_cm_move(cm_info
$mod, $sr = null) {
2097 $modcontext = context_module
::instance($mod->id
);
2098 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2101 $str = get_strings(array('move'));
2104 if (!isset($baseurl)) {
2105 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2108 $baseurl->param('sr', $sr);
2112 if ($hasmanageactivities) {
2113 $pixicon = 'i/dragdrop';
2115 if (!course_ajax_enabled($mod->get_course())) {
2116 // Override for course frontpage until we get drag/drop working there.
2117 $pixicon = 't/move';
2120 return html_writer
::link(
2121 new moodle_url($baseurl, array('copy' => $mod->id
)),
2122 $OUTPUT->pix_icon($pixicon, $str->move
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2123 array('class' => 'editing_move', 'data-action' => 'move', 'data-sectionreturn' => $sr)
2130 * given a course object with shortname & fullname, this function will
2131 * truncate the the number of chars allowed and add ... if it was too long
2133 function course_format_name ($course,$max=100) {
2135 $context = context_course
::instance($course->id
);
2136 $shortname = format_string($course->shortname
, true, array('context' => $context));
2137 $fullname = format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
2138 $str = $shortname.': '. $fullname;
2139 if (core_text
::strlen($str) <= $max) {
2143 return core_text
::substr($str,0,$max-3).'...';
2148 * Is the user allowed to add this type of module to this course?
2149 * @param object $course the course settings. Only $course->id is used.
2150 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2151 * @return bool whether the current user is allowed to add this type of module to this course.
2153 function course_allowed_module($course, $modname) {
2154 if (is_numeric($modname)) {
2155 throw new coding_exception('Function course_allowed_module no longer
2156 supports numeric module ids. Please update your code to pass the module name.');
2159 $capability = 'mod/' . $modname . ':addinstance';
2160 if (!get_capability_info($capability)) {
2161 // Debug warning that the capability does not exist, but no more than once per page.
2162 static $warned = array();
2163 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
2164 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM
) {
2165 debugging('The module ' . $modname . ' does not define the standard capability ' .
2166 $capability , DEBUG_DEVELOPER
);
2167 $warned[$modname] = 1;
2170 // If the capability does not exist, the module can always be added.
2174 $coursecontext = context_course
::instance($course->id
);
2175 return has_capability($capability, $coursecontext);
2179 * Efficiently moves many courses around while maintaining
2180 * sortorder in order.
2182 * @param array $courseids is an array of course ids
2183 * @param int $categoryid
2184 * @return bool success
2186 function move_courses($courseids, $categoryid) {
2189 if (empty($courseids)) {
2194 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2198 $courseids = array_reverse($courseids);
2199 $newparent = context_coursecat
::instance($category->id
);
2202 list($where, $params) = $DB->get_in_or_equal($courseids);
2203 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2204 foreach ($dbcourses as $dbcourse) {
2205 $course = new stdClass();
2206 $course->id
= $dbcourse->id
;
2207 $course->timemodified
= time();
2208 $course->category
= $category->id
;
2209 $course->sortorder
= $category->sortorder + MAX_COURSES_IN_CATEGORY
- $i++
;
2210 if ($category->visible
== 0) {
2211 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2212 // to previous state if somebody unhides the category.
2213 $course->visible
= 0;
2216 $DB->update_record('course', $course);
2218 // Update context, so it can be passed to event.
2219 $context = context_course
::instance($course->id
);
2220 $context->update_moved($newparent);
2222 // Trigger a course updated event.
2223 $event = \core\event\course_updated
::create(array(
2224 'objectid' => $course->id
,
2225 'context' => context_course
::instance($course->id
),
2226 'other' => array('shortname' => $dbcourse->shortname
,
2227 'fullname' => $dbcourse->fullname
)
2229 $event->set_legacy_logdata(array($course->id
, 'course', 'move', 'edit.php?id=' . $course->id
, $course->id
));
2232 fix_course_sortorder();
2233 cache_helper
::purge_by_event('changesincourse');
2239 * Returns the display name of the given section that the course prefers
2241 * Implementation of this function is provided by course format
2242 * @see format_base::get_section_name()
2244 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2245 * @param int|stdClass $section Section object from database or just field course_sections.section
2246 * @return string Display name that the course format prefers, e.g. "Week 2"
2248 function get_section_name($courseorid, $section) {
2249 return course_get_format($courseorid)->get_section_name($section);
2253 * Tells if current course format uses sections
2255 * @param string $format Course format ID e.g. 'weeks' $course->format
2258 function course_format_uses_sections($format) {
2259 $course = new stdClass();
2260 $course->format
= $format;
2261 return course_get_format($course)->uses_sections();
2265 * Returns the information about the ajax support in the given source format
2267 * The returned object's property (boolean)capable indicates that
2268 * the course format supports Moodle course ajax features.
2270 * @param string $format
2273 function course_format_ajax_support($format) {
2274 $course = new stdClass();
2275 $course->format
= $format;
2276 return course_get_format($course)->supports_ajax();
2280 * Can the current user delete this course?
2281 * Course creators have exception,
2282 * 1 day after the creation they can sill delete the course.
2283 * @param int $courseid
2286 function can_delete_course($courseid) {
2289 $context = context_course
::instance($courseid);
2291 if (has_capability('moodle/course:delete', $context)) {
2295 // hack: now try to find out if creator created this course recently (1 day)
2296 if (!has_capability('moodle/course:create', $context)) {
2300 $since = time() - 60*60*24;
2301 $course = get_course($courseid);
2303 if ($course->timecreated
< $since) {
2304 return false; // Return if the course was not created in last 24 hours.
2307 $logmanger = get_log_manager();
2308 $readers = $logmanger->get_readers('\core\log\sql_reader');
2309 $reader = reset($readers);
2311 if (empty($reader)) {
2312 return false; // No log reader found.
2316 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2317 $params = array('userid' => $USER->id
, 'since' => $since, 'courseid' => $course->id
, 'eventname' => '\core\event\course_created');
2319 return (bool)$reader->get_events_select_count($select, $params);
2323 * Save the Your name for 'Some role' strings.
2325 * @param integer $courseid the id of this course.
2326 * @param array $data the data that came from the course settings form.
2328 function save_local_role_names($courseid, $data) {
2330 $context = context_course
::instance($courseid);
2332 foreach ($data as $fieldname => $value) {
2333 if (strpos($fieldname, 'role_') !== 0) {
2336 list($ignored, $roleid) = explode('_', $fieldname);
2338 // make up our mind whether we want to delete, update or insert
2340 $DB->delete_records('role_names', array('contextid' => $context->id
, 'roleid' => $roleid));
2342 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id
, 'roleid' => $roleid))) {
2343 $rolename->name
= $value;
2344 $DB->update_record('role_names', $rolename);
2347 $rolename = new stdClass
;
2348 $rolename->contextid
= $context->id
;
2349 $rolename->roleid
= $roleid;
2350 $rolename->name
= $value;
2351 $DB->insert_record('role_names', $rolename);
2353 // This will ensure the course contacts cache is purged..
2354 core_course_category
::role_assignment_changed($roleid, $context);
2359 * Returns options to use in course overviewfiles filemanager
2361 * @param null|stdClass|core_course_list_element|int $course either object that has 'id' property or just the course id;
2362 * may be empty if course does not exist yet (course create form)
2363 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2364 * or null if overviewfiles are disabled
2366 function course_overviewfiles_options($course) {
2368 if (empty($CFG->courseoverviewfileslimit
)) {
2371 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext
), -1, PREG_SPLIT_NO_EMPTY
);
2372 if (in_array('*', $accepted_types) ||
empty($accepted_types)) {
2373 $accepted_types = '*';
2375 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2376 // Make sure extensions are prefixed with dot unless they are valid typegroups
2377 foreach ($accepted_types as $i => $type) {
2378 if (substr($type, 0, 1) !== '.') {
2379 require_once($CFG->libdir
. '/filelib.php');
2380 if (!count(file_get_typegroup('extension', $type))) {
2381 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2382 $accepted_types[$i] = '.'. $type;
2387 if (!empty($corrected)) {
2388 set_config('courseoverviewfilesext', join(',', $accepted_types));
2392 'maxfiles' => $CFG->courseoverviewfileslimit
,
2393 'maxbytes' => $CFG->maxbytes
,
2395 'accepted_types' => $accepted_types
2397 if (!empty($course->id
)) {
2398 $options['context'] = context_course
::instance($course->id
);
2399 } else if (is_int($course) && $course > 0) {
2400 $options['context'] = context_course
::instance($course);
2406 * Create a course and either return a $course object
2408 * Please note this functions does not verify any access control,
2409 * the calling code is responsible for all validation (usually it is the form definition).
2411 * @param array $editoroptions course description editor options
2412 * @param object $data - all the data needed for an entry in the 'course' table
2413 * @return object new course instance
2415 function create_course($data, $editoroptions = NULL) {
2418 //check the categoryid - must be given for all new courses
2419 $category = $DB->get_record('course_categories', array('id'=>$data->category
), '*', MUST_EXIST
);
2421 // Check if the shortname already exists.
2422 if (!empty($data->shortname
)) {
2423 if ($DB->record_exists('course', array('shortname' => $data->shortname
))) {
2424 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2428 // Check if the idnumber already exists.
2429 if (!empty($data->idnumber
)) {
2430 if ($DB->record_exists('course', array('idnumber' => $data->idnumber
))) {
2431 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2435 if ($errorcode = course_validate_dates((array)$data)) {
2436 throw new moodle_exception($errorcode);
2439 // Check if timecreated is given.
2440 $data->timecreated
= !empty($data->timecreated
) ?
$data->timecreated
: time();
2441 $data->timemodified
= $data->timecreated
;
2443 // place at beginning of any category
2444 $data->sortorder
= 0;
2446 if ($editoroptions) {
2447 // summary text is updated later, we need context to store the files first
2448 $data->summary
= '';
2449 $data->summary_format
= FORMAT_HTML
;
2452 if (!isset($data->visible
)) {
2453 // data not from form, add missing visibility info
2454 $data->visible
= $category->visible
;
2456 $data->visibleold
= $data->visible
;
2458 $newcourseid = $DB->insert_record('course', $data);
2459 $context = context_course
::instance($newcourseid, MUST_EXIST
);
2461 if ($editoroptions) {
2462 // Save the files used in the summary editor and store
2463 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2464 $DB->set_field('course', 'summary', $data->summary
, array('id'=>$newcourseid));
2465 $DB->set_field('course', 'summaryformat', $data->summary_format
, array('id'=>$newcourseid));
2467 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2468 // Save the course overviewfiles
2469 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2472 // update course format options
2473 course_get_format($newcourseid)->update_course_format_options($data);
2475 $course = course_get_format($newcourseid)->get_course();
2477 fix_course_sortorder();
2478 // purge appropriate caches in case fix_course_sortorder() did not change anything
2479 cache_helper
::purge_by_event('changesincourse');
2481 // Trigger a course created event.
2482 $event = \core\event\course_created
::create(array(
2483 'objectid' => $course->id
,
2484 'context' => context_course
::instance($course->id
),
2485 'other' => array('shortname' => $course->shortname
,
2486 'fullname' => $course->fullname
)
2492 blocks_add_default_course_blocks($course);
2494 // Create default section and initial sections if specified (unless they've already been created earlier).
2495 // We do not want to call course_create_sections_if_missing() because to avoid creating course cache.
2496 $numsections = isset($data->numsections
) ?
$data->numsections
: 0;
2497 $existingsections = $DB->get_fieldset_sql('SELECT section from {course_sections} WHERE course = ?', [$newcourseid]);
2498 $newsections = array_diff(range(0, $numsections), $existingsections);
2499 foreach ($newsections as $sectionnum) {
2500 course_create_section($newcourseid, $sectionnum, true);
2503 // Save any custom role names.
2504 save_local_role_names($course->id
, (array)$data);
2506 // set up enrolments
2507 enrol_course_updated(true, $course, $data);
2509 // Update course tags.
2510 if (isset($data->tags
)) {
2511 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2514 // Save custom fields if there are any of them in the form.
2515 $handler = core_course\customfield\course_handler
::create();
2516 // Make sure to set the handler's parent context first.
2517 $coursecatcontext = context_coursecat
::instance($category->id
);
2518 $handler->set_parent_context($coursecatcontext);
2519 // Save the custom field data.
2520 $data->id
= $course->id
;
2521 $handler->instance_form_save($data, true);
2529 * Please note this functions does not verify any access control,
2530 * the calling code is responsible for all validation (usually it is the form definition).
2532 * @param object $data - all the data needed for an entry in the 'course' table
2533 * @param array $editoroptions course description editor options
2536 function update_course($data, $editoroptions = NULL) {
2539 $data->timemodified
= time();
2541 // Prevent changes on front page course.
2542 if ($data->id
== SITEID
) {
2543 throw new moodle_exception('invalidcourse', 'error');
2546 $oldcourse = course_get_format($data->id
)->get_course();
2547 $context = context_course
::instance($oldcourse->id
);
2549 if ($editoroptions) {
2550 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2552 if ($overviewfilesoptions = course_overviewfiles_options($data->id
)) {
2553 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2556 // Check we don't have a duplicate shortname.
2557 if (!empty($data->shortname
) && $oldcourse->shortname
!= $data->shortname
) {
2558 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname
, $data->id
))) {
2559 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2563 // Check we don't have a duplicate idnumber.
2564 if (!empty($data->idnumber
) && $oldcourse->idnumber
!= $data->idnumber
) {
2565 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber
, $data->id
))) {
2566 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2570 if ($errorcode = course_validate_dates((array)$data)) {
2571 throw new moodle_exception($errorcode);
2574 if (!isset($data->category
) or empty($data->category
)) {
2575 // prevent nulls and 0 in category field
2576 unset($data->category
);
2578 $changesincoursecat = $movecat = (isset($data->category
) and $oldcourse->category
!= $data->category
);
2580 if (!isset($data->visible
)) {
2581 // data not from form, add missing visibility info
2582 $data->visible
= $oldcourse->visible
;
2585 if ($data->visible
!= $oldcourse->visible
) {
2586 // reset the visibleold flag when manually hiding/unhiding course
2587 $data->visibleold
= $data->visible
;
2588 $changesincoursecat = true;
2591 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category
));
2592 if (empty($newcategory->visible
)) {
2593 // make sure when moving into hidden category the course is hidden automatically
2599 // Set newsitems to 0 if format does not support announcements.
2600 if (isset($data->format
)) {
2601 $newcourseformat = course_get_format((object)['format' => $data->format
]);
2602 if (!$newcourseformat->supports_news()) {
2603 $data->newsitems
= 0;
2607 // Update custom fields if there are any of them in the form.
2608 $handler = core_course\customfield\course_handler
::create();
2609 $handler->instance_form_save($data);
2611 // Update with the new data
2612 $DB->update_record('course', $data);
2613 // make sure the modinfo cache is reset
2614 rebuild_course_cache($data->id
);
2616 // update course format options with full course data
2617 course_get_format($data->id
)->update_course_format_options($data, $oldcourse);
2619 $course = $DB->get_record('course', array('id'=>$data->id
));
2622 $newparent = context_coursecat
::instance($course->category
);
2623 $context->update_moved($newparent);
2625 $fixcoursesortorder = $movecat ||
(isset($data->sortorder
) && ($oldcourse->sortorder
!= $data->sortorder
));
2626 if ($fixcoursesortorder) {
2627 fix_course_sortorder();
2630 // purge appropriate caches in case fix_course_sortorder() did not change anything
2631 cache_helper
::purge_by_event('changesincourse');
2632 if ($changesincoursecat) {
2633 cache_helper
::purge_by_event('changesincoursecat');
2636 // Test for and remove blocks which aren't appropriate anymore
2637 blocks_remove_inappropriate($course);
2639 // Save any custom role names.
2640 save_local_role_names($course->id
, $data);
2642 // update enrol settings
2643 enrol_course_updated(false, $course, $data);
2645 // Update course tags.
2646 if (isset($data->tags
)) {
2647 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2650 // Trigger a course updated event.
2651 $event = \core\event\course_updated
::create(array(
2652 'objectid' => $course->id
,
2653 'context' => context_course
::instance($course->id
),
2654 'other' => array('shortname' => $course->shortname
,
2655 'fullname' => $course->fullname
)
2658 $event->set_legacy_logdata(array($course->id
, 'course', 'update', 'edit.php?id=' . $course->id
, $course->id
));
2661 if ($oldcourse->format
!== $course->format
) {
2662 // Remove all options stored for the previous format
2663 // We assume that new course format migrated everything it needed watching trigger
2664 // 'course_updated' and in method format_XXX::update_course_format_options()
2665 $DB->delete_records('course_format_options',
2666 array('courseid' => $course->id
, 'format' => $oldcourse->format
));
2671 * Average number of participants
2674 function average_number_of_participants() {
2677 //count total of enrolments for visible course (except front page)
2678 $sql = 'SELECT COUNT(*) FROM (
2679 SELECT DISTINCT ue.userid, e.courseid
2680 FROM {user_enrolments} ue, {enrol} e, {course} c
2681 WHERE ue.enrolid = e.id
2682 AND e.courseid <> :siteid
2683 AND c.id = e.courseid
2684 AND c.visible = 1) total';
2685 $params = array('siteid' => $SITE->id
);
2686 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2689 //count total of visible courses (minus front page)
2690 $coursetotal = $DB->count_records('course', array('visible' => 1));
2691 $coursetotal = $coursetotal - 1 ;
2693 //average of enrolment
2694 if (empty($coursetotal)) {
2695 $participantaverage = 0;
2697 $participantaverage = $enrolmenttotal / $coursetotal;
2700 return $participantaverage;
2704 * Average number of course modules
2707 function average_number_of_courses_modules() {
2710 //count total of visible course module (except front page)
2711 $sql = 'SELECT COUNT(*) FROM (
2712 SELECT cm.course, cm.module
2713 FROM {course} c, {course_modules} cm
2714 WHERE c.id = cm.course
2717 AND c.visible = 1) total';
2718 $params = array('siteid' => $SITE->id
);
2719 $moduletotal = $DB->count_records_sql($sql, $params);
2722 //count total of visible courses (minus front page)
2723 $coursetotal = $DB->count_records('course', array('visible' => 1));
2724 $coursetotal = $coursetotal - 1 ;
2726 //average of course module
2727 if (empty($coursetotal)) {
2728 $coursemoduleaverage = 0;
2730 $coursemoduleaverage = $moduletotal / $coursetotal;
2733 return $coursemoduleaverage;
2737 * This class pertains to course requests and contains methods associated with
2738 * create, approving, and removing course requests.
2740 * Please note we do not allow embedded images here because there is no context
2741 * to store them with proper access control.
2743 * @copyright 2009 Sam Hemelryk
2744 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2747 * @property-read int $id
2748 * @property-read string $fullname
2749 * @property-read string $shortname
2750 * @property-read string $summary
2751 * @property-read int $summaryformat
2752 * @property-read int $summarytrust
2753 * @property-read string $reason
2754 * @property-read int $requester
2756 class course_request
{
2759 * This is the stdClass that stores the properties for the course request
2760 * and is externally accessed through the __get magic method
2763 protected $properties;
2766 * An array of options for the summary editor used by course request forms.
2767 * This is initially set by {@link summary_editor_options()}
2771 protected static $summaryeditoroptions;
2774 * Static function to prepare the summary editor for working with a course
2778 * @param null|stdClass $data Optional, an object containing the default values
2779 * for the form, these may be modified when preparing the
2780 * editor so this should be called before creating the form
2781 * @return stdClass An object that can be used to set the default values for
2784 public static function prepare($data=null) {
2785 if ($data === null) {
2786 $data = new stdClass
;
2788 $data = file_prepare_standard_editor($data, 'summary', self
::summary_editor_options());
2793 * Static function to create a new course request when passed an array of properties
2796 * This function also handles saving any files that may have been used in the editor
2799 * @param stdClass $data
2800 * @return course_request The newly created course request
2802 public static function create($data) {
2803 global $USER, $DB, $CFG;
2804 $data->requester
= $USER->id
;
2806 // Setting the default category if none set.
2807 if (empty($data->category
) ||
empty($CFG->requestcategoryselection
)) {
2808 $data->category
= $CFG->defaultrequestcategory
;
2811 // Summary is a required field so copy the text over
2812 $data->summary
= $data->summary_editor
['text'];
2813 $data->summaryformat
= $data->summary_editor
['format'];
2815 $data->id
= $DB->insert_record('course_request', $data);
2817 // Create a new course_request object and return it
2818 $request = new course_request($data);
2820 // Notify the admin if required.
2821 if ($users = get_users_from_config($CFG->courserequestnotify
, 'moodle/site:approvecourse')) {
2824 $a->link
= "$CFG->wwwroot/course/pending.php";
2825 $a->user
= fullname($USER);
2826 $subject = get_string('courserequest');
2827 $message = get_string('courserequestnotifyemail', 'admin', $a);
2828 foreach ($users as $user) {
2829 $request->notify($user, $USER, 'courserequested', $subject, $message);
2837 * Returns an array of options to use with a summary editor
2839 * @uses course_request::$summaryeditoroptions
2840 * @return array An array of options to use with the editor
2842 public static function summary_editor_options() {
2844 if (self
::$summaryeditoroptions === null) {
2845 self
::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2847 return self
::$summaryeditoroptions;
2851 * Loads the properties for this course request object. Id is required and if
2852 * only id is provided then we load the rest of the properties from the database
2854 * @param stdClass|int $properties Either an object containing properties
2855 * or the course_request id to load
2857 public function __construct($properties) {
2859 if (empty($properties->id
)) {
2860 if (empty($properties)) {
2861 throw new coding_exception('You must provide a course request id when creating a course_request object');
2864 $properties = new stdClass
;
2865 $properties->id
= (int)$id;
2868 if (empty($properties->requester
)) {
2869 if (!($this->properties
= $DB->get_record('course_request', array('id' => $properties->id
)))) {
2870 print_error('unknowncourserequest');
2873 $this->properties
= $properties;
2875 $this->properties
->collision
= null;
2879 * Returns the requested property
2881 * @param string $key
2884 public function __get($key) {
2885 return $this->properties
->$key;
2889 * Override this to ensure empty($request->blah) calls return a reliable answer...
2891 * This is required because we define the __get method
2894 * @return bool True is it not empty, false otherwise
2896 public function __isset($key) {
2897 return (!empty($this->properties
->$key));
2901 * Returns the user who requested this course
2903 * Uses a static var to cache the results and cut down the number of db queries
2905 * @staticvar array $requesters An array of cached users
2906 * @return stdClass The user who requested the course
2908 public function get_requester() {
2910 static $requesters= array();
2911 if (!array_key_exists($this->properties
->requester
, $requesters)) {
2912 $requesters[$this->properties
->requester
] = $DB->get_record('user', array('id'=>$this->properties
->requester
));
2914 return $requesters[$this->properties
->requester
];
2918 * Checks that the shortname used by the course does not conflict with any other
2919 * courses that exist
2921 * @param string|null $shortnamemark The string to append to the requests shortname
2922 * should a conflict be found
2923 * @return bool true is there is a conflict, false otherwise
2925 public function check_shortname_collision($shortnamemark = '[*]') {
2928 if ($this->properties
->collision
!== null) {
2929 return $this->properties
->collision
;
2932 if (empty($this->properties
->shortname
)) {
2933 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER
);
2934 $this->properties
->collision
= false;
2935 } else if ($DB->record_exists('course', array('shortname' => $this->properties
->shortname
))) {
2936 if (!empty($shortnamemark)) {
2937 $this->properties
->shortname
.= ' '.$shortnamemark;
2939 $this->properties
->collision
= true;
2941 $this->properties
->collision
= false;
2943 return $this->properties
->collision
;
2947 * Returns the category where this course request should be created
2949 * Note that we don't check here that user has a capability to view
2950 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2951 * 'moodle/course:changecategory'
2953 * @return core_course_category
2955 public function get_category() {
2957 // If the category is not set, if the current user does not have the rights to change the category, or if the
2958 // category does not exist, we set the default category to the course to be approved.
2959 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2960 if (empty($this->properties
->category
) ||
!has_capability('moodle/course:changecategory', context_system
::instance()) ||
2961 (!$category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
, true))) {
2962 $category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
, true);
2965 $category = core_course_category
::get_default();
2971 * This function approves the request turning it into a course
2973 * This function converts the course request into a course, at the same time
2974 * transferring any files used in the summary to the new course and then removing
2975 * the course request and the files associated with it.
2977 * @return int The id of the course that was created from this request
2979 public function approve() {
2980 global $CFG, $DB, $USER;
2982 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
2984 $user = $DB->get_record('user', array('id' => $this->properties
->requester
, 'deleted'=>0), '*', MUST_EXIST
);
2986 $courseconfig = get_config('moodlecourse');
2988 // Transfer appropriate settings
2989 $data = clone($this->properties
);
2991 unset($data->reason
);
2992 unset($data->requester
);
2995 $category = $this->get_category();
2996 $data->category
= $category->id
;
2997 // Set misc settings
2998 $data->requested
= 1;
3000 // Apply course default settings
3001 $data->format
= $courseconfig->format
;
3002 $data->newsitems
= $courseconfig->newsitems
;
3003 $data->showgrades
= $courseconfig->showgrades
;
3004 $data->showreports
= $courseconfig->showreports
;
3005 $data->maxbytes
= $courseconfig->maxbytes
;
3006 $data->groupmode
= $courseconfig->groupmode
;
3007 $data->groupmodeforce
= $courseconfig->groupmodeforce
;
3008 $data->visible
= $courseconfig->visible
;
3009 $data->visibleold
= $data->visible
;
3010 $data->lang
= $courseconfig->lang
;
3011 $data->enablecompletion
= $courseconfig->enablecompletion
;
3012 $data->numsections
= $courseconfig->numsections
;
3013 $data->startdate
= usergetmidnight(time());
3014 if ($courseconfig->courseenddateenabled
) {
3015 $data->enddate
= usergetmidnight(time()) +
$courseconfig->courseduration
;
3018 list($data->fullname
, $data->shortname
) = restore_dbops
::calculate_course_names(0, $data->fullname
, $data->shortname
);
3020 $course = create_course($data);
3021 $context = context_course
::instance($course->id
, MUST_EXIST
);
3023 // add enrol instances
3024 if (!$DB->record_exists('enrol', array('courseid'=>$course->id
, 'enrol'=>'manual'))) {
3025 if ($manual = enrol_get_plugin('manual')) {
3026 $manual->add_default_instance($course);
3030 // enrol the requester as teacher if necessary
3031 if (!empty($CFG->creatornewroleid
) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3032 enrol_try_internal_enrol($course->id
, $user->id
, $CFG->creatornewroleid
);
3037 $a = new stdClass();
3038 $a->name
= format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
3039 $a->url
= $CFG->wwwroot
.'/course/view.php?id=' . $course->id
;
3040 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a), $course->id
);
3046 * Reject a course request
3048 * This function rejects a course request, emailing the requesting user the
3049 * provided notice and then removing the request from the database
3051 * @param string $notice The message to display to the user
3053 public function reject($notice) {
3055 $user = $DB->get_record('user', array('id' => $this->properties
->requester
), '*', MUST_EXIST
);
3056 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3061 * Deletes the course request and any associated files
3063 public function delete() {
3065 $DB->delete_records('course_request', array('id' => $this->properties
->id
));
3069 * Send a message from one user to another using events_trigger
3071 * @param object $touser
3072 * @param object $fromuser
3073 * @param string $name
3074 * @param string $subject
3075 * @param string $message
3076 * @param int|null $courseid
3078 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message, $courseid = null) {
3079 $eventdata = new \core\message\
message();
3080 $eventdata->courseid
= empty($courseid) ? SITEID
: $courseid;
3081 $eventdata->component
= 'moodle';
3082 $eventdata->name
= $name;
3083 $eventdata->userfrom
= $fromuser;
3084 $eventdata->userto
= $touser;
3085 $eventdata->subject
= $subject;
3086 $eventdata->fullmessage
= $message;
3087 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
3088 $eventdata->fullmessagehtml
= '';
3089 $eventdata->smallmessage
= '';
3090 $eventdata->notification
= 1;
3091 message_send($eventdata);
3096 * Return a list of page types
3097 * @param string $pagetype current page type
3098 * @param context $parentcontext Block's parent context
3099 * @param context $currentcontext Current context of block
3100 * @return array array of page types
3102 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3103 if ($pagetype === 'course-index' ||
$pagetype === 'course-index-category') {
3104 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3105 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3106 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3108 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) ||
$coursecontext->instanceid
== SITEID
)) {
3109 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3110 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3112 // Otherwise consider it a page inside a course even if $currentcontext is null
3113 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3114 'course-*' => get_string('page-course-x', 'pagetype'),
3115 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3122 * Determine whether course ajax should be enabled for the specified course
3124 * @param stdClass $course The course to test against
3125 * @return boolean Whether course ajax is enabled or note
3127 function course_ajax_enabled($course) {
3128 global $CFG, $PAGE, $SITE;
3130 // The user must be editing for AJAX to be included
3131 if (!$PAGE->user_is_editing()) {
3135 // Check that the theme suports
3136 if (!$PAGE->theme
->enablecourseajax
) {
3140 // Check that the course format supports ajax functionality
3141 // The site 'format' doesn't have information on course format support
3142 if ($SITE->id
!== $course->id
) {
3143 $courseformatajaxsupport = course_format_ajax_support($course->format
);
3144 if (!$courseformatajaxsupport->capable
) {
3149 // All conditions have been met so course ajax should be enabled
3154 * Include the relevant javascript and language strings for the resource
3155 * toolbox YUI module
3157 * @param integer $id The ID of the course being applied to
3158 * @param array $usedmodules An array containing the names of the modules in use on the page
3159 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3160 * @param stdClass $config An object containing configuration parameters for ajax modules including:
3161 * * resourceurl The URL to post changes to for resource changes
3162 * * sectionurl The URL to post changes to for section changes
3163 * * pageparams Additional parameters to pass through in the post
3166 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3167 global $CFG, $PAGE, $SITE;
3169 // Ensure that ajax should be included
3170 if (!course_ajax_enabled($course)) {
3175 $config = new stdClass();
3178 // The URL to use for resource changes
3179 if (!isset($config->resourceurl
)) {
3180 $config->resourceurl
= '/course/rest.php';
3183 // The URL to use for section changes
3184 if (!isset($config->sectionurl
)) {
3185 $config->sectionurl
= '/course/rest.php';
3188 // Any additional parameters which need to be included on page submission
3189 if (!isset($config->pageparams
)) {
3190 $config->pageparams
= array();
3193 // Include course dragdrop
3194 if (course_format_uses_sections($course->format
)) {
3195 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3197 'courseid' => $course->id
,
3198 'ajaxurl' => $config->sectionurl
,
3199 'config' => $config,
3202 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3204 'courseid' => $course->id
,
3205 'ajaxurl' => $config->resourceurl
,
3206 'config' => $config,
3210 // Require various strings for the command toolbox
3211 $PAGE->requires
->strings_for_js(array(
3214 'deletechecktypename',
3216 'edittitleinstructions',
3224 'clicktochangeinbrackets',
3229 'movecoursesection',
3232 'emptydragdropregion',
3238 // Include section-specific strings for formats which support sections.
3239 if (course_format_uses_sections($course->format
)) {
3240 $PAGE->requires
->strings_for_js(array(
3243 ), 'format_' . $course->format
);
3246 // For confirming resource deletion we need the name of the module in question
3247 foreach ($usedmodules as $module => $modname) {
3248 $PAGE->requires
->string_for_js('pluginname', $module);
3251 // Load drag and drop upload AJAX.
3252 require_once($CFG->dirroot
.'/course/dnduploadlib.php');
3253 dndupload_add_to_course($course, $enabledmodules);
3255 $PAGE->requires
->js_call_amd('core_course/actions', 'initCoursePage', array($course->format
));
3261 * Returns the sorted list of available course formats, filtered by enabled if necessary
3263 * @param bool $enabledonly return only formats that are enabled
3264 * @return array array of sorted format names
3266 function get_sorted_course_formats($enabledonly = false) {
3268 $formats = core_component
::get_plugin_list('format');
3270 if (!empty($CFG->format_plugins_sortorder
)) {
3271 $order = explode(',', $CFG->format_plugins_sortorder
);
3272 $order = array_merge(array_intersect($order, array_keys($formats)),
3273 array_diff(array_keys($formats), $order));
3275 $order = array_keys($formats);
3277 if (!$enabledonly) {
3280 $sortedformats = array();
3281 foreach ($order as $formatname) {
3282 if (!get_config('format_'.$formatname, 'disabled')) {
3283 $sortedformats[] = $formatname;
3286 return $sortedformats;
3290 * The URL to use for the specified course (with section)
3292 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3293 * @param int|stdClass $section Section object from database or just field course_sections.section
3294 * if omitted the course view page is returned
3295 * @param array $options options for view URL. At the moment core uses:
3296 * 'navigation' (bool) if true and section has no separate page, the function returns null
3297 * 'sr' (int) used by multipage formats to specify to which section to return
3298 * @return moodle_url The url of course
3300 function course_get_url($courseorid, $section = null, $options = array()) {
3301 return course_get_format($courseorid)->get_view_url($section, $options);
3308 * - capability checks and other checks
3309 * - create the module from the module info
3311 * @param object $module
3312 * @return object the created module info
3313 * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3315 function create_module($moduleinfo) {
3318 require_once($CFG->dirroot
. '/course/modlib.php');
3320 // Check manadatory attributs.
3321 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3322 if (plugin_supports('mod', $moduleinfo->modulename
, FEATURE_MOD_INTRO
, true)) {
3323 $mandatoryfields[] = 'introeditor';
3325 foreach($mandatoryfields as $mandatoryfield) {
3326 if (!isset($moduleinfo->{$mandatoryfield})) {
3327 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3331 // Some additional checks (capability / existing instances).
3332 $course = $DB->get_record('course', array('id'=>$moduleinfo->course
), '*', MUST_EXIST
);
3333 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename
, $moduleinfo->section
);
3336 $moduleinfo->module
= $module->id
;
3337 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3346 * - capability and other checks
3347 * - update the module
3349 * @param object $module
3350 * @return object the updated module info
3351 * @throws moodle_exception if current user is not allowed to update the module
3353 function update_module($moduleinfo) {
3356 require_once($CFG->dirroot
. '/course/modlib.php');
3358 // Check the course module exists.
3359 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule
, 0, false, MUST_EXIST
);
3361 // Check the course exists.
3362 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
3364 // Some checks (capaibility / existing instances).
3365 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3367 // Retrieve few information needed by update_moduleinfo.
3368 $moduleinfo->modulename
= $cm->modname
;
3369 if (!isset($moduleinfo->scale
)) {
3370 $moduleinfo->scale
= 0;
3372 $moduleinfo->type
= 'mod';
3374 // Update the module.
3375 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3381 * Duplicate a module on the course for ajax.
3383 * @see mod_duplicate_module()
3384 * @param object $course The course
3385 * @param object $cm The course module to duplicate
3386 * @param int $sr The section to link back to (used for creating the links)
3387 * @throws moodle_exception if the plugin doesn't support duplication
3388 * @return Object containing:
3389 * - fullcontent: The HTML markup for the created CM
3390 * - cmid: The CMID of the newly created CM
3391 * - redirect: Whether to trigger a redirect following this change
3393 function mod_duplicate_activity($course, $cm, $sr = null) {
3396 $newcm = duplicate_module($course, $cm);
3398 $resp = new stdClass();
3400 $courserenderer = $PAGE->get_renderer('core', 'course');
3401 $completioninfo = new completion_info($course);
3402 $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3403 $newcm, null, array());
3405 $resp->fullcontent
= $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3406 $resp->cmid
= $newcm->id
;
3408 // Trigger a redirect.
3409 $resp->redirect
= true;
3415 * Api to duplicate a module.
3417 * @param object $course course object.
3418 * @param object $cm course module object to be duplicated.
3422 * @throws coding_exception
3423 * @throws moodle_exception
3424 * @throws restore_controller_exception
3426 * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3428 function duplicate_module($course, $cm) {
3429 global $CFG, $DB, $USER;
3430 require_once($CFG->dirroot
. '/backup/util/includes/backup_includes.php');
3431 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
3432 require_once($CFG->libdir
. '/filelib.php');
3434 $a = new stdClass();
3435 $a->modtype
= get_string('modulename', $cm->modname
);
3436 $a->modname
= format_string($cm->name
);
3438 if (!plugin_supports('mod', $cm->modname
, FEATURE_BACKUP_MOODLE2
)) {
3439 throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3442 // Backup the activity.
3444 $bc = new backup_controller(backup
::TYPE_1ACTIVITY
, $cm->id
, backup
::FORMAT_MOODLE
,
3445 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
);
3447 $backupid = $bc->get_backupid();
3448 $backupbasepath = $bc->get_plan()->get_basepath();
3450 $bc->execute_plan();
3454 // Restore the backup immediately.
3456 $rc = new restore_controller($backupid, $course->id
,
3457 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
, backup
::TARGET_CURRENT_ADDING
);
3459 // Make sure that the restore_general_groups setting is always enabled when duplicating an activity.
3460 $plan = $rc->get_plan();
3461 $groupsetting = $plan->get_setting('groups');
3462 if (empty($groupsetting->get_value())) {
3463 $groupsetting->set_value(true);
3466 $cmcontext = context_module
::instance($cm->id
);
3467 if (!$rc->execute_precheck()) {
3468 $precheckresults = $rc->get_precheck_results();
3469 if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3470 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3471 fulldelete($backupbasepath);
3476 $rc->execute_plan();
3478 // Now a bit hacky part follows - we try to get the cmid of the newly
3479 // restored copy of the module.
3481 $tasks = $rc->get_plan()->get_tasks();
3482 foreach ($tasks as $task) {
3483 if (is_subclass_of($task, 'restore_activity_task')) {
3484 if ($task->get_old_contextid() == $cmcontext->id
) {
3485 $newcmid = $task->get_moduleid();
3493 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3494 fulldelete($backupbasepath);
3497 // If we know the cmid of the new course module, let us move it
3498 // right below the original one. otherwise it will stay at the
3499 // end of the section.
3501 // Proceed with activity renaming before everything else. We don't use APIs here to avoid
3502 // triggering a lot of create/update duplicated events.
3503 $newcm = get_coursemodule_from_id($cm->modname
, $newcmid, $cm->course
);
3504 // Add ' (copy)' to duplicates. Note we don't cleanup or validate lengths here. It comes
3505 // from original name that was valid, so the copy should be too.
3506 $newname = get_string('duplicatedmodule', 'moodle', $newcm->name
);
3507 $DB->set_field($cm->modname
, 'name', $newname, ['id' => $newcm->instance
]);
3509 $section = $DB->get_record('course_sections', array('id' => $cm->section
, 'course' => $cm->course
));
3510 $modarray = explode(",", trim($section->sequence
));
3511 $cmindex = array_search($cm->id
, $modarray);
3512 if ($cmindex !== false && $cmindex < count($modarray) - 1) {
3513 moveto_module($newcm, $section, $modarray[$cmindex +
1]);
3516 // Update calendar events with the duplicated module.
3517 // The following line is to be removed in MDL-58906.
3518 course_module_update_calendar_events($newcm->modname
, null, $newcm);
3520 // Trigger course module created event. We can trigger the event only if we know the newcmid.
3521 $newcm = get_fast_modinfo($cm->course
)->get_cm($newcmid);
3522 $event = \core\event\course_module_created
::create_from_cm($newcm);
3526 return isset($newcm) ?
$newcm : null;
3530 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3531 * Sorts by descending order of time.
3533 * @param stdClass $a First object
3534 * @param stdClass $b Second object
3535 * @return int 0,1,-1 representing the order
3537 function compare_activities_by_time_desc($a, $b) {
3538 // Make sure the activities actually have a timestamp property.
3539 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3542 // We treat instances without timestamp as if they have a timestamp of 0.
3543 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3546 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3549 if ($a->timestamp
== $b->timestamp
) {
3552 return ($a->timestamp
> $b->timestamp
) ?
-1 : 1;
3556 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3557 * Sorts by ascending order of time.
3559 * @param stdClass $a First object
3560 * @param stdClass $b Second object
3561 * @return int 0,1,-1 representing the order
3563 function compare_activities_by_time_asc($a, $b) {
3564 // Make sure the activities actually have a timestamp property.
3565 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3568 // We treat instances without timestamp as if they have a timestamp of 0.
3569 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3572 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3575 if ($a->timestamp
== $b->timestamp
) {
3578 return ($a->timestamp
< $b->timestamp
) ?
-1 : 1;
3582 * Changes the visibility of a course.
3584 * @param int $courseid The course to change.
3585 * @param bool $show True to make it visible, false otherwise.
3588 function course_change_visibility($courseid, $show = true) {
3589 $course = new stdClass
;
3590 $course->id
= $courseid;
3591 $course->visible
= ($show) ?
'1' : '0';
3592 $course->visibleold
= $course->visible
;
3593 update_course($course);
3598 * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3600 * @param stdClass|core_course_list_element $course
3601 * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3604 function course_change_sortorder_by_one($course, $up) {
3606 $params = array($course->sortorder
, $course->category
);
3608 $select = 'sortorder < ? AND category = ?';
3609 $sort = 'sortorder DESC';
3611 $select = 'sortorder > ? AND category = ?';
3612 $sort = 'sortorder ASC';
3614 fix_course_sortorder();
3615 $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3617 $swapcourse = reset($swapcourse);
3618 $DB->set_field('course', 'sortorder', $swapcourse->sortorder
, array('id' => $course->id
));
3619 $DB->set_field('course', 'sortorder', $course->sortorder
, array('id' => $swapcourse->id
));
3620 // Finally reorder courses.
3621 fix_course_sortorder();
3622 cache_helper
::purge_by_event('changesincourse');
3629 * Changes the sort order of courses in a category so that the first course appears after the second.
3631 * @param int|stdClass $courseorid The course to focus on.
3632 * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3635 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3638 if (!is_object($courseorid)) {
3639 $course = get_course($courseorid);
3641 $course = $courseorid;
3644 if ((int)$moveaftercourseid === 0) {
3645 // We've moving the course to the start of the queue.
3646 $sql = 'SELECT sortorder
3648 WHERE category = :categoryid
3649 ORDER BY sortorder';
3651 'categoryid' => $course->category
3653 $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE
);
3655 $sql = 'UPDATE {course}
3656 SET sortorder = sortorder + 1
3657 WHERE category = :categoryid
3660 'categoryid' => $course->category
,
3661 'id' => $course->id
,
3663 $DB->execute($sql, $params);
3664 $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id
));
3665 } else if ($course->id
=== $moveaftercourseid) {
3666 // They're the same - moronic.
3667 debugging("Invalid move after course given.", DEBUG_DEVELOPER
);
3670 // Moving this course after the given course. It could be before it could be after.
3671 $moveaftercourse = get_course($moveaftercourseid);
3672 if ($course->category
!== $moveaftercourse->category
) {
3673 debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER
);
3676 // Increment all courses in the same category that are ordered after the moveafter course.
3677 // This makes a space for the course we're moving.
3678 $sql = 'UPDATE {course}
3679 SET sortorder = sortorder + 1
3680 WHERE category = :categoryid
3681 AND sortorder > :sortorder';
3683 'categoryid' => $moveaftercourse->category
,
3684 'sortorder' => $moveaftercourse->sortorder
3686 $DB->execute($sql, $params);
3687 $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder +
1, array('id' => $course->id
));
3689 fix_course_sortorder();
3690 cache_helper
::purge_by_event('changesincourse');
3695 * Trigger course viewed event. This API function is used when course view actions happens,
3696 * usually in course/view.php but also in external functions.
3698 * @param stdClass $context course context object
3699 * @param int $sectionnumber section number
3702 function course_view($context, $sectionnumber = 0) {
3704 $eventdata = array('context' => $context);
3706 if (!empty($sectionnumber)) {
3707 $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3710 $event = \core\event\course_viewed
::create($eventdata);
3713 user_accesstime_log($context->instanceid
);
3717 * Returns courses tagged with a specified tag.
3719 * @param core_tag_tag $tag
3720 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3721 * are displayed on the page and the per-page limit may be bigger
3722 * @param int $fromctx context id where the link was displayed, may be used by callbacks
3723 * to display items in the same context first
3724 * @param int $ctx context id where to search for records
3725 * @param bool $rec search in subcontexts as well
3726 * @param int $page 0-based number of page being displayed
3727 * @return \core_tag\output\tagindex
3729 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3732 $perpage = $exclusivemode ?
$CFG->coursesperpage
: 5;
3733 $displayoptions = array(
3734 'limit' => $perpage,
3735 'offset' => $page * $perpage,
3736 'viewmoreurl' => null,
3739 $courserenderer = $PAGE->get_renderer('core', 'course');
3740 $totalcount = core_course_category
::search_courses_count(array('tagid' => $tag->id
, 'ctx' => $ctx, 'rec' => $rec));
3741 $content = $courserenderer->tagged_courses($tag->id
, $exclusivemode, $ctx, $rec, $displayoptions);
3742 $totalpages = ceil($totalcount / $perpage);
3744 return new core_tag\output\tagindex
($tag, 'core', 'course', $content,
3745 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3749 * Implements callback inplace_editable() allowing to edit values in-place
3751 * @param string $itemtype
3752 * @param int $itemid
3753 * @param mixed $newvalue
3754 * @return \core\output\inplace_editable
3756 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3757 if ($itemtype === 'activityname') {
3758 return \core_course\output\course_module_name
::update($itemid, $newvalue);
3763 * This function calculates the minimum and maximum cutoff values for the timestart of
3766 * It will return an array with two values, the first being the minimum cutoff value and
3767 * the second being the maximum cutoff value. Either or both values can be null, which
3768 * indicates there is no minimum or maximum, respectively.
3770 * If a cutoff is required then the function must return an array containing the cutoff
3771 * timestamp and error string to display to the user if the cutoff value is violated.
3773 * A minimum and maximum cutoff return value will look like:
3775 * [1505704373, 'The date must be after this date'],
3776 * [1506741172, 'The date must be before this date']
3779 * @param calendar_event $event The calendar event to get the time range for
3780 * @param stdClass $course The course object to get the range from
3781 * @return array Returns an array with min and max date.
3783 function core_course_core_calendar_get_valid_event_timestart_range(\calendar_event
$event, $course) {
3787 if ($course->startdate
) {
3790 get_string('errorbeforecoursestart', 'calendar')
3794 return [$mindate, $maxdate];
3798 * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3800 * This is a callback used by the tag area core/course_modules to search for course modules
3801 * tagged with a specific tag.
3803 * @param core_tag_tag $tag
3804 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3805 * are displayed on the page and the per-page limit may be bigger
3806 * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3807 * to display items in the same context first
3808 * @param int $contextid context id where to search for records
3809 * @param bool $recursivecontext search in subcontexts as well
3810 * @param int $page 0-based number of page being displayed
3811 * @return \core_tag\output\tagindex
3813 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3814 $recursivecontext = 1, $page = 0) {
3816 $perpage = $exclusivemode ?
20 : 5;
3818 // Build select query.
3819 $ctxselect = context_helper
::get_preload_record_columns_sql('ctx');
3820 $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3821 FROM {course_modules} cm
3822 JOIN {tag_instance} tt ON cm.id = tt.itemid
3823 JOIN {course} c ON cm.course = c.id
3824 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3825 WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3826 AND cm.deletioninprogress = 0
3827 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3829 $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id
, 'component' => 'core',
3830 'coursemodulecontextlevel' => CONTEXT_MODULE
);
3832 $context = context
::instance_by_id($contextid);
3833 $query .= $recursivecontext ?
' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3834 $params['contextid'] = $context->id
;
3835 $params['path'] = $context->path
.'/%';
3838 $query .= ' ORDER BY';
3839 if ($fromcontextid) {
3840 // In order-clause specify that modules from inside "fromctx" context should be returned first.
3841 $fromcontext = context
::instance_by_id($fromcontextid);
3842 $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3843 $params['fromcontextid'] = $fromcontext->id
;
3844 $params['frompath'] = $fromcontext->path
.'/%';
3846 $query .= ' c.sortorder, cm.id';
3847 $totalpages = $page +
1;
3849 // Use core_tag_index_builder to build and filter the list of items.
3850 // Request one item more than we need so we know if next page exists.
3851 $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage +
1);
3852 while ($item = $builder->has_item_that_needs_access_check()) {
3853 context_helper
::preload_from_record($item);
3854 $courseid = $item->courseid
;
3855 if (!$builder->can_access_course($courseid)) {
3856 $builder->set_accessible($item, false);
3859 $modinfo = get_fast_modinfo($builder->get_course($courseid));
3860 // Set accessibility of this item and all other items in the same course.
3861 $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3862 if ($taggeditem->courseid
== $courseid) {
3863 $cm = $modinfo->get_cm($taggeditem->cmid
);
3864 $builder->set_accessible($taggeditem, $cm->uservisible
);
3869 $items = $builder->get_items();
3870 if (count($items) > $perpage) {
3871 $totalpages = $page +
2; // We don't need exact page count, just indicate that the next page exists.
3875 // Build the display contents.
3877 $tagfeed = new core_tag\output\tagfeed
();
3878 foreach ($items as $item) {
3879 context_helper
::preload_from_record($item);
3880 $course = $builder->get_course($item->courseid
);
3881 $modinfo = get_fast_modinfo($course);
3882 $cm = $modinfo->get_cm($item->cmid
);
3883 $courseurl = course_get_url($item->courseid
, $cm->sectionnum
);
3884 $cmname = $cm->get_formatted_name();
3885 if (!$exclusivemode) {
3886 $cmname = shorten_text($cmname, 100);
3888 $cmname = html_writer
::link($cm->url?
:$courseurl, $cmname);
3889 $coursename = format_string($course->fullname
, true,
3890 array('context' => context_course
::instance($item->courseid
)));
3891 $coursename = html_writer
::link($courseurl, $coursename);
3892 $icon = html_writer
::empty_tag('img', array('src' => $cm->get_icon_url()));
3893 $tagfeed->add($icon, $cmname, $coursename);
3896 $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3897 $tagfeed->export_for_template($OUTPUT));
3899 return new core_tag\output\tagindex
($tag, 'core', 'course_modules', $content,
3900 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3905 * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3906 * This function also handles the frontpage course.
3908 * @param stdClass $context context object (it can be a course context or the system context for frontpage settings)
3909 * @param stdClass $course the course where the settings are being rendered
3910 * @return stdClass the navigation options in a course and their availability status
3913 function course_get_user_navigation_options($context, $course = null) {
3916 $isloggedin = isloggedin();
3917 $isguestuser = isguestuser();
3918 $isfrontpage = $context->contextlevel
== CONTEXT_SYSTEM
;
3921 $sitecontext = $context;
3923 $sitecontext = context_system
::instance();
3926 // Sets defaults for all options.
3927 $options = (object) [
3930 'calendar' => false,
3931 'competencies' => false,
3934 'participants' => false,
3939 $options->blogs
= !empty($CFG->enableblogs
) &&
3940 ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL ||
3941 ($CFG->bloglevel
== BLOG_SITE_LEVEL
and ($isloggedin and !$isguestuser)))
3942 && has_capability('moodle/blog:view', $sitecontext);
3944 $options->notes
= !empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
3946 // Frontpage settings?
3948 // We are on the front page, so make sure we use the proper capability (site:viewparticipants).
3949 $options->participants
= course_can_view_participants($sitecontext);
3950 $options->badges
= !empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $sitecontext);
3951 $options->tags
= !empty($CFG->usetags
) && $isloggedin;
3952 $options->search
= !empty($CFG->enableglobalsearch
) && has_capability('moodle/search:query', $sitecontext);
3953 $options->calendar
= $isloggedin;
3955 // We are in a course, so make sure we use the proper capability (course:viewparticipants).
3956 $options->participants
= course_can_view_participants($context);
3957 $options->badges
= !empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
3958 has_capability('moodle/badges:viewbadges', $context);
3959 // Add view grade report is permitted.
3962 if (has_capability('moodle/grade:viewall', $context)) {
3964 } else if (!empty($course->showgrades
)) {
3965 $reports = core_component
::get_plugin_list('gradereport');
3966 if (is_array($reports) && count($reports) > 0) { // Get all installed reports.
3967 arsort($reports); // User is last, we want to test it first.
3968 foreach ($reports as $plugin => $plugindir) {
3969 if (has_capability('gradereport/'.$plugin.':view', $context)) {
3970 // Stop when the first visible plugin is found.
3977 $options->grades
= $grades;
3980 if (\core_competency\api
::is_enabled()) {
3981 $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
3982 $options->competencies
= has_any_capability($capabilities, $context);
3988 * Return an object with the list of administration options in a course that are available or not for the current user.
3989 * This function also handles the frontpage settings.
3991 * @param stdClass $course course object (for frontpage it should be a clone of $SITE)
3992 * @param stdClass $context context object (course context)
3993 * @return stdClass the administration options in a course and their availability status
3996 function course_get_user_administration_options($course, $context) {
3998 $isfrontpage = $course->id
== SITEID
;
3999 $completionenabled = $CFG->enablecompletion
&& $course->enablecompletion
;
4000 $hascompletiontabs = count(core_completion\manager
::get_available_completion_tabs($course, $context)) > 0;
4002 $options = new stdClass
;
4003 $options->update
= has_capability('moodle/course:update', $context);
4004 $options->editcompletion
= $CFG->enablecompletion
&&
4005 $course->enablecompletion
&&
4006 ($options->update ||
$hascompletiontabs);
4007 $options->filters
= has_capability('moodle/filter:manage', $context) &&
4008 count(filter_get_available_in_context($context)) > 0;
4009 $options->reports
= has_capability('moodle/site:viewreports', $context);
4010 $options->backup
= has_capability('moodle/backup:backupcourse', $context);
4011 $options->restore
= has_capability('moodle/restore:restorecourse', $context);
4012 $options->files
= ($course->legacyfiles
== 2 && has_capability('moodle/course:managefiles', $context));
4014 if (!$isfrontpage) {
4015 $options->tags
= has_capability('moodle/course:tag', $context);
4016 $options->gradebook
= has_capability('moodle/grade:manage', $context);
4017 $options->outcomes
= !empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $context);
4018 $options->badges
= !empty($CFG->enablebadges
);
4019 $options->import
= has_capability('moodle/restore:restoretargetimport', $context);
4020 $options->reset
= has_capability('moodle/course:reset', $context);
4021 $options->roles
= has_capability('moodle/role:switchroles', $context);
4023 // Set default options to false.
4024 $listofoptions = array('tags', 'gradebook', 'outcomes', 'badges', 'import', 'publish', 'reset', 'roles', 'grades');
4026 foreach ($listofoptions as $option) {
4027 $options->$option = false;
4035 * Validates course start and end dates.
4037 * Checks that the end course date is not greater than the start course date.
4039 * $coursedata['startdate'] or $coursedata['enddate'] may not be set, it depends on the form and user input.
4041 * @param array $coursedata May contain startdate and enddate timestamps, depends on the user input.
4042 * @return mixed False if everything alright, error codes otherwise.
4044 function course_validate_dates($coursedata) {
4046 // If both start and end dates are set end date should be later than the start date.
4047 if (!empty($coursedata['startdate']) && !empty($coursedata['enddate']) &&
4048 ($coursedata['enddate'] < $coursedata['startdate'])) {
4049 return 'enddatebeforestartdate';
4052 // If start date is not set end date can not be set.
4053 if (empty($coursedata['startdate']) && !empty($coursedata['enddate'])) {
4054 return 'nostartdatenoenddate';
4061 * Check for course updates in the given context level instances (only modules supported right Now)
4063 * @param stdClass $course course object
4064 * @param array $tocheck instances to check for updates
4065 * @param array $filter check only for updates in these areas
4066 * @return array list of warnings and instances with updates information
4069 function course_check_updates($course, $tocheck, $filter = array()) {
4072 $instances = array();
4073 $warnings = array();
4074 $modulescallbacksupport = array();
4075 $modinfo = get_fast_modinfo($course);
4077 $supportedplugins = get_plugin_list_with_function('mod', 'check_updates_since');
4080 foreach ($tocheck as $instance) {
4081 if ($instance['contextlevel'] == 'module') {
4082 // Check module visibility.
4084 $cm = $modinfo->get_cm($instance['id']);
4085 } catch (Exception
$e) {
4086 $warnings[] = array(
4088 'itemid' => $instance['id'],
4089 'warningcode' => 'cmidnotincourse',
4090 'message' => 'This module id does not belong to this course.'
4095 if (!$cm->uservisible
) {
4096 $warnings[] = array(
4098 'itemid' => $instance['id'],
4099 'warningcode' => 'nonuservisible',
4100 'message' => 'You don\'t have access to this module.'
4104 if (empty($supportedplugins['mod_' . $cm->modname
])) {
4105 $warnings[] = array(
4107 'itemid' => $instance['id'],
4108 'warningcode' => 'missingcallback',
4109 'message' => 'This module does not implement the check_updates_since callback: ' . $instance['contextlevel'],
4113 // Retrieve the module instance.
4114 $instances[] = array(
4115 'contextlevel' => $instance['contextlevel'],
4116 'id' => $instance['id'],
4117 'updates' => call_user_func($cm->modname
. '_check_updates_since', $cm, $instance['since'], $filter)
4121 $warnings[] = array(
4122 'item' => 'contextlevel',
4123 'itemid' => $instance['id'],
4124 'warningcode' => 'contextlevelnotsupported',
4125 'message' => 'Context level not yet supported ' . $instance['contextlevel'],
4129 return array($instances, $warnings);
4133 * This function classifies a course as past, in progress or future.
4135 * This function may incur a DB hit to calculate course completion.
4136 * @param stdClass $course Course record
4137 * @param stdClass $user User record (optional - defaults to $USER).
4138 * @param completion_info $completioninfo Completion record for the user (optional - will be fetched if required).
4139 * @return string (one of COURSE_TIMELINE_FUTURE, COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_PAST)
4141 function course_classify_for_timeline($course, $user = null, $completioninfo = null) {
4144 if ($user == null) {
4150 if (!empty($course->enddate
) && (course_classify_end_date($course) < $today)) {
4151 return COURSE_TIMELINE_PAST
;
4154 if ($completioninfo == null) {
4155 $completioninfo = new completion_info($course);
4158 // Course was completed.
4159 if ($completioninfo->is_enabled() && $completioninfo->is_course_complete($user->id
)) {
4160 return COURSE_TIMELINE_PAST
;
4163 // Start date not reached.
4164 if (!empty($course->startdate
) && (course_classify_start_date($course) > $today)) {
4165 return COURSE_TIMELINE_FUTURE
;
4168 // Everything else is in progress.
4169 return COURSE_TIMELINE_INPROGRESS
;
4173 * This function calculates the end date to use for display classification purposes,
4174 * incorporating the grace period, if any.
4176 * @param stdClass $course The course record.
4177 * @return int The new enddate.
4179 function course_classify_end_date($course) {
4181 $coursegraceperiodafter = (empty($CFG->coursegraceperiodafter
)) ?
0 : $CFG->coursegraceperiodafter
;
4182 $enddate = (new \
DateTimeImmutable())->setTimestamp($course->enddate
)->modify("+{$coursegraceperiodafter} days");
4183 return $enddate->getTimestamp();
4187 * This function calculates the start date to use for display classification purposes,
4188 * incorporating the grace period, if any.
4190 * @param stdClass $course The course record.
4191 * @return int The new startdate.
4193 function course_classify_start_date($course) {
4195 $coursegraceperiodbefore = (empty($CFG->coursegraceperiodbefore
)) ?
0 : $CFG->coursegraceperiodbefore
;
4196 $startdate = (new \
DateTimeImmutable())->setTimestamp($course->startdate
)->modify("-{$coursegraceperiodbefore} days");
4197 return $startdate->getTimestamp();
4201 * Group a list of courses into either past, future, or in progress.
4203 * The return value will be an array indexed by the COURSE_TIMELINE_* constants
4204 * with each value being an array of courses in that group.
4207 * COURSE_TIMELINE_PAST => [... list of past courses ...],
4208 * COURSE_TIMELINE_FUTURE => [],
4209 * COURSE_TIMELINE_INPROGRESS => []
4212 * @param array $courses List of courses to be grouped.
4215 function course_classify_courses_for_timeline(array $courses) {
4216 return array_reduce($courses, function($carry, $course) {
4217 $classification = course_classify_for_timeline($course);
4218 array_push($carry[$classification], $course);
4222 COURSE_TIMELINE_PAST
=> [],
4223 COURSE_TIMELINE_FUTURE
=> [],
4224 COURSE_TIMELINE_INPROGRESS
=> []
4229 * Get the list of enrolled courses for the current user.
4231 * This function returns a Generator. The courses will be loaded from the database
4232 * in chunks rather than a single query.
4234 * @param int $limit Restrict result set to this amount
4235 * @param int $offset Skip this number of records from the start of the result set
4236 * @param string|null $sort SQL string for sorting
4237 * @param string|null $fields SQL string for fields to be returned
4238 * @param int $dbquerylimit The number of records to load per DB request
4239 * @param array $includecourses courses ids to be restricted
4240 * @param array $hiddencourses courses ids to be excluded
4243 function course_get_enrolled_courses_for_logged_in_user(
4246 string $sort = null,
4247 string $fields = null,
4248 int $dbquerylimit = COURSE_DB_QUERY_LIMIT
,
4249 array $includecourses = [],
4250 array $hiddencourses = []
4253 $haslimit = !empty($limit);
4255 $querylimit = (!$haslimit ||
$limit > $dbquerylimit) ?
$dbquerylimit : $limit;
4257 while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, $includecourses, false, $offset, $hiddencourses)) {
4258 yield from
$courses;
4260 $recordsloaded +
= $querylimit;
4262 if (count($courses) < $querylimit) {
4265 if ($haslimit && $recordsloaded >= $limit) {
4269 $offset +
= $querylimit;
4274 * Search the given $courses for any that match the given $classification up to the specified
4277 * This function will return the subset of courses that match the classification as well as the
4278 * number of courses it had to process to build that subset.
4280 * It is recommended that for larger sets of courses this function is given a Generator that loads
4281 * the courses from the database in chunks.
4283 * @param array|Traversable $courses List of courses to process
4284 * @param string $classification One of the COURSE_TIMELINE_* constants
4285 * @param int $limit Limit the number of results to this amount
4286 * @return array First value is the filtered courses, second value is the number of courses processed
4288 function course_filter_courses_by_timeline_classification(
4290 string $classification,
4294 if (!in_array($classification,
4295 [COURSE_TIMELINE_ALL
, COURSE_TIMELINE_PAST
, COURSE_TIMELINE_INPROGRESS
,
4296 COURSE_TIMELINE_FUTURE
, COURSE_TIMELINE_HIDDEN
])) {
4297 $message = 'Classification must be one of COURSE_TIMELINE_ALL, COURSE_TIMELINE_PAST, '
4298 . 'COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_FUTURE';
4299 throw new moodle_exception($message);
4302 $filteredcourses = [];
4303 $numberofcoursesprocessed = 0;
4306 foreach ($courses as $course) {
4307 $numberofcoursesprocessed++
;
4308 $pref = get_user_preferences('block_myoverview_hidden_course_' . $course->id
, 0);
4310 // Added as of MDL-63457 toggle viewability for each user.
4311 if (($classification == COURSE_TIMELINE_HIDDEN
&& $pref) ||
4312 (($classification == COURSE_TIMELINE_ALL ||
$classification == course_classify_for_timeline($course)) && !$pref)) {
4313 $filteredcourses[] = $course;
4317 if ($limit && $filtermatches >= $limit) {
4318 // We've found the number of requested courses. No need to continue searching.
4323 // Return the number of filtered courses as well as the number of courses that were searched
4324 // in order to find the matching courses. This allows the calling code to do some kind of
4326 return [$filteredcourses, $numberofcoursesprocessed];
4330 * Search the given $courses for any that match the given $classification up to the specified
4333 * This function will return the subset of courses that are favourites as well as the
4334 * number of courses it had to process to build that subset.
4336 * It is recommended that for larger sets of courses this function is given a Generator that loads
4337 * the courses from the database in chunks.
4339 * @param array|Traversable $courses List of courses to process
4340 * @param array $favouritecourseids Array of favourite courses.
4341 * @param int $limit Limit the number of results to this amount
4342 * @return array First value is the filtered courses, second value is the number of courses processed
4344 function course_filter_courses_by_favourites(
4346 $favouritecourseids,
4350 $filteredcourses = [];
4351 $numberofcoursesprocessed = 0;
4354 foreach ($courses as $course) {
4355 $numberofcoursesprocessed++
;
4357 if (in_array($course->id
, $favouritecourseids)) {
4358 $filteredcourses[] = $course;
4362 if ($limit && $filtermatches >= $limit) {
4363 // We've found the number of requested courses. No need to continue searching.
4368 // Return the number of filtered courses as well as the number of courses that were searched
4369 // in order to find the matching courses. This allows the calling code to do some kind of
4371 return [$filteredcourses, $numberofcoursesprocessed];
4375 * Check module updates since a given time.
4376 * This function checks for updates in the module config, file areas, completion, grades, comments and ratings.
4378 * @param cm_info $cm course module data
4379 * @param int $from the time to check
4380 * @param array $fileareas additional file ares to check
4381 * @param array $filter if we need to filter and return only selected updates
4382 * @return stdClass object with the different updates
4385 function course_check_module_updates_since($cm, $from, $fileareas = array(), $filter = array()) {
4386 global $DB, $CFG, $USER;
4388 $context = $cm->context
;
4389 $mod = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
4391 $updates = new stdClass();
4392 $course = get_course($cm->course
);
4393 $component = 'mod_' . $cm->modname
;
4395 // Check changes in the module configuration.
4396 if (isset($mod->timemodified
) and (empty($filter) or in_array('configuration', $filter))) {
4397 $updates->configuration
= (object) array('updated' => false);
4398 if ($updates->configuration
->updated
= $mod->timemodified
> $from) {
4399 $updates->configuration
->timeupdated
= $mod->timemodified
;
4403 // Check for updates in files.
4404 if (plugin_supports('mod', $cm->modname
, FEATURE_MOD_INTRO
)) {
4405 $fileareas[] = 'intro';
4407 if (!empty($fileareas) and (empty($filter) or in_array('fileareas', $filter))) {
4408 $fs = get_file_storage();
4409 $files = $fs->get_area_files($context->id
, $component, $fileareas, false, "filearea, timemodified DESC", false, $from);
4410 foreach ($fileareas as $filearea) {
4411 $updates->{$filearea . 'files'} = (object) array('updated' => false);
4413 foreach ($files as $file) {
4414 $updates->{$file->get_filearea() . 'files'}->updated
= true;
4415 $updates->{$file->get_filearea() . 'files'}->itemids
[] = $file->get_id();
4419 // Check completion.
4420 $supportcompletion = plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_HAS_RULES
);
4421 $supportcompletion = $supportcompletion or plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_TRACKS_VIEWS
);
4422 if ($supportcompletion and (empty($filter) or in_array('completion', $filter))) {
4423 $updates->completion
= (object) array('updated' => false);
4424 $completion = new completion_info($course);
4425 // Use wholecourse to cache all the modules the first time.
4426 $completiondata = $completion->get_data($cm, true);
4427 if ($updates->completion
->updated
= !empty($completiondata->timemodified
) && $completiondata->timemodified
> $from) {
4428 $updates->completion
->timemodified
= $completiondata->timemodified
;
4433 $supportgrades = plugin_supports('mod', $cm->modname
, FEATURE_GRADE_HAS_GRADE
);
4434 $supportgrades = $supportgrades or plugin_supports('mod', $cm->modname
, FEATURE_GRADE_OUTCOMES
);
4435 if ($supportgrades and (empty($filter) or (in_array('gradeitems', $filter) or in_array('outcomes', $filter)))) {
4436 require_once($CFG->libdir
. '/gradelib.php');
4437 $grades = grade_get_grades($course->id
, 'mod', $cm->modname
, $mod->id
, $USER->id
);
4439 if (empty($filter) or in_array('gradeitems', $filter)) {
4440 $updates->gradeitems
= (object) array('updated' => false);
4441 foreach ($grades->items
as $gradeitem) {
4442 foreach ($gradeitem->grades
as $grade) {
4443 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4444 $updates->gradeitems
->updated
= true;
4445 $updates->gradeitems
->itemids
[] = $gradeitem->id
;
4451 if (empty($filter) or in_array('outcomes', $filter)) {
4452 $updates->outcomes
= (object) array('updated' => false);
4453 foreach ($grades->outcomes
as $outcome) {
4454 foreach ($outcome->grades
as $grade) {
4455 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4456 $updates->outcomes
->updated
= true;
4457 $updates->outcomes
->itemids
[] = $outcome->id
;
4465 if (plugin_supports('mod', $cm->modname
, FEATURE_COMMENT
) and (empty($filter) or in_array('comments', $filter))) {
4466 $updates->comments
= (object) array('updated' => false);
4467 require_once($CFG->dirroot
. '/comment/lib.php');
4468 require_once($CFG->dirroot
. '/comment/locallib.php');
4469 $manager = new comment_manager();
4470 $comments = $manager->get_component_comments_since($course, $context, $component, $from, $cm);
4471 if (!empty($comments)) {
4472 $updates->comments
->updated
= true;
4473 $updates->comments
->itemids
= array_keys($comments);
4478 if (plugin_supports('mod', $cm->modname
, FEATURE_RATE
) and (empty($filter) or in_array('ratings', $filter))) {
4479 $updates->ratings
= (object) array('updated' => false);
4480 require_once($CFG->dirroot
. '/rating/lib.php');
4481 $manager = new rating_manager();
4482 $ratings = $manager->get_component_ratings_since($context, $component, $from);
4483 if (!empty($ratings)) {
4484 $updates->ratings
->updated
= true;
4485 $updates->ratings
->itemids
= array_keys($ratings);
4493 * Returns true if the user can view the participant page, false otherwise,
4495 * @param context $context The context we are checking.
4498 function course_can_view_participants($context) {
4499 $viewparticipantscap = 'moodle/course:viewparticipants';
4500 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4501 $viewparticipantscap = 'moodle/site:viewparticipants';
4504 return has_any_capability([$viewparticipantscap, 'moodle/course:enrolreview'], $context);
4508 * Checks if a user can view the participant page, if not throws an exception.
4510 * @param context $context The context we are checking.
4511 * @throws required_capability_exception
4513 function course_require_view_participants($context) {
4514 if (!course_can_view_participants($context)) {
4515 $viewparticipantscap = 'moodle/course:viewparticipants';
4516 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4517 $viewparticipantscap = 'moodle/site:viewparticipants';
4519 throw new required_capability_exception($context, $viewparticipantscap, 'nopermissions', '');
4524 * Return whether the user can download from the specified backup file area in the given context.
4526 * @param string $filearea the backup file area. E.g. 'course', 'backup' or 'automated'.
4527 * @param \context $context
4528 * @param stdClass $user the user object. If not provided, the current user will be checked.
4529 * @return bool true if the user is allowed to download in the context, false otherwise.
4531 function can_download_from_backup_filearea($filearea, \context
$context, stdClass
$user = null) {
4532 $candownload = false;
4533 switch ($filearea) {
4536 $candownload = has_capability('moodle/backup:downloadfile', $context, $user);
4539 // Given the automated backups may contain userinfo, we restrict access such that only users who are able to
4540 // restore with userinfo are able to download the file. Users can't create these backups, so checking 'backup:userinfo'
4541 // doesn't make sense here.
4542 $candownload = has_capability('moodle/backup:downloadfile', $context, $user) &&
4543 has_capability('moodle/restore:userinfo', $context, $user);
4549 return $candownload;
4553 * Get a list of hidden courses
4555 * @param int|object|null $user User override to get the filter from. Defaults to current user
4556 * @return array $ids List of hidden courses
4557 * @throws coding_exception
4559 function get_hidden_courses_on_timeline($user = null) {
4566 $preferences = get_user_preferences(null, null, $user);
4568 foreach ($preferences as $key => $value) {
4569 if (preg_match('/block_myoverview_hidden_course_(\d)+/', $key)) {
4570 $id = preg_split('/block_myoverview_hidden_course_/', $key);
4579 * Returns a list of the most recently courses accessed by a user
4581 * @param int $userid User id from which the courses will be obtained
4582 * @param int $limit Restrict result set to this amount
4583 * @param int $offset Skip this number of records from the start of the result set
4584 * @param string|null $sort SQL string for sorting
4587 function course_get_recent_courses(int $userid = null, int $limit = 0, int $offset = 0, string $sort = null) {
4589 global $CFG, $USER, $DB;
4591 if (empty($userid)) {
4592 $userid = $USER->id
;
4595 $basefields = array('id', 'idnumber', 'summary', 'summaryformat', 'startdate', 'enddate', 'category',
4596 'shortname', 'fullname', 'timeaccess', 'component', 'visible');
4598 $sort = trim($sort);
4600 $sort = 'timeaccess DESC';
4602 $rawsorts = explode(',', $sort);
4604 foreach ($rawsorts as $rawsort) {
4605 $rawsort = trim($rawsort);
4606 $sorts[] = trim($rawsort);
4608 $sort = implode(',', $sorts);
4611 $orderby = "ORDER BY $sort";
4613 $ctxfields = context_helper
::get_preload_record_columns_sql('ctx');
4615 $coursefields = 'c.' .join(',', $basefields);
4617 // Ask the favourites service to give us the join SQL for favourited courses,
4618 // so we can include favourite information in the query.
4619 $usercontext = \context_user
::instance($userid);
4620 $favservice = \core_favourites\service_factory
::get_service_for_user_context($usercontext);
4621 list($favsql, $favparams) = $favservice->get_join_sql_by_type('core_course', 'courses', 'fav', 'ul.courseid');
4623 $sql = "SELECT $coursefields, $ctxfields
4626 ON ctx.contextlevel = :contextlevel
4627 AND ctx.instanceid = c.id
4628 JOIN {user_lastaccess} ul
4629 ON ul.courseid = c.id
4631 WHERE ul.userid = :userid
4632 AND c.visible = :visible
4633 AND EXISTS (SELECT e.id
4635 LEFT JOIN {user_enrolments} ue ON ue.enrolid = e.id
4636 WHERE e.courseid = c.id
4637 AND e.status = :statusenrol
4638 AND ((ue.status = :status
4639 AND ue.userid = ul.userid
4640 AND ue.timestart < :now1
4641 AND (ue.timeend = 0 OR ue.timeend > :now2)
4643 OR e.enrol = :guestenrol
4648 $now = round(time(), -2); // Improves db caching.
4649 $params = ['userid' => $userid, 'contextlevel' => CONTEXT_COURSE
, 'visible' => 1, 'status' => ENROL_USER_ACTIVE
,
4650 'statusenrol' => ENROL_INSTANCE_ENABLED
, 'guestenrol' => 'guest', 'now1' => $now, 'now2' => $now] +
$favparams;
4652 $recentcourses = $DB->get_records_sql($sql, $params, $offset, $limit);
4654 // Filter courses if last access field is hidden.
4655 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
4657 if ($userid != $USER->id
&& isset($hiddenfields['lastaccess'])) {
4658 $recentcourses = array_filter($recentcourses, function($course) {
4659 context_helper
::preload_from_record($course);
4660 $context = context_course
::instance($course->id
, IGNORE_MISSING
);
4661 // If last access was a hidden field, a user requesting info about another user would need permission to view hidden
4663 return has_capability('moodle/course:viewhiddenuserfields', $context);
4667 return $recentcourses;