/mod/lesson/mod_form.php
PHP | 349 lines | 228 code | 64 blank | 57 comment | 21 complexity | 6fa3e02803779e5033573cbe42b11a83 MD5 | raw file
Possible License(s): LGPL-2.1, AGPL-3.0, MPL-2.0-no-copyleft-exception, GPL-3.0, Apache-2.0, BSD-3-Clause
- <?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/>.
- /**
- * Form to define a new instance of lesson or edit an instance.
- * It is used from /course/modedit.php.
- *
- * @package mod
- * @subpackage lesson
- * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
- **/
- defined('MOODLE_INTERNAL') || die();
- require_once($CFG->dirroot.'/course/moodleform_mod.php');
- require_once($CFG->dirroot.'/mod/lesson/locallib.php');
- class mod_lesson_mod_form extends moodleform_mod {
- protected $course = null;
- public function mod_lesson_mod_form($current, $section, $cm, $course) {
- $this->course = $course;
- parent::moodleform_mod($current, $section, $cm, $course);
- }
- function definition() {
- global $CFG, $COURSE, $DB;
- $mform = $this->_form;
- //-------------------------------------------------------------------------------
- $mform->addElement('header', 'general', get_string('general', 'form'));
- /** Legacy slideshow width element to maintain backwards compatibility */
- $mform->addElement('hidden', 'width');
- $mform->setType('width', PARAM_INT);
- $mform->setDefault('width', $CFG->lesson_slideshowwidth);
- /** Legacy slideshow height element to maintain backwards compatibility */
- $mform->addElement('hidden', 'height');
- $mform->setType('height', PARAM_INT);
- $mform->setDefault('height', $CFG->lesson_slideshowheight);
- /** Legacy slideshow background color element to maintain backwards compatibility */
- $mform->addElement('hidden', 'bgcolor');
- $mform->setType('bgcolor', PARAM_TEXT);
- $mform->setDefault('bgcolor', $CFG->lesson_slideshowbgcolor);
- /** Legacy media popup width element to maintain backwards compatibility */
- $mform->addElement('hidden', 'mediawidth');
- $mform->setType('mediawidth', PARAM_INT);
- $mform->setDefault('mediawidth', $CFG->lesson_mediawidth);
- /** Legacy media popup height element to maintain backwards compatibility */
- $mform->addElement('hidden', 'mediaheight');
- $mform->setType('mediaheight', PARAM_INT);
- $mform->setDefault('mediaheight', $CFG->lesson_mediaheight);
- /** Legacy media popup close button element to maintain backwards compatibility */
- $mform->addElement('hidden', 'mediaclose');
- $mform->setType('mediaclose', PARAM_BOOL);
- $mform->setDefault('mediaclose', $CFG->lesson_mediaclose);
- /** Legacy maximum highscores element to maintain backwards compatibility */
- $mform->addElement('hidden', 'maxhighscores');
- $mform->setType('maxhighscores', PARAM_INT);
- $mform->setDefault('maxhighscores', $CFG->lesson_maxhighscores);
- $mform->addElement('text', 'name', get_string('name'), array('size'=>'64'));
- if (!empty($CFG->formatstringstriptags)) {
- $mform->setType('name', PARAM_TEXT);
- } else {
- $mform->setType('name', PARAM_CLEANHTML);
- }
- $mform->addRule('name', null, 'required', null, 'client');
- // Create a text box that can be enabled/disabled for lesson time limit
- $timedgrp = array();
- $timedgrp[] = &$mform->createElement('text', 'maxtime');
- $timedgrp[] = &$mform->createElement('checkbox', 'timed', '', get_string('enable'));
- $mform->addGroup($timedgrp, 'timedgrp', get_string('maxtime', 'lesson'), array(' '), false);
- $mform->disabledIf('timedgrp', 'timed');
- // Add numeric rule to text field
- $timedgrprules = array();
- $timedgrprules['maxtime'][] = array(null, 'numeric', null, 'client');
- $mform->addGroupRule('timedgrp', $timedgrprules);
- // Rest of group setup
- $mform->setDefault('timed', 0);
- $mform->setDefault('maxtime', 20);
- $mform->setType('maxtime', PARAM_INT);
- $numbers = array();
- for ($i=20; $i>1; $i--) {
- $numbers[$i] = $i;
- }
- $mform->addElement('date_time_selector', 'available', get_string('available', 'lesson'), array('optional'=>true));
- $mform->setDefault('available', 0);
- $mform->addElement('date_time_selector', 'deadline', get_string('deadline', 'lesson'), array('optional'=>true));
- $mform->setDefault('deadline', 0);
- $mform->addElement('select', 'maxanswers', get_string('maximumnumberofanswersbranches', 'lesson'), $numbers);
- $mform->setDefault('maxanswers', $CFG->lesson_maxanswers);
- $mform->setType('maxanswers', PARAM_INT);
- $mform->addHelpButton('maxanswers', 'maximumnumberofanswersbranches', 'lesson');
- $mform->addElement('selectyesno', 'usepassword', get_string('usepassword', 'lesson'));
- $mform->addHelpButton('usepassword', 'usepassword', 'lesson');
- $mform->setDefault('usepassword', 0);
- $mform->setAdvanced('usepassword');
- $mform->addElement('passwordunmask', 'password', get_string('password', 'lesson'));
- $mform->setDefault('password', '');
- $mform->setType('password', PARAM_RAW);
- $mform->setAdvanced('password');
- $mform->disabledIf('password', 'usepassword', 'eq', 0);
- $this->standard_grading_coursemodule_elements();
- //-------------------------------------------------------------------------------
- $mform->addElement('header', 'gradeoptions', get_string('gradeoptions', 'lesson'));
- $mform->addElement('selectyesno', 'practice', get_string('practice', 'lesson'));
- $mform->addHelpButton('practice', 'practice', 'lesson');
- $mform->setDefault('practice', 0);
- $mform->addElement('selectyesno', 'custom', get_string('customscoring', 'lesson'));
- $mform->addHelpButton('custom', 'customscoring', 'lesson');
- $mform->setDefault('custom', 1);
- $mform->addElement('selectyesno', 'retake', get_string('retakesallowed', 'lesson'));
- $mform->addHelpButton('retake', 'retakesallowed', 'lesson');
- $mform->setDefault('retake', 0);
- $options = array();
- $options[0] = get_string('usemean', 'lesson');
- $options[1] = get_string('usemaximum', 'lesson');
- $mform->addElement('select', 'usemaxgrade', get_string('handlingofretakes', 'lesson'), $options);
- $mform->addHelpButton('usemaxgrade', 'handlingofretakes', 'lesson');
- $mform->setDefault('usemaxgrade', 0);
- $mform->disabledIf('usemaxgrade', 'retake', 'eq', '0');
- $mform->addElement('selectyesno', 'ongoing', get_string('ongoing', 'lesson'));
- $mform->addHelpButton('ongoing', 'ongoing', 'lesson');
- $mform->setDefault('ongoing', 0);
- //-------------------------------------------------------------------------------
- $mform->addElement('header', 'flowcontrol', get_string('flowcontrol', 'lesson'));
- $mform->addElement('selectyesno', 'modattempts', get_string('modattempts', 'lesson'));
- $mform->addHelpButton('modattempts', 'modattempts', 'lesson');
- $mform->setDefault('modattempts', 0);
- $mform->addElement('selectyesno', 'review', get_string('displayreview', 'lesson'));
- $mform->addHelpButton('review', 'displayreview', 'lesson');
- $mform->setDefault('review', 0);
- $numbers = array();
- for ($i=10; $i>0; $i--) {
- $numbers[$i] = $i;
- }
- $mform->addElement('select', 'maxattempts', get_string('maximumnumberofattempts', 'lesson'), $numbers);
- $mform->addHelpButton('maxattempts', 'maximumnumberofattempts', 'lesson');
- $mform->setDefault('maxattempts', 1);
- $defaultnextpages = array();
- $defaultnextpages[0] = get_string('normal', 'lesson');
- $defaultnextpages[LESSON_UNSEENPAGE] = get_string('showanunseenpage', 'lesson');
- $defaultnextpages[LESSON_UNANSWEREDPAGE] = get_string('showanunansweredpage', 'lesson');
- $mform->addElement('select', 'nextpagedefault', get_string('actionaftercorrectanswer', 'lesson'), $defaultnextpages);
- $mform->addHelpButton('nextpagedefault', 'actionaftercorrectanswer', 'lesson');
- $mform->setDefault('nextpagedefault', $CFG->lesson_defaultnextpage);
- $mform->setAdvanced('nextpagedefault');
- $mform->addElement('selectyesno', 'feedback', get_string('displaydefaultfeedback', 'lesson'));
- $mform->addHelpButton('feedback', 'displaydefaultfeedback', 'lesson');
- $mform->setDefault('feedback', 0);
- $mform->addElement('selectyesno', 'progressbar', get_string('progressbar', 'lesson'));
- $mform->addHelpButton('progressbar', 'progressbar', 'lesson');
- $mform->setDefault('progressbar', 0);
- $mform->addElement('selectyesno', 'displayleft', get_string('displayleftmenu', 'lesson'));
- $mform->addHelpButton('displayleft', 'displayleftmenu', 'lesson');
- $mform->setDefault('displayleft', 0);
- $options = array();
- for($i = 100; $i >= 0; $i--) {
- $options[$i] = $i.'%';
- }
- $mform->addElement('select', 'displayleftif', get_string('displayleftif', 'lesson'), $options);
- $mform->addHelpButton('displayleftif', 'displayleftif', 'lesson');
- $mform->setDefault('displayleftif', 0);
- $mform->setAdvanced('displayleftif');
- $numbers = array();
- for ($i = 100; $i >= 0; $i--) {
- $numbers[$i] = $i;
- }
- $mform->addElement('select', 'minquestions', get_string('minimumnumberofquestions', 'lesson'), $numbers);
- $mform->addHelpButton('minquestions', 'minimumnumberofquestions', 'lesson');
- $mform->setDefault('minquestions', 0);
- $mform->setAdvanced('minquestions');
- $numbers = array();
- for ($i = 100; $i >= 0; $i--) {
- $numbers[$i] = $i;
- }
- $mform->addElement('select', 'maxpages', get_string('numberofpagestoshow', 'lesson'), $numbers);
- $mform->addHelpButton('maxpages', 'numberofpagestoshow', 'lesson');
- $mform->setAdvanced('maxpages');
- $mform->setDefault('maxpages', 0);
- $mform->addElement('selectyesno', 'slideshow', get_string('slideshow', 'lesson'));
- $mform->addHelpButton('slideshow', 'slideshow', 'lesson');
- $mform->setDefault('slideshow', 0);
- $mform->setAdvanced('slideshow');
- // get the modules
- if ($mods = get_course_mods($COURSE->id)) {
- $modinstances = array();
- foreach ($mods as $mod) {
- // get the module name and then store it in a new array
- if ($module = get_coursemodule_from_instance($mod->modname, $mod->instance, $COURSE->id)) {
- if (isset($this->_cm->id) and $this->_cm->id != $mod->id){
- $modinstances[$mod->id] = $mod->modname.' - '.$module->name;
- }
- }
- }
- asort($modinstances); // sort by module name
- $modinstances=array(0=>get_string('none'))+$modinstances;
- $mform->addElement('select', 'activitylink', get_string('activitylink', 'lesson'), $modinstances);
- $mform->addHelpButton('activitylink', 'activitylink', 'lesson');
- $mform->setDefault('activitylink', 0);
- $mform->setAdvanced('activitylink');
- }
- //-------------------------------------------------------------------------------
- $mform->addElement('header', 'mediafileheader', get_string('mediafile', 'lesson'));
- $filepickeroptions = array();
- $filepickeroptions['filetypes'] = '*';
- $filepickeroptions['maxbytes'] = $this->course->maxbytes;
- $mform->addElement('filepicker', 'mediafilepicker', get_string('mediafile', 'lesson'), null, $filepickeroptions);
- $mform->addHelpButton('mediafilepicker', 'mediafile', 'lesson');
- //-------------------------------------------------------------------------------
- $mform->addElement('header', 'dependencyon', get_string('dependencyon', 'lesson'));
- $options = array(0=>get_string('none'));
- if ($lessons = get_all_instances_in_course('lesson', $COURSE)) {
- foreach($lessons as $lesson) {
- if ($lesson->id != $this->_instance){
- $options[$lesson->id] = format_string($lesson->name, true);
- }
- }
- }
- $mform->addElement('select', 'dependency', get_string('dependencyon', 'lesson'), $options);
- $mform->addHelpButton('dependency', 'dependencyon', 'lesson');
- $mform->setDefault('dependency', 0);
- $mform->addElement('text', 'timespent', get_string('timespentminutes', 'lesson'));
- $mform->setDefault('timespent', 0);
- $mform->setType('timespent', PARAM_INT);
- $mform->addElement('checkbox', 'completed', get_string('completed', 'lesson'));
- $mform->setDefault('completed', 0);
- $mform->addElement('text', 'gradebetterthan', get_string('gradebetterthan', 'lesson'));
- $mform->setDefault('gradebetterthan', 0);
- $mform->setType('gradebetterthan', PARAM_INT);
- //-------------------------------------------------------------------------------
- $this->standard_coursemodule_elements();
- //-------------------------------------------------------------------------------
- // buttons
- $this->add_action_buttons();
- }
- /**
- * Enforce defaults here
- *
- * @param array $default_values Form defaults
- * @return void
- **/
- function data_preprocessing(&$default_values) {
- global $DB;
- global $module;
- if (isset($default_values['conditions'])) {
- $conditions = unserialize($default_values['conditions']);
- $default_values['timespent'] = $conditions->timespent;
- $default_values['completed'] = $conditions->completed;
- $default_values['gradebetterthan'] = $conditions->gradebetterthan;
- }
- // after this passwords are clear text, MDL-11090
- if (isset($default_values['password']) and ($module->version<2008112600)) {
- unset($default_values['password']);
- }
- if ($this->current->instance) {
- // editing existing instance - copy existing files into draft area
- $draftitemid = file_get_submitted_draft_itemid('mediafilepicker');
- file_prepare_draft_area($draftitemid, $this->context->id, 'mod_lesson', 'mediafile', 0, array('subdirs'=>0, 'maxbytes' => $this->course->maxbytes, 'maxfiles' => 1));
- $default_values['mediafilepicker'] = $draftitemid;
- }
- }
- /**
- * Enforce validation rules here
- *
- * @param object $data Post data to validate
- * @return array
- **/
- function validation($data, $files) {
- $errors = parent::validation($data, $files);
- if (empty($data['maxtime']) and !empty($data['timed'])) {
- $errors['timedgrp'] = get_string('err_numeric', 'form');
- }
- if (!empty($data['usepassword']) && empty($data['password'])) {
- $errors['password'] = get_string('emptypassword', 'lesson');
- }
- return $errors;
- }
- }