fa70507b2584f80bb3be9a6a4c13639fd6bc4350
[moodle.git] / mod / lesson / mod_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Form to define a new instance of lesson or edit an instance.
20  * It is used from /course/modedit.php.
21  *
22  * @package mod_lesson
23  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
25  **/
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot.'/course/moodleform_mod.php');
30 require_once($CFG->dirroot.'/mod/lesson/locallib.php');
32 class mod_lesson_mod_form extends moodleform_mod {
34     protected $course = null;
36     public function mod_lesson_mod_form($current, $section, $cm, $course) {
37         $this->course = $course;
38         parent::moodleform_mod($current, $section, $cm, $course);
39     }
41     function definition() {
42         global $CFG, $COURSE, $DB;
44         $mform    = $this->_form;
46         $config = get_config('lesson');
48         $mform->addElement('header', 'general', get_string('general', 'form'));
50         /** Legacy slideshow width element to maintain backwards compatibility */
51         $mform->addElement('hidden', 'width');
52         $mform->setType('width', PARAM_INT);
53         $mform->setDefault('width', $CFG->lesson_slideshowwidth);
55         /** Legacy slideshow height element to maintain backwards compatibility */
56         $mform->addElement('hidden', 'height');
57         $mform->setType('height', PARAM_INT);
58         $mform->setDefault('height', $CFG->lesson_slideshowheight);
60         /** Legacy slideshow background color element to maintain backwards compatibility */
61         $mform->addElement('hidden', 'bgcolor');
62         $mform->setType('bgcolor', PARAM_TEXT);
63         $mform->setDefault('bgcolor', $CFG->lesson_slideshowbgcolor);
65         /** Legacy media popup width element to maintain backwards compatibility */
66         $mform->addElement('hidden', 'mediawidth');
67         $mform->setType('mediawidth', PARAM_INT);
68         $mform->setDefault('mediawidth', $CFG->lesson_mediawidth);
70         /** Legacy media popup height element to maintain backwards compatibility */
71         $mform->addElement('hidden', 'mediaheight');
72         $mform->setType('mediaheight', PARAM_INT);
73         $mform->setDefault('mediaheight', $CFG->lesson_mediaheight);
75         /** Legacy media popup close button element to maintain backwards compatibility */
76         $mform->addElement('hidden', 'mediaclose');
77         $mform->setType('mediaclose', PARAM_BOOL);
78         $mform->setDefault('mediaclose', $CFG->lesson_mediaclose);
80         /** Legacy maximum highscores element to maintain backwards compatibility */
81         $mform->addElement('hidden', 'maxhighscores');
82         $mform->setType('maxhighscores', PARAM_INT);
83         $mform->setDefault('maxhighscores', $CFG->lesson_maxhighscores);
85         $mform->addElement('text', 'name', get_string('name'), array('size'=>'64'));
86         if (!empty($CFG->formatstringstriptags)) {
87             $mform->setType('name', PARAM_TEXT);
88         } else {
89             $mform->setType('name', PARAM_CLEANHTML);
90         }
91         $mform->addRule('name', null, 'required', null, 'client');
92         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
93         $this->standard_intro_elements();
95         // Appearance.
96         $mform->addElement('header', 'appearancehdr', get_string('appearance'));
98         $filemanageroptions = array();
99         $filemanageroptions['filetypes'] = '*';
100         $filemanageroptions['maxbytes'] = $this->course->maxbytes;
101         $filemanageroptions['subdirs'] = 0;
102         $filemanageroptions['maxfiles'] = 1;
104         $mform->addElement('filemanager', 'mediafile', get_string('mediafile', 'lesson'), null, $filemanageroptions);
105         $mform->addHelpButton('mediafile', 'mediafile', 'lesson');
107         $mform->addElement('selectyesno', 'progressbar', get_string('progressbar', 'lesson'));
108         $mform->addHelpButton('progressbar', 'progressbar', 'lesson');
109         $mform->setDefault('progressbar', 0);
111         $mform->addElement('selectyesno', 'ongoing', get_string('ongoing', 'lesson'));
112         $mform->addHelpButton('ongoing', 'ongoing', 'lesson');
113         $mform->setDefault('ongoing', 0);
115         $mform->addElement('selectyesno', 'displayleft', get_string('displayleftmenu', 'lesson'));
116         $mform->addHelpButton('displayleft', 'displayleftmenu', 'lesson');
117         $mform->setDefault('displayleft', 0);
119         $options = array();
120         for($i = 100; $i >= 0; $i--) {
121             $options[$i] = $i.'%';
122         }
123         $mform->addElement('select', 'displayleftif', get_string('displayleftif', 'lesson'), $options);
124         $mform->addHelpButton('displayleftif', 'displayleftif', 'lesson');
125         $mform->setDefault('displayleftif', 0);
127         $mform->addElement('selectyesno', 'slideshow', get_string('slideshow', 'lesson'));
128         $mform->addHelpButton('slideshow', 'slideshow', 'lesson');
129         $mform->setDefault('slideshow', 0);
131         $numbers = array();
132         for ($i = 20; $i > 1; $i--) {
133             $numbers[$i] = $i;
134         }
136         $mform->addElement('select', 'maxanswers', get_string('maximumnumberofanswersbranches', 'lesson'), $numbers);
137         $mform->setDefault('maxanswers', $CFG->lesson_maxanswers);
138         $mform->setType('maxanswers', PARAM_INT);
139         $mform->addHelpButton('maxanswers', 'maximumnumberofanswersbranches', 'lesson');
141         $mform->addElement('selectyesno', 'feedback', get_string('displaydefaultfeedback', 'lesson'));
142         $mform->addHelpButton('feedback', 'displaydefaultfeedback', 'lesson');
143         $mform->setDefault('feedback', 0);
145         // Get the modules.
146         if ($mods = get_course_mods($COURSE->id)) {
147             $modinstances = array();
148             foreach ($mods as $mod) {
149                 // Get the module name and then store it in a new array.
150                 if ($module = get_coursemodule_from_instance($mod->modname, $mod->instance, $COURSE->id)) {
151                     // Exclude this lesson, if it's already been saved.
152                     if (!isset($this->_cm->id) || $this->_cm->id != $mod->id) {
153                         $modinstances[$mod->id] = $mod->modname.' - '.$module->name;
154                     }
155                 }
156             }
157             asort($modinstances); // Sort by module name.
158             $modinstances=array(0=>get_string('none'))+$modinstances;
160             $mform->addElement('select', 'activitylink', get_string('activitylink', 'lesson'), $modinstances);
161             $mform->addHelpButton('activitylink', 'activitylink', 'lesson');
162             $mform->setDefault('activitylink', 0);
163         }
165         // Availability.
166         $mform->addElement('header', 'availabilityhdr', get_string('availability'));
168         $mform->addElement('date_time_selector', 'available', get_string('available', 'lesson'), array('optional'=>true));
169         $mform->setDefault('available', 0);
171         $mform->addElement('date_time_selector', 'deadline', get_string('deadline', 'lesson'), array('optional'=>true));
172         $mform->setDefault('deadline', 0);
174         // Time limit.
175         $mform->addElement('duration', 'timelimit', get_string('timelimit', 'lesson'),
176                 array('optional' => true));
177         $mform->addHelpButton('timelimit', 'timelimit', 'lesson');
179         $mform->addElement('selectyesno', 'usepassword', get_string('usepassword', 'lesson'));
180         $mform->addHelpButton('usepassword', 'usepassword', 'lesson');
181         $mform->setDefault('usepassword', 0);
183         $mform->addElement('passwordunmask', 'password', get_string('password', 'lesson'));
184         $mform->setDefault('password', '');
185         $mform->setType('password', PARAM_RAW);
186         $mform->disabledIf('password', 'usepassword', 'eq', 0);
187         $mform->disabledIf('passwordunmask', 'usepassword', 'eq', 0);
189         // Dependent on.
190         if ($this->current && isset($this->current->dependency) && $this->current->dependency) {
191             $mform->addElement('header', 'dependencyon', get_string('prerequisitelesson', 'lesson'));
192             $mform->addElement('static', 'warningobsolete',
193                 get_string('warning', 'lesson'),
194                 get_string('prerequisiteisobsolete', 'lesson'));
195             $options = array(0 => get_string('none'));
196             if ($lessons = get_all_instances_in_course('lesson', $COURSE)) {
197                 foreach ($lessons as $lesson) {
198                     if ($lesson->id != $this->_instance) {
199                         $options[$lesson->id] = format_string($lesson->name, true);
200                     }
202                 }
203             }
204             $mform->addElement('select', 'dependency', get_string('dependencyon', 'lesson'), $options);
205             $mform->addHelpButton('dependency', 'dependencyon', 'lesson');
206             $mform->setDefault('dependency', 0);
208             $mform->addElement('text', 'timespent', get_string('timespentminutes', 'lesson'));
209             $mform->setDefault('timespent', 0);
210             $mform->setType('timespent', PARAM_INT);
211             $mform->disabledIf('timespent', 'dependency', 'eq', 0);
213             $mform->addElement('checkbox', 'completed', get_string('completed', 'lesson'));
214             $mform->setDefault('completed', 0);
215             $mform->disabledIf('completed', 'dependency', 'eq', 0);
217             $mform->addElement('text', 'gradebetterthan', get_string('gradebetterthan', 'lesson'));
218             $mform->setDefault('gradebetterthan', 0);
219             $mform->setType('gradebetterthan', PARAM_INT);
220             $mform->disabledIf('gradebetterthan', 'dependency', 'eq', 0);
221         } else {
222             $mform->addElement('hidden', 'dependency', 0);
223             $mform->setType('dependency', PARAM_INT);
224             $mform->addElement('hidden', 'timespent', 0);
225             $mform->setType('timespent', PARAM_INT);
226             $mform->addElement('hidden', 'completed', 0);
227             $mform->setType('completed', PARAM_INT);
228             $mform->addElement('hidden', 'gradebetterthan', 0);
229             $mform->setType('gradebetterthan', PARAM_INT);
230             $mform->setConstants(array('dependency' => 0, 'timespent' => 0,
231                     'completed' => 0, 'gradebetterthan' => 0));
232         }
234         // Flow control.
235         $mform->addElement('header', 'flowcontrol', get_string('flowcontrol', 'lesson'));
237         $mform->addElement('selectyesno', 'modattempts', get_string('modattempts', 'lesson'));
238         $mform->addHelpButton('modattempts', 'modattempts', 'lesson');
239         $mform->setDefault('modattempts', 0);
241         $mform->addElement('selectyesno', 'review', get_string('displayreview', 'lesson'));
242         $mform->addHelpButton('review', 'displayreview', 'lesson');
243         $mform->setDefault('review', 0);
245         $numbers = array();
246         for ($i = 10; $i > 0; $i--) {
247             $numbers[$i] = $i;
248         }
249         $mform->addElement('select', 'maxattempts', get_string('maximumnumberofattempts', 'lesson'), $numbers);
250         $mform->addHelpButton('maxattempts', 'maximumnumberofattempts', 'lesson');
251         $mform->setDefault('maxattempts', 1);
253         $defaultnextpages = array();
254         $defaultnextpages[0] = get_string('normal', 'lesson');
255         $defaultnextpages[LESSON_UNSEENPAGE] = get_string('showanunseenpage', 'lesson');
256         $defaultnextpages[LESSON_UNANSWEREDPAGE] = get_string('showanunansweredpage', 'lesson');
257         $mform->addElement('select', 'nextpagedefault', get_string('actionaftercorrectanswer', 'lesson'), $defaultnextpages);
258         $mform->addHelpButton('nextpagedefault', 'actionaftercorrectanswer', 'lesson');
259         $mform->setDefault('nextpagedefault', $CFG->lesson_defaultnextpage);
261         $numbers = array();
262         for ($i = 100; $i >= 0; $i--) {
263             $numbers[$i] = $i;
264         }
265         $mform->addElement('select', 'maxpages', get_string('numberofpagestoshow', 'lesson'), $numbers);
266         $mform->addHelpButton('maxpages', 'numberofpagestoshow', 'lesson');
267         $mform->setDefault('maxpages', 0);
269         // Grade.
270         $this->standard_grading_coursemodule_elements();
272         // No header here, so that the following settings are displayed in the grade section.
274         $mform->addElement('selectyesno', 'practice', get_string('practice', 'lesson'));
275         $mform->addHelpButton('practice', 'practice', 'lesson');
276         $mform->setDefault('practice', 0);
278         $mform->addElement('selectyesno', 'custom', get_string('customscoring', 'lesson'));
279         $mform->addHelpButton('custom', 'customscoring', 'lesson');
280         $mform->setDefault('custom', 1);
282         $mform->addElement('selectyesno', 'retake', get_string('retakesallowed', 'lesson'));
283         $mform->addHelpButton('retake', 'retakesallowed', 'lesson');
284         $mform->setDefault('retake', 0);
286         $options = array();
287         $options[0] = get_string('usemean', 'lesson');
288         $options[1] = get_string('usemaximum', 'lesson');
289         $mform->addElement('select', 'usemaxgrade', get_string('handlingofretakes', 'lesson'), $options);
290         $mform->addHelpButton('usemaxgrade', 'handlingofretakes', 'lesson');
291         $mform->setDefault('usemaxgrade', 0);
292         $mform->disabledIf('usemaxgrade', 'retake', 'eq', '0');
294         $numbers = array();
295         for ($i = 100; $i >= 0; $i--) {
296             $numbers[$i] = $i;
297         }
298         $mform->addElement('select', 'minquestions', get_string('minimumnumberofquestions', 'lesson'), $numbers);
299         $mform->addHelpButton('minquestions', 'minimumnumberofquestions', 'lesson');
300         $mform->setDefault('minquestions', 0);
302 //-------------------------------------------------------------------------------
303         $this->standard_coursemodule_elements();
304 //-------------------------------------------------------------------------------
305 // buttons
306         $this->add_action_buttons();
307     }
309     /**
310      * Enforce defaults here
311      *
312      * @param array $defaultvalues Form defaults
313      * @return void
314      **/
315     public function data_preprocessing(&$defaultvalues) {
316         if (isset($defaultvalues['conditions'])) {
317             $conditions = unserialize($defaultvalues['conditions']);
318             $defaultvalues['timespent'] = $conditions->timespent;
319             $defaultvalues['completed'] = $conditions->completed;
320             $defaultvalues['gradebetterthan'] = $conditions->gradebetterthan;
321         }
323         // Set up the completion checkbox which is not part of standard data.
324         $defaultvalues['completiontimespentenabled'] =
325             !empty($defaultvalues['completiontimespent']) ? 1 : 0;
327         if ($this->current->instance) {
328             // Editing existing instance - copy existing files into draft area.
329             $draftitemid = file_get_submitted_draft_itemid('mediafile');
330             file_prepare_draft_area($draftitemid, $this->context->id, 'mod_lesson', 'mediafile', 0, array('subdirs'=>0, 'maxbytes' => $this->course->maxbytes, 'maxfiles' => 1));
331             $defaultvalues['mediafile'] = $draftitemid;
332         }
333     }
335     /**
336      * Enforce validation rules here
337      *
338      * @param object $data Post data to validate
339      * @return array
340      **/
341     function validation($data, $files) {
342         $errors = parent::validation($data, $files);
344         if (!empty($data['usepassword']) && empty($data['password'])) {
345             $errors['password'] = get_string('emptypassword', 'lesson');
346         }
348         return $errors;
349     }
351     /**
352      * Display module-specific activity completion rules.
353      * Part of the API defined by moodleform_mod
354      * @return array Array of string IDs of added items, empty array if none
355      */
356     public function add_completion_rules() {
357         $mform = $this->_form;
359         $mform->addElement('checkbox', 'completionendreached', get_string('completionendreached', 'lesson'),
360                 get_string('completionendreached_desc', 'lesson'));
362         $group = array();
363         $group[] =& $mform->createElement('checkbox', 'completiontimespentenabled', '',
364                 get_string('completiontimespent', 'lesson'));
365         $group[] =& $mform->createElement('duration', 'completiontimespent', array('optional' => true));
366         $mform->addGroup($group, 'completiontimespentgroup', get_string('completiontimespentgroup', 'lesson'), array(' '), false);
367         $mform->disabledIf('completiontimespent[number]', 'completiontimespentenabled', 'notchecked');
368         $mform->disabledIf('completiontimespent[timeunit]', 'completiontimespentenabled', 'notchecked');
370         return array('completionendreached', 'completiontimespentgroup');
371     }
373     /**
374      * Called during validation. Indicates whether a module-specific completion rule is selected.
375      *
376      * @param array $data Input data (not yet validated)
377      * @return bool True if one or more rules is enabled, false if none are.
378      */
379     public function completion_rule_enabled($data) {
380         return !empty($data['completionendreached']) || $data['completiontimespent'] > 0;
381     }
383     public function get_data() {
384         $data = parent::get_data();
385         if (!$data) {
386             return false;
387         }
388         // Turn off completion setting if the checkbox is not ticked.
389         if (!empty($data->completionunlocked)) {
390             $autocompletion = !empty($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;
391             if (empty($data->completiontimespentenabled) || !$autocompletion) {
392                 $data->completiontimespent = 0;
393             }
394         }
395         return $data;
396     }