2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Library of useful functions
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 * @package core_course
25 defined('MOODLE_INTERNAL') ||
die;
27 use core_courseformat\base
as course_format
;
29 require_once($CFG->libdir
.'/completionlib.php');
30 require_once($CFG->libdir
.'/filelib.php');
31 require_once($CFG->libdir
.'/datalib.php');
32 require_once($CFG->dirroot
.'/course/format/lib.php');
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
35 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
38 * Number of courses to display when summaries are included.
40 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
44 // Max courses in log dropdown before switching to optional.
45 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
46 // Max users in log dropdown before switching to optional.
47 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
48 define('FRONTPAGENEWS', '0');
49 define('FRONTPAGECATEGORYNAMES', '2');
50 define('FRONTPAGECATEGORYCOMBO', '4');
51 define('FRONTPAGEENROLLEDCOURSELIST', '5');
52 define('FRONTPAGEALLCOURSELIST', '6');
53 define('FRONTPAGECOURSESEARCH', '7');
54 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
55 define('EXCELROWS', 65535);
56 define('FIRSTUSEDEXCELROW', 3);
58 define('MOD_CLASS_ACTIVITY', 0);
59 define('MOD_CLASS_RESOURCE', 1);
61 define('COURSE_TIMELINE_ALLINCLUDINGHIDDEN', 'allincludinghidden');
62 define('COURSE_TIMELINE_ALL', 'all');
63 define('COURSE_TIMELINE_PAST', 'past');
64 define('COURSE_TIMELINE_INPROGRESS', 'inprogress');
65 define('COURSE_TIMELINE_FUTURE', 'future');
66 define('COURSE_TIMELINE_SEARCH', 'search');
67 define('COURSE_FAVOURITES', 'favourites');
68 define('COURSE_TIMELINE_HIDDEN', 'hidden');
69 define('COURSE_CUSTOMFIELD', 'customfield');
70 define('COURSE_DB_QUERY_LIMIT', 1000);
71 /** Searching for all courses that have no value for the specified custom field. */
72 define('COURSE_CUSTOMFIELD_EMPTY', -1);
74 // Course activity chooser footer default display option.
75 define('COURSE_CHOOSER_FOOTER_NONE', 'hidden');
77 // Download course content options.
78 define('DOWNLOAD_COURSE_CONTENT_DISABLED', 0);
79 define('DOWNLOAD_COURSE_CONTENT_ENABLED', 1);
80 define('DOWNLOAD_COURSE_CONTENT_SITE_DEFAULT', 2);
82 function make_log_url($module, $url) {
85 if (strpos($url, 'report/') === 0) {
86 // there is only one report type, course reports are deprecated
96 if (strpos($url, '../') === 0) {
97 $url = ltrim($url, '.');
99 $url = "/course/$url";
103 $url = "/calendar/$url";
107 $url = "/$module/$url";
120 $url = "/message/$url";
123 $url = "/notes/$url";
132 $url = "/grade/$url";
135 $url = "/mod/$module/$url";
139 //now let's sanitise urls - there might be some ugly nasties:-(
140 $parts = explode('?', $url);
141 $script = array_shift($parts);
142 if (strpos($script, 'http') === 0) {
143 $script = clean_param($script, PARAM_URL
);
145 $script = clean_param($script, PARAM_PATH
);
150 $query = implode('', $parts);
151 $query = str_replace('&', '&', $query); // both & and & are stored in db :-|
152 $parts = explode('&', $query);
153 $eq = urlencode('=');
154 foreach ($parts as $key=>$part) {
155 $part = urlencode(urldecode($part));
156 $part = str_replace($eq, '=', $part);
157 $parts[$key] = $part;
159 $query = '?'.implode('&', $parts);
162 return $script.$query;
166 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
167 $modname="", $modid=0, $modaction="", $groupid=0) {
170 // It is assumed that $date is the GMT time of midnight for that day,
171 // and so the next 86400 seconds worth of logs are printed.
173 /// Setup for group handling.
175 // TODO: I don't understand group/context/etc. enough to be able to do
176 // something interesting with it here
177 // What is the context of a remote course?
179 /// If the group mode is separate, and this user does not have editing privileges,
180 /// then only the user's group can be viewed.
181 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
182 // $groupid = get_current_group($course->id);
184 /// If this course doesn't have groups, no groupid can be specified.
185 //else if (!$course->groupmode) {
194 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
196 LEFT JOIN {user} u ON l.userid = u.id
200 $where .= "l.hostid = :hostid";
201 $params['hostid'] = $hostid;
203 // TODO: Is 1 really a magic number referring to the sitename?
204 if ($course != SITEID ||
$modid != 0) {
205 $where .= " AND l.course=:courseid";
206 $params['courseid'] = $course;
210 $where .= " AND l.module = :modname";
211 $params['modname'] = $modname;
214 if ('site_errors' === $modid) {
215 $where .= " AND ( l.action='error' OR l.action='infected' )";
217 //TODO: This assumes that modids are the same across sites... probably
219 $where .= " AND l.cmid = :modid";
220 $params['modid'] = $modid;
224 $firstletter = substr($modaction, 0, 1);
225 if ($firstletter == '-') {
226 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
227 $params['modaction'] = '%'.substr($modaction, 1).'%';
229 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
230 $params['modaction'] = '%'.$modaction.'%';
235 $where .= " AND l.userid = :user";
236 $params['user'] = $user;
240 $enddate = $date +
86400;
241 $where .= " AND l.time > :date AND l.time < :enddate";
242 $params['date'] = $date;
243 $params['enddate'] = $enddate;
247 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
248 if(!empty($result['totalcount'])) {
249 $where .= " ORDER BY $order";
250 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
252 $result['logs'] = array();
258 * Checks the integrity of the course data.
260 * In summary - compares course_sections.sequence and course_modules.section.
262 * More detailed, checks that:
263 * - course_sections.sequence contains each module id not more than once in the course
264 * - for each moduleid from course_sections.sequence the field course_modules.section
265 * refers to the same section id (this means course_sections.sequence is more
266 * important if they are different)
267 * - ($fullcheck only) each module in the course is present in one of
268 * course_sections.sequence
269 * - ($fullcheck only) removes non-existing course modules from section sequences
271 * If there are any mismatches, the changes are made and records are updated in DB.
273 * Course cache is NOT rebuilt if there are any errors!
275 * This function is used each time when course cache is being rebuilt with $fullcheck = false
276 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
278 * @param int $courseid id of the course
279 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
280 * the list of enabled course modules in the course. Retrieved from DB if not specified.
281 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
282 * @param array $sections records from course_sections table for this course.
283 * Retrieved from DB if not specified
284 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
285 * course modules from sequences. Only to be used in site maintenance mode when we are
286 * sure that another user is not in the middle of the process of moving/removing a module.
287 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
288 * @return array array of messages with found problems. Empty output means everything is ok
290 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
293 if ($sections === null) {
294 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
297 // Retrieve all records from course_modules regardless of module type visibility.
298 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
300 if ($rawmods === null) {
301 $rawmods = get_course_mods($courseid);
303 if (!$fullcheck && (empty($sections) ||
empty($rawmods))) {
304 // If either of the arrays is empty, no modules are displayed anyway.
307 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
309 // First make sure that each module id appears in section sequences only once.
310 // If it appears in several section sequences the last section wins.
311 // If it appears twice in one section sequence, the first occurence wins.
312 $modsection = array();
313 foreach ($sections as $sectionid => $section) {
314 $sections[$sectionid]->newsequence
= $section->sequence
;
315 if (!empty($section->sequence
)) {
316 $sequence = explode(",", $section->sequence
);
317 $sequenceunique = array_unique($sequence);
318 if (count($sequenceunique) != count($sequence)) {
319 // Some course module id appears in this section sequence more than once.
320 ksort($sequenceunique); // Preserve initial order of modules.
321 $sequence = array_values($sequenceunique);
322 $sections[$sectionid]->newsequence
= join(',', $sequence);
323 $messages[] = $debuggingprefix.'Sequence for course section ['.
324 $sectionid.'] is "'.$sections[$sectionid]->sequence
.'", must be "'.$sections[$sectionid]->newsequence
.'"';
326 foreach ($sequence as $cmid) {
327 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
328 // Some course module id appears to be in more than one section's sequences.
329 $wrongsectionid = $modsection[$cmid];
330 $sections[$wrongsectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence
. ','), ',');
331 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
332 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
334 $modsection[$cmid] = $sectionid;
339 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
341 foreach ($rawmods as $cmid => $mod) {
342 if (!isset($modsection[$cmid])) {
343 // This is a module that is not mentioned in course_section.sequence at all.
344 // Add it to the section $mod->section or to the last available section.
345 if ($mod->section
&& isset($sections[$mod->section
])) {
346 $modsection[$cmid] = $mod->section
;
348 $firstsection = reset($sections);
349 $modsection[$cmid] = $firstsection->id
;
351 $sections[$modsection[$cmid]]->newsequence
= trim($sections[$modsection[$cmid]]->newsequence
.','.$cmid, ',');
352 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
353 $modsection[$cmid].']';
356 foreach ($modsection as $cmid => $sectionid) {
357 if (!isset($rawmods[$cmid])) {
358 // Section $sectionid refers to module id that does not exist.
359 $sections[$sectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence
.','), ',');
360 $messages[] = $debuggingprefix.'Course module ['.$cmid.
361 '] does not exist but is present in the sequence of section ['.$sectionid.']';
366 // Update changed sections.
367 if (!$checkonly && !empty($messages)) {
368 foreach ($sections as $sectionid => $section) {
369 if ($section->newsequence
!== $section->sequence
) {
370 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence
));
375 // Now make sure that all modules point to the correct sections.
376 foreach ($rawmods as $cmid => $mod) {
377 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section
) {
379 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
381 $messages[] = $debuggingprefix.'Course module ['.$cmid.
382 '] points to section ['.$mod->section
.'] instead of ['.$modsection[$cmid].']';
390 * For a given course, returns an array of course activity objects
391 * Each item in the array contains he following properties:
393 function get_array_of_activities($courseid) {
394 // cm - course module id
395 // mod - name of the module (eg forum)
396 // section - the number of the section (eg week or topic)
397 // name - the name of the instance
398 // visible - is the instance visible or not
399 // groupingid - grouping id
400 // extra - contains extra string to include in any link
403 $course = $DB->get_record('course', array('id'=>$courseid));
405 if (empty($course)) {
406 throw new moodle_exception('courseidnotfound');
411 $rawmods = get_course_mods($courseid);
412 if (empty($rawmods)) {
413 return $mod; // always return array
415 $courseformat = course_get_format($course);
417 if ($sections = $DB->get_records('course_sections', array('course' => $courseid),
418 'section ASC', 'id,section,sequence,visible')) {
419 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
420 if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
421 debugging(join('<br>', $errormessages));
422 $rawmods = get_course_mods($courseid);
423 $sections = $DB->get_records('course_sections', array('course' => $courseid),
424 'section ASC', 'id,section,sequence,visible');
426 // Build array of activities.
427 foreach ($sections as $section) {
428 if (!empty($section->sequence
)) {
429 $sequence = explode(",", $section->sequence
);
430 foreach ($sequence as $seq) {
431 if (empty($rawmods[$seq])) {
434 // Adjust visibleoncoursepage, value in DB may not respect format availability.
435 $rawmods[$seq]->visibleoncoursepage
= (!$rawmods[$seq]->visible
436 ||
$rawmods[$seq]->visibleoncoursepage
437 ||
empty($CFG->allowstealth
)
438 ||
!$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ?
1 : 0;
440 // Create an object that will be cached.
441 $mod[$seq] = new stdClass();
442 $mod[$seq]->id
= $rawmods[$seq]->instance
;
443 $mod[$seq]->cm
= $rawmods[$seq]->id
;
444 $mod[$seq]->mod
= $rawmods[$seq]->modname
;
446 // Oh dear. Inconsistent names left here for backward compatibility.
447 $mod[$seq]->section
= $section->section
;
448 $mod[$seq]->sectionid
= $rawmods[$seq]->section
;
450 $mod[$seq]->module
= $rawmods[$seq]->module
;
451 $mod[$seq]->added
= $rawmods[$seq]->added
;
452 $mod[$seq]->score
= $rawmods[$seq]->score
;
453 $mod[$seq]->idnumber
= $rawmods[$seq]->idnumber
;
454 $mod[$seq]->visible
= $rawmods[$seq]->visible
;
455 $mod[$seq]->visibleoncoursepage
= $rawmods[$seq]->visibleoncoursepage
;
456 $mod[$seq]->visibleold
= $rawmods[$seq]->visibleold
;
457 $mod[$seq]->groupmode
= $rawmods[$seq]->groupmode
;
458 $mod[$seq]->groupingid
= $rawmods[$seq]->groupingid
;
459 $mod[$seq]->indent
= $rawmods[$seq]->indent
;
460 $mod[$seq]->completion
= $rawmods[$seq]->completion
;
461 $mod[$seq]->extra
= "";
462 $mod[$seq]->completiongradeitemnumber
=
463 $rawmods[$seq]->completiongradeitemnumber
;
464 $mod[$seq]->completionpassgrade
= $rawmods[$seq]->completionpassgrade
;
465 $mod[$seq]->completionview
= $rawmods[$seq]->completionview
;
466 $mod[$seq]->completionexpected
= $rawmods[$seq]->completionexpected
;
467 $mod[$seq]->showdescription
= $rawmods[$seq]->showdescription
;
468 $mod[$seq]->availability
= $rawmods[$seq]->availability
;
469 $mod[$seq]->deletioninprogress
= $rawmods[$seq]->deletioninprogress
;
471 $modname = $mod[$seq]->mod
;
472 $functionname = $modname."_get_coursemodule_info";
474 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
478 include_once("$CFG->dirroot/mod/$modname/lib.php");
480 if ($hasfunction = function_exists($functionname)) {
481 if ($info = $functionname($rawmods[$seq])) {
482 if (!empty($info->icon
)) {
483 $mod[$seq]->icon
= $info->icon
;
485 if (!empty($info->iconcomponent
)) {
486 $mod[$seq]->iconcomponent
= $info->iconcomponent
;
488 if (!empty($info->name
)) {
489 $mod[$seq]->name
= $info->name
;
491 if ($info instanceof cached_cm_info
) {
492 // When using cached_cm_info you can include three new fields
493 // that aren't available for legacy code
494 if (!empty($info->content
)) {
495 $mod[$seq]->content
= $info->content
;
497 if (!empty($info->extraclasses
)) {
498 $mod[$seq]->extraclasses
= $info->extraclasses
;
500 if (!empty($info->iconurl
)) {
501 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
502 $url = new moodle_url($info->iconurl
);
503 $mod[$seq]->iconurl
= $url->out(false);
505 if (!empty($info->onclick
)) {
506 $mod[$seq]->onclick
= $info->onclick
;
508 if (!empty($info->customdata
)) {
509 $mod[$seq]->customdata
= $info->customdata
;
512 // When using a stdclass, the (horrible) deprecated ->extra field
513 // is available for BC
514 if (!empty($info->extra
)) {
515 $mod[$seq]->extra
= $info->extra
;
520 // When there is no modname_get_coursemodule_info function,
521 // but showdescriptions is enabled, then we use the 'intro'
522 // and 'introformat' fields in the module table
523 if (!$hasfunction && $rawmods[$seq]->showdescription
) {
524 if ($modvalues = $DB->get_record($rawmods[$seq]->modname
,
525 array('id' => $rawmods[$seq]->instance
), 'name, intro, introformat')) {
526 // Set content from intro and introformat. Filters are disabled
527 // because we filter it with format_text at display time
528 $mod[$seq]->content
= format_module_intro($rawmods[$seq]->modname
,
529 $modvalues, $rawmods[$seq]->id
, false);
531 // To save making another query just below, put name in here
532 $mod[$seq]->name
= $modvalues->name
;
535 if (!isset($mod[$seq]->name
)) {
536 $mod[$seq]->name
= $DB->get_field($rawmods[$seq]->modname
, "name", array("id"=>$rawmods[$seq]->instance
));
539 // Minimise the database size by unsetting default options when they are
540 // 'empty'. This list corresponds to code in the cm_info constructor.
541 foreach (array('idnumber', 'groupmode', 'groupingid',
542 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
543 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
544 'completionexpected', 'score', 'showdescription', 'deletioninprogress') as $property) {
545 if (property_exists($mod[$seq], $property) &&
546 empty($mod[$seq]->{$property})) {
547 unset($mod[$seq]->{$property});
550 // Special case: this value is usually set to null, but may be 0
551 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
552 is_null($mod[$seq]->completiongradeitemnumber
)) {
553 unset($mod[$seq]->completiongradeitemnumber
);
563 * Returns the localised human-readable names of all used modules
565 * @param bool $plural if true returns the plural forms of the names
566 * @return array where key is the module name (component name without 'mod_') and
567 * the value is the human-readable string. Array sorted alphabetically by value
569 function get_module_types_names($plural = false) {
570 static $modnames = null;
572 if ($modnames === null) {
573 $modnames = array(0 => array(), 1 => array());
574 if ($allmods = $DB->get_records("modules")) {
575 foreach ($allmods as $mod) {
576 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible
) {
577 $modnames[0][$mod->name
] = get_string("modulename", "$mod->name", null, true);
578 $modnames[1][$mod->name
] = get_string("modulenameplural", "$mod->name", null, true);
583 return $modnames[(int)$plural];
587 * Set highlighted section. Only one section can be highlighted at the time.
589 * @param int $courseid course id
590 * @param int $marker highlight section with this number, 0 means remove higlightin
593 function course_set_marker($courseid, $marker) {
595 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
596 if ($COURSE && $COURSE->id
== $courseid) {
597 $COURSE->marker
= $marker;
599 core_courseformat\base
::reset_course_cache($courseid);
600 course_modinfo
::clear_instance_cache($courseid);
604 * For a given course section, marks it visible or hidden,
605 * and does the same for every activity in that section
607 * @param int $courseid course id
608 * @param int $sectionnumber The section number to adjust
609 * @param int $visibility The new visibility
610 * @return array A list of resources which were hidden in the section
612 function set_section_visible($courseid, $sectionnumber, $visibility) {
615 $resourcestotoggle = array();
616 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
617 course_update_section($courseid, $section, array('visible' => $visibility));
619 // Determine which modules are visible for AJAX update
620 $modules = !empty($section->sequence
) ?
explode(',', $section->sequence
) : array();
621 if (!empty($modules)) {
622 list($insql, $params) = $DB->get_in_or_equal($modules);
623 $select = 'id ' . $insql . ' AND visible = ?';
624 array_push($params, $visibility);
626 $select .= ' AND visibleold = 1';
628 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
631 return $resourcestotoggle;
635 * Return the course category context for the category with id $categoryid, except
636 * that if $categoryid is 0, return the system context.
638 * @param integer $categoryid a category id or 0.
639 * @return context the corresponding context
641 function get_category_or_system_context($categoryid) {
643 return context_coursecat
::instance($categoryid, IGNORE_MISSING
);
645 return context_system
::instance();
650 * Print the buttons relating to course requests.
652 * @param context $context current page context.
654 function print_course_request_buttons($context) {
655 global $CFG, $DB, $OUTPUT;
656 if (empty($CFG->enablecourserequests
)) {
659 if (course_request
::can_request($context)) {
660 // Print a button to request a new course.
662 if ($context instanceof context_coursecat
) {
663 $params['category'] = $context->instanceid
;
665 echo $OUTPUT->single_button(new moodle_url('/course/request.php', $params),
666 get_string('requestcourse'), 'get');
668 /// Print a button to manage pending requests
669 if (has_capability('moodle/site:approvecourse', $context)) {
670 $disabled = !$DB->record_exists('course_request', array());
671 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
676 * Does the user have permission to edit things in this category?
678 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
679 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
681 function can_edit_in_category($categoryid = 0) {
682 $context = get_category_or_system_context($categoryid);
683 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
686 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
688 function add_course_module($mod) {
691 $mod->added
= time();
694 $cmid = $DB->insert_record("course_modules", $mod);
695 rebuild_course_cache($mod->course
, true);
700 * Creates a course section and adds it to the specified position
702 * @param int|stdClass $courseorid course id or course object
703 * @param int $position position to add to, 0 means to the end. If position is greater than
704 * number of existing secitons, the section is added to the end. This will become sectionnum of the
705 * new section. All existing sections at this or bigger position will be shifted down.
706 * @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
707 * @return stdClass created section object
709 function course_create_section($courseorid, $position = 0, $skipcheck = false) {
711 $courseid = is_object($courseorid) ?
$courseorid->id
: $courseorid;
713 // Find the last sectionnum among existing sections.
715 $lastsection = $position - 1;
717 $lastsection = (int)$DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', [$courseid]);
720 // First add section to the end.
721 $cw = new stdClass();
722 $cw->course
= $courseid;
723 $cw->section
= $lastsection +
1;
725 $cw->summaryformat
= FORMAT_HTML
;
729 $cw->availability
= null;
730 $cw->timemodified
= time();
731 $cw->id
= $DB->insert_record("course_sections", $cw);
733 // Now move it to the specified position.
734 if ($position > 0 && $position <= $lastsection) {
735 $course = is_object($courseorid) ?
$courseorid : get_course($courseorid);
736 move_section_to($course, $cw->section
, $position, true);
737 $cw->section
= $position;
740 core\event\course_section_created
::create_from_section($cw)->trigger();
742 rebuild_course_cache($courseid, true);
747 * Creates missing course section(s) and rebuilds course cache
749 * @param int|stdClass $courseorid course id or course object
750 * @param int|array $sections list of relative section numbers to create
751 * @return bool if there were any sections created
753 function course_create_sections_if_missing($courseorid, $sections) {
754 if (!is_array($sections)) {
755 $sections = array($sections);
757 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
758 if ($newsections = array_diff($sections, $existing)) {
759 foreach ($newsections as $sectionnum) {
760 course_create_section($courseorid, $sectionnum, true);
768 * Adds an existing module to the section
770 * Updates both tables {course_sections} and {course_modules}
772 * Note: This function does not use modinfo PROVIDED that the section you are
773 * adding the module to already exists. If the section does not exist, it will
774 * build modinfo if necessary and create the section.
776 * @param int|stdClass $courseorid course id or course object
777 * @param int $cmid id of the module already existing in course_modules table
778 * @param int $sectionnum relative number of the section (field course_sections.section)
779 * If section does not exist it will be created
780 * @param int|stdClass $beforemod id or object with field id corresponding to the module
781 * before which the module needs to be included. Null for inserting in the
783 * @return int The course_sections ID where the module is inserted
785 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
787 if (is_object($beforemod)) {
788 $beforemod = $beforemod->id
;
790 if (is_object($courseorid)) {
791 $courseid = $courseorid->id
;
793 $courseid = $courseorid;
795 // Do not try to use modinfo here, there is no guarantee it is valid!
796 $section = $DB->get_record('course_sections',
797 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING
);
799 // This function call requires modinfo.
800 course_create_sections_if_missing($courseorid, $sectionnum);
801 $section = $DB->get_record('course_sections',
802 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST
);
805 $modarray = explode(",", trim($section->sequence
));
806 if (empty($section->sequence
)) {
807 $newsequence = "$cmid";
808 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
809 $insertarray = array($cmid, $beforemod);
810 array_splice($modarray, $key[0], 1, $insertarray);
811 $newsequence = implode(",", $modarray);
813 $newsequence = "$section->sequence,$cmid";
815 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id
));
816 $DB->set_field('course_modules', 'section', $section->id
, array('id' => $cmid));
817 if (is_object($courseorid)) {
818 rebuild_course_cache($courseorid->id
, true);
820 rebuild_course_cache($courseorid, true);
822 return $section->id
; // Return course_sections ID that was used.
826 * Change the group mode of a course module.
828 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
829 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
831 * @param int $id course module ID.
832 * @param int $groupmode the new groupmode value.
833 * @return bool True if the $groupmode was updated.
835 function set_coursemodule_groupmode($id, $groupmode) {
837 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST
);
838 if ($cm->groupmode
!= $groupmode) {
839 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id
));
840 rebuild_course_cache($cm->course
, true);
842 return ($cm->groupmode
!= $groupmode);
845 function set_coursemodule_idnumber($id, $idnumber) {
847 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST
);
848 if ($cm->idnumber
!= $idnumber) {
849 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id
));
850 rebuild_course_cache($cm->course
, true);
852 return ($cm->idnumber
!= $idnumber);
856 * Set the visibility of a module and inherent properties.
858 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
859 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
861 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
862 * has been moved to {@link set_section_visible()} which was the only place from which
863 * the parameter was used.
865 * @param int $id of the module
866 * @param int $visible state of the module
867 * @param int $visibleoncoursepage state of the module on the course page
868 * @return bool false when the module was not found, true otherwise
870 function set_coursemodule_visible($id, $visible, $visibleoncoursepage = 1) {
872 require_once($CFG->libdir
.'/gradelib.php');
873 require_once($CFG->dirroot
.'/calendar/lib.php');
875 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
879 // Create events and propagate visibility to associated grade items if the value has changed.
880 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
881 if ($cm->visible
== $visible && $cm->visibleoncoursepage
== $visibleoncoursepage) {
885 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module
))) {
888 if (($cm->visible
!= $visible) &&
889 ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename)))) {
890 foreach($events as $event) {
892 $event = new calendar_event($event);
893 $event->toggle_visibility(true);
895 $event = new calendar_event($event);
896 $event->toggle_visibility(false);
901 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
902 // affect visibleold to allow for an original visibility restore. See set_section_visible().
903 $cminfo = new stdClass();
905 $cminfo->visible
= $visible;
906 $cminfo->visibleoncoursepage
= $visibleoncoursepage;
907 $cminfo->visibleold
= $visible;
908 $DB->update_record('course_modules', $cminfo);
910 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
911 // Note that this must be done after updating the row in course_modules, in case
912 // the modules grade_item_update function needs to access $cm->visible.
913 if ($cm->visible
!= $visible &&
914 plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY
) &&
915 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
916 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
917 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
918 } else if ($cm->visible
!= $visible) {
919 $grade_items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance
, 'courseid'=>$cm->course
));
921 foreach ($grade_items as $grade_item) {
922 $grade_item->set_hidden(!$visible);
927 rebuild_course_cache($cm->course
, true);
932 * Changes the course module name
934 * @param int $id course module id
935 * @param string $name new value for a name
936 * @return bool whether a change was made
938 function set_coursemodule_name($id, $name) {
940 require_once($CFG->libdir
. '/gradelib.php');
942 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
944 $module = new \
stdClass();
945 $module->id
= $cm->instance
;
947 // Escape strings as they would be by mform.
948 if (!empty($CFG->formatstringstriptags
)) {
949 $module->name
= clean_param($name, PARAM_TEXT
);
951 $module->name
= clean_param($name, PARAM_CLEANHTML
);
953 if ($module->name
=== $cm->name ||
strval($module->name
) === '') {
956 if (\core_text
::strlen($module->name
) > 255) {
957 throw new \
moodle_exception('maximumchars', 'moodle', '', 255);
960 $module->timemodified
= time();
961 $DB->update_record($cm->modname
, $module);
962 $cm->name
= $module->name
;
963 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
964 rebuild_course_cache($cm->course
, true);
966 // Attempt to update the grade item if relevant.
967 $grademodule = $DB->get_record($cm->modname
, array('id' => $cm->instance
));
968 $grademodule->cmidnumber
= $cm->idnumber
;
969 $grademodule->modname
= $cm->modname
;
970 grade_update_mod_grades($grademodule);
972 // Update calendar events with the new name.
973 course_module_update_calendar_events($cm->modname
, $grademodule, $cm);
979 * This function will handle the whole deletion process of a module. This includes calling
980 * the modules delete_instance function, deleting files, events, grades, conditional data,
981 * the data in the course_module and course_sections table and adding a module deletion
984 * @param int $cmid the course module id
985 * @param bool $async whether or not to try to delete the module using an adhoc task. Async also depends on a plugin hook.
986 * @throws moodle_exception
989 function course_delete_module($cmid, $async = false) {
990 // Check the 'course_module_background_deletion_recommended' hook first.
991 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
992 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
993 // It's up to plugins to handle things like whether or not they are enabled.
994 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
995 foreach ($pluginsfunction as $plugintype => $plugins) {
996 foreach ($plugins as $pluginfunction) {
997 if ($pluginfunction()) {
998 return course_module_flag_for_async_deletion($cmid);
1006 require_once($CFG->libdir
.'/gradelib.php');
1007 require_once($CFG->libdir
.'/questionlib.php');
1008 require_once($CFG->dirroot
.'/blog/lib.php');
1009 require_once($CFG->dirroot
.'/calendar/lib.php');
1011 // Get the course module.
1012 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1016 // Get the module context.
1017 $modcontext = context_module
::instance($cm->id
);
1019 // Get the course module name.
1020 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1022 // Get the file location of the delete_instance function for this module.
1023 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1025 // Include the file required to call the delete_instance function for this module.
1026 if (file_exists($modlib)) {
1027 require_once($modlib);
1029 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1030 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1033 $deleteinstancefunction = $modulename . '_delete_instance';
1035 // Ensure the delete_instance function exists for this module.
1036 if (!function_exists($deleteinstancefunction)) {
1037 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1038 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1041 // Allow plugins to use this course module before we completely delete it.
1042 if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
1043 foreach ($pluginsfunction as $plugintype => $plugins) {
1044 foreach ($plugins as $pluginfunction) {
1045 $pluginfunction($cm);
1050 question_delete_activity($cm);
1052 // Call the delete_instance function, if it returns false throw an exception.
1053 if (!$deleteinstancefunction($cm->instance
)) {
1054 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1055 "Cannot delete the module $modulename (instance).");
1058 // Remove all module files in case modules forget to do that.
1059 $fs = get_file_storage();
1060 $fs->delete_area_files($modcontext->id
);
1062 // Delete events from calendar.
1063 if ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename))) {
1064 $coursecontext = context_course
::instance($cm->course
);
1065 foreach($events as $event) {
1066 $event->context
= $coursecontext;
1067 $calendarevent = calendar_event
::load($event);
1068 $calendarevent->delete();
1072 // Delete grade items, outcome items and grades attached to modules.
1073 if ($grade_items = grade_item
::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1074 'iteminstance' => $cm->instance
, 'courseid' => $cm->course
))) {
1075 foreach ($grade_items as $grade_item) {
1076 $grade_item->delete('moddelete');
1080 // Delete associated blogs and blog tag instances.
1081 blog_remove_associations_for_module($modcontext->id
);
1083 // Delete completion and availability data; it is better to do this even if the
1084 // features are not turned on, in case they were turned on previously (these will be
1085 // very quick on an empty table).
1086 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id
));
1087 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id
,
1088 'course' => $cm->course
,
1089 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY
));
1091 // Delete all tag instances associated with the instance of this module.
1092 core_tag_tag
::delete_instances('mod_' . $modulename, null, $modcontext->id
);
1093 core_tag_tag
::remove_all_item_tags('core', 'course_modules', $cm->id
);
1095 // Notify the competency subsystem.
1096 \core_competency\api
::hook_course_module_deleted($cm);
1098 // Delete the context.
1099 context_helper
::delete_instance(CONTEXT_MODULE
, $cm->id
);
1101 // Delete the module from the course_modules table.
1102 $DB->delete_records('course_modules', array('id' => $cm->id
));
1104 // Delete module from that section.
1105 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
1106 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1107 "Cannot delete the module $modulename (instance) from section.");
1110 // Trigger event for course module delete action.
1111 $event = \core\event\course_module_deleted
::create(array(
1112 'courseid' => $cm->course
,
1113 'context' => $modcontext,
1114 'objectid' => $cm->id
,
1116 'modulename' => $modulename,
1117 'instanceid' => $cm->instance
,
1120 $event->add_record_snapshot('course_modules', $cm);
1122 rebuild_course_cache($cm->course
, true);
1126 * Schedule a course module for deletion in the background using an adhoc task.
1128 * This method should not be called directly. Instead, please use course_delete_module($cmid, true), to denote async deletion.
1129 * The real deletion of the module is handled by the task, which calls 'course_delete_module($cmid)'.
1131 * @param int $cmid the course module id.
1132 * @return bool whether the module was successfully scheduled for deletion.
1133 * @throws \moodle_exception
1135 function course_module_flag_for_async_deletion($cmid) {
1136 global $CFG, $DB, $USER;
1137 require_once($CFG->libdir
.'/gradelib.php');
1138 require_once($CFG->libdir
.'/questionlib.php');
1139 require_once($CFG->dirroot
.'/blog/lib.php');
1140 require_once($CFG->dirroot
.'/calendar/lib.php');
1142 // Get the course module.
1143 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1147 // We need to be reasonably certain the deletion is going to succeed before we background the process.
1148 // Make the necessary delete_instance checks, etc. before proceeding further. Throw exceptions if required.
1150 // Get the course module name.
1151 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1153 // Get the file location of the delete_instance function for this module.
1154 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1156 // Include the file required to call the delete_instance function for this module.
1157 if (file_exists($modlib)) {
1158 require_once($modlib);
1160 throw new \
moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1161 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1164 $deleteinstancefunction = $modulename . '_delete_instance';
1166 // Ensure the delete_instance function exists for this module.
1167 if (!function_exists($deleteinstancefunction)) {
1168 throw new \
moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1169 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1172 // We are going to defer the deletion as we can't be sure how long the module's pre_delete code will run for.
1173 $cm->deletioninprogress
= '1';
1174 $DB->update_record('course_modules', $cm);
1176 // Create an adhoc task for the deletion of the course module. The task takes an array of course modules for removal.
1177 $removaltask = new \core_course\task\
course_delete_modules();
1178 $removaltask->set_custom_data(array(
1179 'cms' => array($cm),
1180 'userid' => $USER->id
,
1181 'realuserid' => \core\session\manager
::get_realuser()->id
1184 // Queue the task for the next run.
1185 \core\task\manager
::queue_adhoc_task($removaltask);
1187 // Reset the course cache to hide the module.
1188 rebuild_course_cache($cm->course
, true);
1192 * Checks whether the given course has any course modules scheduled for adhoc deletion.
1194 * @param int $courseid the id of the course.
1195 * @param bool $onlygradable whether to check only gradable modules or all modules.
1196 * @return bool true if the course contains any modules pending deletion, false otherwise.
1198 function course_modules_pending_deletion(int $courseid, bool $onlygradable = false) : bool {
1199 if (empty($courseid)) {
1203 if ($onlygradable) {
1204 // Fetch modules with grade items.
1205 if (!$coursegradeitems = grade_item
::fetch_all(['itemtype' => 'mod', 'courseid' => $courseid])) {
1206 // Return early when there is none.
1211 $modinfo = get_fast_modinfo($courseid);
1212 foreach ($modinfo->get_cms() as $module) {
1213 if ($module->deletioninprogress
== '1') {
1214 if ($onlygradable) {
1215 // Check if the module being deleted is in the list of course modules with grade items.
1216 foreach ($coursegradeitems as $coursegradeitem) {
1217 if ($coursegradeitem->itemmodule
== $module->modname
&& $coursegradeitem->iteminstance
== $module->instance
) {
1218 // The module being deleted is within the gradable modules.
1231 * Checks whether the course module, as defined by modulename and instanceid, is scheduled for deletion within the given course.
1233 * @param int $courseid the course id.
1234 * @param string $modulename the module name. E.g. 'assign', 'book', etc.
1235 * @param int $instanceid the module instance id.
1236 * @return bool true if the course module is pending deletion, false otherwise.
1238 function course_module_instance_pending_deletion($courseid, $modulename, $instanceid) {
1239 if (empty($courseid) ||
empty($modulename) ||
empty($instanceid)) {
1242 $modinfo = get_fast_modinfo($courseid);
1243 $instances = $modinfo->get_instances_of($modulename);
1244 return isset($instances[$instanceid]) && $instances[$instanceid]->deletioninprogress
;
1247 function delete_mod_from_section($modid, $sectionid) {
1250 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1252 $modarray = explode(",", $section->sequence
);
1254 if ($key = array_keys ($modarray, $modid)) {
1255 array_splice($modarray, $key[0], 1);
1256 $newsequence = implode(",", $modarray);
1257 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id
));
1258 rebuild_course_cache($section->course
, true);
1269 * This function updates the calendar events from the information stored in the module table and the course
1272 * @param string $modulename Module name
1273 * @param stdClass $instance Module object. Either the $instance or the $cm must be supplied.
1274 * @param stdClass $cm Course module object. Either the $instance or the $cm must be supplied.
1275 * @return bool Returns true if calendar events are updated.
1276 * @since Moodle 3.3.4
1278 function course_module_update_calendar_events($modulename, $instance = null, $cm = null) {
1281 if (isset($instance) ||
isset($cm)) {
1283 if (!isset($instance)) {
1284 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1287 $cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
);
1290 course_module_calendar_event_update_process($instance, $cm);
1298 * Update all instances through out the site or in a course.
1300 * @param string $modulename Module type to update.
1301 * @param integer $courseid Course id to update events. 0 for the whole site.
1302 * @return bool Returns True if the update was successful.
1303 * @since Moodle 3.3.4
1305 function course_module_bulk_update_calendar_events($modulename, $courseid = 0) {
1310 if (!$instances = $DB->get_records($modulename, array('course' => $courseid))) {
1314 if (!$instances = $DB->get_records($modulename)) {
1319 foreach ($instances as $instance) {
1320 if ($cm = get_coursemodule_from_instance($modulename, $instance->id
, $instance->course
)) {
1321 course_module_calendar_event_update_process($instance, $cm);
1328 * Calendar events for a module instance are updated.
1330 * @param stdClass $instance Module instance object.
1331 * @param stdClass $cm Course Module object.
1332 * @since Moodle 3.3.4
1334 function course_module_calendar_event_update_process($instance, $cm) {
1335 // We need to call *_refresh_events() first because some modules delete 'old' events at the end of the code which
1336 // will remove the completion events.
1337 $refresheventsfunction = $cm->modname
. '_refresh_events';
1338 if (function_exists($refresheventsfunction)) {
1339 call_user_func($refresheventsfunction, $cm->course
, $instance, $cm);
1341 $completionexpected = (!empty($cm->completionexpected
)) ?
$cm->completionexpected
: null;
1342 \core_completion\api
::update_completion_date_event($cm->id
, $cm->modname
, $instance, $completionexpected);
1346 * Moves a section within a course, from a position to another.
1347 * Be very careful: $section and $destination refer to section number,
1350 * @param object $course
1351 * @param int $section Section number (not id!!!)
1352 * @param int $destination
1353 * @param bool $ignorenumsections
1354 * @return boolean Result
1356 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1357 /// Moves a whole course section up and down within the course
1360 if (!$destination && $destination != 0) {
1364 // compartibility with course formats using field 'numsections'
1365 $courseformatoptions = course_get_format($course)->get_format_options();
1366 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1367 ($destination > $courseformatoptions['numsections'])) ||
($destination < 1)) {
1371 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1372 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id
),
1373 'section ASC, id ASC', 'id, section')) {
1377 $movedsections = reorder_sections($sections, $section, $destination);
1379 // Update all sections. Do this in 2 steps to avoid breaking database
1380 // uniqueness constraint
1381 $transaction = $DB->start_delegated_transaction();
1382 foreach ($movedsections as $id => $position) {
1383 if ($sections[$id] !== $position) {
1384 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1387 foreach ($movedsections as $id => $position) {
1388 if ($sections[$id] !== $position) {
1389 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1393 // If we move the highlighted section itself, then just highlight the destination.
1394 // Adjust the higlighted section location if we move something over it either direction.
1395 if ($section == $course->marker
) {
1396 course_set_marker($course->id
, $destination);
1397 } elseif ($section > $course->marker
&& $course->marker
>= $destination) {
1398 course_set_marker($course->id
, $course->marker+
1);
1399 } elseif ($section < $course->marker
&& $course->marker
<= $destination) {
1400 course_set_marker($course->id
, $course->marker
-1);
1403 $transaction->allow_commit();
1404 rebuild_course_cache($course->id
, true);
1409 * This method will delete a course section and may delete all modules inside it.
1411 * No permissions are checked here, use {@link course_can_delete_section()} to
1412 * check if section can actually be deleted.
1414 * @param int|stdClass $course
1415 * @param int|stdClass|section_info $section
1416 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1417 * @param bool $async whether or not to try to delete the section using an adhoc task. Async also depends on a plugin hook.
1418 * @return bool whether section was deleted
1420 function course_delete_section($course, $section, $forcedeleteifnotempty = true, $async = false) {
1423 // Prepare variables.
1424 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1425 $sectionnum = (is_object($section)) ?
$section->section
: (int)$section;
1426 $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1428 // No section exists, can't proceed.
1432 // Check the 'course_module_background_deletion_recommended' hook first.
1433 // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1434 // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1435 // It's up to plugins to handle things like whether or not they are enabled.
1436 if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1437 foreach ($pluginsfunction as $plugintype => $plugins) {
1438 foreach ($plugins as $pluginfunction) {
1439 if ($pluginfunction()) {
1440 return course_delete_section_async($section, $forcedeleteifnotempty);
1446 $format = course_get_format($course);
1447 $sectionname = $format->get_section_name($section);
1450 $result = $format->delete_section($section, $forcedeleteifnotempty);
1452 // Trigger an event for course section deletion.
1454 $context = context_course
::instance($courseid);
1455 $event = \core\event\course_section_deleted
::create(
1457 'objectid' => $section->id
,
1458 'courseid' => $courseid,
1459 'context' => $context,
1461 'sectionnum' => $section->section
,
1462 'sectionname' => $sectionname,
1466 $event->add_record_snapshot('course_sections', $section);
1473 * Course section deletion, using an adhoc task for deletion of the modules it contains.
1474 * 1. Schedule all modules within the section for adhoc removal.
1475 * 2. Move all modules to course section 0.
1476 * 3. Delete the resulting empty section.
1478 * @param \stdClass $section the section to schedule for deletion.
1479 * @param bool $forcedeleteifnotempty whether to force section deletion if it contains modules.
1480 * @return bool true if the section was scheduled for deletion, false otherwise.
1482 function course_delete_section_async($section, $forcedeleteifnotempty = true) {
1485 // Objects only, and only valid ones.
1486 if (!is_object($section) ||
empty($section->id
)) {
1490 // Does the object currently exist in the DB for removal (check for stale objects).
1491 $section = $DB->get_record('course_sections', array('id' => $section->id
));
1492 if (!$section ||
!$section->section
) {
1493 // No section exists, or the section is 0. Can't proceed.
1497 // Check whether the section can be removed.
1498 if (!$forcedeleteifnotempty && (!empty($section->sequence
) ||
!empty($section->summary
))) {
1502 $format = course_get_format($section->course
);
1503 $sectionname = $format->get_section_name($section);
1505 // Flag those modules having no existing deletion flag. Some modules may have been scheduled for deletion manually, and we don't
1506 // want to create additional adhoc deletion tasks for these. Moving them to section 0 will suffice.
1507 $affectedmods = $DB->get_records_select('course_modules', 'course = ? AND section = ? AND deletioninprogress <> ?',
1508 [$section->course
, $section->id
, 1], '', 'id');
1509 $DB->set_field('course_modules', 'deletioninprogress', '1', ['course' => $section->course
, 'section' => $section->id
]);
1511 // Move all modules to section 0.
1512 $modules = $DB->get_records('course_modules', ['section' => $section->id
], '');
1513 $sectionzero = $DB->get_record('course_sections', ['course' => $section->course
, 'section' => '0']);
1514 foreach ($modules as $mod) {
1515 moveto_module($mod, $sectionzero);
1518 // Create and queue an adhoc task for the deletion of the modules.
1519 $removaltask = new \core_course\task\
course_delete_modules();
1521 'cms' => $affectedmods,
1522 'userid' => $USER->id
,
1523 'realuserid' => \core\session\manager
::get_realuser()->id
1525 $removaltask->set_custom_data($data);
1526 \core\task\manager
::queue_adhoc_task($removaltask);
1528 // Delete the now empty section, passing in only the section number, which forces the function to fetch a new object.
1529 // The refresh is needed because the section->sequence is now stale.
1530 $result = $format->delete_section($section->section
, $forcedeleteifnotempty);
1532 // Trigger an event for course section deletion.
1534 $context = \context_course
::instance($section->course
);
1535 $event = \core\event\course_section_deleted
::create(
1537 'objectid' => $section->id
,
1538 'courseid' => $section->course
,
1539 'context' => $context,
1541 'sectionnum' => $section->section
,
1542 'sectionname' => $sectionname,
1546 $event->add_record_snapshot('course_sections', $section);
1549 rebuild_course_cache($section->course
, true);
1555 * Updates the course section
1557 * This function does not check permissions or clean values - this has to be done prior to calling it.
1559 * @param int|stdClass $course
1560 * @param stdClass $section record from course_sections table - it will be updated with the new values
1561 * @param array|stdClass $data
1563 function course_update_section($course, $section, $data) {
1566 $courseid = (is_object($course)) ?
$course->id
: (int)$course;
1568 // Some fields can not be updated using this method.
1569 $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1570 $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible
);
1571 if (array_key_exists('name', $data) && \core_text
::strlen($data['name']) > 255) {
1572 throw new moodle_exception('maximumchars', 'moodle', '', 255);
1575 // Update record in the DB and course format options.
1576 $data['id'] = $section->id
;
1577 $data['timemodified'] = time();
1578 $DB->update_record('course_sections', $data);
1579 rebuild_course_cache($courseid, true);
1580 course_get_format($courseid)->update_section_format_options($data);
1582 // Update fields of the $section object.
1583 foreach ($data as $key => $value) {
1584 if (property_exists($section, $key)) {
1585 $section->$key = $value;
1589 // Trigger an event for course section update.
1590 $event = \core\event\course_section_updated
::create(
1592 'objectid' => $section->id
,
1593 'courseid' => $courseid,
1594 'context' => context_course
::instance($courseid),
1595 'other' => array('sectionnum' => $section->section
)
1600 // If section visibility was changed, hide the modules in this section too.
1601 if ($changevisibility && !empty($section->sequence
)) {
1602 $modules = explode(',', $section->sequence
);
1603 foreach ($modules as $moduleid) {
1604 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1605 if ($data['visible']) {
1606 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1607 set_coursemodule_visible($moduleid, $cm->visibleold
, $cm->visibleoncoursepage
);
1609 // We hide the section, so we hide the module but we store the original state in visibleold.
1610 set_coursemodule_visible($moduleid, 0, $cm->visibleoncoursepage
);
1611 $DB->set_field('course_modules', 'visibleold', $cm->visible
, array('id' => $moduleid));
1613 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1620 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1622 * @param int|stdClass $course
1623 * @param int|stdClass|section_info $section
1626 function course_can_delete_section($course, $section) {
1627 if (is_object($section)) {
1628 $section = $section->section
;
1631 // Not possible to delete 0-section.
1634 // Course format should allow to delete sections.
1635 if (!course_get_format($course)->can_delete_section($section)) {
1638 // Make sure user has capability to update course and move sections.
1639 $context = context_course
::instance(is_object($course) ?
$course->id
: $course);
1640 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1643 // Make sure user has capability to delete each activity in this section.
1644 $modinfo = get_fast_modinfo($course);
1645 if (!empty($modinfo->sections
[$section])) {
1646 foreach ($modinfo->sections
[$section] as $cmid) {
1647 if (!has_capability('moodle/course:manageactivities', context_module
::instance($cmid))) {
1656 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1657 * an original position number and a target position number, rebuilds the array so that the
1658 * move is made without any duplication of section positions.
1659 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1660 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1662 * @param array $sections
1663 * @param int $origin_position
1664 * @param int $target_position
1667 function reorder_sections($sections, $origin_position, $target_position) {
1668 if (!is_array($sections)) {
1672 // We can't move section position 0
1673 if ($origin_position < 1) {
1674 echo "We can't move section position 0";
1678 // Locate origin section in sections array
1679 if (!$origin_key = array_search($origin_position, $sections)) {
1680 echo "searched position not in sections array";
1681 return false; // searched position not in sections array
1684 // Extract origin section
1685 $origin_section = $sections[$origin_key];
1686 unset($sections[$origin_key]);
1688 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1690 $append_array = array();
1691 foreach ($sections as $id => $position) {
1693 $append_array[$id] = $position;
1694 unset($sections[$id]);
1696 if ($position == $target_position) {
1697 if ($target_position < $origin_position) {
1698 $append_array[$id] = $position;
1699 unset($sections[$id]);
1705 // Append moved section
1706 $sections[$origin_key] = $origin_section;
1708 // Append rest of array (if applicable)
1709 if (!empty($append_array)) {
1710 foreach ($append_array as $id => $position) {
1711 $sections[$id] = $position;
1715 // Renumber positions
1717 foreach ($sections as $id => $p) {
1718 $sections[$id] = $position;
1727 * Move the module object $mod to the specified $section
1728 * If $beforemod exists then that is the module
1729 * before which $modid should be inserted
1731 * @param stdClass|cm_info $mod
1732 * @param stdClass|section_info $section
1733 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1734 * before which the module needs to be included. Null for inserting in the
1735 * end of the section
1736 * @return int new value for module visibility (0 or 1)
1738 function moveto_module($mod, $section, $beforemod=NULL) {
1739 global $OUTPUT, $DB;
1741 // Current module visibility state - return value of this function.
1742 $modvisible = $mod->visible
;
1744 // Remove original module from original section.
1745 if (! delete_mod_from_section($mod->id
, $mod->section
)) {
1746 echo $OUTPUT->notification("Could not delete module from existing section");
1749 // If moving to a hidden section then hide module.
1750 if ($mod->section
!= $section->id
) {
1751 if (!$section->visible
&& $mod->visible
) {
1752 // Module was visible but must become hidden after moving to hidden section.
1754 set_coursemodule_visible($mod->id
, 0);
1755 // Set visibleold to 1 so module will be visible when section is made visible.
1756 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id
));
1758 if ($section->visible
&& !$mod->visible
) {
1759 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1760 set_coursemodule_visible($mod->id
, $mod->visibleold
);
1761 $modvisible = $mod->visibleold
;
1765 // Add the module into the new section.
1766 course_add_cm_to_section($section->course
, $mod->id
, $section->section
, $beforemod);
1771 * Returns the list of all editing actions that current user can perform on the module
1773 * @param cm_info $mod The module to produce editing buttons for
1774 * @param int $indent The current indenting (default -1 means no move left-right actions)
1775 * @param int $sr The section to link back to (used for creating the links)
1776 * @return array array of action_link or pix_icon objects
1778 function course_get_cm_edit_actions(cm_info
$mod, $indent = -1, $sr = null) {
1779 global $COURSE, $SITE, $CFG;
1783 $coursecontext = context_course
::instance($mod->course
);
1784 $modcontext = context_module
::instance($mod->id
);
1785 $courseformat = course_get_format($mod->get_course());
1787 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1788 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1790 // No permission to edit anything.
1791 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1795 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1798 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1799 'editsettings', 'duplicate', 'modhide', 'makeavailable', 'makeunavailable', 'modshow'), 'moodle');
1800 $str->assign
= get_string('assignroles', 'role');
1801 $str->groupsnone
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1802 $str->groupsseparate
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1803 $str->groupsvisible
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1806 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1809 $baseurl->param('sr', $sr);
1814 if ($hasmanageactivities) {
1815 $actions['update'] = new action_menu_link_secondary(
1816 new moodle_url($baseurl, array('update' => $mod->id
)),
1817 new pix_icon('t/edit', '', 'moodle', array('class' => 'iconsmall')),
1819 array('class' => 'editing_update', 'data-action' => 'update')
1824 if ($hasmanageactivities && $indent >= 0) {
1825 $indentlimits = new stdClass();
1826 $indentlimits->min
= 0;
1827 $indentlimits->max
= 16;
1828 if (right_to_left()) { // Exchange arrows on RTL
1829 $rightarrow = 't/left';
1830 $leftarrow = 't/right';
1832 $rightarrow = 't/right';
1833 $leftarrow = 't/left';
1836 if ($indent >= $indentlimits->max
) {
1837 $enabledclass = 'hidden';
1841 $actions['moveright'] = new action_menu_link_secondary(
1842 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '1')),
1843 new pix_icon($rightarrow, '', 'moodle', array('class' => 'iconsmall')),
1845 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright',
1846 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1849 if ($indent <= $indentlimits->min
) {
1850 $enabledclass = 'hidden';
1854 $actions['moveleft'] = new action_menu_link_secondary(
1855 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '-1')),
1856 new pix_icon($leftarrow, '', 'moodle', array('class' => 'iconsmall')),
1858 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft',
1859 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1864 // Hide/Show/Available/Unavailable.
1865 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1866 $allowstealth = !empty($CFG->allowstealth
) && $courseformat->allow_stealth_module_visibility($mod, $mod->get_section_info());
1868 $sectionvisible = $mod->get_section_info()->visible
;
1869 // The module on the course page may be in one of the following states:
1870 // - Available and displayed on the course page ($displayedoncoursepage);
1871 // - Not available and not displayed on the course page ($unavailable);
1872 // - Available but not displayed on the course page ($stealth) - this can also be a visible activity in a hidden section.
1873 $displayedoncoursepage = $mod->visible
&& $mod->visibleoncoursepage
&& $sectionvisible;
1874 $unavailable = !$mod->visible
;
1875 $stealth = $mod->visible
&& (!$mod->visibleoncoursepage ||
!$sectionvisible);
1876 if ($displayedoncoursepage) {
1877 $actions['hide'] = new action_menu_link_secondary(
1878 new moodle_url($baseurl, array('hide' => $mod->id
)),
1879 new pix_icon('t/hide', '', 'moodle', array('class' => 'iconsmall')),
1881 array('class' => 'editing_hide', 'data-action' => 'hide')
1883 } else if (!$displayedoncoursepage && $sectionvisible) {
1884 // Offer to "show" only if the section is visible.
1885 $actions['show'] = new action_menu_link_secondary(
1886 new moodle_url($baseurl, array('show' => $mod->id
)),
1887 new pix_icon('t/show', '', 'moodle', array('class' => 'iconsmall')),
1889 array('class' => 'editing_show', 'data-action' => 'show')
1894 // When making the "stealth" module unavailable we perform the same action as hiding the visible module.
1895 $actions['hide'] = new action_menu_link_secondary(
1896 new moodle_url($baseurl, array('hide' => $mod->id
)),
1897 new pix_icon('t/unblock', '', 'moodle', array('class' => 'iconsmall')),
1898 $str->makeunavailable
,
1899 array('class' => 'editing_makeunavailable', 'data-action' => 'hide', 'data-sectionreturn' => $sr)
1901 } else if ($unavailable && (!$sectionvisible ||
$allowstealth) && $mod->has_view()) {
1902 // Allow to make visually hidden module available in gradebook and other reports by making it a "stealth" module.
1903 // When the section is hidden it is an equivalent of "showing" the module.
1904 // Activities without the link (i.e. labels) can not be made available but hidden on course page.
1905 $action = $sectionvisible ?
'stealth' : 'show';
1906 $actions[$action] = new action_menu_link_secondary(
1907 new moodle_url($baseurl, array($action => $mod->id
)),
1908 new pix_icon('t/block', '', 'moodle', array('class' => 'iconsmall')),
1909 $str->makeavailable
,
1910 array('class' => 'editing_makeavailable', 'data-action' => $action, 'data-sectionreturn' => $sr)
1915 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1916 if (has_all_capabilities($dupecaps, $coursecontext) &&
1917 plugin_supports('mod', $mod->modname
, FEATURE_BACKUP_MOODLE2
) &&
1918 course_allowed_module($mod->get_course(), $mod->modname
)) {
1919 $actions['duplicate'] = new action_menu_link_secondary(
1920 new moodle_url($baseurl, array('duplicate' => $mod->id
)),
1921 new pix_icon('t/copy', '', 'moodle', array('class' => 'iconsmall')),
1923 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sectionreturn' => $sr)
1928 if ($hasmanageactivities && !$mod->coursegroupmodeforce
) {
1929 if (plugin_supports('mod', $mod->modname
, FEATURE_GROUPS
, false)) {
1930 if ($mod->effectivegroupmode
== SEPARATEGROUPS
) {
1931 $nextgroupmode = VISIBLEGROUPS
;
1932 $grouptitle = $str->groupsseparate
;
1933 $actionname = 'groupsseparate';
1934 $nextactionname = 'groupsvisible';
1935 $groupimage = 'i/groups';
1936 } else if ($mod->effectivegroupmode
== VISIBLEGROUPS
) {
1937 $nextgroupmode = NOGROUPS
;
1938 $grouptitle = $str->groupsvisible
;
1939 $actionname = 'groupsvisible';
1940 $nextactionname = 'groupsnone';
1941 $groupimage = 'i/groupv';
1943 $nextgroupmode = SEPARATEGROUPS
;
1944 $grouptitle = $str->groupsnone
;
1945 $actionname = 'groupsnone';
1946 $nextactionname = 'groupsseparate';
1947 $groupimage = 'i/groupn';
1950 $actions[$actionname] = new action_menu_link_primary(
1951 new moodle_url($baseurl, array('id' => $mod->id
, 'groupmode' => $nextgroupmode)),
1952 new pix_icon($groupimage, '', 'moodle', array('class' => 'iconsmall')),
1954 array('class' => 'editing_'. $actionname, 'data-action' => $nextactionname,
1955 'aria-live' => 'assertive', 'data-sectionreturn' => $sr)
1958 $actions['nogroupsupport'] = new action_menu_filler();
1963 if (has_capability('moodle/role:assign', $modcontext)){
1964 $actions['assign'] = new action_menu_link_secondary(
1965 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id
)),
1966 new pix_icon('t/assignroles', '', 'moodle', array('class' => 'iconsmall')),
1968 array('class' => 'editing_assign', 'data-action' => 'assignroles', 'data-sectionreturn' => $sr)
1973 if ($hasmanageactivities) {
1974 $actions['delete'] = new action_menu_link_secondary(
1975 new moodle_url($baseurl, array('delete' => $mod->id
)),
1976 new pix_icon('t/delete', '', 'moodle', array('class' => 'iconsmall')),
1978 array('class' => 'editing_delete', 'data-action' => 'delete', 'data-sectionreturn' => $sr)
1986 * Returns the move action.
1988 * @param cm_info $mod The module to produce a move button for
1989 * @param int $sr The section to link back to (used for creating the links)
1990 * @return The markup for the move action, or an empty string if not available.
1992 function course_get_cm_move(cm_info
$mod, $sr = null) {
1998 $modcontext = context_module
::instance($mod->id
);
1999 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2002 $str = get_strings(array('move'));
2005 if (!isset($baseurl)) {
2006 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2009 $baseurl->param('sr', $sr);
2013 if ($hasmanageactivities) {
2014 $pixicon = 'i/dragdrop';
2016 if (!course_ajax_enabled($mod->get_course())) {
2017 // Override for course frontpage until we get drag/drop working there.
2018 $pixicon = 't/move';
2022 'class' => 'editing_move',
2023 'data-action' => 'move',
2024 'data-sectionreturn' => $sr,
2025 'title' => $str->move
,
2026 'aria-label' => $str->move
,
2028 return html_writer
::link(
2029 new moodle_url($baseurl, ['copy' => $mod->id
]),
2030 $OUTPUT->pix_icon($pixicon, '', 'moodle', ['class' => 'iconsmall']),
2038 * given a course object with shortname & fullname, this function will
2039 * truncate the the number of chars allowed and add ... if it was too long
2041 function course_format_name ($course,$max=100) {
2043 $context = context_course
::instance($course->id
);
2044 $shortname = format_string($course->shortname
, true, array('context' => $context));
2045 $fullname = format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
2046 $str = $shortname.': '. $fullname;
2047 if (core_text
::strlen($str) <= $max) {
2051 return core_text
::substr($str,0,$max-3).'...';
2056 * Is the user allowed to add this type of module to this course?
2057 * @param object $course the course settings. Only $course->id is used.
2058 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2059 * @param \stdClass $user the user to check, defaults to the global user if not provided.
2060 * @return bool whether the current user is allowed to add this type of module to this course.
2062 function course_allowed_module($course, $modname, \stdClass
$user = null) {
2064 $user = $user ??
$USER;
2065 if (is_numeric($modname)) {
2066 throw new coding_exception('Function course_allowed_module no longer
2067 supports numeric module ids. Please update your code to pass the module name.');
2070 $capability = 'mod/' . $modname . ':addinstance';
2071 if (!get_capability_info($capability)) {
2072 // Debug warning that the capability does not exist, but no more than once per page.
2073 static $warned = array();
2074 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
2075 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM
) {
2076 debugging('The module ' . $modname . ' does not define the standard capability ' .
2077 $capability , DEBUG_DEVELOPER
);
2078 $warned[$modname] = 1;
2081 // If the capability does not exist, the module can always be added.
2085 $coursecontext = context_course
::instance($course->id
);
2086 return has_capability($capability, $coursecontext, $user);
2090 * Efficiently moves many courses around while maintaining
2091 * sortorder in order.
2093 * @param array $courseids is an array of course ids
2094 * @param int $categoryid
2095 * @return bool success
2097 function move_courses($courseids, $categoryid) {
2100 if (empty($courseids)) {
2105 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2109 $courseids = array_reverse($courseids);
2110 $newparent = context_coursecat
::instance($category->id
);
2113 list($where, $params) = $DB->get_in_or_equal($courseids);
2114 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2115 foreach ($dbcourses as $dbcourse) {
2116 $course = new stdClass();
2117 $course->id
= $dbcourse->id
;
2118 $course->timemodified
= time();
2119 $course->category
= $category->id
;
2120 $course->sortorder
= $category->sortorder +
get_max_courses_in_category() - $i++
;
2121 if ($category->visible
== 0) {
2122 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2123 // to previous state if somebody unhides the category.
2124 $course->visible
= 0;
2127 $DB->update_record('course', $course);
2129 // Update context, so it can be passed to event.
2130 $context = context_course
::instance($course->id
);
2131 $context->update_moved($newparent);
2133 // Trigger a course updated event.
2134 $event = \core\event\course_updated
::create(array(
2135 'objectid' => $course->id
,
2136 'context' => context_course
::instance($course->id
),
2137 'other' => array('shortname' => $dbcourse->shortname
,
2138 'fullname' => $dbcourse->fullname
,
2139 'updatedfields' => array('category' => $category->id
))
2141 $event->set_legacy_logdata(array($course->id
, 'course', 'move', 'edit.php?id=' . $course->id
, $course->id
));
2144 fix_course_sortorder();
2145 cache_helper
::purge_by_event('changesincourse');
2151 * Returns the display name of the given section that the course prefers
2153 * Implementation of this function is provided by course format
2154 * @see core_courseformat\base::get_section_name()
2156 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2157 * @param int|stdClass $section Section object from database or just field course_sections.section
2158 * @return string Display name that the course format prefers, e.g. "Week 2"
2160 function get_section_name($courseorid, $section) {
2161 return course_get_format($courseorid)->get_section_name($section);
2165 * Tells if current course format uses sections
2167 * @param string $format Course format ID e.g. 'weeks' $course->format
2170 function course_format_uses_sections($format) {
2171 $course = new stdClass();
2172 $course->format
= $format;
2173 return course_get_format($course)->uses_sections();
2177 * Returns the information about the ajax support in the given source format
2179 * The returned object's property (boolean)capable indicates that
2180 * the course format supports Moodle course ajax features.
2182 * @param string $format
2185 function course_format_ajax_support($format) {
2186 $course = new stdClass();
2187 $course->format
= $format;
2188 return course_get_format($course)->supports_ajax();
2192 * Can the current user delete this course?
2193 * Course creators have exception,
2194 * 1 day after the creation they can sill delete the course.
2195 * @param int $courseid
2198 function can_delete_course($courseid) {
2201 $context = context_course
::instance($courseid);
2203 if (has_capability('moodle/course:delete', $context)) {
2207 // hack: now try to find out if creator created this course recently (1 day)
2208 if (!has_capability('moodle/course:create', $context)) {
2212 $since = time() - 60*60*24;
2213 $course = get_course($courseid);
2215 if ($course->timecreated
< $since) {
2216 return false; // Return if the course was not created in last 24 hours.
2219 $logmanger = get_log_manager();
2220 $readers = $logmanger->get_readers('\core\log\sql_reader');
2221 $reader = reset($readers);
2223 if (empty($reader)) {
2224 return false; // No log reader found.
2228 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2229 $params = array('userid' => $USER->id
, 'since' => $since, 'courseid' => $course->id
, 'eventname' => '\core\event\course_created');
2231 return (bool)$reader->get_events_select_count($select, $params);
2235 * Save the Your name for 'Some role' strings.
2237 * @param integer $courseid the id of this course.
2238 * @param array $data the data that came from the course settings form.
2240 function save_local_role_names($courseid, $data) {
2242 $context = context_course
::instance($courseid);
2244 foreach ($data as $fieldname => $value) {
2245 if (strpos($fieldname, 'role_') !== 0) {
2248 list($ignored, $roleid) = explode('_', $fieldname);
2250 // make up our mind whether we want to delete, update or insert
2252 $DB->delete_records('role_names', array('contextid' => $context->id
, 'roleid' => $roleid));
2254 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id
, 'roleid' => $roleid))) {
2255 $rolename->name
= $value;
2256 $DB->update_record('role_names', $rolename);
2259 $rolename = new stdClass
;
2260 $rolename->contextid
= $context->id
;
2261 $rolename->roleid
= $roleid;
2262 $rolename->name
= $value;
2263 $DB->insert_record('role_names', $rolename);
2265 // This will ensure the course contacts cache is purged..
2266 core_course_category
::role_assignment_changed($roleid, $context);
2271 * Returns options to use in course overviewfiles filemanager
2273 * @param null|stdClass|core_course_list_element|int $course either object that has 'id' property or just the course id;
2274 * may be empty if course does not exist yet (course create form)
2275 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2276 * or null if overviewfiles are disabled
2278 function course_overviewfiles_options($course) {
2280 if (empty($CFG->courseoverviewfileslimit
)) {
2284 // Create accepted file types based on config value, falling back to default all.
2285 $acceptedtypes = (new \core_form\filetypes_util
)->normalize_file_types($CFG->courseoverviewfilesext
);
2286 if (in_array('*', $acceptedtypes) ||
empty($acceptedtypes)) {
2287 $acceptedtypes = '*';
2291 'maxfiles' => $CFG->courseoverviewfileslimit
,
2292 'maxbytes' => $CFG->maxbytes
,
2294 'accepted_types' => $acceptedtypes
2296 if (!empty($course->id
)) {
2297 $options['context'] = context_course
::instance($course->id
);
2298 } else if (is_int($course) && $course > 0) {
2299 $options['context'] = context_course
::instance($course);
2305 * Create a course and either return a $course object
2307 * Please note this functions does not verify any access control,
2308 * the calling code is responsible for all validation (usually it is the form definition).
2310 * @param array $editoroptions course description editor options
2311 * @param object $data - all the data needed for an entry in the 'course' table
2312 * @return object new course instance
2314 function create_course($data, $editoroptions = NULL) {
2317 //check the categoryid - must be given for all new courses
2318 $category = $DB->get_record('course_categories', array('id'=>$data->category
), '*', MUST_EXIST
);
2320 // Check if the shortname already exists.
2321 if (!empty($data->shortname
)) {
2322 if ($DB->record_exists('course', array('shortname' => $data->shortname
))) {
2323 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2327 // Check if the idnumber already exists.
2328 if (!empty($data->idnumber
)) {
2329 if ($DB->record_exists('course', array('idnumber' => $data->idnumber
))) {
2330 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2334 if (empty($CFG->enablecourserelativedates
)) {
2335 // Make sure we're not setting the relative dates mode when the setting is disabled.
2336 unset($data->relativedatesmode
);
2339 if ($errorcode = course_validate_dates((array)$data)) {
2340 throw new moodle_exception($errorcode);
2343 // Check if timecreated is given.
2344 $data->timecreated
= !empty($data->timecreated
) ?
$data->timecreated
: time();
2345 $data->timemodified
= $data->timecreated
;
2347 // place at beginning of any category
2348 $data->sortorder
= 0;
2350 if ($editoroptions) {
2351 // summary text is updated later, we need context to store the files first
2352 $data->summary
= '';
2353 $data->summary_format
= FORMAT_HTML
;
2356 // Get default completion settings as a fallback in case the enablecompletion field is not set.
2357 $courseconfig = get_config('moodlecourse');
2358 $defaultcompletion = !empty($CFG->enablecompletion
) ?
$courseconfig->enablecompletion
: COMPLETION_DISABLED
;
2359 $enablecompletion = $data->enablecompletion ??
$defaultcompletion;
2360 // Unset showcompletionconditions when completion tracking is not enabled for the course.
2361 if ($enablecompletion == COMPLETION_DISABLED
) {
2362 unset($data->showcompletionconditions
);
2363 } else if (!isset($data->showcompletionconditions
)) {
2364 // Show completion conditions should have a default value when completion is enabled. Set it to the site defaults.
2365 // This scenario can happen when a course is created through data generators or through a web service.
2366 $data->showcompletionconditions
= $courseconfig->showcompletionconditions
;
2369 if (!isset($data->visible
)) {
2370 // data not from form, add missing visibility info
2371 $data->visible
= $category->visible
;
2373 $data->visibleold
= $data->visible
;
2375 $newcourseid = $DB->insert_record('course', $data);
2376 $context = context_course
::instance($newcourseid, MUST_EXIST
);
2378 if ($editoroptions) {
2379 // Save the files used in the summary editor and store
2380 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2381 $DB->set_field('course', 'summary', $data->summary
, array('id'=>$newcourseid));
2382 $DB->set_field('course', 'summaryformat', $data->summary_format
, array('id'=>$newcourseid));
2384 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2385 // Save the course overviewfiles
2386 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2389 // update course format options
2390 course_get_format($newcourseid)->update_course_format_options($data);
2392 $course = course_get_format($newcourseid)->get_course();
2394 fix_course_sortorder();
2395 // purge appropriate caches in case fix_course_sortorder() did not change anything
2396 cache_helper
::purge_by_event('changesincourse');
2398 // Trigger a course created event.
2399 $event = \core\event\course_created
::create(array(
2400 'objectid' => $course->id
,
2401 'context' => context_course
::instance($course->id
),
2402 'other' => array('shortname' => $course->shortname
,
2403 'fullname' => $course->fullname
)
2409 blocks_add_default_course_blocks($course);
2411 // Create default section and initial sections if specified (unless they've already been created earlier).
2412 // We do not want to call course_create_sections_if_missing() because to avoid creating course cache.
2413 $numsections = isset($data->numsections
) ?
$data->numsections
: 0;
2414 $existingsections = $DB->get_fieldset_sql('SELECT section from {course_sections} WHERE course = ?', [$newcourseid]);
2415 $newsections = array_diff(range(0, $numsections), $existingsections);
2416 foreach ($newsections as $sectionnum) {
2417 course_create_section($newcourseid, $sectionnum, true);
2420 // Save any custom role names.
2421 save_local_role_names($course->id
, (array)$data);
2423 // set up enrolments
2424 enrol_course_updated(true, $course, $data);
2426 // Update course tags.
2427 if (isset($data->tags
)) {
2428 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2431 // Save custom fields if there are any of them in the form.
2432 $handler = core_course\customfield\course_handler
::create();
2433 // Make sure to set the handler's parent context first.
2434 $coursecatcontext = context_coursecat
::instance($category->id
);
2435 $handler->set_parent_context($coursecatcontext);
2436 // Save the custom field data.
2437 $data->id
= $course->id
;
2438 $handler->instance_form_save($data, true);
2446 * Please note this functions does not verify any access control,
2447 * the calling code is responsible for all validation (usually it is the form definition).
2449 * @param object $data - all the data needed for an entry in the 'course' table
2450 * @param array $editoroptions course description editor options
2453 function update_course($data, $editoroptions = NULL) {
2456 // Prevent changes on front page course.
2457 if ($data->id
== SITEID
) {
2458 throw new moodle_exception('invalidcourse', 'error');
2461 $oldcourse = course_get_format($data->id
)->get_course();
2462 $context = context_course
::instance($oldcourse->id
);
2464 // Make sure we're not changing whatever the course's relativedatesmode setting is.
2465 unset($data->relativedatesmode
);
2467 // Capture the updated fields for the log data.
2468 $updatedfields = [];
2469 foreach (get_object_vars($oldcourse) as $field => $value) {
2470 if ($field == 'summary_editor') {
2471 if (($data->$field)['text'] !== $value['text']) {
2472 // The summary might be very long, we don't wan't to fill up the log record with the full text.
2473 $updatedfields[$field] = '(updated)';
2475 } else if ($field == 'tags' && isset($data->tags
)) {
2476 // Tags might not have the same array keys, just check the values.
2477 if (array_values($data->$field) !== array_values($value)) {
2478 $updatedfields[$field] = $data->$field;
2481 if (isset($data->$field) && $data->$field != $value) {
2482 $updatedfields[$field] = $data->$field;
2487 $data->timemodified
= time();
2489 if ($editoroptions) {
2490 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2492 if ($overviewfilesoptions = course_overviewfiles_options($data->id
)) {
2493 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2496 // Check we don't have a duplicate shortname.
2497 if (!empty($data->shortname
) && $oldcourse->shortname
!= $data->shortname
) {
2498 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname
, $data->id
))) {
2499 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2503 // Check we don't have a duplicate idnumber.
2504 if (!empty($data->idnumber
) && $oldcourse->idnumber
!= $data->idnumber
) {
2505 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber
, $data->id
))) {
2506 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2510 if ($errorcode = course_validate_dates((array)$data)) {
2511 throw new moodle_exception($errorcode);
2514 if (!isset($data->category
) or empty($data->category
)) {
2515 // prevent nulls and 0 in category field
2516 unset($data->category
);
2518 $changesincoursecat = $movecat = (isset($data->category
) and $oldcourse->category
!= $data->category
);
2520 if (!isset($data->visible
)) {
2521 // data not from form, add missing visibility info
2522 $data->visible
= $oldcourse->visible
;
2525 if ($data->visible
!= $oldcourse->visible
) {
2526 // reset the visibleold flag when manually hiding/unhiding course
2527 $data->visibleold
= $data->visible
;
2528 $changesincoursecat = true;
2531 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category
));
2532 if (empty($newcategory->visible
)) {
2533 // make sure when moving into hidden category the course is hidden automatically
2539 // Set newsitems to 0 if format does not support announcements.
2540 if (isset($data->format
)) {
2541 $newcourseformat = course_get_format((object)['format' => $data->format
]);
2542 if (!$newcourseformat->supports_news()) {
2543 $data->newsitems
= 0;
2547 // Set showcompletionconditions to null when completion tracking has been disabled for the course.
2548 if (isset($data->enablecompletion
) && $data->enablecompletion
== COMPLETION_DISABLED
) {
2549 $data->showcompletionconditions
= null;
2552 // Update custom fields if there are any of them in the form.
2553 $handler = core_course\customfield\course_handler
::create();
2554 $handler->instance_form_save($data);
2556 // Update with the new data
2557 $DB->update_record('course', $data);
2558 // make sure the modinfo cache is reset
2559 rebuild_course_cache($data->id
);
2561 // Purge course image cache in case if course image has been updated.
2562 \cache
::make('core', 'course_image')->delete($data->id
);
2564 // update course format options with full course data
2565 course_get_format($data->id
)->update_course_format_options($data, $oldcourse);
2567 $course = $DB->get_record('course', array('id'=>$data->id
));
2570 $newparent = context_coursecat
::instance($course->category
);
2571 $context->update_moved($newparent);
2573 $fixcoursesortorder = $movecat ||
(isset($data->sortorder
) && ($oldcourse->sortorder
!= $data->sortorder
));
2574 if ($fixcoursesortorder) {
2575 fix_course_sortorder();
2578 // purge appropriate caches in case fix_course_sortorder() did not change anything
2579 cache_helper
::purge_by_event('changesincourse');
2580 if ($changesincoursecat) {
2581 cache_helper
::purge_by_event('changesincoursecat');
2584 // Test for and remove blocks which aren't appropriate anymore
2585 blocks_remove_inappropriate($course);
2587 // Save any custom role names.
2588 save_local_role_names($course->id
, $data);
2590 // update enrol settings
2591 enrol_course_updated(false, $course, $data);
2593 // Update course tags.
2594 if (isset($data->tags
)) {
2595 core_tag_tag
::set_item_tags('core', 'course', $course->id
, context_course
::instance($course->id
), $data->tags
);
2598 // Trigger a course updated event.
2599 $event = \core\event\course_updated
::create(array(
2600 'objectid' => $course->id
,
2601 'context' => context_course
::instance($course->id
),
2602 'other' => array('shortname' => $course->shortname
,
2603 'fullname' => $course->fullname
,
2604 'updatedfields' => $updatedfields)
2607 $event->set_legacy_logdata(array($course->id
, 'course', 'update', 'edit.php?id=' . $course->id
, $course->id
));
2610 if ($oldcourse->format
!== $course->format
) {
2611 // Remove all options stored for the previous format
2612 // We assume that new course format migrated everything it needed watching trigger
2613 // 'course_updated' and in method format_XXX::update_course_format_options()
2614 $DB->delete_records('course_format_options',
2615 array('courseid' => $course->id
, 'format' => $oldcourse->format
));
2620 * Calculate the average number of enrolled participants per course.
2622 * This is intended for statistics purposes during the site registration. Only visible courses are taken into account.
2623 * Front page enrolments are excluded.
2625 * @param bool $onlyactive Consider only active enrolments in enabled plugins and obey the enrolment time restrictions.
2626 * @param int $lastloginsince If specified, count only users who logged in after this timestamp.
2629 function average_number_of_participants(bool $onlyactive = false, int $lastloginsince = null): float {
2636 $sql = "SELECT DISTINCT ue.userid, e.courseid
2637 FROM {user_enrolments} ue
2638 JOIN {enrol} e ON e.id = ue.enrolid
2639 JOIN {course} c ON c.id = e.courseid ";
2641 if ($onlyactive ||
$lastloginsince) {
2642 $sql .= "JOIN {user} u ON u.id = ue.userid ";
2645 $sql .= "WHERE e.courseid <> :siteid
2646 AND c.visible = 1 ";
2649 $sql .= "AND ue.status = :active
2650 AND e.status = :enabled
2651 AND ue.timestart < :now1
2652 AND (ue.timeend = 0 OR ue.timeend > :now2) ";
2654 // Same as in the enrollib - the rounding should help caching in the database.
2655 $now = round(time(), -2);
2658 'active' => ENROL_USER_ACTIVE
,
2659 'enabled' => ENROL_INSTANCE_ENABLED
,
2665 if ($lastloginsince) {
2666 $sql .= "AND u.lastlogin > :lastlogin ";
2667 $params['lastlogin'] = $lastloginsince;
2670 $sql = "SELECT COUNT(*)
2673 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2675 // Get the number of visible courses (exclude the front page).
2676 $coursetotal = $DB->count_records('course', ['visible' => 1]);
2677 $coursetotal = $coursetotal - 1;
2679 if (empty($coursetotal)) {
2680 $participantaverage = 0;
2683 $participantaverage = $enrolmenttotal / $coursetotal;
2686 return $participantaverage;
2690 * Average number of course modules
2693 function average_number_of_courses_modules() {
2696 //count total of visible course module (except front page)
2697 $sql = 'SELECT COUNT(*) FROM (
2698 SELECT cm.course, cm.module
2699 FROM {course} c, {course_modules} cm
2700 WHERE c.id = cm.course
2703 AND c.visible = 1) total';
2704 $params = array('siteid' => $SITE->id
);
2705 $moduletotal = $DB->count_records_sql($sql, $params);
2708 //count total of visible courses (minus front page)
2709 $coursetotal = $DB->count_records('course', array('visible' => 1));
2710 $coursetotal = $coursetotal - 1 ;
2712 //average of course module
2713 if (empty($coursetotal)) {
2714 $coursemoduleaverage = 0;
2716 $coursemoduleaverage = $moduletotal / $coursetotal;
2719 return $coursemoduleaverage;
2723 * This class pertains to course requests and contains methods associated with
2724 * create, approving, and removing course requests.
2726 * Please note we do not allow embedded images here because there is no context
2727 * to store them with proper access control.
2729 * @copyright 2009 Sam Hemelryk
2730 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2733 * @property-read int $id
2734 * @property-read string $fullname
2735 * @property-read string $shortname
2736 * @property-read string $summary
2737 * @property-read int $summaryformat
2738 * @property-read int $summarytrust
2739 * @property-read string $reason
2740 * @property-read int $requester
2742 class course_request
{
2745 * This is the stdClass that stores the properties for the course request
2746 * and is externally accessed through the __get magic method
2749 protected $properties;
2752 * An array of options for the summary editor used by course request forms.
2753 * This is initially set by {@link summary_editor_options()}
2757 protected static $summaryeditoroptions;
2760 * Static function to prepare the summary editor for working with a course
2764 * @param null|stdClass $data Optional, an object containing the default values
2765 * for the form, these may be modified when preparing the
2766 * editor so this should be called before creating the form
2767 * @return stdClass An object that can be used to set the default values for
2770 public static function prepare($data=null) {
2771 if ($data === null) {
2772 $data = new stdClass
;
2774 $data = file_prepare_standard_editor($data, 'summary', self
::summary_editor_options());
2779 * Static function to create a new course request when passed an array of properties
2782 * This function also handles saving any files that may have been used in the editor
2785 * @param stdClass $data
2786 * @return course_request The newly created course request
2788 public static function create($data) {
2789 global $USER, $DB, $CFG;
2790 $data->requester
= $USER->id
;
2792 // Setting the default category if none set.
2793 if (empty($data->category
) ||
!empty($CFG->lockrequestcategory
)) {
2794 $data->category
= $CFG->defaultrequestcategory
;
2797 // Summary is a required field so copy the text over
2798 $data->summary
= $data->summary_editor
['text'];
2799 $data->summaryformat
= $data->summary_editor
['format'];
2801 $data->id
= $DB->insert_record('course_request', $data);
2803 // Create a new course_request object and return it
2804 $request = new course_request($data);
2806 // Notify the admin if required.
2807 if ($users = get_users_from_config($CFG->courserequestnotify
, 'moodle/site:approvecourse')) {
2810 $a->link
= "$CFG->wwwroot/course/pending.php";
2811 $a->user
= fullname($USER);
2812 $subject = get_string('courserequest');
2813 $message = get_string('courserequestnotifyemail', 'admin', $a);
2814 foreach ($users as $user) {
2815 $request->notify($user, $USER, 'courserequested', $subject, $message);
2823 * Returns an array of options to use with a summary editor
2825 * @uses course_request::$summaryeditoroptions
2826 * @return array An array of options to use with the editor
2828 public static function summary_editor_options() {
2830 if (self
::$summaryeditoroptions === null) {
2831 self
::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2833 return self
::$summaryeditoroptions;
2837 * Loads the properties for this course request object. Id is required and if
2838 * only id is provided then we load the rest of the properties from the database
2840 * @param stdClass|int $properties Either an object containing properties
2841 * or the course_request id to load
2843 public function __construct($properties) {
2845 if (empty($properties->id
)) {
2846 if (empty($properties)) {
2847 throw new coding_exception('You must provide a course request id when creating a course_request object');
2850 $properties = new stdClass
;
2851 $properties->id
= (int)$id;
2854 if (empty($properties->requester
)) {
2855 if (!($this->properties
= $DB->get_record('course_request', array('id' => $properties->id
)))) {
2856 print_error('unknowncourserequest');
2859 $this->properties
= $properties;
2861 $this->properties
->collision
= null;
2865 * Returns the requested property
2867 * @param string $key
2870 public function __get($key) {
2871 return $this->properties
->$key;
2875 * Override this to ensure empty($request->blah) calls return a reliable answer...
2877 * This is required because we define the __get method
2880 * @return bool True is it not empty, false otherwise
2882 public function __isset($key) {
2883 return (!empty($this->properties
->$key));
2887 * Returns the user who requested this course
2889 * Uses a static var to cache the results and cut down the number of db queries
2891 * @staticvar array $requesters An array of cached users
2892 * @return stdClass The user who requested the course
2894 public function get_requester() {
2896 static $requesters= array();
2897 if (!array_key_exists($this->properties
->requester
, $requesters)) {
2898 $requesters[$this->properties
->requester
] = $DB->get_record('user', array('id'=>$this->properties
->requester
));
2900 return $requesters[$this->properties
->requester
];
2904 * Checks that the shortname used by the course does not conflict with any other
2905 * courses that exist
2907 * @param string|null $shortnamemark The string to append to the requests shortname
2908 * should a conflict be found
2909 * @return bool true is there is a conflict, false otherwise
2911 public function check_shortname_collision($shortnamemark = '[*]') {
2914 if ($this->properties
->collision
!== null) {
2915 return $this->properties
->collision
;
2918 if (empty($this->properties
->shortname
)) {
2919 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER
);
2920 $this->properties
->collision
= false;
2921 } else if ($DB->record_exists('course', array('shortname' => $this->properties
->shortname
))) {
2922 if (!empty($shortnamemark)) {
2923 $this->properties
->shortname
.= ' '.$shortnamemark;
2925 $this->properties
->collision
= true;
2927 $this->properties
->collision
= false;
2929 return $this->properties
->collision
;
2933 * Checks user capability to approve a requested course
2935 * If course was requested without category for some reason (might happen if $CFG->defaultrequestcategory is
2936 * misconfigured), we check capabilities 'moodle/site:approvecourse' and 'moodle/course:changecategory'.
2940 public function can_approve() {
2943 if ($this->properties
->category
) {
2944 $category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
);
2945 } else if ($CFG->defaultrequestcategory
) {
2946 $category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
);
2949 return has_capability('moodle/site:approvecourse', $category->get_context());
2952 // We can not determine the context where the course should be created. The approver should have
2953 // both capabilities to approve courses and change course category in the system context.
2954 return has_all_capabilities(['moodle/site:approvecourse', 'moodle/course:changecategory'], context_system
::instance());
2958 * Returns the category where this course request should be created
2960 * Note that we don't check here that user has a capability to view
2961 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2962 * 'moodle/course:changecategory'
2964 * @return core_course_category
2966 public function get_category() {
2968 if ($this->properties
->category
&& ($category = core_course_category
::get($this->properties
->category
, IGNORE_MISSING
))) {
2970 } else if ($CFG->defaultrequestcategory
&&
2971 ($category = core_course_category
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
))) {
2974 return core_course_category
::get_default();
2979 * This function approves the request turning it into a course
2981 * This function converts the course request into a course, at the same time
2982 * transferring any files used in the summary to the new course and then removing
2983 * the course request and the files associated with it.
2985 * @return int The id of the course that was created from this request
2987 public function approve() {
2988 global $CFG, $DB, $USER;
2990 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
2992 $user = $DB->get_record('user', array('id' => $this->properties
->requester
, 'deleted'=>0), '*', MUST_EXIST
);
2994 $courseconfig = get_config('moodlecourse');
2996 // Transfer appropriate settings
2997 $data = clone($this->properties
);
2999 unset($data->reason
);
3000 unset($data->requester
);
3003 $category = $this->get_category();
3004 $data->category
= $category->id
;
3005 // Set misc settings
3006 $data->requested
= 1;
3008 // Apply course default settings
3009 $data->format
= $courseconfig->format
;
3010 $data->newsitems
= $courseconfig->newsitems
;
3011 $data->showgrades
= $courseconfig->showgrades
;
3012 $data->showreports
= $courseconfig->showreports
;
3013 $data->maxbytes
= $courseconfig->maxbytes
;
3014 $data->groupmode
= $courseconfig->groupmode
;
3015 $data->groupmodeforce
= $courseconfig->groupmodeforce
;
3016 $data->visible
= $courseconfig->visible
;
3017 $data->visibleold
= $data->visible
;
3018 $data->lang
= $courseconfig->lang
;
3019 $data->enablecompletion
= $courseconfig->enablecompletion
;
3020 $data->numsections
= $courseconfig->numsections
;
3021 $data->startdate
= usergetmidnight(time());
3022 if ($courseconfig->courseenddateenabled
) {
3023 $data->enddate
= usergetmidnight(time()) +
$courseconfig->courseduration
;
3026 list($data->fullname
, $data->shortname
) = restore_dbops
::calculate_course_names(0, $data->fullname
, $data->shortname
);
3028 $course = create_course($data);
3029 $context = context_course
::instance($course->id
, MUST_EXIST
);
3031 // add enrol instances
3032 if (!$DB->record_exists('enrol', array('courseid'=>$course->id
, 'enrol'=>'manual'))) {
3033 if ($manual = enrol_get_plugin('manual')) {
3034 $manual->add_default_instance($course);
3038 // enrol the requester as teacher if necessary
3039 if (!empty($CFG->creatornewroleid
) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3040 enrol_try_internal_enrol($course->id
, $user->id
, $CFG->creatornewroleid
);
3045 $a = new stdClass();
3046 $a->name
= format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
3047 $a->url
= $CFG->wwwroot
.'/course/view.php?id=' . $course->id
;
3048 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a), $course->id
);
3054 * Reject a course request
3056 * This function rejects a course request, emailing the requesting user the
3057 * provided notice and then removing the request from the database
3059 * @param string $notice The message to display to the user
3061 public function reject($notice) {
3063 $user = $DB->get_record('user', array('id' => $this->properties
->requester
), '*', MUST_EXIST
);
3064 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3069 * Deletes the course request and any associated files
3071 public function delete() {
3073 $DB->delete_records('course_request', array('id' => $this->properties
->id
));
3077 * Send a message from one user to another using events_trigger
3079 * @param object $touser
3080 * @param object $fromuser
3081 * @param string $name
3082 * @param string $subject
3083 * @param string $message
3084 * @param int|null $courseid
3086 protected function notify($touser, $fromuser, $name, $subject, $message, $courseid = null) {
3087 $eventdata = new \core\message\
message();
3088 $eventdata->courseid
= empty($courseid) ? SITEID
: $courseid;
3089 $eventdata->component
= 'moodle';
3090 $eventdata->name
= $name;
3091 $eventdata->userfrom
= $fromuser;
3092 $eventdata->userto
= $touser;
3093 $eventdata->subject
= $subject;
3094 $eventdata->fullmessage
= $message;
3095 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
3096 $eventdata->fullmessagehtml
= '';
3097 $eventdata->smallmessage
= '';
3098 $eventdata->notification
= 1;
3099 message_send($eventdata);
3103 * Checks if current user can request a course in this context
3105 * @param context $context
3108 public static function can_request(context
$context) {
3110 if (empty($CFG->enablecourserequests
)) {
3113 if (has_capability('moodle/course:create', $context)) {
3117 if ($context instanceof context_system
) {
3118 $defaultcontext = context_coursecat
::instance($CFG->defaultrequestcategory
, IGNORE_MISSING
);
3119 return $defaultcontext &&
3120 has_capability('moodle/course:request', $defaultcontext);
3121 } else if ($context instanceof context_coursecat
) {
3122 if (!$CFG->lockrequestcategory ||
$CFG->defaultrequestcategory
== $context->instanceid
) {
3123 return has_capability('moodle/course:request', $context);
3131 * Return a list of page types
3132 * @param string $pagetype current page type
3133 * @param context $parentcontext Block's parent context
3134 * @param context $currentcontext Current context of block
3135 * @return array array of page types
3137 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3138 if ($pagetype === 'course-index' ||
$pagetype === 'course-index-category') {
3139 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3140 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3141 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3143 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) ||
$coursecontext->instanceid
== SITEID
)) {
3144 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3145 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3147 // Otherwise consider it a page inside a course even if $currentcontext is null
3148 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3149 'course-*' => get_string('page-course-x', 'pagetype'),
3150 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3157 * Determine whether course ajax should be enabled for the specified course
3159 * @param stdClass $course The course to test against
3160 * @return boolean Whether course ajax is enabled or note
3162 function course_ajax_enabled($course) {
3163 global $CFG, $PAGE, $SITE;
3165 // The user must be editing for AJAX to be included
3166 if (!$PAGE->user_is_editing()) {
3170 // Check that the theme suports
3171 if (!$PAGE->theme
->enablecourseajax
) {
3175 // Check that the course format supports ajax functionality
3176 // The site 'format' doesn't have information on course format support
3177 if ($SITE->id
!== $course->id
) {
3178 $courseformatajaxsupport = course_format_ajax_support($course->format
);
3179 if (!$courseformatajaxsupport->capable
) {
3184 // All conditions have been met so course ajax should be enabled
3189 * Include the relevant javascript and language strings for the resource
3190 * toolbox YUI module
3192 * @param integer $id The ID of the course being applied to
3193 * @param array $usedmodules An array containing the names of the modules in use on the page
3194 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3195 * @param stdClass $config An object containing configuration parameters for ajax modules including:
3196 * * resourceurl The URL to post changes to for resource changes
3197 * * sectionurl The URL to post changes to for section changes
3198 * * pageparams Additional parameters to pass through in the post
3201 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3202 global $CFG, $PAGE, $SITE;
3204 // Init the course editor module to support UI components.
3205 $format = course_get_format($course);
3206 include_course_editor($format);
3208 // Ensure that ajax should be included
3209 if (!course_ajax_enabled($course)) {
3213 // Component based formats don't use YUI drag and drop anymore.
3214 if (!$format->supports_components() && course_format_uses_sections($course->format
)) {
3217 $config = new stdClass();
3220 // The URL to use for resource changes
3221 if (!isset($config->resourceurl
)) {
3222 $config->resourceurl
= '/course/rest.php';
3225 // The URL to use for section changes
3226 if (!isset($config->sectionurl
)) {
3227 $config->sectionurl
= '/course/rest.php';
3230 // Any additional parameters which need to be included on page submission
3231 if (!isset($config->pageparams
)) {
3232 $config->pageparams
= array();
3235 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3237 'courseid' => $course->id
,
3238 'ajaxurl' => $config->sectionurl
,
3239 'config' => $config,
3242 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3244 'courseid' => $course->id
,
3245 'ajaxurl' => $config->resourceurl
,
3246 'config' => $config,
3250 // Require various strings for the command toolbox
3251 $PAGE->requires
->strings_for_js(array(
3254 'deletechecktypename',
3256 'edittitleinstructions',
3264 'clicktochangeinbrackets',
3269 'movecoursesection',
3272 'emptydragdropregion',
3278 // Include section-specific strings for formats which support sections.
3279 if (course_format_uses_sections($course->format
)) {
3280 $PAGE->requires
->strings_for_js(array(
3283 ), 'format_' . $course->format
);
3286 // For confirming resource deletion we need the name of the module in question
3287 foreach ($usedmodules as $module => $modname) {
3288 $PAGE->requires
->string_for_js('pluginname', $module);
3291 // Load drag and drop upload AJAX.
3292 require_once($CFG->dirroot
.'/course/dnduploadlib.php');
3293 dndupload_add_to_course($course, $enabledmodules);
3295 $PAGE->requires
->js_call_amd('core_course/actions', 'initCoursePage', array($course->format
));
3301 * Include and configure the course editor modules.
3303 * @param course_format $format the course format instance.
3305 function include_course_editor(course_format
$format) {
3306 global $PAGE, $SITE;
3308 $course = $format->get_course();
3310 if ($SITE->id
=== $course->id
) {
3314 // Edition mode and some format specs must be passed to the init method.
3316 'editing' => $format->show_editor(),
3317 'supportscomponents' => $format->supports_components(),
3319 // All the new editor elements will be loaded after the course is presented and
3320 // the initial course state will be generated using core_course_get_state webservice.
3321 $PAGE->requires
->js_call_amd('core_courseformat/courseeditor', 'setViewFormat', [$course->id
, $setup]);
3325 * Returns the sorted list of available course formats, filtered by enabled if necessary
3327 * @param bool $enabledonly return only formats that are enabled
3328 * @return array array of sorted format names
3330 function get_sorted_course_formats($enabledonly = false) {
3332 $formats = core_component
::get_plugin_list('format');
3334 if (!empty($CFG->format_plugins_sortorder
)) {
3335 $order = explode(',', $CFG->format_plugins_sortorder
);
3336 $order = array_merge(array_intersect($order, array_keys($formats)),
3337 array_diff(array_keys($formats), $order));
3339 $order = array_keys($formats);
3341 if (!$enabledonly) {
3344 $sortedformats = array();
3345 foreach ($order as $formatname) {
3346 if (!get_config('format_'.$formatname, 'disabled')) {
3347 $sortedformats[] = $formatname;
3350 return $sortedformats;
3354 * The URL to use for the specified course (with section)
3356 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3357 * @param int|stdClass $section Section object from database or just field course_sections.section
3358 * if omitted the course view page is returned
3359 * @param array $options options for view URL. At the moment core uses:
3360 * 'navigation' (bool) if true and section has no separate page, the function returns null
3361 * 'sr' (int) used by multipage formats to specify to which section to return
3362 * @return moodle_url The url of course
3364 function course_get_url($courseorid, $section = null, $options = array()) {
3365 return course_get_format($courseorid)->get_view_url($section, $options);
3372 * - capability checks and other checks
3373 * - create the module from the module info
3375 * @param object $module
3376 * @return object the created module info
3377 * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3379 function create_module($moduleinfo) {
3382 require_once($CFG->dirroot
. '/course/modlib.php');
3384 // Check manadatory attributs.
3385 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3386 if (plugin_supports('mod', $moduleinfo->modulename
, FEATURE_MOD_INTRO
, true)) {
3387 $mandatoryfields[] = 'introeditor';
3389 foreach($mandatoryfields as $mandatoryfield) {
3390 if (!isset($moduleinfo->{$mandatoryfield})) {
3391 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3395 // Some additional checks (capability / existing instances).
3396 $course = $DB->get_record('course', array('id'=>$moduleinfo->course
), '*', MUST_EXIST
);
3397 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename
, $moduleinfo->section
);
3400 $moduleinfo->module
= $module->id
;
3401 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3410 * - capability and other checks
3411 * - update the module
3413 * @param object $module
3414 * @return object the updated module info
3415 * @throws moodle_exception if current user is not allowed to update the module
3417 function update_module($moduleinfo) {
3420 require_once($CFG->dirroot
. '/course/modlib.php');
3422 // Check the course module exists.
3423 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule
, 0, false, MUST_EXIST
);
3425 // Check the course exists.
3426 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
3428 // Some checks (capaibility / existing instances).
3429 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3431 // Retrieve few information needed by update_moduleinfo.
3432 $moduleinfo->modulename
= $cm->modname
;
3433 if (!isset($moduleinfo->scale
)) {
3434 $moduleinfo->scale
= 0;
3436 $moduleinfo->type
= 'mod';
3438 // Update the module.
3439 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3445 * Duplicate a module on the course for ajax.
3447 * @see mod_duplicate_module()
3448 * @param object $course The course
3449 * @param object $cm The course module to duplicate
3450 * @param int $sr The section to link back to (used for creating the links)
3451 * @throws moodle_exception if the plugin doesn't support duplication
3452 * @return Object containing:
3453 * - fullcontent: The HTML markup for the created CM
3454 * - cmid: The CMID of the newly created CM
3455 * - redirect: Whether to trigger a redirect following this change
3457 function mod_duplicate_activity($course, $cm, $sr = null) {
3460 $newcm = duplicate_module($course, $cm);
3462 $resp = new stdClass();
3465 $format = course_get_format($course);
3466 $renderer = $format->get_renderer($PAGE);
3467 $modinfo = $format->get_modinfo();
3468 $section = $modinfo->get_section_info($newcm->sectionnum
);
3470 // Get the new element html content.
3471 $resp->fullcontent
= $renderer->course_section_updated_cm_item($format, $section, $newcm);
3473 $resp->cmid
= $newcm->id
;
3475 // Trigger a redirect.
3476 $resp->redirect
= true;
3482 * Api to duplicate a module.
3484 * @param object $course course object.
3485 * @param object $cm course module object to be duplicated.
3489 * @throws coding_exception
3490 * @throws moodle_exception
3491 * @throws restore_controller_exception
3493 * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3495 function duplicate_module($course, $cm) {
3496 global $CFG, $DB, $USER;
3497 require_once($CFG->dirroot
. '/backup/util/includes/backup_includes.php');
3498 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
3499 require_once($CFG->libdir
. '/filelib.php');
3501 $a = new stdClass();
3502 $a->modtype
= get_string('modulename', $cm->modname
);
3503 $a->modname
= format_string($cm->name
);
3505 if (!plugin_supports('mod', $cm->modname
, FEATURE_BACKUP_MOODLE2
)) {
3506 throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3509 // Backup the activity.
3511 $bc = new backup_controller(backup
::TYPE_1ACTIVITY
, $cm->id
, backup
::FORMAT_MOODLE
,
3512 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
);
3514 $backupid = $bc->get_backupid();
3515 $backupbasepath = $bc->get_plan()->get_basepath();
3517 $bc->execute_plan();
3521 // Restore the backup immediately.
3523 $rc = new restore_controller($backupid, $course->id
,
3524 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
, backup
::TARGET_CURRENT_ADDING
);
3526 // Make sure that the restore_general_groups setting is always enabled when duplicating an activity.
3527 $plan = $rc->get_plan();
3528 $groupsetting = $plan->get_setting('groups');
3529 if (empty($groupsetting->get_value())) {
3530 $groupsetting->set_value(true);
3533 $cmcontext = context_module
::instance($cm->id
);
3534 if (!$rc->execute_precheck()) {
3535 $precheckresults = $rc->get_precheck_results();
3536 if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3537 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3538 fulldelete($backupbasepath);
3543 $rc->execute_plan();
3545 // Now a bit hacky part follows - we try to get the cmid of the newly
3546 // restored copy of the module.
3548 $tasks = $rc->get_plan()->get_tasks();
3549 foreach ($tasks as $task) {
3550 if (is_subclass_of($task, 'restore_activity_task')) {
3551 if ($task->get_old_contextid() == $cmcontext->id
) {
3552 $newcmid = $task->get_moduleid();
3560 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3561 fulldelete($backupbasepath);
3564 // If we know the cmid of the new course module, let us move it
3565 // right below the original one. otherwise it will stay at the
3566 // end of the section.
3568 // Proceed with activity renaming before everything else. We don't use APIs here to avoid
3569 // triggering a lot of create/update duplicated events.
3570 $newcm = get_coursemodule_from_id($cm->modname
, $newcmid, $cm->course
);
3571 // Add ' (copy)' to duplicates. Note we don't cleanup or validate lengths here. It comes
3572 // from original name that was valid, so the copy should be too.
3573 $newname = get_string('duplicatedmodule', 'moodle', $newcm->name
);
3574 $DB->set_field($cm->modname
, 'name', $newname, ['id' => $newcm->instance
]);
3576 $section = $DB->get_record('course_sections', array('id' => $cm->section
, 'course' => $cm->course
));
3577 $modarray = explode(",", trim($section->sequence
));
3578 $cmindex = array_search($cm->id
, $modarray);
3579 if ($cmindex !== false && $cmindex < count($modarray) - 1) {
3580 moveto_module($newcm, $section, $modarray[$cmindex +
1]);
3583 // Update calendar events with the duplicated module.
3584 // The following line is to be removed in MDL-58906.
3585 course_module_update_calendar_events($newcm->modname
, null, $newcm);
3587 // Trigger course module created event. We can trigger the event only if we know the newcmid.
3588 $newcm = get_fast_modinfo($cm->course
)->get_cm($newcmid);
3589 $event = \core\event\course_module_created
::create_from_cm($newcm);
3593 return isset($newcm) ?
$newcm : null;
3597 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3598 * Sorts by descending order of time.
3600 * @param stdClass $a First object
3601 * @param stdClass $b Second object
3602 * @return int 0,1,-1 representing the order
3604 function compare_activities_by_time_desc($a, $b) {
3605 // Make sure the activities actually have a timestamp property.
3606 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3609 // We treat instances without timestamp as if they have a timestamp of 0.
3610 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3613 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3616 if ($a->timestamp
== $b->timestamp
) {
3619 return ($a->timestamp
> $b->timestamp
) ?
-1 : 1;
3623 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3624 * Sorts by ascending order of time.
3626 * @param stdClass $a First object
3627 * @param stdClass $b Second object
3628 * @return int 0,1,-1 representing the order
3630 function compare_activities_by_time_asc($a, $b) {
3631 // Make sure the activities actually have a timestamp property.
3632 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3635 // We treat instances without timestamp as if they have a timestamp of 0.
3636 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3639 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3642 if ($a->timestamp
== $b->timestamp
) {
3645 return ($a->timestamp
< $b->timestamp
) ?
-1 : 1;
3649 * Changes the visibility of a course.
3651 * @param int $courseid The course to change.
3652 * @param bool $show True to make it visible, false otherwise.
3655 function course_change_visibility($courseid, $show = true) {
3656 $course = new stdClass
;
3657 $course->id
= $courseid;
3658 $course->visible
= ($show) ?
'1' : '0';
3659 $course->visibleold
= $course->visible
;
3660 update_course($course);
3665 * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3667 * @param stdClass|core_course_list_element $course
3668 * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3671 function course_change_sortorder_by_one($course, $up) {
3673 $params = array($course->sortorder
, $course->category
);
3675 $select = 'sortorder < ? AND category = ?';
3676 $sort = 'sortorder DESC';
3678 $select = 'sortorder > ? AND category = ?';
3679 $sort = 'sortorder ASC';
3681 fix_course_sortorder();
3682 $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3684 $swapcourse = reset($swapcourse);
3685 $DB->set_field('course', 'sortorder', $swapcourse->sortorder
, array('id' => $course->id
));
3686 $DB->set_field('course', 'sortorder', $course->sortorder
, array('id' => $swapcourse->id
));
3687 // Finally reorder courses.
3688 fix_course_sortorder();
3689 cache_helper
::purge_by_event('changesincourse');
3696 * Changes the sort order of courses in a category so that the first course appears after the second.
3698 * @param int|stdClass $courseorid The course to focus on.
3699 * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3702 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3705 if (!is_object($courseorid)) {
3706 $course = get_course($courseorid);
3708 $course = $courseorid;
3711 if ((int)$moveaftercourseid === 0) {
3712 // We've moving the course to the start of the queue.
3713 $sql = 'SELECT sortorder
3715 WHERE category = :categoryid
3716 ORDER BY sortorder';
3718 'categoryid' => $course->category
3720 $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE
);
3722 $sql = 'UPDATE {course}
3723 SET sortorder = sortorder + 1
3724 WHERE category = :categoryid
3727 'categoryid' => $course->category
,
3728 'id' => $course->id
,
3730 $DB->execute($sql, $params);
3731 $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id
));
3732 } else if ($course->id
=== $moveaftercourseid) {
3733 // They're the same - moronic.
3734 debugging("Invalid move after course given.", DEBUG_DEVELOPER
);
3737 // Moving this course after the given course. It could be before it could be after.
3738 $moveaftercourse = get_course($moveaftercourseid);
3739 if ($course->category
!== $moveaftercourse->category
) {
3740 debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER
);
3743 // Increment all courses in the same category that are ordered after the moveafter course.
3744 // This makes a space for the course we're moving.
3745 $sql = 'UPDATE {course}
3746 SET sortorder = sortorder + 1
3747 WHERE category = :categoryid
3748 AND sortorder > :sortorder';
3750 'categoryid' => $moveaftercourse->category
,
3751 'sortorder' => $moveaftercourse->sortorder
3753 $DB->execute($sql, $params);
3754 $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder +
1, array('id' => $course->id
));
3756 fix_course_sortorder();
3757 cache_helper
::purge_by_event('changesincourse');
3762 * Trigger course viewed event. This API function is used when course view actions happens,
3763 * usually in course/view.php but also in external functions.
3765 * @param stdClass $context course context object
3766 * @param int $sectionnumber section number
3769 function course_view($context, $sectionnumber = 0) {
3771 $eventdata = array('context' => $context);
3773 if (!empty($sectionnumber)) {
3774 $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3777 $event = \core\event\course_viewed
::create($eventdata);
3780 user_accesstime_log($context->instanceid
);
3784 * Returns courses tagged with a specified tag.
3786 * @param core_tag_tag $tag
3787 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3788 * are displayed on the page and the per-page limit may be bigger
3789 * @param int $fromctx context id where the link was displayed, may be used by callbacks
3790 * to display items in the same context first
3791 * @param int $ctx context id where to search for records
3792 * @param bool $rec search in subcontexts as well
3793 * @param int $page 0-based number of page being displayed
3794 * @return \core_tag\output\tagindex
3796 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3799 $perpage = $exclusivemode ?
$CFG->coursesperpage
: 5;
3800 $displayoptions = array(
3801 'limit' => $perpage,
3802 'offset' => $page * $perpage,
3803 'viewmoreurl' => null,
3806 $courserenderer = $PAGE->get_renderer('core', 'course');
3807 $totalcount = core_course_category
::search_courses_count(array('tagid' => $tag->id
, 'ctx' => $ctx, 'rec' => $rec));
3808 $content = $courserenderer->tagged_courses($tag->id
, $exclusivemode, $ctx, $rec, $displayoptions);
3809 $totalpages = ceil($totalcount / $perpage);
3811 return new core_tag\output\tagindex
($tag, 'core', 'course', $content,
3812 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3816 * Implements callback inplace_editable() allowing to edit values in-place
3818 * @param string $itemtype
3819 * @param int $itemid
3820 * @param mixed $newvalue
3821 * @return \core\output\inplace_editable
3823 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3824 if ($itemtype === 'activityname') {
3825 return \core_courseformat\output\local\content\cm\cmname
::update($itemid, $newvalue);
3830 * This function calculates the minimum and maximum cutoff values for the timestart of
3833 * It will return an array with two values, the first being the minimum cutoff value and
3834 * the second being the maximum cutoff value. Either or both values can be null, which
3835 * indicates there is no minimum or maximum, respectively.
3837 * If a cutoff is required then the function must return an array containing the cutoff
3838 * timestamp and error string to display to the user if the cutoff value is violated.
3840 * A minimum and maximum cutoff return value will look like:
3842 * [1505704373, 'The date must be after this date'],
3843 * [1506741172, 'The date must be before this date']
3846 * @param calendar_event $event The calendar event to get the time range for
3847 * @param stdClass $course The course object to get the range from
3848 * @return array Returns an array with min and max date.
3850 function core_course_core_calendar_get_valid_event_timestart_range(\calendar_event
$event, $course) {
3854 if ($course->startdate
) {
3857 get_string('errorbeforecoursestart', 'calendar')
3861 return [$mindate, $maxdate];
3865 * Render the message drawer to be included in the top of the body of each page.
3867 * @return string HTML
3869 function core_course_drawer(): string {
3871 $format = course_get_format($PAGE->course
);
3873 // Only course and modules are able to render course index.
3874 $ismod = strpos($PAGE->pagetype
, 'mod-') === 0;
3875 if ($ismod ||
$PAGE->pagetype
== 'course-view-' . $format->get_format()) {
3876 $renderer = $format->get_renderer($PAGE);
3877 if (method_exists($renderer, 'course_index_drawer')) {
3878 return $renderer->course_index_drawer($format);
3886 * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3888 * This is a callback used by the tag area core/course_modules to search for course modules
3889 * tagged with a specific tag.
3891 * @param core_tag_tag $tag
3892 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3893 * are displayed on the page and the per-page limit may be bigger
3894 * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3895 * to display items in the same context first
3896 * @param int $contextid context id where to search for records
3897 * @param bool $recursivecontext search in subcontexts as well
3898 * @param int $page 0-based number of page being displayed
3899 * @return \core_tag\output\tagindex
3901 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3902 $recursivecontext = 1, $page = 0) {
3904 $perpage = $exclusivemode ?
20 : 5;
3906 // Build select query.
3907 $ctxselect = context_helper
::get_preload_record_columns_sql('ctx');
3908 $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3909 FROM {course_modules} cm
3910 JOIN {tag_instance} tt ON cm.id = tt.itemid
3911 JOIN {course} c ON cm.course = c.id
3912 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3913 WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3914 AND cm.deletioninprogress = 0
3915 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3917 $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id
, 'component' => 'core',
3918 'coursemodulecontextlevel' => CONTEXT_MODULE
);
3920 $context = context
::instance_by_id($contextid);
3921 $query .= $recursivecontext ?
' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3922 $params['contextid'] = $context->id
;
3923 $params['path'] = $context->path
.'/%';
3926 $query .= ' ORDER BY';
3927 if ($fromcontextid) {
3928 // In order-clause specify that modules from inside "fromctx" context should be returned first.
3929 $fromcontext = context
::instance_by_id($fromcontextid);
3930 $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3931 $params['fromcontextid'] = $fromcontext->id
;
3932 $params['frompath'] = $fromcontext->path
.'/%';
3934 $query .= ' c.sortorder, cm.id';
3935 $totalpages = $page +
1;
3937 // Use core_tag_index_builder to build and filter the list of items.
3938 // Request one item more than we need so we know if next page exists.
3939 $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage +
1);
3940 while ($item = $builder->has_item_that_needs_access_check()) {
3941 context_helper
::preload_from_record($item);
3942 $courseid = $item->courseid
;
3943 if (!$builder->can_access_course($courseid)) {
3944 $builder->set_accessible($item, false);
3947 $modinfo = get_fast_modinfo($builder->get_course($courseid));
3948 // Set accessibility of this item and all other items in the same course.
3949 $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3950 if ($taggeditem->courseid
== $courseid) {
3951 $cm = $modinfo->get_cm($taggeditem->cmid
);
3952 $builder->set_accessible($taggeditem, $cm->uservisible
);
3957 $items = $builder->get_items();
3958 if (count($items) > $perpage) {
3959 $totalpages = $page +
2; // We don't need exact page count, just indicate that the next page exists.
3963 // Build the display contents.
3965 $tagfeed = new core_tag\output\tagfeed
();
3966 foreach ($items as $item) {
3967 context_helper
::preload_from_record($item);
3968 $course = $builder->get_course($item->courseid
);
3969 $modinfo = get_fast_modinfo($course);
3970 $cm = $modinfo->get_cm($item->cmid
);
3971 $courseurl = course_get_url($item->courseid
, $cm->sectionnum
);
3972 $cmname = $cm->get_formatted_name();
3973 if (!$exclusivemode) {
3974 $cmname = shorten_text($cmname, 100);
3976 $cmname = html_writer
::link($cm->url?
:$courseurl, $cmname);
3977 $coursename = format_string($course->fullname
, true,
3978 array('context' => context_course
::instance($item->courseid
)));
3979 $coursename = html_writer
::link($courseurl, $coursename);
3980 $icon = html_writer
::empty_tag('img', array('src' => $cm->get_icon_url()));
3981 $tagfeed->add($icon, $cmname, $coursename);
3984 $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3985 $tagfeed->export_for_template($OUTPUT));
3987 return new core_tag\output\tagindex
($tag, 'core', 'course_modules', $content,
3988 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3993 * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3994 * This function also handles the frontpage course.
3996 * @param stdClass $context context object (it can be a course context or the system context for frontpage settings)
3997 * @param stdClass $course the course where the settings are being rendered
3998 * @return stdClass the navigation options in a course and their availability status
4001 function course_get_user_navigation_options($context, $course = null) {
4004 $isloggedin = isloggedin();
4005 $isguestuser = isguestuser();
4006 $isfrontpage = $context->contextlevel
== CONTEXT_SYSTEM
;
4009 $sitecontext = $context;
4011 $sitecontext = context_system
::instance();
4014 // Sets defaults for all options.
4015 $options = (object) [
4018 'calendar' => false,
4019 'competencies' => false,
4022 'participants' => false,
4027 $options->blogs
= !empty($CFG->enableblogs
) &&
4028 ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL ||
4029 ($CFG->bloglevel
== BLOG_SITE_LEVEL
and ($isloggedin and !$isguestuser)))
4030 && has_capability('moodle/blog:view', $sitecontext);
4032 $options->notes
= !empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
4034 // Frontpage settings?
4036 // We are on the front page, so make sure we use the proper capability (site:viewparticipants).
4037 $options->participants
= course_can_view_participants($sitecontext);
4038 $options->badges
= !empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $sitecontext);
4039 $options->tags
= !empty($CFG->usetags
) && $isloggedin;
4040 $options->search
= !empty($CFG->enableglobalsearch
) && has_capability('moodle/search:query', $sitecontext);
4041 $options->calendar
= $isloggedin;
4043 // We are in a course, so make sure we use the proper capability (course:viewparticipants).
4044 $options->participants
= course_can_view_participants($context);
4045 $options->badges
= !empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
4046 has_capability('moodle/badges:viewbadges', $context);
4047 // Add view grade report is permitted.
4050 if (has_capability('moodle/grade:viewall', $context)) {
4052 } else if (!empty($course->showgrades
)) {
4053 $reports = core_component
::get_plugin_list('gradereport');
4054 if (is_array($reports) && count($reports) > 0) { // Get all installed reports.
4055 arsort($reports); // User is last, we want to test it first.
4056 foreach ($reports as $plugin => $plugindir) {
4057 if (has_capability('gradereport/'.$plugin.':view', $context)) {
4058 // Stop when the first visible plugin is found.
4065 $options->grades
= $grades;
4068 if (\core_competency\api
::is_enabled()) {
4069 $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
4070 $options->competencies
= has_any_capability($capabilities, $context);
4076 * Return an object with the list of administration options in a course that are available or not for the current user.
4077 * This function also handles the frontpage settings.
4079 * @param stdClass $course course object (for frontpage it should be a clone of $SITE)
4080 * @param stdClass $context context object (course context)
4081 * @return stdClass the administration options in a course and their availability status
4084 function course_get_user_administration_options($course, $context) {
4086 $isfrontpage = $course->id
== SITEID
;
4087 $completionenabled = $CFG->enablecompletion
&& $course->enablecompletion
;
4088 $hascompletiontabs = count(core_completion\manager
::get_available_completion_tabs($course, $context)) > 0;
4089 $options = new stdClass
;
4090 $options->update
= has_capability('moodle/course:update', $context);
4091 $options->editcompletion
= $CFG->enablecompletion
&&
4092 $course->enablecompletion
&&
4093 ($options->update ||
$hascompletiontabs);
4094 $options->filters
= has_capability('moodle/filter:manage', $context) &&
4095 count(filter_get_available_in_context($context)) > 0;
4096 $options->reports
= has_capability('moodle/site:viewreports', $context);
4097 $options->backup
= has_capability('moodle/backup:backupcourse', $context);
4098 $options->restore
= has_capability('moodle/restore:restorecourse', $context);
4099 $options->copy
= \core_course\management\helper
::can_copy_course($course->id
);
4100 $options->files
= ($course->legacyfiles
== 2 && has_capability('moodle/course:managefiles', $context));
4102 if (!$isfrontpage) {
4103 $options->tags
= has_capability('moodle/course:tag', $context);
4104 $options->gradebook
= has_capability('moodle/grade:manage', $context);
4105 $options->outcomes
= !empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $context);
4106 $options->badges
= !empty($CFG->enablebadges
);
4107 $options->import
= has_capability('moodle/restore:restoretargetimport', $context);
4108 $options->reset
= has_capability('moodle/course:reset', $context);
4109 $options->roles
= has_capability('moodle/role:switchroles', $context);
4111 // Set default options to false.
4112 $listofoptions = array('tags', 'gradebook', 'outcomes', 'badges', 'import', 'publish', 'reset', 'roles', 'grades');
4114 foreach ($listofoptions as $option) {
4115 $options->$option = false;
4123 * Validates course start and end dates.
4125 * Checks that the end course date is not greater than the start course date.
4127 * $coursedata['startdate'] or $coursedata['enddate'] may not be set, it depends on the form and user input.
4129 * @param array $coursedata May contain startdate and enddate timestamps, depends on the user input.
4130 * @return mixed False if everything alright, error codes otherwise.
4132 function course_validate_dates($coursedata) {
4134 // If both start and end dates are set end date should be later than the start date.
4135 if (!empty($coursedata['startdate']) && !empty($coursedata['enddate']) &&
4136 ($coursedata['enddate'] < $coursedata['startdate'])) {
4137 return 'enddatebeforestartdate';
4140 // If start date is not set end date can not be set.
4141 if (empty($coursedata['startdate']) && !empty($coursedata['enddate'])) {
4142 return 'nostartdatenoenddate';
4149 * Check for course updates in the given context level instances (only modules supported right Now)
4151 * @param stdClass $course course object
4152 * @param array $tocheck instances to check for updates
4153 * @param array $filter check only for updates in these areas
4154 * @return array list of warnings and instances with updates information
4157 function course_check_updates($course, $tocheck, $filter = array()) {
4160 $instances = array();
4161 $warnings = array();
4162 $modulescallbacksupport = array();
4163 $modinfo = get_fast_modinfo($course);
4165 $supportedplugins = get_plugin_list_with_function('mod', 'check_updates_since');
4168 foreach ($tocheck as $instance) {
4169 if ($instance['contextlevel'] == 'module') {
4170 // Check module visibility.
4172 $cm = $modinfo->get_cm($instance['id']);
4173 } catch (Exception
$e) {
4174 $warnings[] = array(
4176 'itemid' => $instance['id'],
4177 'warningcode' => 'cmidnotincourse',
4178 'message' => 'This module id does not belong to this course.'
4183 if (!$cm->uservisible
) {
4184 $warnings[] = array(
4186 'itemid' => $instance['id'],
4187 'warningcode' => 'nonuservisible',
4188 'message' => 'You don\'t have access to this module.'
4192 if (empty($supportedplugins['mod_' . $cm->modname
])) {
4193 $warnings[] = array(
4195 'itemid' => $instance['id'],
4196 'warningcode' => 'missingcallback',
4197 'message' => 'This module does not implement the check_updates_since callback: ' . $instance['contextlevel'],
4201 // Retrieve the module instance.
4202 $instances[] = array(
4203 'contextlevel' => $instance['contextlevel'],
4204 'id' => $instance['id'],
4205 'updates' => call_user_func($cm->modname
. '_check_updates_since', $cm, $instance['since'], $filter)
4209 $warnings[] = array(
4210 'item' => 'contextlevel',
4211 'itemid' => $instance['id'],
4212 'warningcode' => 'contextlevelnotsupported',
4213 'message' => 'Context level not yet supported ' . $instance['contextlevel'],
4217 return array($instances, $warnings);
4221 * This function classifies a course as past, in progress or future.
4223 * This function may incur a DB hit to calculate course completion.
4224 * @param stdClass $course Course record
4225 * @param stdClass $user User record (optional - defaults to $USER).
4226 * @param completion_info $completioninfo Completion record for the user (optional - will be fetched if required).
4227 * @return string (one of COURSE_TIMELINE_FUTURE, COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_PAST)
4229 function course_classify_for_timeline($course, $user = null, $completioninfo = null) {
4232 if ($user == null) {
4238 if (!empty($course->enddate
) && (course_classify_end_date($course) < $today)) {
4239 return COURSE_TIMELINE_PAST
;
4242 if ($completioninfo == null) {
4243 $completioninfo = new completion_info($course);
4246 // Course was completed.
4247 if ($completioninfo->is_enabled() && $completioninfo->is_course_complete($user->id
)) {
4248 return COURSE_TIMELINE_PAST
;
4251 // Start date not reached.
4252 if (!empty($course->startdate
) && (course_classify_start_date($course) > $today)) {
4253 return COURSE_TIMELINE_FUTURE
;
4256 // Everything else is in progress.
4257 return COURSE_TIMELINE_INPROGRESS
;
4261 * This function calculates the end date to use for display classification purposes,
4262 * incorporating the grace period, if any.
4264 * @param stdClass $course The course record.
4265 * @return int The new enddate.
4267 function course_classify_end_date($course) {
4269 $coursegraceperiodafter = (empty($CFG->coursegraceperiodafter
)) ?
0 : $CFG->coursegraceperiodafter
;
4270 $enddate = (new \
DateTimeImmutable())->setTimestamp($course->enddate
)->modify("+{$coursegraceperiodafter} days");
4271 return $enddate->getTimestamp();
4275 * This function calculates the start date to use for display classification purposes,
4276 * incorporating the grace period, if any.
4278 * @param stdClass $course The course record.
4279 * @return int The new startdate.
4281 function course_classify_start_date($course) {
4283 $coursegraceperiodbefore = (empty($CFG->coursegraceperiodbefore
)) ?
0 : $CFG->coursegraceperiodbefore
;
4284 $startdate = (new \
DateTimeImmutable())->setTimestamp($course->startdate
)->modify("-{$coursegraceperiodbefore} days");
4285 return $startdate->getTimestamp();
4289 * Group a list of courses into either past, future, or in progress.
4291 * The return value will be an array indexed by the COURSE_TIMELINE_* constants
4292 * with each value being an array of courses in that group.
4295 * COURSE_TIMELINE_PAST => [... list of past courses ...],
4296 * COURSE_TIMELINE_FUTURE => [],
4297 * COURSE_TIMELINE_INPROGRESS => []
4300 * @param array $courses List of courses to be grouped.
4303 function course_classify_courses_for_timeline(array $courses) {
4304 return array_reduce($courses, function($carry, $course) {
4305 $classification = course_classify_for_timeline($course);
4306 array_push($carry[$classification], $course);
4310 COURSE_TIMELINE_PAST
=> [],
4311 COURSE_TIMELINE_FUTURE
=> [],
4312 COURSE_TIMELINE_INPROGRESS
=> []
4317 * Get the list of enrolled courses for the current user.
4319 * This function returns a Generator. The courses will be loaded from the database
4320 * in chunks rather than a single query.
4322 * @param int $limit Restrict result set to this amount
4323 * @param int $offset Skip this number of records from the start of the result set
4324 * @param string|null $sort SQL string for sorting
4325 * @param string|null $fields SQL string for fields to be returned
4326 * @param int $dbquerylimit The number of records to load per DB request
4327 * @param array $includecourses courses ids to be restricted
4328 * @param array $hiddencourses courses ids to be excluded
4331 function course_get_enrolled_courses_for_logged_in_user(
4334 string $sort = null,
4335 string $fields = null,
4336 int $dbquerylimit = COURSE_DB_QUERY_LIMIT
,
4337 array $includecourses = [],
4338 array $hiddencourses = []
4341 $haslimit = !empty($limit);
4343 $querylimit = (!$haslimit ||
$limit > $dbquerylimit) ?
$dbquerylimit : $limit;
4345 while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, $includecourses, false, $offset, $hiddencourses)) {
4346 yield from
$courses;
4348 $recordsloaded +
= $querylimit;
4350 if (count($courses) < $querylimit) {
4353 if ($haslimit && $recordsloaded >= $limit) {
4357 $offset +
= $querylimit;
4362 * Get the list of enrolled courses the current user searched for.
4364 * This function returns a Generator. The courses will be loaded from the database
4365 * in chunks rather than a single query.
4367 * @param int $limit Restrict result set to this amount
4368 * @param int $offset Skip this number of records from the start of the result set
4369 * @param string|null $sort SQL string for sorting
4370 * @param string|null $fields SQL string for fields to be returned
4371 * @param int $dbquerylimit The number of records to load per DB request
4372 * @param array $searchcriteria contains search criteria
4373 * @param array $options display options, same as in get_courses() except 'recursive' is ignored -
4374 * search is always category-independent
4377 function course_get_enrolled_courses_for_logged_in_user_from_search(
4380 string $sort = null,
4381 string $fields = null,
4382 int $dbquerylimit = COURSE_DB_QUERY_LIMIT
,
4383 array $searchcriteria = [],
4387 $haslimit = !empty($limit);
4389 $querylimit = (!$haslimit ||
$limit > $dbquerylimit) ?
$dbquerylimit : $limit;
4390 $ids = core_course_category
::search_courses($searchcriteria, $options);
4392 // If no courses were found matching the criteria return back.
4397 while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, $ids, false, $offset)) {
4398 yield from
$courses;
4400 $recordsloaded +
= $querylimit;
4402 if (count($courses) < $querylimit) {
4405 if ($haslimit && $recordsloaded >= $limit) {
4409 $offset +
= $querylimit;
4414 * Search the given $courses for any that match the given $classification up to the specified
4417 * This function will return the subset of courses that match the classification as well as the
4418 * number of courses it had to process to build that subset.
4420 * It is recommended that for larger sets of courses this function is given a Generator that loads
4421 * the courses from the database in chunks.
4423 * @param array|Traversable $courses List of courses to process
4424 * @param string $classification One of the COURSE_TIMELINE_* constants
4425 * @param int $limit Limit the number of results to this amount
4426 * @return array First value is the filtered courses, second value is the number of courses processed
4428 function course_filter_courses_by_timeline_classification(
4430 string $classification,
4434 if (!in_array($classification,
4435 [COURSE_TIMELINE_ALLINCLUDINGHIDDEN
, COURSE_TIMELINE_ALL
, COURSE_TIMELINE_PAST
, COURSE_TIMELINE_INPROGRESS
,
4436 COURSE_TIMELINE_FUTURE
, COURSE_TIMELINE_HIDDEN
, COURSE_TIMELINE_SEARCH
])) {
4437 $message = 'Classification must be one of COURSE_TIMELINE_ALLINCLUDINGHIDDEN, COURSE_TIMELINE_ALL, COURSE_TIMELINE_PAST, '
4438 . 'COURSE_TIMELINE_INPROGRESS, COURSE_TIMELINE_SEARCH or COURSE_TIMELINE_FUTURE';
4439 throw new moodle_exception($message);
4442 $filteredcourses = [];
4443 $numberofcoursesprocessed = 0;
4446 foreach ($courses as $course) {
4447 $numberofcoursesprocessed++
;
4448 $pref = get_user_preferences('block_myoverview_hidden_course_' . $course->id
, 0);
4450 // Added as of MDL-63457 toggle viewability for each user.
4451 if ($classification == COURSE_TIMELINE_ALLINCLUDINGHIDDEN ||
($classification == COURSE_TIMELINE_HIDDEN
&& $pref) ||
4452 $classification == COURSE_TIMELINE_SEARCH||
4453 (($classification == COURSE_TIMELINE_ALL ||
$classification == course_classify_for_timeline($course)) && !$pref)) {
4454 $filteredcourses[] = $course;
4458 if ($limit && $filtermatches >= $limit) {
4459 // We've found the number of requested courses. No need to continue searching.
4464 // Return the number of filtered courses as well as the number of courses that were searched
4465 // in order to find the matching courses. This allows the calling code to do some kind of
4467 return [$filteredcourses, $numberofcoursesprocessed];
4471 * Search the given $courses for any that match the given $classification up to the specified
4474 * This function will return the subset of courses that are favourites as well as the
4475 * number of courses it had to process to build that subset.
4477 * It is recommended that for larger sets of courses this function is given a Generator that loads
4478 * the courses from the database in chunks.
4480 * @param array|Traversable $courses List of courses to process
4481 * @param array $favouritecourseids Array of favourite courses.
4482 * @param int $limit Limit the number of results to this amount
4483 * @return array First value is the filtered courses, second value is the number of courses processed
4485 function course_filter_courses_by_favourites(
4487 $favouritecourseids,
4491 $filteredcourses = [];
4492 $numberofcoursesprocessed = 0;
4495 foreach ($courses as $course) {
4496 $numberofcoursesprocessed++
;
4498 if (in_array($course->id
, $favouritecourseids)) {
4499 $filteredcourses[] = $course;
4503 if ($limit && $filtermatches >= $limit) {
4504 // We've found the number of requested courses. No need to continue searching.
4509 // Return the number of filtered courses as well as the number of courses that were searched
4510 // in order to find the matching courses. This allows the calling code to do some kind of
4512 return [$filteredcourses, $numberofcoursesprocessed];
4516 * Search the given $courses for any that have a $customfieldname value that matches the given
4517 * $customfieldvalue, up to the specified $limit.
4519 * This function will return the subset of courses that matches the value as well as the
4520 * number of courses it had to process to build that subset.
4522 * It is recommended that for larger sets of courses this function is given a Generator that loads
4523 * the courses from the database in chunks.
4525 * @param array|Traversable $courses List of courses to process
4526 * @param string $customfieldname the shortname of the custom field to match against
4527 * @param string $customfieldvalue the value this custom field needs to match
4528 * @param int $limit Limit the number of results to this amount
4529 * @return array First value is the filtered courses, second value is the number of courses processed
4531 function course_filter_courses_by_customfield(
4543 // Prepare the list of courses to search through.
4545 foreach ($courses as $course) {
4546 $coursesbyid[$course->id
] = $course;
4548 if (!$coursesbyid) {
4551 list($csql, $params) = $DB->get_in_or_equal(array_keys($coursesbyid), SQL_PARAMS_NAMED
);
4553 // Get the id of the custom field.
4556 FROM {customfield_field} f
4557 JOIN {customfield_category} cat ON cat.id = f.categoryid
4558 WHERE f.shortname = ?
4559 AND cat.component = 'core_course'
4560 AND cat.area = 'course'
4562 $fieldid = $DB->get_field_sql($sql, [$customfieldname]);
4567 // Get a list of courseids that match that custom field value.
4568 if ($customfieldvalue == COURSE_CUSTOMFIELD_EMPTY
) {
4569 $comparevalue = $DB->sql_compare_text('cd.value');
4573 LEFT JOIN {customfield_data} cd ON cd.instanceid = c.id AND cd.fieldid = :fieldid
4575 AND (cd.value IS NULL OR $comparevalue = '' OR $comparevalue = '0')
4577 $params['fieldid'] = $fieldid;
4578 $matchcourseids = $DB->get_fieldset_sql($sql, $params);
4580 $comparevalue = $DB->sql_compare_text('value');
4581 $select = "fieldid = :fieldid AND $comparevalue = :customfieldvalue AND instanceid $csql";
4582 $params['fieldid'] = $fieldid;
4583 $params['customfieldvalue'] = $customfieldvalue;
4584 $matchcourseids = $DB->get_fieldset_select('customfield_data', 'instanceid', $select, $params);
4587 // Prepare the list of courses to return.
4588 $filteredcourses = [];
4589 $numberofcoursesprocessed = 0;
4592 foreach ($coursesbyid as $course) {
4593 $numberofcoursesprocessed++
;
4595 if (in_array($course->id
, $matchcourseids)) {
4596 $filteredcourses[] = $course;
4600 if ($limit && $filtermatches >= $limit) {
4601 // We've found the number of requested courses. No need to continue searching.
4606 // Return the number of filtered courses as well as the number of courses that were searched
4607 // in order to find the matching courses. This allows the calling code to do some kind of
4609 return [$filteredcourses, $numberofcoursesprocessed];
4613 * Check module updates since a given time.
4614 * This function checks for updates in the module config, file areas, completion, grades, comments and ratings.
4616 * @param cm_info $cm course module data
4617 * @param int $from the time to check
4618 * @param array $fileareas additional file ares to check
4619 * @param array $filter if we need to filter and return only selected updates
4620 * @return stdClass object with the different updates
4623 function course_check_module_updates_since($cm, $from, $fileareas = array(), $filter = array()) {
4624 global $DB, $CFG, $USER;
4626 $context = $cm->context
;
4627 $mod = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
4629 $updates = new stdClass();
4630 $course = get_course($cm->course
);
4631 $component = 'mod_' . $cm->modname
;
4633 // Check changes in the module configuration.
4634 if (isset($mod->timemodified
) and (empty($filter) or in_array('configuration', $filter))) {
4635 $updates->configuration
= (object) array('updated' => false);
4636 if ($updates->configuration
->updated
= $mod->timemodified
> $from) {
4637 $updates->configuration
->timeupdated
= $mod->timemodified
;
4641 // Check for updates in files.
4642 if (plugin_supports('mod', $cm->modname
, FEATURE_MOD_INTRO
)) {
4643 $fileareas[] = 'intro';
4645 if (!empty($fileareas) and (empty($filter) or in_array('fileareas', $filter))) {
4646 $fs = get_file_storage();
4647 $files = $fs->get_area_files($context->id
, $component, $fileareas, false, "filearea, timemodified DESC", false, $from);
4648 foreach ($fileareas as $filearea) {
4649 $updates->{$filearea . 'files'} = (object) array('updated' => false);
4651 foreach ($files as $file) {
4652 $updates->{$file->get_filearea() . 'files'}->updated
= true;
4653 $updates->{$file->get_filearea() . 'files'}->itemids
[] = $file->get_id();
4657 // Check completion.
4658 $supportcompletion = plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_HAS_RULES
);
4659 $supportcompletion = $supportcompletion or plugin_supports('mod', $cm->modname
, FEATURE_COMPLETION_TRACKS_VIEWS
);
4660 if ($supportcompletion and (empty($filter) or in_array('completion', $filter))) {
4661 $updates->completion
= (object) array('updated' => false);
4662 $completion = new completion_info($course);
4663 // Use wholecourse to cache all the modules the first time.
4664 $completiondata = $completion->get_data($cm, true);
4665 if ($updates->completion
->updated
= !empty($completiondata->timemodified
) && $completiondata->timemodified
> $from) {
4666 $updates->completion
->timemodified
= $completiondata->timemodified
;
4671 $supportgrades = plugin_supports('mod', $cm->modname
, FEATURE_GRADE_HAS_GRADE
);
4672 $supportgrades = $supportgrades or plugin_supports('mod', $cm->modname
, FEATURE_GRADE_OUTCOMES
);
4673 if ($supportgrades and (empty($filter) or (in_array('gradeitems', $filter) or in_array('outcomes', $filter)))) {
4674 require_once($CFG->libdir
. '/gradelib.php');
4675 $grades = grade_get_grades($course->id
, 'mod', $cm->modname
, $mod->id
, $USER->id
);
4677 if (empty($filter) or in_array('gradeitems', $filter)) {
4678 $updates->gradeitems
= (object) array('updated' => false);
4679 foreach ($grades->items
as $gradeitem) {
4680 foreach ($gradeitem->grades
as $grade) {
4681 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4682 $updates->gradeitems
->updated
= true;
4683 $updates->gradeitems
->itemids
[] = $gradeitem->id
;
4689 if (empty($filter) or in_array('outcomes', $filter)) {
4690 $updates->outcomes
= (object) array('updated' => false);
4691 foreach ($grades->outcomes
as $outcome) {
4692 foreach ($outcome->grades
as $grade) {
4693 if ($grade->datesubmitted
> $from or $grade->dategraded
> $from) {
4694 $updates->outcomes
->updated
= true;
4695 $updates->outcomes
->itemids
[] = $outcome->id
;
4703 if (plugin_supports('mod', $cm->modname
, FEATURE_COMMENT
) and (empty($filter) or in_array('comments', $filter))) {
4704 $updates->comments
= (object) array('updated' => false);
4705 require_once($CFG->dirroot
. '/comment/lib.php');
4706 require_once($CFG->dirroot
. '/comment/locallib.php');
4707 $manager = new comment_manager();
4708 $comments = $manager->get_component_comments_since($course, $context, $component, $from, $cm);
4709 if (!empty($comments)) {
4710 $updates->comments
->updated
= true;
4711 $updates->comments
->itemids
= array_keys($comments);
4716 if (plugin_supports('mod', $cm->modname
, FEATURE_RATE
) and (empty($filter) or in_array('ratings', $filter))) {
4717 $updates->ratings
= (object) array('updated' => false);
4718 require_once($CFG->dirroot
. '/rating/lib.php');
4719 $manager = new rating_manager();
4720 $ratings = $manager->get_component_ratings_since($context, $component, $from);
4721 if (!empty($ratings)) {
4722 $updates->ratings
->updated
= true;
4723 $updates->ratings
->itemids
= array_keys($ratings);
4731 * Returns true if the user can view the participant page, false otherwise,
4733 * @param context $context The context we are checking.
4736 function course_can_view_participants($context) {
4737 $viewparticipantscap = 'moodle/course:viewparticipants';
4738 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4739 $viewparticipantscap = 'moodle/site:viewparticipants';
4742 return has_any_capability([$viewparticipantscap, 'moodle/course:enrolreview'], $context);
4746 * Checks if a user can view the participant page, if not throws an exception.
4748 * @param context $context The context we are checking.
4749 * @throws required_capability_exception
4751 function course_require_view_participants($context) {
4752 if (!course_can_view_participants($context)) {
4753 $viewparticipantscap = 'moodle/course:viewparticipants';
4754 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4755 $viewparticipantscap = 'moodle/site:viewparticipants';
4757 throw new required_capability_exception($context, $viewparticipantscap, 'nopermissions', '');
4762 * Return whether the user can download from the specified backup file area in the given context.
4764 * @param string $filearea the backup file area. E.g. 'course', 'backup' or 'automated'.
4765 * @param \context $context
4766 * @param stdClass $user the user object. If not provided, the current user will be checked.
4767 * @return bool true if the user is allowed to download in the context, false otherwise.
4769 function can_download_from_backup_filearea($filearea, \context
$context, stdClass
$user = null) {
4770 $candownload = false;
4771 switch ($filearea) {
4774 $candownload = has_capability('moodle/backup:downloadfile', $context, $user);
4777 // Given the automated backups may contain userinfo, we restrict access such that only users who are able to
4778 // restore with userinfo are able to download the file. Users can't create these backups, so checking 'backup:userinfo'
4779 // doesn't make sense here.
4780 $candownload = has_capability('moodle/backup:downloadfile', $context, $user) &&
4781 has_capability('moodle/restore:userinfo', $context, $user);
4787 return $candownload;
4791 * Get a list of hidden courses
4793 * @param int|object|null $user User override to get the filter from. Defaults to current user
4794 * @return array $ids List of hidden courses
4795 * @throws coding_exception
4797 function get_hidden_courses_on_timeline($user = null) {
4804 $preferences = get_user_preferences(null, null, $user);
4806 foreach ($preferences as $key => $value) {
4807 if (preg_match('/block_myoverview_hidden_course_(\d)+/', $key)) {
4808 $id = preg_split('/block_myoverview_hidden_course_/', $key);
4817 * Returns a list of the most recently courses accessed by a user
4819 * @param int $userid User id from which the courses will be obtained
4820 * @param int $limit Restrict result set to this amount
4821 * @param int $offset Skip this number of records from the start of the result set
4822 * @param string|null $sort SQL string for sorting
4825 function course_get_recent_courses(int $userid = null, int $limit = 0, int $offset = 0, string $sort = null) {
4827 global $CFG, $USER, $DB;
4829 if (empty($userid)) {
4830 $userid = $USER->id
;
4834 'id', 'idnumber', 'summary', 'summaryformat', 'startdate', 'enddate', 'category',
4835 'shortname', 'fullname', 'timeaccess', 'component', 'visible',
4836 'showactivitydates', 'showcompletionconditions',
4840 $sort = 'timeaccess DESC';
4842 // The SQL string for sorting can define sorting by multiple columns.
4843 $rawsorts = explode(',', $sort);
4845 // Validate and trim the sort parameters in the SQL string for sorting.
4846 foreach ($rawsorts as $rawsort) {
4847 $sort = trim($rawsort);
4848 $sortparams = explode(' ', $sort);
4849 // A valid sort statement can not have more than 2 params (ex. 'summary desc' or 'timeaccess').
4850 if (count($sortparams) > 2) {
4851 throw new invalid_parameter_exception(
4852 'Invalid structure of the sort parameter, allowed structure: fieldname [ASC|DESC].');
4854 $sortfield = trim($sortparams[0]);
4855 // Validate the value which defines the field to sort by.
4856 if (!in_array($sortfield, $basefields)) {
4857 throw new invalid_parameter_exception('Invalid field in the sort parameter, allowed fields: ' .
4858 implode(', ', $basefields) . '.');
4860 $sortdirection = isset($sortparams[1]) ?
trim($sortparams[1]) : '';
4861 // Validate the value which defines the sort direction (if present).
4862 $allowedsortdirections = ['asc', 'desc'];
4863 if (!empty($sortdirection) && !in_array(strtolower($sortdirection), $allowedsortdirections)) {
4864 throw new invalid_parameter_exception('Invalid sort direction in the sort parameter, allowed values: ' .
4865 implode(', ', $allowedsortdirections) . '.');
4869 $sort = implode(',', $sorts);
4872 $ctxfields = context_helper
::get_preload_record_columns_sql('ctx');
4874 $coursefields = 'c.' . join(',', $basefields);
4876 // Ask the favourites service to give us the join SQL for favourited courses,
4877 // so we can include favourite information in the query.
4878 $usercontext = \context_user
::instance($userid);
4879 $favservice = \core_favourites\service_factory
::get_service_for_user_context($usercontext);
4880 list($favsql, $favparams) = $favservice->get_join_sql_by_type('core_course', 'courses', 'fav', 'ul.courseid');
4882 $sql = "SELECT $coursefields, $ctxfields
4885 ON ctx.contextlevel = :contextlevel
4886 AND ctx.instanceid = c.id
4887 JOIN {user_lastaccess} ul
4888 ON ul.courseid = c.id
4890 LEFT JOIN {enrol} eg ON eg.courseid = c.id AND eg.status = :statusenrolg AND eg.enrol = :guestenrol
4891 WHERE ul.userid = :userid
4892 AND c.visible = :visible
4893 AND (eg.id IS NOT NULL
4894 OR EXISTS (SELECT e.id
4896 JOIN {user_enrolments} ue ON ue.enrolid = e.id
4897 WHERE e.courseid = c.id
4898 AND e.status = :statusenrol
4899 AND ue.status = :status
4900 AND ue.userid = :userid2
4901 AND ue.timestart < :now1
4902 AND (ue.timeend = 0 OR ue.timeend > :now2)
4906 $now = round(time(), -2); // Improves db caching.
4907 $params = ['userid' => $userid, 'contextlevel' => CONTEXT_COURSE
, 'visible' => 1, 'status' => ENROL_USER_ACTIVE
,
4908 'statusenrol' => ENROL_INSTANCE_ENABLED
, 'guestenrol' => 'guest', 'now1' => $now, 'now2' => $now,
4909 'userid2' => $userid, 'statusenrolg' => ENROL_INSTANCE_ENABLED
] +
$favparams;
4911 $recentcourses = $DB->get_records_sql($sql, $params, $offset, $limit);
4913 // Filter courses if last access field is hidden.
4914 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
4916 if ($userid != $USER->id
&& isset($hiddenfields['lastaccess'])) {
4917 $recentcourses = array_filter($recentcourses, function($course) {
4918 context_helper
::preload_from_record($course);
4919 $context = context_course
::instance($course->id
, IGNORE_MISSING
);
4920 // If last access was a hidden field, a user requesting info about another user would need permission to view hidden
4922 return has_capability('moodle/course:viewhiddenuserfields', $context);
4926 return $recentcourses;
4930 * Calculate the course start date and offset for the given user ids.
4932 * If the course is a fixed date course then the course start date will be returned.
4933 * If the course is a relative date course then the course date will be calculated and
4934 * and offset provided.
4936 * The dates are returned as an array with the index being the user id. The array
4937 * contains the start date and start offset values for the user.
4939 * If the user is not enrolled in the course then the course start date will be returned.
4941 * If we have a course which starts on 1563244000 and 2 users, id 123 and 456, where the
4942 * former is enrolled in the course at 1563244693 and the latter is not enrolled then the
4943 * return value would look like:
4946 * 'start' => 1563244693,
4947 * 'startoffset' => 693
4950 * 'start' => 1563244000,
4951 * 'startoffset' => 0
4955 * @param stdClass $course The course to fetch dates for.
4956 * @param array $userids The list of user ids to get dates for.
4959 function course_get_course_dates_for_user_ids(stdClass
$course, array $userids): array {
4960 if (empty($course->relativedatesmode
)) {
4961 // This course isn't set to relative dates so we can early return with the course
4963 return array_reduce($userids, function($carry, $userid) use ($course) {
4965 'start' => $course->startdate
,
4972 // We're dealing with a relative dates course now so we need to calculate some dates.
4973 $cache = cache
::make('core', 'course_user_dates');
4975 $uncacheduserids = [];
4977 // Try fetching the values from the cache so that we don't need to do a DB request.
4978 foreach ($userids as $userid) {
4979 $cachekey = "{$course->id}_{$userid}";
4980 $cachedvalue = $cache->get($cachekey);
4982 if ($cachedvalue === false) {
4983 // Looks like we haven't seen this user for this course before so we'll have
4985 $uncacheduserids[] = $userid;
4987 [$start, $startoffset] = $cachedvalue;
4990 'startoffset' => $startoffset
4995 if (!empty($uncacheduserids)) {
4996 // Load the enrolments for any users we haven't seen yet. Set the "onlyactive" param
4997 // to false because it filters out users with enrolment start times in the future which
4999 $enrolments = enrol_get_course_users($course->id
, false, $uncacheduserids);
5001 foreach ($uncacheduserids as $userid) {
5002 // Find the user enrolment that has the earliest start date.
5003 $enrolment = array_reduce(array_values($enrolments), function($carry, $enrolment) use ($userid) {
5004 // Only consider enrolments for this user if the user enrolment is active and the
5005 // enrolment method is enabled.
5007 $enrolment->uestatus
== ENROL_USER_ACTIVE
&&
5008 $enrolment->estatus
== ENROL_INSTANCE_ENABLED
&&
5009 $enrolment->id
== $userid
5011 if (is_null($carry)) {
5012 // Haven't found an enrolment yet for this user so use the one we just found.
5013 $carry = $enrolment;
5015 // We've already found an enrolment for this user so let's use which ever one
5016 // has the earliest start time.
5017 $carry = $carry->uetimestart
< $enrolment->uetimestart ?
$carry : $enrolment;
5025 // The course is in relative dates mode so we calculate the student's start
5026 // date based on their enrolment start date.
5027 $start = $course->startdate
> $enrolment->uetimestart ?
$course->startdate
: $enrolment->uetimestart
;
5028 $startoffset = $start - $course->startdate
;
5030 // The user is not enrolled in the course so default back to the course start date.
5031 $start = $course->startdate
;
5037 'startoffset' => $startoffset
5040 $cachekey = "{$course->id}_{$userid}";
5041 $cache->set($cachekey, [$start, $startoffset]);
5049 * Calculate the course start date and offset for the given user id.
5051 * If the course is a fixed date course then the course start date will be returned.
5052 * If the course is a relative date course then the course date will be calculated and
5053 * and offset provided.
5055 * The return array contains the start date and start offset values for the user.
5057 * If the user is not enrolled in the course then the course start date will be returned.
5059 * If we have a course which starts on 1563244000. If a user's enrolment starts on 1563244693
5060 * then the return would be:
5062 * 'start' => 1563244693,
5063 * 'startoffset' => 693
5066 * If the use was not enrolled then the return would be:
5068 * 'start' => 1563244000,
5069 * 'startoffset' => 0
5072 * @param stdClass $course The course to fetch dates for.
5073 * @param int $userid The user id to get dates for.
5076 function course_get_course_dates_for_user_id(stdClass
$course, int $userid): array {
5077 return (course_get_course_dates_for_user_ids($course, [$userid]))[$userid];
5081 * Renders the course copy form for the modal on the course management screen.
5083 * @param array $args
5084 * @return string $o Form HTML.
5086 function course_output_fragment_new_base_form($args) {
5088 $serialiseddata = json_decode($args['jsonformdata'], true);
5090 if (!empty($serialiseddata)) {
5091 parse_str($serialiseddata, $formdata);
5094 $context = context_course
::instance($args['courseid']);
5095 $copycaps = \core_course\management\helper
::get_course_copy_capabilities();
5096 require_all_capabilities($copycaps, $context);
5098 $course = get_course($args['courseid']);
5099 $mform = new \core_backup\output\
copy_form(
5101 array('course' => $course, 'returnto' => '', 'returnurl' => ''),
5102 'post', '', ['class' => 'ignoredirty'], true, $formdata);
5104 if (!empty($serialiseddata)) {
5105 // If we were passed non-empty form data we want the mform to call validation functions and show errors.
5106 $mform->is_validated();
5111 $o = ob_get_contents();