Merge branch 'MDL-39155' of https://github.com/jacks92/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');
31 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
33 // First get a list of quiz reports with there own settings pages. If there none,
34 // we use a simpler overall menu structure.
35 $reports = get_plugin_list_with_file('quiz', 'settings.php', false);
36 $reportsbyname = array();
37 foreach ($reports as $report => $reportdir) {
38     $strreportname = get_string($report . 'report', 'quiz_'.$report);
39     $reportsbyname[$strreportname] = $report;
40 }
41 collatorlib::ksort($reportsbyname);
43 // First get a list of quiz reports with there own settings pages. If there none,
44 // we use a simpler overall menu structure.
45 $rules = get_plugin_list_with_file('quizaccess', 'settings.php', false);
46 $rulesbyname = array();
47 foreach ($rules as $rule => $ruledir) {
48     $strrulename = get_string('pluginname', 'quizaccess_' . $rule);
49     $rulesbyname[$strrulename] = $rule;
50 }
51 collatorlib::ksort($rulesbyname);
53 // Create the quiz settings page.
54 if (empty($reportsbyname) && empty($rulesbyname)) {
55     $pagetitle = get_string('modulename', 'quiz');
56 } else {
57     $pagetitle = get_string('generalsettings', 'admin');
58 }
59 $quizsettings = new admin_settingpage('modsettingquiz', $pagetitle, 'moodle/site:config');
61 // Introductory explanation that all the settings are defaults for the add quiz form.
62 $quizsettings->add(new admin_setting_heading('quizintro', '', get_string('configintro', 'quiz')));
64 // Time limit.
65 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/timelimit',
66         get_string('timelimitsec', 'quiz'), get_string('configtimelimitsec', 'quiz'),
67         array('value' => '0', 'adv' => false), PARAM_INT));
69 // What to do with overdue attempts.
70 $quizsettings->add(new mod_quiz_admin_setting_overduehandling('quiz/overduehandling',
71         get_string('overduehandling', 'quiz'), get_string('overduehandling_desc', 'quiz'),
72         array('value' => 'autoabandon', 'adv' => false), null));
74 // Grace period time.
75 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/graceperiod',
76         get_string('graceperiod', 'quiz'), get_string('graceperiod_desc', 'quiz'),
77         array('value' => '86400', 'adv' => false), PARAM_INT));
79 // Minimum grace period used behind the scenes.
80 $quizsettings->add(new admin_setting_configtext('quiz/graceperiodmin',
81         get_string('graceperiodmin', 'quiz'), get_string('graceperiodmin_desc', 'quiz'),
82         60, PARAM_INT));
84 // Number of attempts.
85 $options = array(get_string('unlimited'));
86 for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
87     $options[$i] = $i;
88 }
89 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/attempts',
90         get_string('attemptsallowed', 'quiz'), get_string('configattemptsallowed', 'quiz'),
91         array('value' => 0, 'adv' => false), $options));
93 // Grading method.
94 $quizsettings->add(new mod_quiz_admin_setting_grademethod('quiz/grademethod',
95         get_string('grademethod', 'quiz'), get_string('configgrademethod', 'quiz'),
96         array('value' => QUIZ_GRADEHIGHEST, 'adv' => false), null));
98 // Maximum grade.
99 $quizsettings->add(new admin_setting_configtext('quiz/maximumgrade',
100         get_string('maximumgrade'), get_string('configmaximumgrade', 'quiz'), 10, PARAM_INT));
102 // Shuffle questions.
103 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shufflequestions',
104         get_string('shufflequestions', 'quiz'), get_string('configshufflequestions', 'quiz'),
105         array('value' => 0, 'adv' => false)));
107 // Questions per page.
108 $perpage = array();
109 $perpage[0] = get_string('never');
110 $perpage[1] = get_string('aftereachquestion', 'quiz');
111 for ($i = 2; $i <= QUIZ_MAX_QPP_OPTION; ++$i) {
112     $perpage[$i] = get_string('afternquestions', 'quiz', $i);
114 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questionsperpage',
115         get_string('newpageevery', 'quiz'), get_string('confignewpageevery', 'quiz'),
116         array('value' => 1, 'adv' => false), $perpage));
118 // Navigation method.
119 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/navmethod',
120         get_string('navmethod', 'quiz'), get_string('confignavmethod', 'quiz'),
121         array('value' => QUIZ_NAVMETHOD_FREE, 'adv' => true), quiz_get_navigation_options()));
123 // Shuffle within questions.
124 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shuffleanswers',
125         get_string('shufflewithin', 'quiz'), get_string('configshufflewithin', 'quiz'),
126         array('value' => 1, 'adv' => false)));
128 // Preferred behaviour.
129 $quizsettings->add(new admin_setting_question_behaviour('quiz/preferredbehaviour',
130         get_string('howquestionsbehave', 'question'), get_string('howquestionsbehave_desc', 'quiz'),
131         'deferredfeedback'));
133 // Each attempt builds on last.
134 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/attemptonlast',
135         get_string('eachattemptbuildsonthelast', 'quiz'),
136         get_string('configeachattemptbuildsonthelast', 'quiz'),
137         array('value' => 0, 'adv' => true)));
139 // Review options.
140 $quizsettings->add(new admin_setting_heading('reviewheading',
141         get_string('reviewoptionsheading', 'quiz'), ''));
142 foreach (mod_quiz_admin_review_setting::fields() as $field => $name) {
143     $default = mod_quiz_admin_review_setting::all_on();
144     $forceduring = null;
145     if ($field == 'attempt') {
146         $forceduring = true;
147     } else if ($field == 'overallfeedback') {
148         $default = $default ^ mod_quiz_admin_review_setting::DURING;
149         $forceduring = false;
150     }
151     $quizsettings->add(new mod_quiz_admin_review_setting('quiz/review' . $field,
152             $name, '', $default, $forceduring));
155 // Show the user's picture.
156 $options = array(
157                 QUIZ_SHOWIMAGE_NONE => get_string('shownoimage', 'quiz'),
158                 QUIZ_SHOWIMAGE_SMALL => get_string('showsmallimage', 'quiz'),
159                 QUIZ_SHOWIMAGE_LARGE => get_string('showlargeimage', 'quiz'));
161 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/showuserpicture',
162         get_string('showuserpicture', 'quiz'), get_string('configshowuserpicture', 'quiz'),
163         array('value' => QUIZ_SHOWIMAGE_NONE, 'adv' => false), $options));
165 // Decimal places for overall grades.
166 $options = array();
167 for ($i = 0; $i <= QUIZ_MAX_DECIMAL_OPTION; $i++) {
168     $options[$i] = $i;
170 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/decimalpoints',
171         get_string('decimalplaces', 'quiz'), get_string('configdecimalplaces', 'quiz'),
172         array('value' => 2, 'adv' => false), $options));
174 // Decimal places for question grades.
175 $options = array(-1 => get_string('sameasoverall', 'quiz'));
176 for ($i = 0; $i <= QUIZ_MAX_Q_DECIMAL_OPTION; $i++) {
177     $options[$i] = $i;
179 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questiondecimalpoints',
180         get_string('decimalplacesquestion', 'quiz'),
181         get_string('configdecimalplacesquestion', 'quiz'),
182         array('value' => -1, 'adv' => true), $options));
184 // Show blocks during quiz attempts.
185 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/showblocks',
186         get_string('showblocks', 'quiz'), get_string('configshowblocks', 'quiz'),
187         array('value' => 0, 'adv' => true)));
189 // Password.
190 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/password',
191         get_string('requirepassword', 'quiz'), get_string('configrequirepassword', 'quiz'),
192         array('value' => '', 'adv' => true), PARAM_TEXT));
194 // IP restrictions.
195 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/subnet',
196         get_string('requiresubnet', 'quiz'), get_string('configrequiresubnet', 'quiz'),
197         array('value' => '', 'adv' => true), PARAM_TEXT));
199 // Enforced delay between attempts.
200 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/delay1',
201         get_string('delay1st2nd', 'quiz'), get_string('configdelay1st2nd', 'quiz'),
202         array('value' => 0, 'adv' => true), PARAM_INT));
203 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/delay2',
204         get_string('delaylater', 'quiz'), get_string('configdelaylater', 'quiz'),
205         array('value' => 0, 'adv' => true), PARAM_INT));
207 // Browser security.
208 $quizsettings->add(new mod_quiz_admin_setting_browsersecurity('quiz/browsersecurity',
209         get_string('showinsecurepopup', 'quiz'), get_string('configpopup', 'quiz'),
210         array('value' => '-', 'adv' => true), null));
212 // Allow user to specify if setting outcomes is an advanced setting
213 if (!empty($CFG->enableoutcomes)) {
214     $quizsettings->add(new admin_setting_configcheckbox('quiz/outcomes_adv',
215         get_string('outcomesadvanced', 'quiz'), get_string('configoutcomesadvanced', 'quiz'),
216         '0'));
219 // Autosave frequency.
220 $options = array(
221       0 => get_string('donotuseautosave', 'quiz'),
222      60 => get_string('oneminute', 'quiz'),
223     120 => get_string('numminutes', 'moodle', 2),
224     300 => get_string('numminutes', 'moodle', 5),
225 );
226 $quizsettings->add(new admin_setting_configselect('quiz/autosaveperiod',
227         get_string('autosaveperiod', 'quiz'), get_string('autosaveperiod_desc', 'quiz'), 0, $options));
229 // Now, depending on whether any reports have their own settings page, add
230 // the quiz setting page to the appropriate place in the tree.
231 if (empty($reportsbyname) && empty($rulesbyname)) {
232     $ADMIN->add('modsettings', $quizsettings);
233 } else {
234     $ADMIN->add('modsettings', new admin_category('modsettingsquizcat',
235             get_string('modulename', 'quiz'), $module->is_enabled() === false));
236     $ADMIN->add('modsettingsquizcat', $quizsettings);
238     // Add settings pages for the quiz report subplugins.
239     foreach ($reportsbyname as $strreportname => $report) {
240         $reportname = $report;
242         $settings = new admin_settingpage('modsettingsquizcat'.$reportname,
243                 $strreportname, 'moodle/site:config', $module->is_enabled() === false);
244         if ($ADMIN->fulltree) {
245             include($CFG->dirroot . "/mod/quiz/report/$reportname/settings.php");
246         }
247         if (!empty($settings)) {
248             $ADMIN->add('modsettingsquizcat', $settings);
249         }
250     }
252     // Add settings pages for the quiz access rule subplugins.
253     foreach ($rulesbyname as $strrulename => $rule) {
254         $settings = new admin_settingpage('modsettingsquizcat' . $rule,
255                 $strrulename, 'moodle/site:config', $module->is_enabled() === false);
256         if ($ADMIN->fulltree) {
257             include($CFG->dirroot . "/mod/quiz/accessrule/$rule/settings.php");
258         }
259         if (!empty($settings)) {
260             $ADMIN->add('modsettingsquizcat', $settings);
261         }
262     }
265 $settings = null; // We do not want standard settings link.