7efd52606f5c9060178f26524952229f2da7f98f
[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 ksort($reportsbyname);
42 // Create the quiz settings page.
43 if (empty($reportsbyname)) {
44     $pagetitle = get_string('modulename', 'quiz');
45 } else {
46     $pagetitle = get_string('generalsettings', 'admin');
47 }
48 $quizsettings = new admin_settingpage('modsettingquiz', $pagetitle, 'moodle/site:config');
50 // Introductory explanation that all the settings are defaults for the add quiz form.
51 $quizsettings->add(new admin_setting_heading('quizintro', '', get_string('configintro', 'quiz')));
53 // Time limit.
54 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/timelimit',
55         get_string('timelimitsec', 'quiz'), get_string('configtimelimitsec', 'quiz'),
56         array('value' => '0', 'fix' => false), PARAM_INT));
58 // What to do with overdue attempts.
59 $quizsettings->add(new mod_quiz_admin_setting_overduehandling('quiz/overduehandling',
60         get_string('overduehandling', 'quiz'), get_string('overduehandling_desc', 'quiz'),
61         array('value' => 'autoabandon', 'fix' => false), null));
63 // Grace period time.
64 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/graceperiod',
65         get_string('graceperiod', 'quiz'), get_string('graceperiod_desc', 'quiz'),
66         array('value' => '86400', 'fix' => false), PARAM_INT));
68 // Minimum grace period used behind the scenes.
69 $quizsettings->add(new admin_setting_configtext('quiz/graceperiodmin',
70         get_string('graceperiodmin', 'quiz'), get_string('graceperiodmin_desc', 'quiz'),
71         60, PARAM_INT));
73 // Number of attempts.
74 $options = array(get_string('unlimited'));
75 for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
76     $options[$i] = $i;
77 }
78 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/attempts',
79         get_string('attemptsallowed', 'quiz'), get_string('configattemptsallowed', 'quiz'),
80         array('value' => 0, 'fix' => false), $options));
82 // Grading method.
83 $quizsettings->add(new mod_quiz_admin_setting_grademethod('quiz/grademethod',
84         get_string('grademethod', 'quiz'), get_string('configgrademethod', 'quiz'),
85         array('value' => QUIZ_GRADEHIGHEST, 'fix' => false), null));
87 // Maximum grade.
88 $quizsettings->add(new admin_setting_configtext('quiz/maximumgrade',
89         get_string('maximumgrade'), get_string('configmaximumgrade', 'quiz'), 10, PARAM_INT));
91 // Shuffle questions.
92 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shufflequestions',
93         get_string('shufflequestions', 'quiz'), get_string('configshufflequestions', 'quiz'),
94         array('value' => 0, 'adv' => false)));
96 // Questions per page.
97 $perpage = array();
98 $perpage[0] = get_string('never');
99 $perpage[1] = get_string('aftereachquestion', 'quiz');
100 for ($i = 2; $i <= QUIZ_MAX_QPP_OPTION; ++$i) {
101     $perpage[$i] = get_string('afternquestions', 'quiz', $i);
103 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questionsperpage',
104         get_string('newpageevery', 'quiz'), get_string('confignewpageevery', 'quiz'),
105         array('value' => 1, 'fix' => false), $perpage));
107 // Navigation method.
108 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/navmethod',
109         get_string('navmethod', 'quiz'), get_string('confignavmethod', 'quiz'),
110         array('value' => QUIZ_NAVMETHOD_FREE, 'adv' => true), quiz_get_navigation_options()));
112 // Shuffle within questions.
113 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shuffleanswers',
114         get_string('shufflewithin', 'quiz'), get_string('configshufflewithin', 'quiz'),
115         array('value' => 1, 'adv' => false)));
117 // Preferred behaviour.
118 $quizsettings->add(new admin_setting_question_behaviour('quiz/preferredbehaviour',
119         get_string('howquestionsbehave', 'question'), get_string('howquestionsbehave_desc', 'quiz'),
120         'deferredfeedback'));
122 // Each attempt builds on last.
123 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/attemptonlast',
124         get_string('eachattemptbuildsonthelast', 'quiz'),
125         get_string('configeachattemptbuildsonthelast', 'quiz'),
126         array('value' => 0, 'adv' => true)));
128 // Review options.
129 $quizsettings->add(new admin_setting_heading('reviewheading',
130         get_string('reviewoptionsheading', 'quiz'), ''));
131 foreach (mod_quiz_admin_review_setting::fields() as $field => $name) {
132     $default = mod_quiz_admin_review_setting::all_on();
133     $forceduring = null;
134     if ($field == 'attempt') {
135         $forceduring = true;
136     } else if ($field == 'overallfeedback') {
137         $default = $default ^ mod_quiz_admin_review_setting::DURING;
138         $forceduring = false;
139     }
140     $quizsettings->add(new mod_quiz_admin_review_setting('quiz/review' . $field,
141             $name, '', $default, $forceduring));
144 // Show the user's picture.
145 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/showuserpicture',
146         get_string('showuserpicture', 'quiz'), get_string('configshowuserpicture', 'quiz'),
147         array('value' => 0, 'adv' => false)));
149 // Decimal places for overall grades.
150 $options = array();
151 for ($i = 0; $i <= QUIZ_MAX_DECIMAL_OPTION; $i++) {
152     $options[$i] = $i;
154 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/decimalpoints',
155         get_string('decimalplaces', 'quiz'), get_string('configdecimalplaces', 'quiz'),
156         array('value' => 2, 'fix' => false), $options));
158 // Decimal places for question grades.
159 $options = array(-1 => get_string('sameasoverall', 'quiz'));
160 for ($i = 0; $i <= QUIZ_MAX_Q_DECIMAL_OPTION; $i++) {
161     $options[$i] = $i;
163 $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questiondecimalpoints',
164         get_string('decimalplacesquestion', 'quiz'),
165         get_string('configdecimalplacesquestion', 'quiz'),
166         array('value' => -1, 'fix' => true), $options));
168 // Show blocks during quiz attempts.
169 $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/showblocks',
170         get_string('showblocks', 'quiz'), get_string('configshowblocks', 'quiz'),
171         array('value' => 0, 'adv' => true)));
173 // Password.
174 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/password',
175         get_string('requirepassword', 'quiz'), get_string('configrequirepassword', 'quiz'),
176         array('value' => '', 'fix' => true), PARAM_TEXT));
178 // IP restrictions.
179 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/subnet',
180         get_string('requiresubnet', 'quiz'), get_string('configrequiresubnet', 'quiz'),
181         array('value' => '', 'fix' => true), PARAM_TEXT));
183 // Enforced delay between attempts.
184 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/delay1',
185         get_string('delay1st2nd', 'quiz'), get_string('configdelay1st2nd', 'quiz'),
186         array('value' => 0, 'fix' => true), PARAM_INT));
187 $quizsettings->add(new admin_setting_configtext_with_advanced('quiz/delay2',
188         get_string('delaylater', 'quiz'), get_string('configdelaylater', 'quiz'),
189         array('value' => 0, 'fix' => true), PARAM_INT));
191 // Browser security.
192 $quizsettings->add(new mod_quiz_admin_setting_browsersecurity('quiz/browsersecurity',
193         get_string('showinsecurepopup', 'quiz'), get_string('configpopup', 'quiz'),
194         array('value' => '-', 'adv' => true), null));
196 // Now, depending on whether any reports have their own settings page, add
197 // the quiz setting page to the appropriate place in the tree.
198 if (empty($reportsbyname)) {
199     $ADMIN->add('modsettings', $quizsettings);
200 } else {
201     $ADMIN->add('modsettings', new admin_category('modsettingsquizcat',
202             get_string('modulename', 'quiz'), $module->is_enabled() === false));
203     $ADMIN->add('modsettingsquizcat', $quizsettings);
205     // Add the report pages for the settings.php files in sub directories of mod/quiz/report.
206     foreach ($reportsbyname as $strreportname => $report) {
207         $reportname = $report;
209         $settings = new admin_settingpage('modsettingsquizcat'.$reportname,
210                 $strreportname, 'moodle/site:config', $module->is_enabled() === false);
211         if ($ADMIN->fulltree) {
212             include($CFG->dirroot . "/mod/quiz/report/$reportname/settings.php");
213         }
214         $ADMIN->add('modsettingsquizcat', $settings);
215     }
218 $settings = null; // We do not want standard settings link.