Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This page handles editing and creation of lesson overrides
 *
 * @package   mod_lesson
 * @copyright 2015 Jean-Michel Vedrine
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


require_once(__DIR__ . '/../../config.php');
require_once($CFG->dirroot.'/mod/lesson/lib.php');
require_once($CFG->dirroot.'/mod/lesson/locallib.php');
require_once($CFG->dirroot.'/mod/lesson/override_form.php');


$cmid = optional_param('cmid', 0, PARAM_INT);
$overrideid = optional_param('id', 0, PARAM_INT);
$action = optional_param('action', null, PARAM_ALPHA);
$reset = optional_param('reset', false, PARAM_BOOL);

$override = null;
if ($overrideid) {

    if (! $override = $DB->get_record('lesson_overrides', array('id' => $overrideid))) {
< print_error('invalidoverrideid', 'lesson');
> throw new \moodle_exception('invalidoverrideid', 'lesson');
} $lesson = new lesson($DB->get_record('lesson', array('id' => $override->lessonid), '*', MUST_EXIST)); list($course, $cm) = get_course_and_cm_from_instance($lesson, 'lesson'); } else if ($cmid) { list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'lesson'); $lesson = new lesson($DB->get_record('lesson', array('id' => $cm->instance), '*', MUST_EXIST)); } else {
< print_error('invalidcoursemodule');
> throw new \moodle_exception('invalidcoursemodule');
} $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST); $url = new moodle_url('/mod/lesson/overrideedit.php'); if ($action) { $url->param('action', $action); } if ($overrideid) { $url->param('id', $overrideid); } else { $url->param('cmid', $cmid); } $PAGE->set_url($url); require_login($course, false, $cm); $context = context_module::instance($cm->id); // Add or edit an override. require_capability('mod/lesson:manageoverrides', $context); if ($overrideid) { // Editing an override. $data = clone $override; if ($override->groupid) { if (!groups_group_visible($override->groupid, $course, $cm)) {
< print_error('invalidoverrideid', 'lesson');
> throw new \moodle_exception('invalidoverrideid', 'lesson');
} } else { if (!groups_user_groups_visible($course, $override->userid, $cm)) {
< print_error('invalidoverrideid', 'lesson');
> throw new \moodle_exception('invalidoverrideid', 'lesson');
} } } else { // Creating a new override. $data = new stdClass(); } // Merge lesson defaults with data. $keys = array('available', 'deadline', 'review', 'timelimit', 'maxattempts', 'retake', 'password'); foreach ($keys as $key) { if (!isset($data->{$key}) || $reset) { $data->{$key} = $lesson->{$key}; } } // True if group-based override. $groupmode = !empty($data->groupid) || ($action === 'addgroup' && empty($overrideid)); // If we are duplicating an override, then clear the user/group and override id // since they will change. if ($action === 'duplicate') { $override->id = $data->id = null; $override->userid = $data->userid = null; $override->groupid = $data->groupid = null; } $overridelisturl = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $cm->id)); if (!$groupmode) { $overridelisturl->param('mode', 'user'); } // Setup the form. $mform = new lesson_override_form($url, $cm, $lesson, $context, $groupmode, $override); $mform->set_data($data); if ($mform->is_cancelled()) { redirect($overridelisturl); } else if (optional_param('resetbutton', 0, PARAM_ALPHA)) { $url->param('reset', true); redirect($url); } else if ($fromform = $mform->get_data()) { // Process the data. $fromform->lessonid = $lesson->id; // Replace unchanged values with null. foreach ($keys as $key) { if ($fromform->{$key} == $lesson->{$key}) { $fromform->{$key} = null; } } // See if we are replacing an existing override. $userorgroupchanged = false; if (empty($override->id)) { $userorgroupchanged = true; } else if (!empty($fromform->userid)) { $userorgroupchanged = $fromform->userid !== $override->userid; } else { $userorgroupchanged = $fromform->groupid !== $override->groupid; } if ($userorgroupchanged) { $conditions = array( 'lessonid' => $lesson->id, 'userid' => empty($fromform->userid) ? null : $fromform->userid, 'groupid' => empty($fromform->groupid) ? null : $fromform->groupid); if ($oldoverride = $DB->get_record('lesson_overrides', $conditions)) { // There is an old override, so we merge any new settings on top of // the older override. foreach ($keys as $key) { if (is_null($fromform->{$key})) { $fromform->{$key} = $oldoverride->{$key}; } } $lesson->delete_override($oldoverride->id); } } // Set the common parameters for one of the events we may be triggering. $params = array( 'context' => $context, 'other' => array( 'lessonid' => $lesson->id ) ); if (!empty($override->id)) { $fromform->id = $override->id; $DB->update_record('lesson_overrides', $fromform);
> $cachekey = $groupmode ? "{$fromform->lessonid}_g_{$fromform->groupid}" : "{$fromform->lessonid}_u_{$fromform->userid}"; > cache::make('mod_lesson', 'overrides')->delete($cachekey);
// Determine which override updated event to fire. $params['objectid'] = $override->id; if (!$groupmode) { $params['relateduserid'] = $fromform->userid; $event = \mod_lesson\event\user_override_updated::create($params); } else { $params['other']['groupid'] = $fromform->groupid; $event = \mod_lesson\event\group_override_updated::create($params); } // Trigger the override updated event. $event->trigger(); } else { unset($fromform->id); $fromform->id = $DB->insert_record('lesson_overrides', $fromform);
> $cachekey = $groupmode ? "{$fromform->lessonid}_g_{$fromform->groupid}" : "{$fromform->lessonid}_u_{$fromform->userid}"; > cache::make('mod_lesson', 'overrides')->delete($cachekey);
// Determine which override created event to fire. $params['objectid'] = $fromform->id; if (!$groupmode) { $params['relateduserid'] = $fromform->userid; $event = \mod_lesson\event\user_override_created::create($params); } else { $params['other']['groupid'] = $fromform->groupid; $event = \mod_lesson\event\group_override_created::create($params); } // Trigger the override created event. $event->trigger(); } if ($groupmode) { // Priorities may have shifted, so we need to update all of the calendar events for group overrides. lesson_update_events($lesson); } else { // User override. We only need to update the calendar event for this user override. lesson_update_events($lesson, $fromform); } if (!empty($fromform->submitbutton)) { redirect($overridelisturl); } // The user pressed the 'again' button, so redirect back to this page. $url->remove_params('cmid'); $url->param('action', 'duplicate'); $url->param('id', $fromform->id); redirect($url); } // Print the form. $pagetitle = get_string('editoverride', 'lesson'); $PAGE->navbar->add($pagetitle); $PAGE->set_pagelayout('admin');
> $PAGE->set_secondary_active_tab('mod_lesson_useroverrides'); $PAGE->set_title($pagetitle); > $PAGE->add_body_class('limitedwidth');
$PAGE->set_heading($course->fullname); echo $OUTPUT->header(); echo $OUTPUT->heading(format_string($lesson->name, true, array('context' => $context))); $mform->display(); echo $OUTPUT->footer();