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/>.
  16
  17 /**
  18  * Administration settings definitions for the quiz module.
  19  *
  20  * @package   mod_quiz
  21  * @copyright 2010 Petr Skoda
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 require_once($CFG->dirroot . '/mod/quiz/lib.php');
  29
  30 // First get a list of quiz reports with there own settings pages. If there none,
  31 // we use a simpler overall menu structure.
  32 $reports = core_component::get_plugin_list_with_file('quiz', 'settings.php', false);
  33 $reportsbyname = array();
  34 foreach ($reports as $report => $reportdir) {
  35     $strreportname = get_string($report . 'report', 'quiz_'.$report);
  36     $reportsbyname[$strreportname] = $report;
  37 }
  38 core_collator::ksort($reportsbyname);
  39
  40 // First get a list of quiz reports with there own settings pages. If there none,
  41 // we use a simpler overall menu structure.
  42 $rules = core_component::get_plugin_list_with_file('quizaccess', 'settings.php', false);
  43 $rulesbyname = array();
  44 foreach ($rules as $rule => $ruledir) {
  45     $strrulename = get_string('pluginname', 'quizaccess_' . $rule);
  46     $rulesbyname[$strrulename] = $rule;
  47 }
  48 core_collator::ksort($rulesbyname);
  49
  50 // Create the quiz settings page.
  51 if (empty($reportsbyname) && empty($rulesbyname)) {
  52     $pagetitle = get_string('modulename', 'quiz');
  53 } else {
  54     $pagetitle = get_string('generalsettings', 'admin');
  55 }
  56 $quizsettings = new admin_settingpage('modsettingquiz', $pagetitle, 'moodle/site:config');
  57
  58 if ($ADMIN->fulltree) {
  59     // Introductory explanation that all the settings are defaults for the add quiz form.
  60     $quizsettings->add(new admin_setting_heading('quizintro', '', get_string('configintro', 'quiz')));
  61
  62     // Time limit.
  63     $quizsettings->add(new admin_setting_configduration_with_advanced('quiz/timelimit',
  64             get_string('timelimit', 'quiz'), get_string('configtimelimitsec', 'quiz'),
  65             array('value' => '0', 'adv' => false), 60));
  66
  67     // What to do with overdue attempts.
  68     $quizsettings->add(new mod_quiz_admin_setting_overduehandling('quiz/overduehandling',
  69             get_string('overduehandling', 'quiz'), get_string('overduehandling_desc', 'quiz'),
  70             array('value' => 'autosubmit', 'adv' => false), null));
  71
  72     // Grace period time.
  73     $quizsettings->add(new admin_setting_configduration_with_advanced('quiz/graceperiod',
  74             get_string('graceperiod', 'quiz'), get_string('graceperiod_desc', 'quiz'),
  75             array('value' => '86400', 'adv' => false)));
  76
  77     // Minimum grace period used behind the scenes.
  78     $quizsettings->add(new admin_setting_configduration('quiz/graceperiodmin',
  79             get_string('graceperiodmin', 'quiz'), get_string('graceperiodmin_desc', 'quiz'),
  80             60, 1));
  81
  82     // Number of attempts.
  83     $options = array(get_string('unlimited'));
  84     for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
  85         $options[$i] = $i;
  86     }
  87     $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/attempts',
  88             get_string('attemptsallowed', 'quiz'), get_string('configattemptsallowed', 'quiz'),
  89             array('value' => 0, 'adv' => false), $options));
  90
  91     // Grading method.
  92     $quizsettings->add(new mod_quiz_admin_setting_grademethod('quiz/grademethod',
  93             get_string('grademethod', 'quiz'), get_string('configgrademethod', 'quiz'),
  94             array('value' => QUIZ_GRADEHIGHEST, 'adv' => false), null));
  95
  96     // Maximum grade.
  97     $quizsettings->add(new admin_setting_configtext('quiz/maximumgrade',
  98             get_string('maximumgrade'), get_string('configmaximumgrade', 'quiz'), 10, PARAM_INT));
  99
 100     // Questions per page.
 101     $perpage = array();
 102     $perpage[0] = get_string('never');
 103     $perpage[1] = get_string('aftereachquestion', 'quiz');
 104     for ($i = 2; $i <= QUIZ_MAX_QPP_OPTION; ++$i) {
 105         $perpage[$i] = get_string('afternquestions', 'quiz', $i);
 106     }
 107     $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/questionsperpage',
 108             get_string('newpageevery', 'quiz'), get_string('confignewpageevery', 'quiz'),
 109             array('value' => 1, 'adv' => false), $perpage));
 110
 111     // Navigation method.
 112     $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/navmethod',
 113             get_string('navmethod', 'quiz'), get_string('confignavmethod', 'quiz'),
 114             array('value' => QUIZ_NAVMETHOD_FREE, 'adv' => true), quiz_get_navigation_options()));
 115
 116     // Shuffle within questions.
 117     $quizsettings->add(new admin_setting_configcheckbox_with_advanced('quiz/shuffleanswers',
 118             get_string('shufflewithin', 'quiz'), get_string('configshufflewithin', 'quiz'),
 119             array('value' => 1, 'adv' => false)));
 120
 121     // Preferred behaviour.
 122     $quizsettings->add(new admin_setting_question_behaviour('quiz/preferredbehaviour',
 123             get_string('howquestionsbehave', 'question'), get_string('howquestionsbehave_desc', 'quiz'),
 124             'deferredfeedback'));
 125
 126     // Can redo completed questions.
 127     $quizsettings->add(new admin_setting_configselect_with_advanced('quiz/canredoquestions',
 128             get_string('canredoquestions', 'quiz'), get_string('canredoquestions_desc', 'quiz'),
 129             array('value' => 0, 'adv' => true),
 130             array(0 => get_string('no'), 1 => get_string('canredoquestionsyes', 'quiz'))));
 131
 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)));
 137
 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));
 152     }
 153
 154     // Show the user's picture.
 155     $quizsettings->add(new mod_quiz_admin_setting_user_image('quiz/showuserpicture',
 156             get_string('showuserpicture', 'quiz'), get_string('configshowuserpicture', 'quiz'),
 157             array('value' => 0, 'adv' => false), null));
 158
 159     // Decimal places for overall grades.
 160     $options = array();
 161     for ($i = 0; $i <= QUIZ_MAX_DECIMAL_OPTION; $i++) {
 162         $options[$i] = $i;
 163     }
 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));
 167
 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;
 172     }
 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));
 177
 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)));
 182
 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' => false), PARAM_TEXT));
 187
 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));
 192
 193     // Enforced delay between attempts.
 194     $quizsettings->add(new admin_setting_configduration_with_advanced('quiz/delay1',
 195             get_string('delay1st2nd', 'quiz'), get_string('configdelay1st2nd', 'quiz'),
 196             array('value' => 0, 'adv' => true), 60));
 197     $quizsettings->add(new admin_setting_configduration_with_advanced('quiz/delay2',
 198             get_string('delaylater', 'quiz'), get_string('configdelaylater', 'quiz'),
 199             array('value' => 0, 'adv' => true), 60));
 200
 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));
 205
 206     $quizsettings->add(new admin_setting_configtext('quiz/initialnumfeedbacks',
 207             get_string('initialnumfeedbacks', 'quiz'), get_string('initialnumfeedbacks_desc', 'quiz'),
 208             2, PARAM_INT, 5));
 209
 210     // Allow user to specify if setting outcomes is an advanced setting.
 211     if (!empty($CFG->enableoutcomes)) {
 212         $quizsettings->add(new admin_setting_configcheckbox('quiz/outcomes_adv',
 213             get_string('outcomesadvanced', 'quiz'), get_string('configoutcomesadvanced', 'quiz'),
 214             '0'));
 215     }
 216
 217     // Autosave frequency.
 218     $quizsettings->add(new admin_setting_configduration('quiz/autosaveperiod',
 219             get_string('autosaveperiod', 'quiz'), get_string('autosaveperiod_desc', 'quiz'), 60, 1));
 220 }
 221
 222 // Now, depending on whether any reports have their own settings page, add
 223 // the quiz setting page to the appropriate place in the tree.
 224 if (empty($reportsbyname) && empty($rulesbyname)) {
 225     $ADMIN->add('modsettings', $quizsettings);
 226 } else {
 227     $ADMIN->add('modsettings', new admin_category('modsettingsquizcat',
 228             get_string('modulename', 'quiz'), $module->is_enabled() === false));
 229     $ADMIN->add('modsettingsquizcat', $quizsettings);
 230
 231     // Add settings pages for the quiz report subplugins.
 232     foreach ($reportsbyname as $strreportname => $report) {
 233         $reportname = $report;
 234
 235         $settings = new admin_settingpage('modsettingsquizcat'.$reportname,
 236                 $strreportname, 'moodle/site:config', $module->is_enabled() === false);
 237         if ($ADMIN->fulltree) {
 238             include($CFG->dirroot . "/mod/quiz/report/$reportname/settings.php");
 239         }
 240         if (!empty($settings)) {
 241             $ADMIN->add('modsettingsquizcat', $settings);
 242         }
 243     }
 244
 245     // Add settings pages for the quiz access rule subplugins.
 246     foreach ($rulesbyname as $strrulename => $rule) {
 247         $settings = new admin_settingpage('modsettingsquizcat' . $rule,
 248                 $strrulename, 'moodle/site:config', $module->is_enabled() === false);
 249         if ($ADMIN->fulltree) {
 250             include($CFG->dirroot . "/mod/quiz/accessrule/$rule/settings.php");
 251         }
 252         if (!empty($settings)) {
 253             $ADMIN->add('modsettingsquizcat', $settings);
 254         }
 255     }
 256 }
 257
 258 $settings = null; // We do not want standard settings link.