MDL-37172 Hardcoded strings in some question imports formats
[moodle.git] / question / format / learnwise / format.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  * Examview question importer.
19  *
20  * @package    qformat
21  * @subpackage learnwise
22  * @copyright  2005 Alton College, Hampshire, UK
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Examview question importer.
32  *
33  * Alton College, Hampshire, UK - Tom Flannaghan, Andrew Walker
34  *
35  * Imports learnwise multiple choice questions (single and multiple answers)
36  * currently ignores the deduct attribute for multiple answer questions
37  * deductions are currently simply found by dividing the award for the incorrect
38  * answer by the total number of options
39  *
40  * @copyright  2005 Alton College, Hampshire, UK
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class qformat_learnwise extends qformat_default {
45     public function provide_import() {
46         return true;
47     }
49     public function export_file_extension() {
50         return '.xml';
51     }
53     protected function readquestions($lines) {
54         $questions = array();
55         $currentquestion = array();
57         foreach($lines as $line) {
58             $line = trim($line);
59             $currentquestion[] = $line;
61             if ($question = $this->readquestion($currentquestion)) {
62                 $questions[] = $question;
63                 $currentquestion = array();
64             }
65         }
66         return $questions;
67     }
69     protected function readquestion($lines) {
70         global $OUTPUT;
72         $text = implode(' ', $lines);
73         $text = str_replace(array('\t','\n','\r'), array('','',''), $text);
75         $startpos = strpos($text, '<question type');
76         $endpos = strpos($text, '</question>');
77         if ($startpos === false || $endpos === false) {
78             return false;
79         }
81         preg_match("/<question type=[\"\']([^\"\']+)[\"\']>/i", $text, $matches);
82         $type = strtolower($matches[1]); // multichoice or multianswerchoice
84         $questiontext = textlib::entities_to_utf8($this->stringbetween($text, '<text>', '</text>'));
85         $questionhint = textlib::entities_to_utf8($this->stringbetween($text, '<hint>', '</hint>'));
86         $questionaward = $this->stringbetween($text, '<award>', '</award>');
87         $optionlist = $this->stringbetween($text, '<answer>', '</answer>');
89         $optionlist = explode('<option', $optionlist);
91         $n = 0;
93         $optionscorrect = array();
94         $optionstext = array();
96         if ($type == 'multichoice') {
97             foreach ($optionlist as $option) {
98                 if (trim($option) === '') {
99                     continue;
100                 }
101                 $correct = $this->stringbetween($option, ' correct="', '">');
102                 $answer = $this->stringbetween($option, '">', '</option>');
103                 $optionscorrect[$n] = $correct;
104                 $optionstext[$n] = textlib::entities_to_utf8($answer);
105                 ++$n;
106             }
107         } else if ($type == 'multianswerchoice') {
108             $numcorrect = 0;
109             $totalaward = 0;
111             $optionsaward = array();
113             foreach ($optionlist as $option) {
114                 if (trim($option) === '') {
115                     continue;
116                 }
117                 preg_match("/correct=\"([^\"]*)\"/i", $option, $correctmatch);
118                 preg_match("/award=\"([^\"]*)\"/i", $option, $awardmatch);
120                 $correct = $correctmatch[1];
121                 $award = $awardmatch[1];
122                 if ($correct == 'yes') {
123                     $totalaward += $award;
124                     ++$numcorrect;
125                 }
127                 $answer = $this->stringbetween($option, '">', '</option>');
129                 $optionscorrect[$n] = $correct;
130                 $optionstext[$n] = textlib::entities_to_utf8($answer);
131                 $optionsaward[$n] = $award;
132                 ++$n;
133             }
135         } else {
136             echo $OUTPUT->notification(get_string('unknownorunhandledtype', 'question', $type));
137         }
139         $question = $this->defaultquestion();
140         $question->qtype = 'multichoice';
141         $question->name = $this->create_default_question_name($questiontext, get_string('questionname', 'question'));
142         $this->add_blank_combined_feedback($question);
144         $question->questiontext = $questiontext;
145         $question->questiontextformat = FORMAT_HTML;
146         $question->single = ($type == 'multichoice') ? 1 : 0;
148         $question->fraction = array();
149         $question->answer = array();
150         for ($n = 0; $n < count($optionstext); ++$n) {
151             if ($optionstext[$n]) {
152                 if (!isset($numcorrect)) {
153                     // Single answer.
154                     if ($optionscorrect[$n] == 'yes') {
155                         $fraction = (int) $questionaward;
156                     } else {
157                         $fraction = 0;
158                     }
159                 } else {
160                     // Multiple answers.
161                     if ($optionscorrect[$n] == 'yes') {
162                         $fraction = $optionsaward[$n] / $totalaward;
163                     } else {
164                         $fraction = -$optionsaward[$n] / count($optionstext);
165                     }
166                 }
167                 $question->fraction[] = $fraction;
168                 $question->answer[] = array('text' => $optionstext[$n], 'format' => FORMAT_HTML);
169                 $question->feedback[] = array('text' => '', 'format' => FORMAT_HTML); // No feedback in this type.
170             }
171         }
173         return $question;
174     }
176     /**
177      * Extract the substring of $text between $start and $end.
178      * @param string $text text to analyse.
179      * @param string $start opening delimiter.
180      * @param string $end closing delimiter.
181      * @return string the requested substring.
182      */
183     protected function stringbetween($text, $start, $end) {
184         $startpos = strpos($text, $start) + strlen($start);
185         $endpos = strpos($text, $end);
187         if ($startpos <= $endpos) {
188             return substr($text, $startpos, $endpos - $startpos);
189         }
190     }