2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Library of useful functions
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 * @package core_course
25 defined('MOODLE_INTERNAL') ||
die;
27 require_once($CFG->libdir
.'/completionlib.php');
28 require_once($CFG->libdir
.'/filelib.php');
29 require_once($CFG->dirroot
.'/course/format/lib.php');
31 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
32 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
35 * Number of courses to display when summaries are included.
37 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
39 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
41 // Max courses in log dropdown before switching to optional.
42 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
43 // Max users in log dropdown before switching to optional.
44 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
45 define('FRONTPAGENEWS', '0');
46 define('FRONTPAGECATEGORYNAMES', '2');
47 define('FRONTPAGECATEGORYCOMBO', '4');
48 define('FRONTPAGEENROLLEDCOURSELIST', '5');
49 define('FRONTPAGEALLCOURSELIST', '6');
50 define('FRONTPAGECOURSESEARCH', '7');
51 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 function make_log_url($module, $url) {
61 if (strpos($url, 'report/') === 0) {
62 // there is only one report type, course reports are deprecated
72 if (strpos($url, '../') === 0) {
73 $url = ltrim($url, '.');
75 $url = "/course/$url";
79 $url = "/calendar/$url";
83 $url = "/$module/$url";
96 $url = "/message/$url";
108 $url = "/grade/$url";
111 $url = "/mod/$module/$url";
115 //now let's sanitise urls - there might be some ugly nasties:-(
116 $parts = explode('?', $url);
117 $script = array_shift($parts);
118 if (strpos($script, 'http') === 0) {
119 $script = clean_param($script, PARAM_URL
);
121 $script = clean_param($script, PARAM_PATH
);
126 $query = implode('', $parts);
127 $query = str_replace('&', '&', $query); // both & and & are stored in db :-|
128 $parts = explode('&', $query);
129 $eq = urlencode('=');
130 foreach ($parts as $key=>$part) {
131 $part = urlencode(urldecode($part));
132 $part = str_replace($eq, '=', $part);
133 $parts[$key] = $part;
135 $query = '?'.implode('&', $parts);
138 return $script.$query;
142 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
143 $modname="", $modid=0, $modaction="", $groupid=0) {
146 // It is assumed that $date is the GMT time of midnight for that day,
147 // and so the next 86400 seconds worth of logs are printed.
149 /// Setup for group handling.
151 // TODO: I don't understand group/context/etc. enough to be able to do
152 // something interesting with it here
153 // What is the context of a remote course?
155 /// If the group mode is separate, and this user does not have editing privileges,
156 /// then only the user's group can be viewed.
157 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
158 // $groupid = get_current_group($course->id);
160 /// If this course doesn't have groups, no groupid can be specified.
161 //else if (!$course->groupmode) {
170 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
172 LEFT JOIN {user} u ON l.userid = u.id
176 $where .= "l.hostid = :hostid";
177 $params['hostid'] = $hostid;
179 // TODO: Is 1 really a magic number referring to the sitename?
180 if ($course != SITEID ||
$modid != 0) {
181 $where .= " AND l.course=:courseid";
182 $params['courseid'] = $course;
186 $where .= " AND l.module = :modname";
187 $params['modname'] = $modname;
190 if ('site_errors' === $modid) {
191 $where .= " AND ( l.action='error' OR l.action='infected' )";
193 //TODO: This assumes that modids are the same across sites... probably
195 $where .= " AND l.cmid = :modid";
196 $params['modid'] = $modid;
200 $firstletter = substr($modaction, 0, 1);
201 if ($firstletter == '-') {
202 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
203 $params['modaction'] = '%'.substr($modaction, 1).'%';
205 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
206 $params['modaction'] = '%'.$modaction.'%';
211 $where .= " AND l.userid = :user";
212 $params['user'] = $user;
216 $enddate = $date +
86400;
217 $where .= " AND l.time > :date AND l.time < :enddate";
218 $params['date'] = $date;
219 $params['enddate'] = $enddate;
223 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
224 if(!empty($result['totalcount'])) {
225 $where .= " ORDER BY $order";
226 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
228 $result['logs'] = array();
233 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
234 $modname="", $modid=0, $modaction="", $groupid=0) {
235 global $DB, $SESSION, $USER;
236 // It is assumed that $date is the GMT time of midnight for that day,
237 // and so the next 86400 seconds worth of logs are printed.
239 /// Setup for group handling.
241 /// If the group mode is separate, and this user does not have editing privileges,
242 /// then only the user's group can be viewed.
243 if ($course->groupmode
== SEPARATEGROUPS
and !has_capability('moodle/course:managegroups', context_course
::instance($course->id
))) {
244 if (isset($SESSION->currentgroup
[$course->id
])) {
245 $groupid = $SESSION->currentgroup
[$course->id
];
247 $groupid = groups_get_all_groups($course->id
, $USER->id
);
248 if (is_array($groupid)) {
249 $groupid = array_shift(array_keys($groupid));
250 $SESSION->currentgroup
[$course->id
] = $groupid;
256 /// If this course doesn't have groups, no groupid can be specified.
257 else if (!$course->groupmode
) {
264 if ($course->id
!= SITEID ||
$modid != 0) {
265 $joins[] = "l.course = :courseid";
266 $params['courseid'] = $course->id
;
270 $joins[] = "l.module = :modname";
271 $params['modname'] = $modname;
274 if ('site_errors' === $modid) {
275 $joins[] = "( l.action='error' OR l.action='infected' )";
277 $joins[] = "l.cmid = :modid";
278 $params['modid'] = $modid;
282 $firstletter = substr($modaction, 0, 1);
283 if ($firstletter == '-') {
284 $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
285 $params['modaction'] = '%'.substr($modaction, 1).'%';
287 $joins[] = $DB->sql_like('l.action', ':modaction', false);
288 $params['modaction'] = '%'.$modaction.'%';
293 /// Getting all members of a group.
294 if ($groupid and !$user) {
295 if ($gusers = groups_get_members($groupid)) {
296 $gusers = array_keys($gusers);
297 $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
299 $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
303 $joins[] = "l.userid = :userid";
304 $params['userid'] = $user;
308 $enddate = $date +
86400;
309 $joins[] = "l.time > :date AND l.time < :enddate";
310 $params['date'] = $date;
311 $params['enddate'] = $enddate;
314 $selector = implode(' AND ', $joins);
316 $totalcount = 0; // Initialise
318 $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
319 $result['totalcount'] = $totalcount;
324 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
325 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
327 global $CFG, $DB, $OUTPUT;
329 if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
330 $modname, $modid, $modaction, $groupid)) {
331 echo $OUTPUT->notification("No logs found!");
332 echo $OUTPUT->footer();
338 if ($course->id
== SITEID
) {
340 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
341 foreach ($ccc as $cc) {
342 $courses[$cc->id
] = $cc->shortname
;
346 $courses[$course->id
] = $course->shortname
;
349 $totalcount = $logs['totalcount'];
352 $tt = getdate(time());
353 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
355 $strftimedatetime = get_string("strftimedatetime");
357 echo "<div class=\"info\">\n";
358 print_string("displayingrecords", "", $totalcount);
361 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
363 $table = new html_table();
364 $table->classes
= array('logtable','generaltable');
365 $table->align
= array('right', 'left', 'left');
366 $table->head
= array(
368 get_string('ip_address'),
369 get_string('fullnameuser'),
370 get_string('action'),
373 $table->data
= array();
375 if ($course->id
== SITEID
) {
376 array_unshift($table->align
, 'left');
377 array_unshift($table->head
, get_string('course'));
380 // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
381 if (empty($logs['logs'])) {
382 $logs['logs'] = array();
385 foreach ($logs['logs'] as $log) {
387 if (isset($ldcache[$log->module
][$log->action
])) {
388 $ld = $ldcache[$log->module
][$log->action
];
390 $ld = $DB->get_record('log_display', array('module'=>$log->module
, 'action'=>$log->action
));
391 $ldcache[$log->module
][$log->action
] = $ld;
393 if ($ld && is_numeric($log->info
)) {
394 // ugly hack to make sure fullname is shown correctly
395 if ($ld->mtable
== 'user' && $ld->field
== $DB->sql_concat('firstname', "' '" , 'lastname')) {
396 $log->info
= fullname($DB->get_record($ld->mtable
, array('id'=>$log->info
)), true);
398 $log->info
= $DB->get_field($ld->mtable
, $ld->field
, array('id'=>$log->info
));
403 $log->info
= format_string($log->info
);
405 // If $log->url has been trimmed short by the db size restriction
406 // code in add_to_log, keep a note so we don't add a link to a broken url
407 $brokenurl=(core_text
::strlen($log->url
)==100 && core_text
::substr($log->url
,97)=='...');
410 if ($course->id
== SITEID
) {
411 if (empty($log->course
)) {
412 $row[] = get_string('site');
414 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course
])."</a>";
418 $row[] = userdate($log->time
, '%a').' '.userdate($log->time
, $strftimedatetime);
420 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
421 $row[] = $OUTPUT->action_link($link, $log->ip
, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
423 $row[] = html_writer
::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course
::instance($course->id
))));
425 $displayaction="$log->module $log->action";
427 $row[] = $displayaction;
429 $link = make_log_url($log->module
,$log->url
);
430 $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
433 $table->data
[] = $row;
436 echo html_writer
::table($table);
437 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
441 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
442 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
444 global $CFG, $DB, $OUTPUT;
446 if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
447 $modname, $modid, $modaction, $groupid)) {
448 echo $OUTPUT->notification("No logs found!");
449 echo $OUTPUT->footer();
453 if ($course->id
== SITEID
) {
455 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
456 foreach ($ccc as $cc) {
457 $courses[$cc->id
] = $cc->shortname
;
462 $totalcount = $logs['totalcount'];
465 $tt = getdate(time());
466 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
468 $strftimedatetime = get_string("strftimedatetime");
470 echo "<div class=\"info\">\n";
471 print_string("displayingrecords", "", $totalcount);
474 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
476 echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
478 if ($course->id
== SITEID
) {
479 echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
481 echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
482 echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
483 echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
484 echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
485 echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
488 if (empty($logs['logs'])) {
494 foreach ($logs['logs'] as $log) {
496 $log->info
= $log->coursename
;
497 $row = ($row +
1) %
2;
499 if (isset($ldcache[$log->module
][$log->action
])) {
500 $ld = $ldcache[$log->module
][$log->action
];
502 $ld = $DB->get_record('log_display', array('module'=>$log->module
, 'action'=>$log->action
));
503 $ldcache[$log->module
][$log->action
] = $ld;
505 if (0 && $ld && !empty($log->info
)) {
506 // ugly hack to make sure fullname is shown correctly
507 if (($ld->mtable
== 'user') and ($ld->field
== $DB->sql_concat('firstname', "' '" , 'lastname'))) {
508 $log->info
= fullname($DB->get_record($ld->mtable
, array('id'=>$log->info
)), true);
510 $log->info
= $DB->get_field($ld->mtable
, $ld->field
, array('id'=>$log->info
));
515 $log->info
= format_string($log->info
);
517 echo '<tr class="r'.$row.'">';
518 if ($course->id
== SITEID
) {
519 $courseshortname = format_string($courses[$log->course
], true, array('context' => context_course
::instance(SITEID
)));
520 echo "<td class=\"r$row c0\" >\n";
521 echo " <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
524 echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time
, '%a').
525 ' '.userdate($log->time
, $strftimedatetime)."</td>\n";
526 echo "<td class=\"r$row c2\" >\n";
527 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
528 echo $OUTPUT->action_link($link, $log->ip
, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
530 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course
::instance($course->id
)));
531 echo "<td class=\"r$row c3\" >\n";
532 echo " <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
534 echo "<td class=\"r$row c4\">\n";
535 echo $log->action
.': '.$log->module
;
537 echo "<td class=\"r$row c5\">{$log->info}</td>\n";
542 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
546 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
547 $modid, $modaction, $groupid) {
550 require_once($CFG->libdir
. '/csvlib.class.php');
552 $csvexporter = new csv_export_writer('tab');
555 $header[] = get_string('course');
556 $header[] = get_string('time');
557 $header[] = get_string('ip_address');
558 $header[] = get_string('fullnameuser');
559 $header[] = get_string('action');
560 $header[] = get_string('info');
562 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
563 $modname, $modid, $modaction, $groupid)) {
569 if ($course->id
== SITEID
) {
571 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
572 foreach ($ccc as $cc) {
573 $courses[$cc->id
] = $cc->shortname
;
577 $courses[$course->id
] = $course->shortname
;
582 $tt = getdate(time());
583 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
585 $strftimedatetime = get_string("strftimedatetime");
587 $csvexporter->set_filename('logs', '.txt');
588 $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
589 $csvexporter->add_data($title);
590 $csvexporter->add_data($header);
592 if (empty($logs['logs'])) {
596 foreach ($logs['logs'] as $log) {
597 if (isset($ldcache[$log->module
][$log->action
])) {
598 $ld = $ldcache[$log->module
][$log->action
];
600 $ld = $DB->get_record('log_display', array('module'=>$log->module
, 'action'=>$log->action
));
601 $ldcache[$log->module
][$log->action
] = $ld;
603 if ($ld && is_numeric($log->info
)) {
604 // ugly hack to make sure fullname is shown correctly
605 if (($ld->mtable
== 'user') and ($ld->field
== $DB->sql_concat('firstname', "' '" , 'lastname'))) {
606 $log->info
= fullname($DB->get_record($ld->mtable
, array('id'=>$log->info
)), true);
608 $log->info
= $DB->get_field($ld->mtable
, $ld->field
, array('id'=>$log->info
));
613 $log->info
= format_string($log->info
);
614 $log->info
= strip_tags(urldecode($log->info
)); // Some XSS protection
616 $coursecontext = context_course
::instance($course->id
);
617 $firstField = format_string($courses[$log->course
], true, array('context' => $coursecontext));
618 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
619 $actionurl = $CFG->wwwroot
. make_log_url($log->module
,$log->url
);
620 $row = array($firstField, userdate($log->time
, $strftimedatetime), $log->ip
, $fullname, $log->module
.' '.$log->action
.' ('.$actionurl.')', $log->info
);
621 $csvexporter->add_data($row);
623 $csvexporter->download_file();
628 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
629 $modid, $modaction, $groupid) {
633 require_once("$CFG->libdir/excellib.class.php");
635 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
636 $modname, $modid, $modaction, $groupid)) {
642 if ($course->id
== SITEID
) {
644 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
645 foreach ($ccc as $cc) {
646 $courses[$cc->id
] = $cc->shortname
;
650 $courses[$course->id
] = $course->shortname
;
655 $tt = getdate(time());
656 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
658 $strftimedatetime = get_string("strftimedatetime");
660 $nroPages = ceil(count($logs)/(EXCELROWS
-FIRSTUSEDEXCELROW+
1));
661 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
664 $workbook = new MoodleExcelWorkbook('-');
665 $workbook->send($filename);
667 $worksheet = array();
668 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
669 get_string('fullnameuser'), get_string('action'), get_string('info'));
671 // Creating worksheets
672 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++
) {
673 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
674 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
675 $worksheet[$wsnumber]->set_column(1, 1, 30);
676 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
677 userdate(time(), $strftimedatetime));
679 foreach ($headers as $item) {
680 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW
-1,$col,$item,'');
685 if (empty($logs['logs'])) {
690 $formatDate =& $workbook->add_format();
691 $formatDate->set_num_format(get_string('log_excel_date_format'));
693 $row = FIRSTUSEDEXCELROW
;
695 $myxls =& $worksheet[$wsnumber];
696 foreach ($logs['logs'] as $log) {
697 if (isset($ldcache[$log->module
][$log->action
])) {
698 $ld = $ldcache[$log->module
][$log->action
];
700 $ld = $DB->get_record('log_display', array('module'=>$log->module
, 'action'=>$log->action
));
701 $ldcache[$log->module
][$log->action
] = $ld;
703 if ($ld && is_numeric($log->info
)) {
704 // ugly hack to make sure fullname is shown correctly
705 if (($ld->mtable
== 'user') and ($ld->field
== $DB->sql_concat('firstname', "' '" , 'lastname'))) {
706 $log->info
= fullname($DB->get_record($ld->mtable
, array('id'=>$log->info
)), true);
708 $log->info
= $DB->get_field($ld->mtable
, $ld->field
, array('id'=>$log->info
));
713 $log->info
= format_string($log->info
);
714 $log->info
= strip_tags(urldecode($log->info
)); // Some XSS protection
717 if ($row > EXCELROWS
) {
719 $myxls =& $worksheet[$wsnumber];
720 $row = FIRSTUSEDEXCELROW
;
724 $coursecontext = context_course
::instance($course->id
);
726 $myxls->write($row, 0, format_string($courses[$log->course
], true, array('context' => $coursecontext)), '');
727 $myxls->write_date($row, 1, $log->time
, $formatDate); // write_date() does conversion/timezone support. MDL-14934
728 $myxls->write($row, 2, $log->ip
, '');
729 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
730 $myxls->write($row, 3, $fullname, '');
731 $actionurl = $CFG->wwwroot
. make_log_url($log->module
,$log->url
);
732 $myxls->write($row, 4, $log->module
.' '.$log->action
.' ('.$actionurl.')', '');
733 $myxls->write($row, 5, $log->info
, '');
742 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
743 $modid, $modaction, $groupid) {
747 require_once("$CFG->libdir/odslib.class.php");
749 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
750 $modname, $modid, $modaction, $groupid)) {
756 if ($course->id
== SITEID
) {
758 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
759 foreach ($ccc as $cc) {
760 $courses[$cc->id
] = $cc->shortname
;
764 $courses[$course->id
] = $course->shortname
;
769 $tt = getdate(time());
770 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
772 $strftimedatetime = get_string("strftimedatetime");
774 $nroPages = ceil(count($logs)/(EXCELROWS
-FIRSTUSEDEXCELROW+
1));
775 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
778 $workbook = new MoodleODSWorkbook('-');
779 $workbook->send($filename);
781 $worksheet = array();
782 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
783 get_string('fullnameuser'), get_string('action'), get_string('info'));
785 // Creating worksheets
786 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++
) {
787 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
788 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
789 $worksheet[$wsnumber]->set_column(1, 1, 30);
790 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
791 userdate(time(), $strftimedatetime));
793 foreach ($headers as $item) {
794 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW
-1,$col,$item,'');
799 if (empty($logs['logs'])) {
804 $formatDate =& $workbook->add_format();
805 $formatDate->set_num_format(get_string('log_excel_date_format'));
807 $row = FIRSTUSEDEXCELROW
;
809 $myxls =& $worksheet[$wsnumber];
810 foreach ($logs['logs'] as $log) {
811 if (isset($ldcache[$log->module
][$log->action
])) {
812 $ld = $ldcache[$log->module
][$log->action
];
814 $ld = $DB->get_record('log_display', array('module'=>$log->module
, 'action'=>$log->action
));
815 $ldcache[$log->module
][$log->action
] = $ld;
817 if ($ld && is_numeric($log->info
)) {
818 // ugly hack to make sure fullname is shown correctly
819 if (($ld->mtable
== 'user') and ($ld->field
== $DB->sql_concat('firstname', "' '" , 'lastname'))) {
820 $log->info
= fullname($DB->get_record($ld->mtable
, array('id'=>$log->info
)), true);
822 $log->info
= $DB->get_field($ld->mtable
, $ld->field
, array('id'=>$log->info
));
827 $log->info
= format_string($log->info
);
828 $log->info
= strip_tags(urldecode($log->info
)); // Some XSS protection
831 if ($row > EXCELROWS
) {
833 $myxls =& $worksheet[$wsnumber];
834 $row = FIRSTUSEDEXCELROW
;
838 $coursecontext = context_course
::instance($course->id
);
840 $myxls->write_string($row, 0, format_string($courses[$log->course
], true, array('context' => $coursecontext)));
841 $myxls->write_date($row, 1, $log->time
);
842 $myxls->write_string($row, 2, $log->ip
);
843 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
844 $myxls->write_string($row, 3, $fullname);
845 $actionurl = $CFG->wwwroot
. make_log_url($log->module
,$log->url
);
846 $myxls->write_string($row, 4, $log->module
.' '.$log->action
.' ('.$actionurl.')');
847 $myxls->write_string($row, 5, $log->info
);
857 * Checks the integrity of the course data.
859 * In summary - compares course_sections.sequence and course_modules.section.
861 * More detailed, checks that:
862 * - course_sections.sequence contains each module id not more than once in the course
863 * - for each moduleid from course_sections.sequence the field course_modules.section
864 * refers to the same section id (this means course_sections.sequence is more
865 * important if they are different)
866 * - ($fullcheck only) each module in the course is present in one of
867 * course_sections.sequence
868 * - ($fullcheck only) removes non-existing course modules from section sequences
870 * If there are any mismatches, the changes are made and records are updated in DB.
872 * Course cache is NOT rebuilt if there are any errors!
874 * This function is used each time when course cache is being rebuilt with $fullcheck = false
875 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
877 * @param int $courseid id of the course
878 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
879 * the list of enabled course modules in the course. Retrieved from DB if not specified.
880 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
881 * @param array $sections records from course_sections table for this course.
882 * Retrieved from DB if not specified
883 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
884 * course modules from sequences. Only to be used in site maintenance mode when we are
885 * sure that another user is not in the middle of the process of moving/removing a module.
886 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
887 * @return array array of messages with found problems. Empty output means everything is ok
889 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
892 if ($sections === null) {
893 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
896 // Retrieve all records from course_modules regardless of module type visibility.
897 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
899 if ($rawmods === null) {
900 $rawmods = get_course_mods($courseid);
902 if (!$fullcheck && (empty($sections) ||
empty($rawmods))) {
903 // If either of the arrays is empty, no modules are displayed anyway.
906 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
908 // First make sure that each module id appears in section sequences only once.
909 // If it appears in several section sequences the last section wins.
910 // If it appears twice in one section sequence, the first occurence wins.
911 $modsection = array();
912 foreach ($sections as $sectionid => $section) {
913 $sections[$sectionid]->newsequence
= $section->sequence
;
914 if (!empty($section->sequence
)) {
915 $sequence = explode(",", $section->sequence
);
916 $sequenceunique = array_unique($sequence);
917 if (count($sequenceunique) != count($sequence)) {
918 // Some course module id appears in this section sequence more than once.
919 ksort($sequenceunique); // Preserve initial order of modules.
920 $sequence = array_values($sequenceunique);
921 $sections[$sectionid]->newsequence
= join(',', $sequence);
922 $messages[] = $debuggingprefix.'Sequence for course section ['.
923 $sectionid.'] is "'.$sections[$sectionid]->sequence
.'", must be "'.$sections[$sectionid]->newsequence
.'"';
925 foreach ($sequence as $cmid) {
926 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
927 // Some course module id appears to be in more than one section's sequences.
928 $wrongsectionid = $modsection[$cmid];
929 $sections[$wrongsectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence
. ','), ',');
930 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
931 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
933 $modsection[$cmid] = $sectionid;
938 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
940 foreach ($rawmods as $cmid => $mod) {
941 if (!isset($modsection[$cmid])) {
942 // This is a module that is not mentioned in course_section.sequence at all.
943 // Add it to the section $mod->section or to the last available section.
944 if ($mod->section
&& isset($sections[$mod->section
])) {
945 $modsection[$cmid] = $mod->section
;
947 $firstsection = reset($sections);
948 $modsection[$cmid] = $firstsection->id
;
950 $sections[$modsection[$cmid]]->newsequence
= trim($sections[$modsection[$cmid]]->newsequence
.','.$cmid, ',');
951 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
952 $modsection[$cmid].']';
955 foreach ($modsection as $cmid => $sectionid) {
956 if (!isset($rawmods[$cmid])) {
957 // Section $sectionid refers to module id that does not exist.
958 $sections[$sectionid]->newsequence
= trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence
.','), ',');
959 $messages[] = $debuggingprefix.'Course module ['.$cmid.
960 '] does not exist but is present in the sequence of section ['.$sectionid.']';
965 // Update changed sections.
966 if (!$checkonly && !empty($messages)) {
967 foreach ($sections as $sectionid => $section) {
968 if ($section->newsequence
!== $section->sequence
) {
969 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence
));
974 // Now make sure that all modules point to the correct sections.
975 foreach ($rawmods as $cmid => $mod) {
976 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section
) {
978 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
980 $messages[] = $debuggingprefix.'Course module ['.$cmid.
981 '] points to section ['.$mod->section
.'] instead of ['.$modsection[$cmid].']';
989 * For a given course, returns an array of course activity objects
990 * Each item in the array contains he following properties:
992 function get_array_of_activities($courseid) {
993 // cm - course module id
994 // mod - name of the module (eg forum)
995 // section - the number of the section (eg week or topic)
996 // name - the name of the instance
997 // visible - is the instance visible or not
998 // groupingid - grouping id
999 // extra - contains extra string to include in any link
1002 $course = $DB->get_record('course', array('id'=>$courseid));
1004 if (empty($course)) {
1005 throw new moodle_exception('courseidnotfound');
1010 $rawmods = get_course_mods($courseid);
1011 if (empty($rawmods)) {
1012 return $mod; // always return array
1015 if ($sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence')) {
1016 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
1017 if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
1018 debugging(join('<br>', $errormessages));
1019 $rawmods = get_course_mods($courseid);
1020 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence');
1022 // Build array of activities.
1023 foreach ($sections as $section) {
1024 if (!empty($section->sequence
)) {
1025 $sequence = explode(",", $section->sequence
);
1026 foreach ($sequence as $seq) {
1027 if (empty($rawmods[$seq])) {
1030 $mod[$seq] = new stdClass();
1031 $mod[$seq]->id
= $rawmods[$seq]->instance
;
1032 $mod[$seq]->cm
= $rawmods[$seq]->id
;
1033 $mod[$seq]->mod
= $rawmods[$seq]->modname
;
1035 // Oh dear. Inconsistent names left here for backward compatibility.
1036 $mod[$seq]->section
= $section->section
;
1037 $mod[$seq]->sectionid
= $rawmods[$seq]->section
;
1039 $mod[$seq]->module
= $rawmods[$seq]->module
;
1040 $mod[$seq]->added
= $rawmods[$seq]->added
;
1041 $mod[$seq]->score
= $rawmods[$seq]->score
;
1042 $mod[$seq]->idnumber
= $rawmods[$seq]->idnumber
;
1043 $mod[$seq]->visible
= $rawmods[$seq]->visible
;
1044 $mod[$seq]->visibleold
= $rawmods[$seq]->visibleold
;
1045 $mod[$seq]->groupmode
= $rawmods[$seq]->groupmode
;
1046 $mod[$seq]->groupingid
= $rawmods[$seq]->groupingid
;
1047 $mod[$seq]->indent
= $rawmods[$seq]->indent
;
1048 $mod[$seq]->completion
= $rawmods[$seq]->completion
;
1049 $mod[$seq]->extra
= "";
1050 $mod[$seq]->completiongradeitemnumber
=
1051 $rawmods[$seq]->completiongradeitemnumber
;
1052 $mod[$seq]->completionview
= $rawmods[$seq]->completionview
;
1053 $mod[$seq]->completionexpected
= $rawmods[$seq]->completionexpected
;
1054 $mod[$seq]->showdescription
= $rawmods[$seq]->showdescription
;
1055 $mod[$seq]->availability
= $rawmods[$seq]->availability
;
1057 $modname = $mod[$seq]->mod
;
1058 $functionname = $modname."_get_coursemodule_info";
1060 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1064 include_once("$CFG->dirroot/mod/$modname/lib.php");
1066 if ($hasfunction = function_exists($functionname)) {
1067 if ($info = $functionname($rawmods[$seq])) {
1068 if (!empty($info->icon
)) {
1069 $mod[$seq]->icon
= $info->icon
;
1071 if (!empty($info->iconcomponent
)) {
1072 $mod[$seq]->iconcomponent
= $info->iconcomponent
;
1074 if (!empty($info->name
)) {
1075 $mod[$seq]->name
= $info->name
;
1077 if ($info instanceof cached_cm_info
) {
1078 // When using cached_cm_info you can include three new fields
1079 // that aren't available for legacy code
1080 if (!empty($info->content
)) {
1081 $mod[$seq]->content
= $info->content
;
1083 if (!empty($info->extraclasses
)) {
1084 $mod[$seq]->extraclasses
= $info->extraclasses
;
1086 if (!empty($info->iconurl
)) {
1087 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
1088 $url = new moodle_url($info->iconurl
);
1089 $mod[$seq]->iconurl
= $url->out(false);
1091 if (!empty($info->onclick
)) {
1092 $mod[$seq]->onclick
= $info->onclick
;
1094 if (!empty($info->customdata
)) {
1095 $mod[$seq]->customdata
= $info->customdata
;
1098 // When using a stdclass, the (horrible) deprecated ->extra field
1099 // is available for BC
1100 if (!empty($info->extra
)) {
1101 $mod[$seq]->extra
= $info->extra
;
1106 // When there is no modname_get_coursemodule_info function,
1107 // but showdescriptions is enabled, then we use the 'intro'
1108 // and 'introformat' fields in the module table
1109 if (!$hasfunction && $rawmods[$seq]->showdescription
) {
1110 if ($modvalues = $DB->get_record($rawmods[$seq]->modname
,
1111 array('id' => $rawmods[$seq]->instance
), 'name, intro, introformat')) {
1112 // Set content from intro and introformat. Filters are disabled
1113 // because we filter it with format_text at display time
1114 $mod[$seq]->content
= format_module_intro($rawmods[$seq]->modname
,
1115 $modvalues, $rawmods[$seq]->id
, false);
1117 // To save making another query just below, put name in here
1118 $mod[$seq]->name
= $modvalues->name
;
1121 if (!isset($mod[$seq]->name
)) {
1122 $mod[$seq]->name
= $DB->get_field($rawmods[$seq]->modname
, "name", array("id"=>$rawmods[$seq]->instance
));
1125 // Minimise the database size by unsetting default options when they are
1126 // 'empty'. This list corresponds to code in the cm_info constructor.
1127 foreach (array('idnumber', 'groupmode', 'groupingid',
1128 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1129 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
1130 'completionexpected', 'score', 'showdescription') as $property) {
1131 if (property_exists($mod[$seq], $property) &&
1132 empty($mod[$seq]->{$property})) {
1133 unset($mod[$seq]->{$property});
1136 // Special case: this value is usually set to null, but may be 0
1137 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1138 is_null($mod[$seq]->completiongradeitemnumber
)) {
1139 unset($mod[$seq]->completiongradeitemnumber
);
1149 * Returns the localised human-readable names of all used modules
1151 * @param bool $plural if true returns the plural forms of the names
1152 * @return array where key is the module name (component name without 'mod_') and
1153 * the value is the human-readable string. Array sorted alphabetically by value
1155 function get_module_types_names($plural = false) {
1156 static $modnames = null;
1158 if ($modnames === null) {
1159 $modnames = array(0 => array(), 1 => array());
1160 if ($allmods = $DB->get_records("modules")) {
1161 foreach ($allmods as $mod) {
1162 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible
) {
1163 $modnames[0][$mod->name
] = get_string("modulename", "$mod->name");
1164 $modnames[1][$mod->name
] = get_string("modulenameplural", "$mod->name");
1167 core_collator
::asort($modnames[0]);
1168 core_collator
::asort($modnames[1]);
1171 return $modnames[(int)$plural];
1175 * Set highlighted section. Only one section can be highlighted at the time.
1177 * @param int $courseid course id
1178 * @param int $marker highlight section with this number, 0 means remove higlightin
1181 function course_set_marker($courseid, $marker) {
1183 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1184 format_base
::reset_course_cache($courseid);
1188 * For a given course section, marks it visible or hidden,
1189 * and does the same for every activity in that section
1191 * @param int $courseid course id
1192 * @param int $sectionnumber The section number to adjust
1193 * @param int $visibility The new visibility
1194 * @return array A list of resources which were hidden in the section
1196 function set_section_visible($courseid, $sectionnumber, $visibility) {
1199 $resourcestotoggle = array();
1200 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1201 $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id
));
1203 $event = \core\event\course_section_updated
::create(array(
1204 'context' => context_course
::instance($courseid),
1205 'objectid' => $section->id
,
1207 'sectionnum' => $sectionnumber
1210 $event->add_record_snapshot('course_sections', $section);
1213 if (!empty($section->sequence
)) {
1214 $modules = explode(",", $section->sequence
);
1215 foreach ($modules as $moduleid) {
1216 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1218 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1219 set_coursemodule_visible($moduleid, $cm->visibleold
);
1221 // We hide the section, so we hide the module but we store the original state in visibleold.
1222 set_coursemodule_visible($moduleid, 0);
1223 $DB->set_field('course_modules', 'visibleold', $cm->visible
, array('id' => $moduleid));
1225 \core\event\course_module_updated
::create_from_cm($cm)->trigger();
1229 rebuild_course_cache($courseid, true);
1231 // Determine which modules are visible for AJAX update
1232 if (!empty($modules)) {
1233 list($insql, $params) = $DB->get_in_or_equal($modules);
1234 $select = 'id ' . $insql . ' AND visible = ?';
1235 array_push($params, $visibility);
1237 $select .= ' AND visibleold = 1';
1239 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1242 return $resourcestotoggle;
1246 * Retrieve all metadata for the requested modules
1248 * @param object $course The Course
1249 * @param array $modnames An array containing the list of modules and their
1251 * @param int $sectionreturn The section to return to
1252 * @return array A list of stdClass objects containing metadata about each
1255 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1256 global $CFG, $OUTPUT;
1258 // get_module_metadata will be called once per section on the page and courses may show
1259 // different modules to one another
1260 static $modlist = array();
1261 if (!isset($modlist[$course->id
])) {
1262 $modlist[$course->id
] = array();
1266 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id
, 'sesskey' => sesskey()));
1267 if ($sectionreturn !== null) {
1268 $urlbase->param('sr', $sectionreturn);
1270 foreach($modnames as $modname => $modnamestr) {
1271 if (!course_allowed_module($course, $modname)) {
1274 if (isset($modlist[$course->id
][$modname])) {
1275 // This module is already cached
1276 $return[$modname] = $modlist[$course->id
][$modname];
1280 // Include the module lib
1281 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1282 if (!file_exists($libfile)) {
1285 include_once($libfile);
1287 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1288 $gettypesfunc = $modname.'_get_types';
1289 $types = MOD_SUBTYPE_NO_CHILDREN
;
1290 if (function_exists($gettypesfunc)) {
1291 $types = $gettypesfunc();
1293 if ($types !== MOD_SUBTYPE_NO_CHILDREN
) {
1294 if (is_array($types) && count($types) > 0) {
1295 $group = new stdClass();
1296 $group->name
= $modname;
1297 $group->icon
= $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1298 foreach($types as $type) {
1299 if ($type->typestr
=== '--') {
1302 if (strpos($type->typestr
, '--') === 0) {
1303 $group->title
= str_replace('--', '', $type->typestr
);
1306 // Set the Sub Type metadata
1307 $subtype = new stdClass();
1308 $subtype->title
= $type->typestr
;
1309 $subtype->type
= str_replace('&', '&', $type->type
);
1310 $subtype->name
= preg_replace('/.*type=/', '', $subtype->type
);
1311 $subtype->archetype
= $type->modclass
;
1313 // The group archetype should match the subtype archetypes and all subtypes
1314 // should have the same archetype
1315 $group->archetype
= $subtype->archetype
;
1317 if (!empty($type->help
)) {
1318 $subtype->help
= $type->help
;
1319 } else if (get_string_manager()->string_exists('help' . $subtype->name
, $modname)) {
1320 $subtype->help
= get_string('help' . $subtype->name
, $modname);
1322 $subtype->link
= new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name
));
1323 $group->types
[] = $subtype;
1325 $modlist[$course->id
][$modname] = $group;
1328 $module = new stdClass();
1329 $module->title
= $modnamestr;
1330 $module->name
= $modname;
1331 $module->link
= new moodle_url($urlbase, array('add' => $modname));
1332 $module->icon
= $OUTPUT->pix_icon('icon', '', $module->name
, array('class' => 'icon'));
1333 $sm = get_string_manager();
1334 if ($sm->string_exists('modulename_help', $modname)) {
1335 $module->help
= get_string('modulename_help', $modname);
1336 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs
1337 $link = get_string('modulename_link', $modname);
1338 $linktext = get_string('morehelp');
1339 $module->help
.= html_writer
::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1342 $module->archetype
= plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
1343 $modlist[$course->id
][$modname] = $module;
1345 if (isset($modlist[$course->id
][$modname])) {
1346 $return[$modname] = $modlist[$course->id
][$modname];
1348 debugging("Invalid module metadata configuration for {$modname}");
1356 * Return the course category context for the category with id $categoryid, except
1357 * that if $categoryid is 0, return the system context.
1359 * @param integer $categoryid a category id or 0.
1360 * @return context the corresponding context
1362 function get_category_or_system_context($categoryid) {
1364 return context_coursecat
::instance($categoryid, IGNORE_MISSING
);
1366 return context_system
::instance();
1371 * Returns full course categories trees to be used in html_writer::select()
1373 * Calls {@link coursecat::make_categories_list()} to build the tree and
1374 * adds whitespace to denote nesting
1376 * @return array array mapping coursecat id to the display name
1378 function make_categories_options() {
1380 require_once($CFG->libdir
. '/coursecatlib.php');
1381 $cats = coursecat
::make_categories_list('', 0, ' / ');
1382 foreach ($cats as $key => $value) {
1383 // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1384 $cats[$key] = str_repeat(' ', substr_count($value, ' / ')). $value;
1390 * Print the buttons relating to course requests.
1392 * @param object $context current page context.
1394 function print_course_request_buttons($context) {
1395 global $CFG, $DB, $OUTPUT;
1396 if (empty($CFG->enablecourserequests
)) {
1399 if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
1400 /// Print a button to request a new course
1401 echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
1403 /// Print a button to manage pending requests
1404 if ($context->contextlevel
== CONTEXT_SYSTEM
&& has_capability('moodle/site:approvecourse', $context)) {
1405 $disabled = !$DB->record_exists('course_request', array());
1406 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
1411 * Does the user have permission to edit things in this category?
1413 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1414 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1416 function can_edit_in_category($categoryid = 0) {
1417 $context = get_category_or_system_context($categoryid);
1418 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1421 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1423 function add_course_module($mod) {
1426 $mod->added
= time();
1429 $cmid = $DB->insert_record("course_modules", $mod);
1430 rebuild_course_cache($mod->course
, true);
1435 * Creates missing course section(s) and rebuilds course cache
1437 * @param int|stdClass $courseorid course id or course object
1438 * @param int|array $sections list of relative section numbers to create
1439 * @return bool if there were any sections created
1441 function course_create_sections_if_missing($courseorid, $sections) {
1443 if (!is_array($sections)) {
1444 $sections = array($sections);
1446 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1447 if (is_object($courseorid)) {
1448 $courseorid = $courseorid->id
;
1450 $coursechanged = false;
1451 foreach ($sections as $sectionnum) {
1452 if (!in_array($sectionnum, $existing)) {
1453 $cw = new stdClass();
1454 $cw->course
= $courseorid;
1455 $cw->section
= $sectionnum;
1457 $cw->summaryformat
= FORMAT_HTML
;
1459 $id = $DB->insert_record("course_sections", $cw);
1460 $coursechanged = true;
1463 if ($coursechanged) {
1464 rebuild_course_cache($courseorid, true);
1466 return $coursechanged;
1470 * Adds an existing module to the section
1472 * Updates both tables {course_sections} and {course_modules}
1474 * Note: This function does not use modinfo PROVIDED that the section you are
1475 * adding the module to already exists. If the section does not exist, it will
1476 * build modinfo if necessary and create the section.
1478 * @param int|stdClass $courseorid course id or course object
1479 * @param int $cmid id of the module already existing in course_modules table
1480 * @param int $sectionnum relative number of the section (field course_sections.section)
1481 * If section does not exist it will be created
1482 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1483 * before which the module needs to be included. Null for inserting in the
1484 * end of the section
1485 * @return int The course_sections ID where the module is inserted
1487 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1488 global $DB, $COURSE;
1489 if (is_object($beforemod)) {
1490 $beforemod = $beforemod->id
;
1492 if (is_object($courseorid)) {
1493 $courseid = $courseorid->id
;
1495 $courseid = $courseorid;
1497 // Do not try to use modinfo here, there is no guarantee it is valid!
1498 $section = $DB->get_record('course_sections',
1499 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING
);
1501 // This function call requires modinfo.
1502 course_create_sections_if_missing($courseorid, $sectionnum);
1503 $section = $DB->get_record('course_sections',
1504 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST
);
1507 $modarray = explode(",", trim($section->sequence
));
1508 if (empty($section->sequence
)) {
1509 $newsequence = "$cmid";
1510 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1511 $insertarray = array($cmid, $beforemod);
1512 array_splice($modarray, $key[0], 1, $insertarray);
1513 $newsequence = implode(",", $modarray);
1515 $newsequence = "$section->sequence,$cmid";
1517 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id
));
1518 $DB->set_field('course_modules', 'section', $section->id
, array('id' => $cmid));
1519 if (is_object($courseorid)) {
1520 rebuild_course_cache($courseorid->id
, true);
1522 rebuild_course_cache($courseorid, true);
1524 return $section->id
; // Return course_sections ID that was used.
1528 * Change the group mode of a course module.
1530 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1531 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1533 * @param int $id course module ID.
1534 * @param int $groupmode the new groupmode value.
1535 * @return bool True if the $groupmode was updated.
1537 function set_coursemodule_groupmode($id, $groupmode) {
1539 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST
);
1540 if ($cm->groupmode
!= $groupmode) {
1541 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id
));
1542 rebuild_course_cache($cm->course
, true);
1544 return ($cm->groupmode
!= $groupmode);
1547 function set_coursemodule_idnumber($id, $idnumber) {
1549 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST
);
1550 if ($cm->idnumber
!= $idnumber) {
1551 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id
));
1552 rebuild_course_cache($cm->course
, true);
1554 return ($cm->idnumber
!= $idnumber);
1558 * Set the visibility of a module and inherent properties.
1560 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1561 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1563 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1564 * has been moved to {@link set_section_visible()} which was the only place from which
1565 * the parameter was used.
1567 * @param int $id of the module
1568 * @param int $visible state of the module
1569 * @return bool false when the module was not found, true otherwise
1571 function set_coursemodule_visible($id, $visible) {
1573 require_once($CFG->libdir
.'/gradelib.php');
1574 require_once($CFG->dirroot
.'/calendar/lib.php');
1576 // Trigger developer's attention when using the previously removed argument.
1577 if (func_num_args() > 2) {
1578 debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1579 has been removed.', DEBUG_DEVELOPER
);
1582 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1586 // Create events and propagate visibility to associated grade items if the value has changed.
1587 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1588 if ($cm->visible
== $visible) {
1592 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module
))) {
1595 if ($events = $DB->get_records('event', array('instance'=>$cm->instance
, 'modulename'=>$modulename))) {
1596 foreach($events as $event) {
1598 $event = new calendar_event($event);
1599 $event->toggle_visibility(true);
1601 $event = new calendar_event($event);
1602 $event->toggle_visibility(false);
1607 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1608 // affect visibleold to allow for an original visibility restore. See set_section_visible().
1609 $cminfo = new stdClass();
1611 $cminfo->visible
= $visible;
1612 $cminfo->visibleold
= $visible;
1613 $DB->update_record('course_modules', $cminfo);
1615 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1616 // Note that this must be done after updating the row in course_modules, in case
1617 // the modules grade_item_update function needs to access $cm->visible.
1618 if (plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY
) &&
1619 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1620 $instance = $DB->get_record($modulename, array('id' => $cm->instance
), '*', MUST_EXIST
);
1621 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1623 $grade_items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance
, 'courseid'=>$cm->course
));
1625 foreach ($grade_items as $grade_item) {
1626 $grade_item->set_hidden(!$visible);
1631 rebuild_course_cache($cm->course
, true);
1636 * This function will handle the whole deletion process of a module. This includes calling
1637 * the modules delete_instance function, deleting files, events, grades, conditional data,
1638 * the data in the course_module and course_sections table and adding a module deletion
1641 * @param int $cmid the course module id
1644 function course_delete_module($cmid) {
1647 require_once($CFG->libdir
.'/gradelib.php');
1648 require_once($CFG->libdir
.'/questionlib.php');
1649 require_once($CFG->dirroot
.'/blog/lib.php');
1650 require_once($CFG->dirroot
.'/calendar/lib.php');
1651 require_once($CFG->dirroot
.'/tag/lib.php');
1653 // Get the course module.
1654 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1658 // Get the module context.
1659 $modcontext = context_module
::instance($cm->id
);
1661 // Get the course module name.
1662 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module
), MUST_EXIST
);
1664 // Get the file location of the delete_instance function for this module.
1665 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1667 // Include the file required to call the delete_instance function for this module.
1668 if (file_exists($modlib)) {
1669 require_once($modlib);
1671 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1672 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1675 $deleteinstancefunction = $modulename . '_delete_instance';
1677 // Ensure the delete_instance function exists for this module.
1678 if (!function_exists($deleteinstancefunction)) {
1679 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1680 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1683 // Delete activity context questions and question categories.
1684 question_delete_activity($cm);
1686 // Call the delete_instance function, if it returns false throw an exception.
1687 if (!$deleteinstancefunction($cm->instance
)) {
1688 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1689 "Cannot delete the module $modulename (instance).");
1692 // Remove all module files in case modules forget to do that.
1693 $fs = get_file_storage();
1694 $fs->delete_area_files($modcontext->id
);
1696 // Delete events from calendar.
1697 if ($events = $DB->get_records('event', array('instance' => $cm->instance
, 'modulename' => $modulename))) {
1698 foreach($events as $event) {
1699 $calendarevent = calendar_event
::load($event->id
);
1700 $calendarevent->delete();
1704 // Delete grade items, outcome items and grades attached to modules.
1705 if ($grade_items = grade_item
::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1706 'iteminstance' => $cm->instance
, 'courseid' => $cm->course
))) {
1707 foreach ($grade_items as $grade_item) {
1708 $grade_item->delete('moddelete');
1712 // Delete completion and availability data; it is better to do this even if the
1713 // features are not turned on, in case they were turned on previously (these will be
1714 // very quick on an empty table).
1715 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id
));
1716 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id
,
1717 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY
));
1719 // Delete all tag instances associated with the instance of this module.
1720 tag_delete_instances('mod_' . $modulename, $modcontext->id
);
1722 // Delete the context.
1723 context_helper
::delete_instance(CONTEXT_MODULE
, $cm->id
);
1725 // Delete the module from the course_modules table.
1726 $DB->delete_records('course_modules', array('id' => $cm->id
));
1728 // Delete module from that section.
1729 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
1730 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1731 "Cannot delete the module $modulename (instance) from section.");
1734 // Trigger event for course module delete action.
1735 $event = \core\event\course_module_deleted
::create(array(
1736 'courseid' => $cm->course
,
1737 'context' => $modcontext,
1738 'objectid' => $cm->id
,
1740 'modulename' => $modulename,
1741 'instanceid' => $cm->instance
,
1744 $event->add_record_snapshot('course_modules', $cm);
1746 rebuild_course_cache($cm->course
, true);
1749 function delete_mod_from_section($modid, $sectionid) {
1752 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1754 $modarray = explode(",", $section->sequence
);
1756 if ($key = array_keys ($modarray, $modid)) {
1757 array_splice($modarray, $key[0], 1);
1758 $newsequence = implode(",", $modarray);
1759 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id
));
1760 rebuild_course_cache($section->course
, true);
1771 * Moves a section within a course, from a position to another.
1772 * Be very careful: $section and $destination refer to section number,
1775 * @param object $course
1776 * @param int $section Section number (not id!!!)
1777 * @param int $destination
1778 * @param bool $ignorenumsections
1779 * @return boolean Result
1781 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1782 /// Moves a whole course section up and down within the course
1785 if (!$destination && $destination != 0) {
1789 // compartibility with course formats using field 'numsections'
1790 $courseformatoptions = course_get_format($course)->get_format_options();
1791 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1792 ($destination > $courseformatoptions['numsections'])) ||
($destination < 1)) {
1796 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1797 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id
),
1798 'section ASC, id ASC', 'id, section')) {
1802 $movedsections = reorder_sections($sections, $section, $destination);
1804 // Update all sections. Do this in 2 steps to avoid breaking database
1805 // uniqueness constraint
1806 $transaction = $DB->start_delegated_transaction();
1807 foreach ($movedsections as $id => $position) {
1808 if ($sections[$id] !== $position) {
1809 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1812 foreach ($movedsections as $id => $position) {
1813 if ($sections[$id] !== $position) {
1814 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1818 // If we move the highlighted section itself, then just highlight the destination.
1819 // Adjust the higlighted section location if we move something over it either direction.
1820 if ($section == $course->marker
) {
1821 course_set_marker($course->id
, $destination);
1822 } elseif ($section > $course->marker
&& $course->marker
>= $destination) {
1823 course_set_marker($course->id
, $course->marker+
1);
1824 } elseif ($section < $course->marker
&& $course->marker
<= $destination) {
1825 course_set_marker($course->id
, $course->marker
-1);
1828 $transaction->allow_commit();
1829 rebuild_course_cache($course->id
, true);
1834 * This method will delete a course section and may delete all modules inside it.
1836 * No permissions are checked here, use {@link course_can_delete_section()} to
1837 * check if section can actually be deleted.
1839 * @param int|stdClass $course
1840 * @param int|stdClass|section_info $section
1841 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1842 * @return bool whether section was deleted
1844 function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
1845 return course_get_format($course)->delete_section($section, $forcedeleteifnotempty);
1849 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1851 * @param int|stdClass $course
1852 * @param int|stdClass|section_info $section
1855 function course_can_delete_section($course, $section) {
1856 if (is_object($section)) {
1857 $section = $section->section
;
1860 // Not possible to delete 0-section.
1863 // Course format should allow to delete sections.
1864 if (!course_get_format($course)->can_delete_section($section)) {
1867 // Make sure user has capability to update course and move sections.
1868 $context = context_course
::instance(is_object($course) ?
$course->id
: $course);
1869 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1872 // Make sure user has capability to delete each activity in this section.
1873 $modinfo = get_fast_modinfo($course);
1874 if (!empty($modinfo->sections
[$section])) {
1875 foreach ($modinfo->sections
[$section] as $cmid) {
1876 if (!has_capability('moodle/course:manageactivities', context_module
::instance($cmid))) {
1885 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1886 * an original position number and a target position number, rebuilds the array so that the
1887 * move is made without any duplication of section positions.
1888 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1889 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1891 * @param array $sections
1892 * @param int $origin_position
1893 * @param int $target_position
1896 function reorder_sections($sections, $origin_position, $target_position) {
1897 if (!is_array($sections)) {
1901 // We can't move section position 0
1902 if ($origin_position < 1) {
1903 echo "We can't move section position 0";
1907 // Locate origin section in sections array
1908 if (!$origin_key = array_search($origin_position, $sections)) {
1909 echo "searched position not in sections array";
1910 return false; // searched position not in sections array
1913 // Extract origin section
1914 $origin_section = $sections[$origin_key];
1915 unset($sections[$origin_key]);
1917 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1919 $append_array = array();
1920 foreach ($sections as $id => $position) {
1922 $append_array[$id] = $position;
1923 unset($sections[$id]);
1925 if ($position == $target_position) {
1926 if ($target_position < $origin_position) {
1927 $append_array[$id] = $position;
1928 unset($sections[$id]);
1934 // Append moved section
1935 $sections[$origin_key] = $origin_section;
1937 // Append rest of array (if applicable)
1938 if (!empty($append_array)) {
1939 foreach ($append_array as $id => $position) {
1940 $sections[$id] = $position;
1944 // Renumber positions
1946 foreach ($sections as $id => $p) {
1947 $sections[$id] = $position;
1956 * Move the module object $mod to the specified $section
1957 * If $beforemod exists then that is the module
1958 * before which $modid should be inserted
1960 * @param stdClass|cm_info $mod
1961 * @param stdClass|section_info $section
1962 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1963 * before which the module needs to be included. Null for inserting in the
1964 * end of the section
1965 * @return int new value for module visibility (0 or 1)
1967 function moveto_module($mod, $section, $beforemod=NULL) {
1968 global $OUTPUT, $DB;
1970 // Current module visibility state - return value of this function.
1971 $modvisible = $mod->visible
;
1973 // Remove original module from original section.
1974 if (! delete_mod_from_section($mod->id
, $mod->section
)) {
1975 echo $OUTPUT->notification("Could not delete module from existing section");
1978 // If moving to a hidden section then hide module.
1979 if ($mod->section
!= $section->id
) {
1980 if (!$section->visible
&& $mod->visible
) {
1981 // Module was visible but must become hidden after moving to hidden section.
1983 set_coursemodule_visible($mod->id
, 0);
1984 // Set visibleold to 1 so module will be visible when section is made visible.
1985 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id
));
1987 if ($section->visible
&& !$mod->visible
) {
1988 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1989 set_coursemodule_visible($mod->id
, $mod->visibleold
);
1990 $modvisible = $mod->visibleold
;
1994 // Add the module into the new section.
1995 course_add_cm_to_section($section->course
, $mod->id
, $section->section
, $beforemod);
2000 * Returns the list of all editing actions that current user can perform on the module
2002 * @param cm_info $mod The module to produce editing buttons for
2003 * @param int $indent The current indenting (default -1 means no move left-right actions)
2004 * @param int $sr The section to link back to (used for creating the links)
2005 * @return array array of action_link or pix_icon objects
2007 function course_get_cm_edit_actions(cm_info
$mod, $indent = -1, $sr = null) {
2008 global $COURSE, $SITE;
2012 $coursecontext = context_course
::instance($mod->course
);
2013 $modcontext = context_module
::instance($mod->id
);
2015 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2016 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2018 // No permission to edit anything.
2019 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2023 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2026 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2027 'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
2028 $str->assign
= get_string('assignroles', 'role');
2029 $str->groupsnone
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2030 $str->groupsseparate
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2031 $str->groupsvisible
= get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2034 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2037 $baseurl->param('sr', $sr);
2042 if ($hasmanageactivities) {
2043 $actions['update'] = new action_menu_link_secondary(
2044 new moodle_url($baseurl, array('update' => $mod->id
)),
2045 new pix_icon('t/edit', $str->editsettings
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2047 array('class' => 'editing_update', 'data-action' => 'update')
2052 if ($hasmanageactivities && $indent >= 0) {
2053 $indentlimits = new stdClass();
2054 $indentlimits->min
= 0;
2055 $indentlimits->max
= 16;
2056 if (right_to_left()) { // Exchange arrows on RTL
2057 $rightarrow = 't/left';
2058 $leftarrow = 't/right';
2060 $rightarrow = 't/right';
2061 $leftarrow = 't/left';
2064 if ($indent >= $indentlimits->max
) {
2065 $enabledclass = 'hidden';
2069 $actions['moveright'] = new action_menu_link_secondary(
2070 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '1')),
2071 new pix_icon($rightarrow, $str->moveright
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2073 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
2076 if ($indent <= $indentlimits->min
) {
2077 $enabledclass = 'hidden';
2081 $actions['moveleft'] = new action_menu_link_secondary(
2082 new moodle_url($baseurl, array('id' => $mod->id
, 'indent' => '-1')),
2083 new pix_icon($leftarrow, $str->moveleft
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2085 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
2091 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2092 if ($mod->visible
) {
2093 $actions['hide'] = new action_menu_link_secondary(
2094 new moodle_url($baseurl, array('hide' => $mod->id
)),
2095 new pix_icon('t/hide', $str->hide
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2097 array('class' => 'editing_hide', 'data-action' => 'hide')
2100 $actions['show'] = new action_menu_link_secondary(
2101 new moodle_url($baseurl, array('show' => $mod->id
)),
2102 new pix_icon('t/show', $str->show
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2104 array('class' => 'editing_show', 'data-action' => 'show')
2109 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2110 if (has_all_capabilities($dupecaps, $coursecontext) &&
2111 plugin_supports('mod', $mod->modname
, FEATURE_BACKUP_MOODLE2
)) {
2112 $actions['duplicate'] = new action_menu_link_secondary(
2113 new moodle_url($baseurl, array('duplicate' => $mod->id
)),
2114 new pix_icon('t/copy', $str->duplicate
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2116 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
2121 if ($hasmanageactivities && !$mod->coursegroupmodeforce
) {
2122 if (plugin_supports('mod', $mod->modname
, FEATURE_GROUPS
, 0)) {
2123 if ($mod->effectivegroupmode
== SEPARATEGROUPS
) {
2124 $nextgroupmode = VISIBLEGROUPS
;
2125 $grouptitle = $str->groupsseparate
;
2126 $actionname = 'groupsseparate';
2127 $groupimage = 'i/groups';
2128 } else if ($mod->effectivegroupmode
== VISIBLEGROUPS
) {
2129 $nextgroupmode = NOGROUPS
;
2130 $grouptitle = $str->groupsvisible
;
2131 $actionname = 'groupsvisible';
2132 $groupimage = 'i/groupv';
2134 $nextgroupmode = SEPARATEGROUPS
;
2135 $grouptitle = $str->groupsnone
;
2136 $actionname = 'groupsnone';
2137 $groupimage = 'i/groupn';
2140 $actions[$actionname] = new action_menu_link_primary(
2141 new moodle_url($baseurl, array('id' => $mod->id
, 'groupmode' => $nextgroupmode)),
2142 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
2144 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
2147 $actions['nogroupsupport'] = new action_menu_filler();
2152 if (has_capability('moodle/role:assign', $modcontext)){
2153 $actions['assign'] = new action_menu_link_secondary(
2154 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id
)),
2155 new pix_icon('t/assignroles', $str->assign
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2157 array('class' => 'editing_assign', 'data-action' => 'assignroles')
2162 if ($hasmanageactivities) {
2163 $actions['delete'] = new action_menu_link_secondary(
2164 new moodle_url($baseurl, array('delete' => $mod->id
)),
2165 new pix_icon('t/delete', $str->delete
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2167 array('class' => 'editing_delete', 'data-action' => 'delete')
2175 * Returns the rename action.
2177 * @param cm_info $mod The module to produce editing buttons for
2178 * @param int $sr The section to link back to (used for creating the links)
2179 * @return The markup for the rename action, or an empty string if not available.
2181 function course_get_cm_rename_action(cm_info
$mod, $sr = null) {
2182 global $COURSE, $OUTPUT;
2187 $modcontext = context_module
::instance($mod->id
);
2188 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2191 $str = get_strings(array('edittitle'));
2194 if (!isset($baseurl)) {
2195 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2199 $baseurl->param('sr', $sr);
2203 if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
2204 (($mod->course
== $COURSE->id
) ||
($mod->course
== SITEID
))) {
2205 // we will not display link if we are on some other-course page (where we should not see this module anyway)
2206 return html_writer
::span(
2208 new moodle_url($baseurl, array('update' => $mod->id
)),
2209 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2211 'class' => 'editing_title',
2212 'data-action' => 'edittitle',
2213 'title' => $str->edittitle
,
2222 * Returns the move action.
2224 * @param cm_info $mod The module to produce a move button for
2225 * @param int $sr The section to link back to (used for creating the links)
2226 * @return The markup for the move action, or an empty string if not available.
2228 function course_get_cm_move(cm_info
$mod, $sr = null) {
2234 $modcontext = context_module
::instance($mod->id
);
2235 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2238 $str = get_strings(array('move'));
2241 if (!isset($baseurl)) {
2242 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2245 $baseurl->param('sr', $sr);
2249 if ($hasmanageactivities) {
2250 $pixicon = 'i/dragdrop';
2252 if (!course_ajax_enabled($mod->get_course())) {
2253 // Override for course frontpage until we get drag/drop working there.
2254 $pixicon = 't/move';
2257 return html_writer
::link(
2258 new moodle_url($baseurl, array('copy' => $mod->id
)),
2259 $OUTPUT->pix_icon($pixicon, $str->move
, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2260 array('class' => 'editing_move', 'data-action' => 'move')
2267 * given a course object with shortname & fullname, this function will
2268 * truncate the the number of chars allowed and add ... if it was too long
2270 function course_format_name ($course,$max=100) {
2272 $context = context_course
::instance($course->id
);
2273 $shortname = format_string($course->shortname
, true, array('context' => $context));
2274 $fullname = format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
2275 $str = $shortname.': '. $fullname;
2276 if (core_text
::strlen($str) <= $max) {
2280 return core_text
::substr($str,0,$max-3).'...';
2285 * Is the user allowed to add this type of module to this course?
2286 * @param object $course the course settings. Only $course->id is used.
2287 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2288 * @return bool whether the current user is allowed to add this type of module to this course.
2290 function course_allowed_module($course, $modname) {
2291 if (is_numeric($modname)) {
2292 throw new coding_exception('Function course_allowed_module no longer
2293 supports numeric module ids. Please update your code to pass the module name.');
2296 $capability = 'mod/' . $modname . ':addinstance';
2297 if (!get_capability_info($capability)) {
2298 // Debug warning that the capability does not exist, but no more than once per page.
2299 static $warned = array();
2300 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE
, MOD_ARCHETYPE_OTHER
);
2301 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM
) {
2302 debugging('The module ' . $modname . ' does not define the standard capability ' .
2303 $capability , DEBUG_DEVELOPER
);
2304 $warned[$modname] = 1;
2307 // If the capability does not exist, the module can always be added.
2311 $coursecontext = context_course
::instance($course->id
);
2312 return has_capability($capability, $coursecontext);
2316 * Efficiently moves many courses around while maintaining
2317 * sortorder in order.
2319 * @param array $courseids is an array of course ids
2320 * @param int $categoryid
2321 * @return bool success
2323 function move_courses($courseids, $categoryid) {
2326 if (empty($courseids)) {
2331 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2335 $courseids = array_reverse($courseids);
2336 $newparent = context_coursecat
::instance($category->id
);
2339 list($where, $params) = $DB->get_in_or_equal($courseids);
2340 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2341 foreach ($dbcourses as $dbcourse) {
2342 $course = new stdClass();
2343 $course->id
= $dbcourse->id
;
2344 $course->category
= $category->id
;
2345 $course->sortorder
= $category->sortorder + MAX_COURSES_IN_CATEGORY
- $i++
;
2346 if ($category->visible
== 0) {
2347 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2348 // to previous state if somebody unhides the category.
2349 $course->visible
= 0;
2352 $DB->update_record('course', $course);
2354 // Update context, so it can be passed to event.
2355 $context = context_course
::instance($course->id
);
2356 $context->update_moved($newparent);
2358 // Trigger a course updated event.
2359 $event = \core\event\course_updated
::create(array(
2360 'objectid' => $course->id
,
2361 'context' => context_course
::instance($course->id
),
2362 'other' => array('shortname' => $dbcourse->shortname
,
2363 'fullname' => $dbcourse->fullname
)
2365 $event->set_legacy_logdata(array($course->id
, 'course', 'move', 'edit.php?id=' . $course->id
, $course->id
));
2368 fix_course_sortorder();
2369 cache_helper
::purge_by_event('changesincourse');
2375 * Returns the display name of the given section that the course prefers
2377 * Implementation of this function is provided by course format
2378 * @see format_base::get_section_name()
2380 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2381 * @param int|stdClass $section Section object from database or just field course_sections.section
2382 * @return string Display name that the course format prefers, e.g. "Week 2"
2384 function get_section_name($courseorid, $section) {
2385 return course_get_format($courseorid)->get_section_name($section);
2389 * Tells if current course format uses sections
2391 * @param string $format Course format ID e.g. 'weeks' $course->format
2394 function course_format_uses_sections($format) {
2395 $course = new stdClass();
2396 $course->format
= $format;
2397 return course_get_format($course)->uses_sections();
2401 * Returns the information about the ajax support in the given source format
2403 * The returned object's property (boolean)capable indicates that
2404 * the course format supports Moodle course ajax features.
2406 * @param string $format
2409 function course_format_ajax_support($format) {
2410 $course = new stdClass();
2411 $course->format
= $format;
2412 return course_get_format($course)->supports_ajax();
2416 * Can the current user delete this course?
2417 * Course creators have exception,
2418 * 1 day after the creation they can sill delete the course.
2419 * @param int $courseid
2422 function can_delete_course($courseid) {
2425 $context = context_course
::instance($courseid);
2427 if (has_capability('moodle/course:delete', $context)) {
2431 // hack: now try to find out if creator created this course recently (1 day)
2432 if (!has_capability('moodle/course:create', $context)) {
2436 $since = time() - 60*60*24;
2437 $course = get_course($courseid);
2439 if ($course->timecreated
< $since) {
2440 return false; // Return if the course was not created in last 24 hours.
2443 $logmanger = get_log_manager();
2444 $readers = $logmanger->get_readers('\core\log\sql_reader');
2445 $reader = reset($readers);
2447 if (empty($reader)) {
2448 return false; // No log reader found.
2452 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2453 $params = array('userid' => $USER->id
, 'since' => $since, 'courseid' => $course->id
, 'eventname' => '\core\event\course_created');
2455 return (bool)$reader->get_events_select_count($select, $params);
2459 * Save the Your name for 'Some role' strings.
2461 * @param integer $courseid the id of this course.
2462 * @param array $data the data that came from the course settings form.
2464 function save_local_role_names($courseid, $data) {
2466 $context = context_course
::instance($courseid);
2468 foreach ($data as $fieldname => $value) {
2469 if (strpos($fieldname, 'role_') !== 0) {
2472 list($ignored, $roleid) = explode('_', $fieldname);
2474 // make up our mind whether we want to delete, update or insert
2476 $DB->delete_records('role_names', array('contextid' => $context->id
, 'roleid' => $roleid));
2478 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id
, 'roleid' => $roleid))) {
2479 $rolename->name
= $value;
2480 $DB->update_record('role_names', $rolename);
2483 $rolename = new stdClass
;
2484 $rolename->contextid
= $context->id
;
2485 $rolename->roleid
= $roleid;
2486 $rolename->name
= $value;
2487 $DB->insert_record('role_names', $rolename);
2493 * Returns options to use in course overviewfiles filemanager
2495 * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2496 * may be empty if course does not exist yet (course create form)
2497 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2498 * or null if overviewfiles are disabled
2500 function course_overviewfiles_options($course) {
2502 if (empty($CFG->courseoverviewfileslimit
)) {
2505 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext
), -1, PREG_SPLIT_NO_EMPTY
);
2506 if (in_array('*', $accepted_types) ||
empty($accepted_types)) {
2507 $accepted_types = '*';
2509 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2510 // Make sure extensions are prefixed with dot unless they are valid typegroups
2511 foreach ($accepted_types as $i => $type) {
2512 if (substr($type, 0, 1) !== '.') {
2513 require_once($CFG->libdir
. '/filelib.php');
2514 if (!count(file_get_typegroup('extension', $type))) {
2515 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2516 $accepted_types[$i] = '.'. $type;
2521 if (!empty($corrected)) {
2522 set_config('courseoverviewfilesext', join(',', $accepted_types));
2526 'maxfiles' => $CFG->courseoverviewfileslimit
,
2527 'maxbytes' => $CFG->maxbytes
,
2529 'accepted_types' => $accepted_types
2531 if (!empty($course->id
)) {
2532 $options['context'] = context_course
::instance($course->id
);
2533 } else if (is_int($course) && $course > 0) {
2534 $options['context'] = context_course
::instance($course);
2540 * Create a course and either return a $course object
2542 * Please note this functions does not verify any access control,
2543 * the calling code is responsible for all validation (usually it is the form definition).
2545 * @param array $editoroptions course description editor options
2546 * @param object $data - all the data needed for an entry in the 'course' table
2547 * @return object new course instance
2549 function create_course($data, $editoroptions = NULL) {
2551 require_once($CFG->dirroot
.'/tag/lib.php');
2553 //check the categoryid - must be given for all new courses
2554 $category = $DB->get_record('course_categories', array('id'=>$data->category
), '*', MUST_EXIST
);
2556 // Check if the shortname already exists.
2557 if (!empty($data->shortname
)) {
2558 if ($DB->record_exists('course', array('shortname' => $data->shortname
))) {
2559 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2563 // Check if the idnumber already exists.
2564 if (!empty($data->idnumber
)) {
2565 if ($DB->record_exists('course', array('idnumber' => $data->idnumber
))) {
2566 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2570 // Check if timecreated is given.
2571 $data->timecreated
= !empty($data->timecreated
) ?
$data->timecreated
: time();
2572 $data->timemodified
= $data->timecreated
;
2574 // place at beginning of any category
2575 $data->sortorder
= 0;
2577 if ($editoroptions) {
2578 // summary text is updated later, we need context to store the files first
2579 $data->summary
= '';
2580 $data->summary_format
= FORMAT_HTML
;
2583 if (!isset($data->visible
)) {
2584 // data not from form, add missing visibility info
2585 $data->visible
= $category->visible
;
2587 $data->visibleold
= $data->visible
;
2589 $newcourseid = $DB->insert_record('course', $data);
2590 $context = context_course
::instance($newcourseid, MUST_EXIST
);
2592 if ($editoroptions) {
2593 // Save the files used in the summary editor and store
2594 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2595 $DB->set_field('course', 'summary', $data->summary
, array('id'=>$newcourseid));
2596 $DB->set_field('course', 'summaryformat', $data->summary_format
, array('id'=>$newcourseid));
2598 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2599 // Save the course overviewfiles
2600 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2603 // update course format options
2604 course_get_format($newcourseid)->update_course_format_options($data);
2606 $course = course_get_format($newcourseid)->get_course();
2608 fix_course_sortorder();
2609 // purge appropriate caches in case fix_course_sortorder() did not change anything
2610 cache_helper
::purge_by_event('changesincourse');
2612 // new context created - better mark it as dirty
2613 $context->mark_dirty();
2615 // Trigger a course created event.
2616 $event = \core\event\course_created
::create(array(
2617 'objectid' => $course->id
,
2618 'context' => context_course
::instance($course->id
),
2619 'other' => array('shortname' => $course->shortname
,
2620 'fullname' => $course->fullname
)
2625 blocks_add_default_course_blocks($course);
2627 // Create a default section.
2628 course_create_sections_if_missing($course, 0);
2630 // Save any custom role names.
2631 save_local_role_names($course->id
, (array)$data);
2633 // set up enrolments
2634 enrol_course_updated(true, $course, $data);
2636 // Update course tags.
2637 if ($CFG->usetags
&& isset($data->tags
)) {
2638 tag_set('course', $course->id
, $data->tags
, 'core', context_course
::instance($course->id
)->id
);
2647 * Please note this functions does not verify any access control,
2648 * the calling code is responsible for all validation (usually it is the form definition).
2650 * @param object $data - all the data needed for an entry in the 'course' table
2651 * @param array $editoroptions course description editor options
2654 function update_course($data, $editoroptions = NULL) {
2656 require_once($CFG->dirroot
.'/tag/lib.php');
2658 $data->timemodified
= time();
2660 $oldcourse = course_get_format($data->id
)->get_course();
2661 $context = context_course
::instance($oldcourse->id
);
2663 if ($editoroptions) {
2664 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2666 if ($overviewfilesoptions = course_overviewfiles_options($data->id
)) {
2667 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2670 // Check we don't have a duplicate shortname.
2671 if (!empty($data->shortname
) && $oldcourse->shortname
!= $data->shortname
) {
2672 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname
, $data->id
))) {
2673 throw new moodle_exception('shortnametaken', '', '', $data->shortname
);
2677 // Check we don't have a duplicate idnumber.
2678 if (!empty($data->idnumber
) && $oldcourse->idnumber
!= $data->idnumber
) {
2679 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber
, $data->id
))) {
2680 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber
);
2684 if (!isset($data->category
) or empty($data->category
)) {
2685 // prevent nulls and 0 in category field
2686 unset($data->category
);
2688 $changesincoursecat = $movecat = (isset($data->category
) and $oldcourse->category
!= $data->category
);
2690 if (!isset($data->visible
)) {
2691 // data not from form, add missing visibility info
2692 $data->visible
= $oldcourse->visible
;
2695 if ($data->visible
!= $oldcourse->visible
) {
2696 // reset the visibleold flag when manually hiding/unhiding course
2697 $data->visibleold
= $data->visible
;
2698 $changesincoursecat = true;
2701 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category
));
2702 if (empty($newcategory->visible
)) {
2703 // make sure when moving into hidden category the course is hidden automatically
2709 // Update with the new data
2710 $DB->update_record('course', $data);
2711 // make sure the modinfo cache is reset
2712 rebuild_course_cache($data->id
);
2714 // update course format options with full course data
2715 course_get_format($data->id
)->update_course_format_options($data, $oldcourse);
2717 $course = $DB->get_record('course', array('id'=>$data->id
));
2720 $newparent = context_coursecat
::instance($course->category
);
2721 $context->update_moved($newparent);
2723 $fixcoursesortorder = $movecat ||
(isset($data->sortorder
) && ($oldcourse->sortorder
!= $data->sortorder
));
2724 if ($fixcoursesortorder) {
2725 fix_course_sortorder();
2728 // purge appropriate caches in case fix_course_sortorder() did not change anything
2729 cache_helper
::purge_by_event('changesincourse');
2730 if ($changesincoursecat) {
2731 cache_helper
::purge_by_event('changesincoursecat');
2734 // Test for and remove blocks which aren't appropriate anymore
2735 blocks_remove_inappropriate($course);
2737 // Save any custom role names.
2738 save_local_role_names($course->id
, $data);
2740 // update enrol settings
2741 enrol_course_updated(false, $course, $data);
2743 // Update course tags.
2744 if ($CFG->usetags
&& isset($data->tags
)) {
2745 tag_set('course', $course->id
, $data->tags
, 'core', context_course
::instance($course->id
)->id
);
2748 // Trigger a course updated event.
2749 $event = \core\event\course_updated
::create(array(
2750 'objectid' => $course->id
,
2751 'context' => context_course
::instance($course->id
),
2752 'other' => array('shortname' => $course->shortname
,
2753 'fullname' => $course->fullname
)
2756 $event->set_legacy_logdata(array($course->id
, 'course', 'update', 'edit.php?id=' . $course->id
, $course->id
));
2759 if ($oldcourse->format
!== $course->format
) {
2760 // Remove all options stored for the previous format
2761 // We assume that new course format migrated everything it needed watching trigger
2762 // 'course_updated' and in method format_XXX::update_course_format_options()
2763 $DB->delete_records('course_format_options',
2764 array('courseid' => $course->id
, 'format' => $oldcourse->format
));
2769 * Average number of participants
2772 function average_number_of_participants() {
2775 //count total of enrolments for visible course (except front page)
2776 $sql = 'SELECT COUNT(*) FROM (
2777 SELECT DISTINCT ue.userid, e.courseid
2778 FROM {user_enrolments} ue, {enrol} e, {course} c
2779 WHERE ue.enrolid = e.id
2780 AND e.courseid <> :siteid
2781 AND c.id = e.courseid
2782 AND c.visible = 1) total';
2783 $params = array('siteid' => $SITE->id
);
2784 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2787 //count total of visible courses (minus front page)
2788 $coursetotal = $DB->count_records('course', array('visible' => 1));
2789 $coursetotal = $coursetotal - 1 ;
2791 //average of enrolment
2792 if (empty($coursetotal)) {
2793 $participantaverage = 0;
2795 $participantaverage = $enrolmenttotal / $coursetotal;
2798 return $participantaverage;
2802 * Average number of course modules
2805 function average_number_of_courses_modules() {
2808 //count total of visible course module (except front page)
2809 $sql = 'SELECT COUNT(*) FROM (
2810 SELECT cm.course, cm.module
2811 FROM {course} c, {course_modules} cm
2812 WHERE c.id = cm.course
2815 AND c.visible = 1) total';
2816 $params = array('siteid' => $SITE->id
);
2817 $moduletotal = $DB->count_records_sql($sql, $params);
2820 //count total of visible courses (minus front page)
2821 $coursetotal = $DB->count_records('course', array('visible' => 1));
2822 $coursetotal = $coursetotal - 1 ;
2824 //average of course module
2825 if (empty($coursetotal)) {
2826 $coursemoduleaverage = 0;
2828 $coursemoduleaverage = $moduletotal / $coursetotal;
2831 return $coursemoduleaverage;
2835 * This class pertains to course requests and contains methods associated with
2836 * create, approving, and removing course requests.
2838 * Please note we do not allow embedded images here because there is no context
2839 * to store them with proper access control.
2841 * @copyright 2009 Sam Hemelryk
2842 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2845 * @property-read int $id
2846 * @property-read string $fullname
2847 * @property-read string $shortname
2848 * @property-read string $summary
2849 * @property-read int $summaryformat
2850 * @property-read int $summarytrust
2851 * @property-read string $reason
2852 * @property-read int $requester
2854 class course_request
{
2857 * This is the stdClass that stores the properties for the course request
2858 * and is externally accessed through the __get magic method
2861 protected $properties;
2864 * An array of options for the summary editor used by course request forms.
2865 * This is initially set by {@link summary_editor_options()}
2869 protected static $summaryeditoroptions;
2872 * Static function to prepare the summary editor for working with a course
2876 * @param null|stdClass $data Optional, an object containing the default values
2877 * for the form, these may be modified when preparing the
2878 * editor so this should be called before creating the form
2879 * @return stdClass An object that can be used to set the default values for
2882 public static function prepare($data=null) {
2883 if ($data === null) {
2884 $data = new stdClass
;
2886 $data = file_prepare_standard_editor($data, 'summary', self
::summary_editor_options());
2891 * Static function to create a new course request when passed an array of properties
2894 * This function also handles saving any files that may have been used in the editor
2897 * @param stdClass $data
2898 * @return course_request The newly created course request
2900 public static function create($data) {
2901 global $USER, $DB, $CFG;
2902 $data->requester
= $USER->id
;
2904 // Setting the default category if none set.
2905 if (empty($data->category
) ||
empty($CFG->requestcategoryselection
)) {
2906 $data->category
= $CFG->defaultrequestcategory
;
2909 // Summary is a required field so copy the text over
2910 $data->summary
= $data->summary_editor
['text'];
2911 $data->summaryformat
= $data->summary_editor
['format'];
2913 $data->id
= $DB->insert_record('course_request', $data);
2915 // Create a new course_request object and return it
2916 $request = new course_request($data);
2918 // Notify the admin if required.
2919 if ($users = get_users_from_config($CFG->courserequestnotify
, 'moodle/site:approvecourse')) {
2922 $a->link
= "$CFG->wwwroot/course/pending.php";
2923 $a->user
= fullname($USER);
2924 $subject = get_string('courserequest');
2925 $message = get_string('courserequestnotifyemail', 'admin', $a);
2926 foreach ($users as $user) {
2927 $request->notify($user, $USER, 'courserequested', $subject, $message);
2935 * Returns an array of options to use with a summary editor
2937 * @uses course_request::$summaryeditoroptions
2938 * @return array An array of options to use with the editor
2940 public static function summary_editor_options() {
2942 if (self
::$summaryeditoroptions === null) {
2943 self
::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2945 return self
::$summaryeditoroptions;
2949 * Loads the properties for this course request object. Id is required and if
2950 * only id is provided then we load the rest of the properties from the database
2952 * @param stdClass|int $properties Either an object containing properties
2953 * or the course_request id to load
2955 public function __construct($properties) {
2957 if (empty($properties->id
)) {
2958 if (empty($properties)) {
2959 throw new coding_exception('You must provide a course request id when creating a course_request object');
2962 $properties = new stdClass
;
2963 $properties->id
= (int)$id;
2966 if (empty($properties->requester
)) {
2967 if (!($this->properties
= $DB->get_record('course_request', array('id' => $properties->id
)))) {
2968 print_error('unknowncourserequest');
2971 $this->properties
= $properties;
2973 $this->properties
->collision
= null;
2977 * Returns the requested property
2979 * @param string $key
2982 public function __get($key) {
2983 return $this->properties
->$key;
2987 * Override this to ensure empty($request->blah) calls return a reliable answer...
2989 * This is required because we define the __get method
2992 * @return bool True is it not empty, false otherwise
2994 public function __isset($key) {
2995 return (!empty($this->properties
->$key));
2999 * Returns the user who requested this course
3001 * Uses a static var to cache the results and cut down the number of db queries
3003 * @staticvar array $requesters An array of cached users
3004 * @return stdClass The user who requested the course
3006 public function get_requester() {
3008 static $requesters= array();
3009 if (!array_key_exists($this->properties
->requester
, $requesters)) {
3010 $requesters[$this->properties
->requester
] = $DB->get_record('user', array('id'=>$this->properties
->requester
));
3012 return $requesters[$this->properties
->requester
];
3016 * Checks that the shortname used by the course does not conflict with any other
3017 * courses that exist
3019 * @param string|null $shortnamemark The string to append to the requests shortname
3020 * should a conflict be found
3021 * @return bool true is there is a conflict, false otherwise
3023 public function check_shortname_collision($shortnamemark = '[*]') {
3026 if ($this->properties
->collision
!== null) {
3027 return $this->properties
->collision
;
3030 if (empty($this->properties
->shortname
)) {
3031 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER
);
3032 $this->properties
->collision
= false;
3033 } else if ($DB->record_exists('course', array('shortname' => $this->properties
->shortname
))) {
3034 if (!empty($shortnamemark)) {
3035 $this->properties
->shortname
.= ' '.$shortnamemark;
3037 $this->properties
->collision
= true;
3039 $this->properties
->collision
= false;
3041 return $this->properties
->collision
;
3045 * Returns the category where this course request should be created
3047 * Note that we don't check here that user has a capability to view
3048 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3049 * 'moodle/course:changecategory'
3053 public function get_category() {
3055 require_once($CFG->libdir
.'/coursecatlib.php');
3056 // If the category is not set, if the current user does not have the rights to change the category, or if the
3057 // category does not exist, we set the default category to the course to be approved.
3058 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3059 if (empty($this->properties
->category
) ||
!has_capability('moodle/course:changecategory', context_system
::instance()) ||
3060 (!$category = coursecat
::get($this->properties
->category
, IGNORE_MISSING
, true))) {
3061 $category = coursecat
::get($CFG->defaultrequestcategory
, IGNORE_MISSING
, true);
3064 $category = coursecat
::get_default();
3070 * This function approves the request turning it into a course
3072 * This function converts the course request into a course, at the same time
3073 * transferring any files used in the summary to the new course and then removing
3074 * the course request and the files associated with it.
3076 * @return int The id of the course that was created from this request
3078 public function approve() {
3079 global $CFG, $DB, $USER;
3081 $user = $DB->get_record('user', array('id' => $this->properties
->requester
, 'deleted'=>0), '*', MUST_EXIST
);
3083 $courseconfig = get_config('moodlecourse');
3085 // Transfer appropriate settings
3086 $data = clone($this->properties
);
3088 unset($data->reason
);
3089 unset($data->requester
);
3092 $category = $this->get_category();
3093 $data->category
= $category->id
;
3094 // Set misc settings
3095 $data->requested
= 1;
3097 // Apply course default settings
3098 $data->format
= $courseconfig->format
;
3099 $data->newsitems
= $courseconfig->newsitems
;
3100 $data->showgrades
= $courseconfig->showgrades
;
3101 $data->showreports
= $courseconfig->showreports
;
3102 $data->maxbytes
= $courseconfig->maxbytes
;
3103 $data->groupmode
= $courseconfig->groupmode
;
3104 $data->groupmodeforce
= $courseconfig->groupmodeforce
;
3105 $data->visible
= $courseconfig->visible
;
3106 $data->visibleold
= $data->visible
;
3107 $data->lang
= $courseconfig->lang
;
3109 $course = create_course($data);
3110 $context = context_course
::instance($course->id
, MUST_EXIST
);
3112 // add enrol instances
3113 if (!$DB->record_exists('enrol', array('courseid'=>$course->id
, 'enrol'=>'manual'))) {
3114 if ($manual = enrol_get_plugin('manual')) {
3115 $manual->add_default_instance($course);
3119 // enrol the requester as teacher if necessary
3120 if (!empty($CFG->creatornewroleid
) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3121 enrol_try_internal_enrol($course->id
, $user->id
, $CFG->creatornewroleid
);
3126 $a = new stdClass();
3127 $a->name
= format_string($course->fullname
, true, array('context' => context_course
::instance($course->id
)));
3128 $a->url
= $CFG->wwwroot
.'/course/view.php?id=' . $course->id
;
3129 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3135 * Reject a course request
3137 * This function rejects a course request, emailing the requesting user the
3138 * provided notice and then removing the request from the database
3140 * @param string $notice The message to display to the user
3142 public function reject($notice) {
3144 $user = $DB->get_record('user', array('id' => $this->properties
->requester
), '*', MUST_EXIST
);
3145 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3150 * Deletes the course request and any associated files
3152 public function delete() {
3154 $DB->delete_records('course_request', array('id' => $this->properties
->id
));
3158 * Send a message from one user to another using events_trigger
3160 * @param object $touser
3161 * @param object $fromuser
3162 * @param string $name
3163 * @param string $subject
3164 * @param string $message
3166 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3167 $eventdata = new stdClass();
3168 $eventdata->component
= 'moodle';
3169 $eventdata->name
= $name;
3170 $eventdata->userfrom
= $fromuser;
3171 $eventdata->userto
= $touser;
3172 $eventdata->subject
= $subject;
3173 $eventdata->fullmessage
= $message;
3174 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
3175 $eventdata->fullmessagehtml
= '';
3176 $eventdata->smallmessage
= '';
3177 $eventdata->notification
= 1;
3178 message_send($eventdata);
3183 * Return a list of page types
3184 * @param string $pagetype current page type
3185 * @param context $parentcontext Block's parent context
3186 * @param context $currentcontext Current context of block
3187 * @return array array of page types
3189 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3190 if ($pagetype === 'course-index' ||
$pagetype === 'course-index-category') {
3191 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3192 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3193 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3195 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) ||
$coursecontext->instanceid
== SITEID
)) {
3196 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3197 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3199 // Otherwise consider it a page inside a course even if $currentcontext is null
3200 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3201 'course-*' => get_string('page-course-x', 'pagetype'),
3202 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3209 * Determine whether course ajax should be enabled for the specified course
3211 * @param stdClass $course The course to test against
3212 * @return boolean Whether course ajax is enabled or note
3214 function course_ajax_enabled($course) {
3215 global $CFG, $PAGE, $SITE;
3217 // The user must be editing for AJAX to be included
3218 if (!$PAGE->user_is_editing()) {
3222 // Check that the theme suports
3223 if (!$PAGE->theme
->enablecourseajax
) {
3227 // Check that the course format supports ajax functionality
3228 // The site 'format' doesn't have information on course format support
3229 if ($SITE->id
!== $course->id
) {
3230 $courseformatajaxsupport = course_format_ajax_support($course->format
);
3231 if (!$courseformatajaxsupport->capable
) {
3236 // All conditions have been met so course ajax should be enabled
3241 * Include the relevant javascript and language strings for the resource
3242 * toolbox YUI module
3244 * @param integer $id The ID of the course being applied to
3245 * @param array $usedmodules An array containing the names of the modules in use on the page
3246 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3247 * @param stdClass $config An object containing configuration parameters for ajax modules including:
3248 * * resourceurl The URL to post changes to for resource changes
3249 * * sectionurl The URL to post changes to for section changes
3250 * * pageparams Additional parameters to pass through in the post
3253 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3254 global $CFG, $PAGE, $SITE;
3256 // Ensure that ajax should be included
3257 if (!course_ajax_enabled($course)) {
3262 $config = new stdClass();
3265 // The URL to use for resource changes
3266 if (!isset($config->resourceurl
)) {
3267 $config->resourceurl
= '/course/rest.php';
3270 // The URL to use for section changes
3271 if (!isset($config->sectionurl
)) {
3272 $config->sectionurl
= '/course/rest.php';
3275 // Any additional parameters which need to be included on page submission
3276 if (!isset($config->pageparams
)) {
3277 $config->pageparams
= array();
3280 // Include toolboxes
3281 $PAGE->requires
->yui_module('moodle-course-toolboxes',
3282 'M.course.init_resource_toolbox',
3284 'courseid' => $course->id
,
3285 'ajaxurl' => $config->resourceurl
,
3286 'config' => $config,
3289 $PAGE->requires
->yui_module('moodle-course-toolboxes',
3290 'M.course.init_section_toolbox',
3292 'courseid' => $course->id
,
3293 'format' => $course->format
,
3294 'ajaxurl' => $config->sectionurl
,
3295 'config' => $config,
3299 // Include course dragdrop
3300 if (course_format_uses_sections($course->format
)) {
3301 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3303 'courseid' => $course->id
,
3304 'ajaxurl' => $config->sectionurl
,
3305 'config' => $config,
3308 $PAGE->requires
->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3310 'courseid' => $course->id
,
3311 'ajaxurl' => $config->resourceurl
,
3312 'config' => $config,
3316 // Require various strings for the command toolbox
3317 $PAGE->requires
->strings_for_js(array(
3320 'deletechecktypename',
3322 'edittitleinstructions',
3330 'clicktochangeinbrackets',
3335 'movecoursesection',
3338 'emptydragdropregion',
3344 // Include section-specific strings for formats which support sections.
3345 if (course_format_uses_sections($course->format
)) {
3346 $PAGE->requires
->strings_for_js(array(
3349 ), 'format_' . $course->format
);
3352 // For confirming resource deletion we need the name of the module in question
3353 foreach ($usedmodules as $module => $modname) {
3354 $PAGE->requires
->string_for_js('pluginname', $module);
3357 // Load drag and drop upload AJAX.
3358 require_once($CFG->dirroot
.'/course/dnduploadlib.php');
3359 dndupload_add_to_course($course, $enabledmodules);
3365 * Returns the sorted list of available course formats, filtered by enabled if necessary
3367 * @param bool $enabledonly return only formats that are enabled
3368 * @return array array of sorted format names
3370 function get_sorted_course_formats($enabledonly = false) {
3372 $formats = core_component
::get_plugin_list('format');
3374 if (!empty($CFG->format_plugins_sortorder
)) {
3375 $order = explode(',', $CFG->format_plugins_sortorder
);
3376 $order = array_merge(array_intersect($order, array_keys($formats)),
3377 array_diff(array_keys($formats), $order));
3379 $order = array_keys($formats);
3381 if (!$enabledonly) {
3384 $sortedformats = array();
3385 foreach ($order as $formatname) {
3386 if (!get_config('format_'.$formatname, 'disabled')) {
3387 $sortedformats[] = $formatname;
3390 return $sortedformats;
3394 * The URL to use for the specified course (with section)
3396 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3397 * @param int|stdClass $section Section object from database or just field course_sections.section
3398 * if omitted the course view page is returned
3399 * @param array $options options for view URL. At the moment core uses:
3400 * 'navigation' (bool) if true and section has no separate page, the function returns null
3401 * 'sr' (int) used by multipage formats to specify to which section to return
3402 * @return moodle_url The url of course
3404 function course_get_url($courseorid, $section = null, $options = array()) {
3405 return course_get_format($courseorid)->get_view_url($section, $options);
3412 * - capability checks and other checks
3413 * - create the module from the module info
3415 * @param object $module
3416 * @return object the created module info
3417 * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3419 function create_module($moduleinfo) {
3422 require_once($CFG->dirroot
. '/course/modlib.php');
3424 // Check manadatory attributs.
3425 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3426 if (plugin_supports('mod', $moduleinfo->modulename
, FEATURE_MOD_INTRO
, true)) {
3427 $mandatoryfields[] = 'introeditor';
3429 foreach($mandatoryfields as $mandatoryfield) {
3430 if (!isset($moduleinfo->{$mandatoryfield})) {
3431 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3435 // Some additional checks (capability / existing instances).
3436 $course = $DB->get_record('course', array('id'=>$moduleinfo->course
), '*', MUST_EXIST
);
3437 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename
, $moduleinfo->section
);
3440 $moduleinfo->module
= $module->id
;
3441 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3450 * - capability and other checks
3451 * - update the module
3453 * @param object $module
3454 * @return object the updated module info
3455 * @throws moodle_exception if current user is not allowed to update the module
3457 function update_module($moduleinfo) {
3460 require_once($CFG->dirroot
. '/course/modlib.php');
3462 // Check the course module exists.
3463 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule
, 0, false, MUST_EXIST
);
3465 // Check the course exists.
3466 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
3468 // Some checks (capaibility / existing instances).
3469 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3471 // Retrieve few information needed by update_moduleinfo.
3472 $moduleinfo->modulename
= $cm->modname
;
3473 if (!isset($moduleinfo->scale
)) {
3474 $moduleinfo->scale
= 0;
3476 $moduleinfo->type
= 'mod';
3478 // Update the module.
3479 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3485 * Duplicate a module on the course for ajax.
3487 * @see mod_duplicate_module()
3488 * @param object $course The course
3489 * @param object $cm The course module to duplicate
3490 * @param int $sr The section to link back to (used for creating the links)
3491 * @throws moodle_exception if the plugin doesn't support duplication
3492 * @return Object containing:
3493 * - fullcontent: The HTML markup for the created CM
3494 * - cmid: The CMID of the newly created CM
3495 * - redirect: Whether to trigger a redirect following this change
3497 function mod_duplicate_activity($course, $cm, $sr = null) {
3500 $newcm = duplicate_module($course, $cm);
3502 $resp = new stdClass();
3504 $courserenderer = $PAGE->get_renderer('core', 'course');
3505 $completioninfo = new completion_info($course);
3506 $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3507 $newcm, null, array());
3509 $resp->fullcontent
= $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3510 $resp->cmid
= $newcm->id
;
3512 // Trigger a redirect.
3513 $resp->redirect
= true;
3519 * Api to duplicate a module.
3521 * @param object $course course object.
3522 * @param object $cm course module object to be duplicated.
3526 * @throws coding_exception
3527 * @throws moodle_exception
3528 * @throws restore_controller_exception
3530 * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3532 function duplicate_module($course, $cm) {
3533 global $CFG, $DB, $USER;
3534 require_once($CFG->dirroot
. '/backup/util/includes/backup_includes.php');
3535 require_once($CFG->dirroot
. '/backup/util/includes/restore_includes.php');
3536 require_once($CFG->libdir
. '/filelib.php');
3538 $a = new stdClass();
3539 $a->modtype
= get_string('modulename', $cm->modname
);
3540 $a->modname
= format_string($cm->name
);
3542 if (!plugin_supports('mod', $cm->modname
, FEATURE_BACKUP_MOODLE2
)) {
3543 throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3546 // Backup the activity.
3548 $bc = new backup_controller(backup
::TYPE_1ACTIVITY
, $cm->id
, backup
::FORMAT_MOODLE
,
3549 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
);
3551 $backupid = $bc->get_backupid();
3552 $backupbasepath = $bc->get_plan()->get_basepath();
3554 $bc->execute_plan();
3558 // Restore the backup immediately.
3560 $rc = new restore_controller($backupid, $course->id
,
3561 backup
::INTERACTIVE_NO
, backup
::MODE_IMPORT
, $USER->id
, backup
::TARGET_CURRENT_ADDING
);
3563 $cmcontext = context_module
::instance($cm->id
);
3564 if (!$rc->execute_precheck()) {
3565 $precheckresults = $rc->get_precheck_results();
3566 if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3567 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3568 fulldelete($backupbasepath);
3573 $rc->execute_plan();
3575 // Now a bit hacky part follows - we try to get the cmid of the newly
3576 // restored copy of the module.
3578 $tasks = $rc->get_plan()->get_tasks();
3579 foreach ($tasks as $task) {
3580 if (is_subclass_of($task, 'restore_activity_task')) {
3581 if ($task->get_old_contextid() == $cmcontext->id
) {
3582 $newcmid = $task->get_moduleid();
3588 // If we know the cmid of the new course module, let us move it
3589 // right below the original one. otherwise it will stay at the
3590 // end of the section.
3592 $info = get_fast_modinfo($course);
3593 $newcm = $info->get_cm($newcmid);
3594 $section = $DB->get_record('course_sections', array('id' => $cm->section
, 'course' => $cm->course
));
3595 moveto_module($newcm, $section, $cm);
3596 moveto_module($cm, $section, $newcm);
3598 // Trigger course module created event. We can trigger the event only if we know the newcmid.
3599 $event = \core\event\course_module_created
::create_from_cm($newcm);
3602 rebuild_course_cache($cm->course
);
3606 if (empty($CFG->keeptempdirectoriesonbackup
)) {
3607 fulldelete($backupbasepath);
3610 return isset($newcm) ?
$newcm : null;
3614 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3615 * Sorts by descending order of time.
3617 * @param stdClass $a First object
3618 * @param stdClass $b Second object
3619 * @return int 0,1,-1 representing the order
3621 function compare_activities_by_time_desc($a, $b) {
3622 // Make sure the activities actually have a timestamp property.
3623 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3626 // We treat instances without timestamp as if they have a timestamp of 0.
3627 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3630 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3633 if ($a->timestamp
== $b->timestamp
) {
3636 return ($a->timestamp
> $b->timestamp
) ?
-1 : 1;
3640 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3641 * Sorts by ascending order of time.
3643 * @param stdClass $a First object
3644 * @param stdClass $b Second object
3645 * @return int 0,1,-1 representing the order
3647 function compare_activities_by_time_asc($a, $b) {
3648 // Make sure the activities actually have a timestamp property.
3649 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3652 // We treat instances without timestamp as if they have a timestamp of 0.
3653 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3656 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3659 if ($a->timestamp
== $b->timestamp
) {
3662 return ($a->timestamp
< $b->timestamp
) ?
-1 : 1;
3666 * Changes the visibility of a course.
3668 * @param int $courseid The course to change.
3669 * @param bool $show True to make it visible, false otherwise.
3672 function course_change_visibility($courseid, $show = true) {
3673 $course = new stdClass
;
3674 $course->id
= $courseid;
3675 $course->visible
= ($show) ?
'1' : '0';
3676 $course->visibleold
= $course->visible
;
3677 update_course($course);
3682 * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3684 * @param stdClass|course_in_list $course
3685 * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3688 function course_change_sortorder_by_one($course, $up) {
3690 $params = array($course->sortorder
, $course->category
);
3692 $select = 'sortorder < ? AND category = ?';
3693 $sort = 'sortorder DESC';
3695 $select = 'sortorder > ? AND category = ?';
3696 $sort = 'sortorder ASC';
3698 fix_course_sortorder();
3699 $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3701 $swapcourse = reset($swapcourse);
3702 $DB->set_field('course', 'sortorder', $swapcourse->sortorder
, array('id' => $course->id
));
3703 $DB->set_field('course', 'sortorder', $course->sortorder
, array('id' => $swapcourse->id
));
3704 // Finally reorder courses.
3705 fix_course_sortorder();
3706 cache_helper
::purge_by_event('changesincourse');
3713 * Changes the sort order of courses in a category so that the first course appears after the second.
3715 * @param int|stdClass $courseorid The course to focus on.
3716 * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3719 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3722 if (!is_object($courseorid)) {
3723 $course = get_course($courseorid);
3725 $course = $courseorid;
3728 if ((int)$moveaftercourseid === 0) {
3729 // We've moving the course to the start of the queue.
3730 $sql = 'SELECT sortorder
3732 WHERE category = :categoryid
3733 ORDER BY sortorder';
3735 'categoryid' => $course->category
3737 $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE
);
3739 $sql = 'UPDATE {course}
3740 SET sortorder = sortorder + 1
3741 WHERE category = :categoryid
3744 'categoryid' => $course->category
,
3745 'id' => $course->id
,
3747 $DB->execute($sql, $params);
3748 $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id
));
3749 } else if ($course->id
=== $moveaftercourseid) {
3750 // They're the same - moronic.
3751 debugging("Invalid move after course given.", DEBUG_DEVELOPER
);
3754 // Moving this course after the given course. It could be before it could be after.
3755 $moveaftercourse = get_course($moveaftercourseid);
3756 if ($course->category
!== $moveaftercourse->category
) {
3757 debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER
);
3760 // Increment all courses in the same category that are ordered after the moveafter course.
3761 // This makes a space for the course we're moving.
3762 $sql = 'UPDATE {course}
3763 SET sortorder = sortorder + 1
3764 WHERE category = :categoryid
3765 AND sortorder > :sortorder';
3767 'categoryid' => $moveaftercourse->category
,
3768 'sortorder' => $moveaftercourse->sortorder
3770 $DB->execute($sql, $params);
3771 $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder +
1, array('id' => $course->id
));
3773 fix_course_sortorder();
3774 cache_helper
::purge_by_event('changesincourse');
3779 * Trigger course viewed event. This API function is used when course view actions happens,
3780 * usually in course/view.php but also in external functions.
3782 * @param stdClass $context course context object
3783 * @param int $sectionnumber section number
3786 function course_view($context, $sectionnumber = 0) {
3788 $eventdata = array('context' => $context);
3790 if (!empty($sectionnumber)) {
3791 $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3794 $event = \core\event\course_viewed
::create($eventdata);