Merge branch 'wip-MDL-40100-m26' of git://github.com/samhemelryk/moodle
[moodle.git] / mod / quiz / settings.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
8 //
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.
13 //
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/>.
17 /**
18  * Administration settings definitions for the quiz module.
19  *
20  * @package    mod
21  * @subpackage quiz
22  * @copyright  2010 Petr Skoda
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/mod/quiz/lib.php');
30 require_once($CFG->dirroot . '/mod/quiz/settingslib.php');
32 // First get a list of quiz reports with there own settings pages. If there none,
33 // we use a simpler overall menu structure.
34 $reports = get_plugin_list_with_file('quiz', 'settings.php', false);
35 $reportsbyname = array();
36 foreach ($reports as $report => $reportdir) {
37     $strreportname = get_string($report . 'report', 'quiz_'.$report);
38     $reportsbyname[$strreportname] = $report;
39 }
40 collatorlib::ksort($reportsbyname);
42 // First get a list of quiz reports with there own settings pages. If there none,
43 // we use a simpler overall menu structure.
44 $rules = get_plugin_list_with_file('quizaccess', 'settings.php', false);
45 $rulesbyname = array();
46 foreach ($rules as $rule => $ruledir) {
47     $strrulename = get_string('pluginname', 'quizaccess_' . $rule);
48     $rulesbyname[$strrulename] = $rule;
49 }
50 collatorlib::ksort($rulesbyname);
52 // Create the quiz settings page.
53 if (empty($reportsbyname) && empty($rulesbyname)) {
54     $pagetitle = get_string('modulename', 'quiz');
55 } else {
56     $pagetitle = get_string('generalsettings', 'admin');
57 }
58 $quizsettings = new admin_settingpage('modsettingquiz', $pagetitle, 'moodle/site:config');
60 // Introductory explanation that all the settings are defaults for the add quiz form.
61 $quizsettings->add(new admin_setting_heading('quizintro', '', get_string('configintro', 'quiz')));
63 // Time limit.
64 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/timelimit',
65         get_string('timelimitsec', 'quiz'), get_string('configtimelimitsec', 'quiz'),
66         array('value' => '0', 'adv' => false), PARAM_INT));
68 // What to do with overdue attempts.
69 $quizsettings->add(new mod_quiz_admin_setting_overduehandling('quiz/overduehandling',
70         get_string('overduehandling', 'quiz'), get_string('overduehandling_desc', 'quiz'),
71         array('value' => 'autoabandon', 'adv' => false), null));
73 // Grace period time.
74 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/graceperiod',
75         get_string('graceperiod', 'quiz'), get_string('graceperiod_desc', 'quiz'),
76         array('value' => '86400', 'adv' => false), PARAM_INT));
78 // Minimum grace period used behind the scenes.
79 $quizsettings->add(new admin_setting_configtext('quiz/graceperiodmin',
80         get_string('graceperiodmin', 'quiz'), get_string('graceperiodmin_desc', 'quiz'),
81         60, PARAM_INT));
83 // Number of attempts.
84 $options = array(get_string('unlimited'));
85 for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
86     $options[$i] = $i;
87 }
88 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/attempts',
89         get_string('attemptsallowed', 'quiz'), get_string('configattemptsallowed', 'quiz'),
90         array('value' => 0, 'adv' => false), $options));
92 // Grading method.
93 $quizsettings->add(new mod_quiz_admin_setting_grademethod('quiz/grademethod',
94         get_string('grademethod', 'quiz'), get_string('configgrademethod', 'quiz'),
95         array('value' => QUIZ_GRADEHIGHEST, 'adv' => false), null));
97 // Maximum grade.
98 $quizsettings->add(new admin_setting_configtext('quiz/maximumgrade',
99         get_string('maximumgrade'), get_string('configmaximumgrade', 'quiz'), 10, PARAM_INT));
101 // Shuffle questions.
102 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shufflequestions',
103         get_string('shufflequestions', 'quiz'), get_string('configshufflequestions', 'quiz'),
104         array('value' => 0, 'adv' => false)));
106 // Questions per page.
107 $perpage = array();
108 $perpage[0] = get_string('never');
109 $perpage[1] = get_string('aftereachquestion', 'quiz');
110 for ($i = 2; $i <= QUIZ_MAX_QPP_OPTION; ++$i) {
111     $perpage[$i] = get_string('afternquestions', 'quiz', $i);
113 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questionsperpage',
114         get_string('newpageevery', 'quiz'), get_string('confignewpageevery', 'quiz'),
115         array('value' => 1, 'adv' => false), $perpage));
117 // Navigation method.
118 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/navmethod',
119         get_string('navmethod', 'quiz'), get_string('confignavmethod', 'quiz'),
120         array('value' => QUIZ_NAVMETHOD_FREE, 'adv' => true), quiz_get_navigation_options()));
122 // Shuffle within questions.
123 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shuffleanswers',
124         get_string('shufflewithin', 'quiz'), get_string('configshufflewithin', 'quiz'),
125         array('value' => 1, 'adv' => false)));
127 // Preferred behaviour.
128 $quizsettings->add(new admin_setting_question_behaviour('quiz/preferredbehaviour',
129         get_string('howquestionsbehave', 'question'), get_string('howquestionsbehave_desc', 'quiz'),
130         'deferredfeedback'));
132 // Each attempt builds on last.
133 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/attemptonlast',
134         get_string('eachattemptbuildsonthelast', 'quiz'),
135         get_string('configeachattemptbuildsonthelast', 'quiz'),
136         array('value' => 0, 'adv' => true)));
138 // Review options.
139 $quizsettings->add(new admin_setting_heading('reviewheading',
140         get_string('reviewoptionsheading', 'quiz'), ''));
141 foreach (mod_quiz_admin_review_setting::fields() as $field => $name) {
142     $default = mod_quiz_admin_review_setting::all_on();
143     $forceduring = null;
144     if ($field == 'attempt') {
145         $forceduring = true;
146     } else if ($field == 'overallfeedback') {
147         $default = $default ^ mod_quiz_admin_review_setting::DURING;
148         $forceduring = false;
149     }
150     $quizsettings->add(new mod_quiz_admin_review_setting('quiz/review' . $field,
151             $name, '', $default, $forceduring));
154 // Show the user's picture.
155 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/showuserpicture',
156         get_string('showuserpicture', 'quiz'), get_string('configshowuserpicture', 'quiz'),
157         array('value' => 0, 'adv' => false)));
159 // Decimal places for overall grades.
160 $options = array();
161 for ($i = 0; $i <= QUIZ_MAX_DECIMAL_OPTION; $i++) {
162     $options[$i] = $i;
164 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/decimalpoints',
165         get_string('decimalplaces', 'quiz'), get_string('configdecimalplaces', 'quiz'),
166         array('value' => 2, 'adv' => false), $options));
168 // Decimal places for question grades.
169 $options = array(-1 => get_string('sameasoverall', 'quiz'));
170 for ($i = 0; $i <= QUIZ_MAX_Q_DECIMAL_OPTION; $i++) {
171     $options[$i] = $i;
173 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questiondecimalpoints',
174         get_string('decimalplacesquestion', 'quiz'),
175         get_string('configdecimalplacesquestion', 'quiz'),
176         array('value' => -1, 'adv' => true), $options));
178 // Show blocks during quiz attempts.
179 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/showblocks',
180         get_string('showblocks', 'quiz'), get_string('configshowblocks', 'quiz'),
181         array('value' => 0, 'adv' => true)));
183 // Password.
184 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/password',
185         get_string('requirepassword', 'quiz'), get_string('configrequirepassword', 'quiz'),
186         array('value' => '', 'adv' => true), PARAM_TEXT));
188 // IP restrictions.
189 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/subnet',
190         get_string('requiresubnet', 'quiz'), get_string('configrequiresubnet', 'quiz'),
191         array('value' => '', 'adv' => true), PARAM_TEXT));
193 // Enforced delay between attempts.
194 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/delay1',
195         get_string('delay1st2nd', 'quiz'), get_string('configdelay1st2nd', 'quiz'),
196         array('value' => 0, 'adv' => true), PARAM_INT));
197 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/delay2',
198         get_string('delaylater', 'quiz'), get_string('configdelaylater', 'quiz'),
199         array('value' => 0, 'adv' => true), PARAM_INT));
201 // Browser security.
202 $quizsettings->add(new mod_quiz_admin_setting_browsersecurity('quiz/browsersecurity',
203         get_string('showinsecurepopup', 'quiz'), get_string('configpopup', 'quiz'),
204         array('value' => '-', 'adv' => true), null));
206 // Allow user to specify if setting outcomes is an advanced setting
207 if (!empty($CFG->enableoutcomes)) {
208     $quizsettings->add(new admin_setting_configcheckbox('quiz/outcomes_adv',
209         get_string('outcomesadvanced', 'quiz'), get_string('configoutcomesadvanced', 'quiz'),
210         '0'));
213 // Autosave frequency.
214 $options = array(
215       0 => get_string('donotuseautosave', 'quiz'),
216      60 => get_string('oneminute', 'quiz'),
217     120 => get_string('numminutes', 'moodle', 2),
218     300 => get_string('numminutes', 'moodle', 5),
219 );
220 $quizsettings->add(new admin_setting_configselect('quiz/autosaveperiod',
221         get_string('autosaveperiod', 'quiz'), get_string('autosaveperiod_desc', 'quiz'), 0, $options));
223 // Now, depending on whether any reports have their own settings page, add
224 // the quiz setting page to the appropriate place in the tree.
225 if (empty($reportsbyname) && empty($rulesbyname)) {
226     $ADMIN->add('modsettings', $quizsettings);
227 } else {
228     $ADMIN->add('modsettings', new admin_category('modsettingsquizcat',
229             get_string('modulename', 'quiz'), $module->is_enabled() === false));
230     $ADMIN->add('modsettingsquizcat', $quizsettings);
232     // Add settings pages for the quiz report subplugins.
233     foreach ($reportsbyname as $strreportname => $report) {
234         $reportname = $report;
236         $settings = new admin_settingpage('modsettingsquizcat'.$reportname,
237                 $strreportname, 'moodle/site:config', $module->is_enabled() === false);
238         if ($ADMIN->fulltree) {
239             include($CFG->dirroot . "/mod/quiz/report/$reportname/settings.php");
240         }
241         if (!empty($settings)) {
242             $ADMIN->add('modsettingsquizcat', $settings);
243         }
244     }
246     // Add settings pages for the quiz access rule subplugins.
247     foreach ($rulesbyname as $strrulename => $rule) {
248         $settings = new admin_settingpage('modsettingsquizcat' . $rule,
249                 $strrulename, 'moodle/site:config', $module->is_enabled() === false);
250         if ($ADMIN->fulltree) {
251             include($CFG->dirroot . "/mod/quiz/accessrule/$rule/settings.php");
252         }
253         if (!empty($settings)) {
254             $ADMIN->add('modsettingsquizcat', $settings);
255         }
256     }
259 $settings = null; // We do not want standard settings link.