weekly release 2.5dev
[moodle.git] / question / type / calculated / datasetdefinitions_form.php
CommitLineData
8fc3e643 1<?php
d3603157
TH
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
830e47a8 17/**
d3603157
TH
18 * Defines the editing form for the calculated question data set definitions.
19 *
20 * @package qtype
21 * @subpackage calculated
22 * @copyright 2007 Jamie Pratt me@jamiep.org
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
830e47a8 24 */
25
d3603157 26
a17b297d
TH
27defined('MOODLE_INTERNAL') || die();
28
72553162
TH
29require_once($CFG->dirroot . '/question/type/edit_question_form.php');
30
a17b297d 31
d3603157
TH
32/**
33 * Calculated question data set definitions editing form definition.
34 *
35 * @copyright 2007 Jamie Pratt me@jamiep.org
36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 */
72553162 38class question_dataset_dependent_definitions_form extends question_wizard_form {
8fc3e643 39 /**
40 * Question object with options and answers already loaded by get_question_options
41 * Be careful how you use this it is needed sometimes to set up the structure of the
42 * form in definition_inner but data is always loaded into the form with set_defaults.
43 *
44 * @var object
45 */
f184c65c 46 protected $question;
8fc3e643 47 /**
48 * Reference to question type object
49 *
50 * @var question_dataset_dependent_questiontype
51 */
f184c65c 52 protected $qtypeobj;
8fc3e643 53 /**
54 * Add question-type specific form fields.
55 *
56 * @param MoodleQuickForm $mform the form being built.
57 */
f184c65c
TH
58 public function __construct($submiturl, $question) {
59 global $DB;
8fc3e643 60 $this->question = $question;
18f9b2d2 61 $this->qtypeobj = question_bank::get_qtype($this->question->qtype);
4454447d 62 // Validate the question category.
f184c65c
TH
63 if (!$category = $DB->get_record('question_categories',
64 array('id' => $question->category))) {
4454447d
PS
65 print_error('categorydoesnotexist', 'question', $returnurl);
66 }
315efce7 67 $this->category = $category;
d197ea43 68 $this->categorycontext = context::instance_by_id($category->contextid);
f184c65c 69 parent::__construct($submiturl);
8fc3e643 70 }
c7df5006
TH
71
72 protected function definition() {
60b5ecd3 73 global $SESSION;
f184c65c 74 $mform = $this->_form;
8fc3e643 75 $possibledatasets = $this->qtypeobj->find_dataset_names($this->question->questiontext);
76 $mandatorydatasets = array();
f184c65c 77 if (isset($this->question->options->answers)) {
60b5ecd3 78 foreach ($this->question->options->answers as $answer) {
79 $mandatorydatasets += $this->qtypeobj->find_dataset_names($answer->answer);
80 }
f184c65c
TH
81 } else {
82 foreach ($SESSION->calculated->questionform->answers as $answer) {
60b5ecd3 83 $mandatorydatasets += $this->qtypeobj->find_dataset_names($answer);
84 }
8fc3e643 85 }
60b5ecd3 86
8fc3e643 87 $key = 0;
92e2ed8f 88 $datadefscat= array();
89 $datadefscat = $this->qtypeobj->get_dataset_definitions_category($this->question);
8fc3e643 90 $datasetmenus = array();
5940864e 91 $label = "<div class='mdl-align'>".get_string('datasetrole', 'qtype_calculated')."</div>";
f184c65c
TH
92 // explaining the role of datasets so other strings can be shortened
93 $mform->addElement('html', $label);
94 $mform->addElement('header', 'mandatoryhdr',
95 get_string('mandatoryhdr', 'qtype_calculated'));
5940864e 96 $labelsharedwildcard = get_string('sharedwildcard', 'qtype_calculated');
92e2ed8f 97
8fc3e643 98 foreach ($mandatorydatasets as $datasetname) {
99 if (!isset($datasetmenus[$datasetname])) {
100 list($options, $selected) =
101 $this->qtypeobj->dataset_options($this->question, $datasetname);
102 unset($options['0']); // Mandatory...
6ef90fde 103 $label = get_string('wildcard', 'qtype_calculated', $datasetname);
8fc3e643 104 $mform->addElement('select', "dataset[$key]", $label, $options);
f184c65c
TH
105 if (isset($datadefscat[$datasetname])) {
106 $mform->addElement('static', "there is a category",
107 get_string('sharedwildcard', 'qtype_calculated', $datasetname),
108 get_string('dataitemdefined', 'qtype_calculated',
109 $datadefscat[$datasetname]));
110 }
8fc3e643 111 $mform->setDefault("dataset[$key]", $selected);
f184c65c 112 $datasetmenus[$datasetname] = '';
8fc3e643 113 $key++;
114 }
115 }
f184c65c 116 $mform->addElement('header', 'possiblehdr', get_string('possiblehdr', 'qtype_calculated'));
92e2ed8f 117
8fc3e643 118 foreach ($possibledatasets as $datasetname) {
119 if (!isset($datasetmenus[$datasetname])) {
f184c65c
TH
120 list($options, $selected) = $this->qtypeobj->dataset_options(
121 $this->question, $datasetname, false);
6ef90fde 122 $label = get_string('wildcard', 'qtype_calculated', $datasetname);
8fc3e643 123 $mform->addElement('select', "dataset[$key]", $label, $options);
f184c65c
TH
124 if (isset($datadefscat[$datasetname])) {
125 $mform->addElement('static', "there is a category",
126 get_string('sharedwildcard', 'qtype_calculated', $datasetname),
127 get_string('dataitemdefined', 'qtype_calculated',
128 $datadefscat[$datasetname]));
129 }
79bb7202 130
8fc3e643 131 $mform->setDefault("dataset[$key]", $selected);
f184c65c 132 $datasetmenus[$datasetname] = '';
8fc3e643 133 $key++;
134 }
135 }
1bf9a631 136 // temporary strings
f184c65c
TH
137 $mform->addElement('header', 'synchronizehdr',
138 get_string('synchronize', 'qtype_calculated'));
139 $mform->addElement('radio', 'synchronize', '',
140 get_string('synchronizeno', 'qtype_calculated'), 0);
141 $mform->addElement('radio', 'synchronize', '',
142 get_string('synchronizeyes', 'qtype_calculated'), 1);
143 $mform->addElement('radio', 'synchronize', '',
144 get_string('synchronizeyesdisplay', 'qtype_calculated'), 2);
145 if (isset($this->question->options) &&
146 isset($this->question->options->synchronize)) {
147 $mform->setDefault('synchronize', $this->question->options->synchronize);
f79a4158 148 } else {
f184c65c 149 $mform->setDefault('synchronize', 0);
f79a4158 150 }
151
a8d2a373 152 $this->add_action_buttons(false, get_string('nextpage', 'qtype_calculated'));
60b5ecd3 153
72553162 154 $this->add_hidden_fields();
79bb7202 155
315efce7 156 $mform->addElement('hidden', 'category');
72553162 157 $mform->setType('category', PARAM_SEQUENCE);
79bb7202 158
60b5ecd3 159 $mform->addElement('hidden', 'wizard', 'datasetitems');
160 $mform->setType('wizard', PARAM_ALPHA);
8fc3e643 161 }
f184c65c
TH
162
163 public function validation($data, $files) {
a78890d5 164 $errors = parent::validation($data, $files);
92e2ed8f 165 $datasets = $data['dataset'];
f184c65c
TH
166 $countvalid = 0;
167 foreach ($datasets as $key => $dataset) {
168 if ($dataset != '0') {
92e2ed8f 169 $countvalid++;
170 }
171 }
f184c65c
TH
172 if (!$countvalid) {
173 foreach ($datasets as $key => $dataset) {
174 $errors['dataset['.$key.']'] =
175 get_string('atleastonerealdataset', 'qtype_calculated');
92e2ed8f 176 }
f184c65c 177 }
92e2ed8f 178 return $errors;
179 }
8fc3e643 180}