/mod/lesson/pagetypes/multichoice.php
PHP | 579 lines | 460 code | 66 blank | 53 comment | 116 complexity | 58924b375e0a65f75b94019c84badea7 MD5 | raw file
Possible License(s): Apache-2.0, LGPL-2.1, BSD-3-Clause, MIT, GPL-3.0
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * Multichoice
- *
- * @package mod_lesson
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- **/
- defined('MOODLE_INTERNAL') || die();
- /** Multichoice question type */
- define("LESSON_PAGE_MULTICHOICE", "3");
- class lesson_page_type_multichoice extends lesson_page {
- protected $type = lesson_page::TYPE_QUESTION;
- protected $typeidstring = 'multichoice';
- protected $typeid = LESSON_PAGE_MULTICHOICE;
- protected $string = null;
- public function get_typeid() {
- return $this->typeid;
- }
- public function get_typestring() {
- if ($this->string===null) {
- $this->string = get_string($this->typeidstring, 'lesson');
- }
- return $this->string;
- }
- public function get_idstring() {
- return $this->typeidstring;
- }
- /**
- * Gets an array of the jumps used by the answers of this page
- *
- * @return array
- */
- public function get_jumps() {
- global $DB;
- $jumps = array();
- if ($answers = $this->get_answers()) {
- foreach ($answers as $answer) {
- if ($answer->answer === '') {
- // show only jumps for real branches (==have description)
- continue;
- }
- $jumps[] = $this->get_jump_name($answer->jumpto);
- }
- } else {
- // We get here is the lesson was created on a Moodle 1.9 site and
- // the lesson contains question pages without any answers.
- $jumps[] = $this->get_jump_name($this->properties->nextpageid);
- }
- return $jumps;
- }
- public function get_used_answers() {
- $answers = $this->get_answers();
- foreach ($answers as $key=>$answer) {
- if ($answer->answer === '') {
- unset($answers[$key]);
- } else {
- $answers[$key] = parent::rewrite_answers_urls($answer);
- }
- }
- return $answers;
- }
- public function display($renderer, $attempt) {
- global $CFG, $PAGE;
- $answers = $this->get_used_answers();
- shuffle($answers);
- $action = $CFG->wwwroot.'/mod/lesson/continue.php';
- $params = array('answers'=>$answers, 'lessonid'=>$this->lesson->id, 'contents'=>$this->get_contents(), 'attempt'=>$attempt);
- if ($this->properties->qoption) {
- $mform = new lesson_display_answer_form_multichoice_multianswer($action, $params);
- } else {
- $mform = new lesson_display_answer_form_multichoice_singleanswer($action, $params);
- }
- $data = new stdClass;
- $data->id = $PAGE->cm->id;
- $data->pageid = $this->properties->id;
- $mform->set_data($data);
- // Trigger an event question viewed.
- $eventparams = array(
- 'context' => context_module::instance($PAGE->cm->id),
- 'objectid' => $this->properties->id,
- 'other' => array(
- 'pagetype' => $this->get_typestring()
- )
- );
- $event = \mod_lesson\event\question_viewed::create($eventparams);
- $event->trigger();
- return $mform->display();
- }
- public function check_answer() {
- global $DB, $CFG, $PAGE;
- $result = parent::check_answer();
- $formattextdefoptions = new stdClass();
- $formattextdefoptions->noclean = true;
- $formattextdefoptions->para = false;
- $answers = $this->get_used_answers();
- shuffle($answers);
- $action = $CFG->wwwroot.'/mod/lesson/continue.php';
- $params = array('answers'=>$answers, 'lessonid'=>$this->lesson->id, 'contents'=>$this->get_contents());
- if ($this->properties->qoption) {
- $mform = new lesson_display_answer_form_multichoice_multianswer($action, $params);
- } else {
- $mform = new lesson_display_answer_form_multichoice_singleanswer($action, $params);
- }
- $data = $mform->get_data();
- require_sesskey();
- if (!$data) {
- $result->inmediatejump = true;
- $result->newpageid = $this->properties->id;
- return $result;
- }
- if ($this->properties->qoption) {
- // Multianswer allowed, user's answer is an array
- if (empty($data->answer) || !is_array($data->answer)) {
- $result->noanswer = true;
- return $result;
- }
- $studentanswers = array();
- foreach ($data->answer as $key=>$value) {
- $studentanswers[] = (int)$key;
- }
- // get what the user answered
- $result->userresponse = implode(",", $studentanswers);
- // get the answers in a set order, the id order
- $answers = $this->get_used_answers();
- $ncorrect = 0;
- $nhits = 0;
- $responses = array();
- $correctanswerid = 0;
- $wronganswerid = 0;
- // store student's answers for displaying on feedback page
- $result->studentanswer = '';
- $result->studentanswerformat = FORMAT_HTML;
- foreach ($answers as $answer) {
- foreach ($studentanswers as $answerid) {
- if ($answerid == $answer->id) {
- $studentanswerarray[] = format_text($answer->answer, $answer->answerformat, $formattextdefoptions);
- $responses[$answerid] = format_text($answer->response, $answer->responseformat, $formattextdefoptions);
- }
- }
- }
- $result->studentanswer = implode(self::MULTIANSWER_DELIMITER, $studentanswerarray);
- $correctpageid = null;
- $wrongpageid = null;
- // Iterate over all the possible answers.
- foreach ($answers as $answer) {
- if ($this->lesson->custom) {
- $iscorrectanswer = $answer->score > 0;
- } else {
- $iscorrectanswer = $this->lesson->jumpto_is_correct($this->properties->id, $answer->jumpto);
- }
- // Iterate over all the student answers to check if he selected the current possible answer.
- foreach ($studentanswers as $answerid) {
- if ($answerid == $answer->id) {
- if ($iscorrectanswer) {
- $nhits++;
- } else {
- // Always jump to the page related to the student's first wrong answer.
- if (!isset($wrongpageid)) {
- // Leave in its "raw" state - will be converted into a proper page id later.
- $wrongpageid = $answer->jumpto;
- }
- // Save the answer id for scoring.
- if ($wronganswerid == 0) {
- $wronganswerid = $answer->id;
- }
- }
- }
- }
- if ($iscorrectanswer) {
- $ncorrect++;
- // Save the first jumpto page id, may be needed!
- if (!isset($correctpageid)) {
- // Leave in its "raw" state - will be converted into a proper page id later.
- $correctpageid = $answer->jumpto;
- }
- // Save the answer id for scoring.
- if ($correctanswerid == 0) {
- $correctanswerid = $answer->id;
- }
- }
- }
- if ((count($studentanswers) == $ncorrect) and ($nhits == $ncorrect)) {
- $result->correctanswer = true;
- $result->response = implode(self::MULTIANSWER_DELIMITER, $responses);
- $result->newpageid = $correctpageid;
- $result->answerid = $correctanswerid;
- } else {
- $result->response = implode(self::MULTIANSWER_DELIMITER, $responses);
- $result->newpageid = $wrongpageid;
- $result->answerid = $wronganswerid;
- }
- } else {
- // only one answer allowed
- if (!isset($data->answerid) || (empty($data->answerid) && !is_int($data->answerid))) {
- $result->noanswer = true;
- return $result;
- }
- $result->answerid = $data->answerid;
- if (!$answer = $DB->get_record("lesson_answers", array("id" => $result->answerid))) {
- print_error("Continue: answer record not found");
- }
- $answer = parent::rewrite_answers_urls($answer);
- if ($this->lesson->jumpto_is_correct($this->properties->id, $answer->jumpto)) {
- $result->correctanswer = true;
- }
- if ($this->lesson->custom) {
- if ($answer->score > 0) {
- $result->correctanswer = true;
- } else {
- $result->correctanswer = false;
- }
- }
- $result->newpageid = $answer->jumpto;
- $result->response = format_text($answer->response, $answer->responseformat, $formattextdefoptions);
- $result->userresponse = format_text($answer->answer, $answer->answerformat, $formattextdefoptions);
- $result->studentanswer = $result->userresponse;
- }
- return $result;
- }
- public function option_description_string() {
- if ($this->properties->qoption) {
- return " - ".get_string("multianswer", "lesson");
- }
- return parent::option_description_string();
- }
- public function display_answers(html_table $table) {
- $answers = $this->get_used_answers();
- $options = new stdClass;
- $options->noclean = true;
- $options->para = false;
- $i = 1;
- foreach ($answers as $answer) {
- $answer = parent::rewrite_answers_urls($answer);
- $cells = array();
- if ($this->lesson->custom && $answer->score > 0) {
- // if the score is > 0, then it is correct
- $cells[] = '<label class="correct">' . get_string('answer', 'lesson') . " {$i}</label>: \n";
- } else if ($this->lesson->custom) {
- $cells[] = '<label>' . get_string('answer', 'lesson') . " {$i}</label>: \n";
- } else if ($this->lesson->jumpto_is_correct($this->properties->id, $answer->jumpto)) {
- // underline correct answers
- $cells[] = '<span class="correct">' . get_string('answer', 'lesson') . " {$i}</span>: \n";
- } else {
- $cells[] = '<label class="correct">' . get_string('answer', 'lesson') . " {$i}</label>: \n";
- }
- $cells[] = format_text($answer->answer, $answer->answerformat, $options);
- $table->data[] = new html_table_row($cells);
- $cells = array();
- $cells[] = '<label>' . get_string('response', 'lesson') . " {$i} </label>:\n";
- $cells[] = format_text($answer->response, $answer->responseformat, $options);
- $table->data[] = new html_table_row($cells);
- $cells = array();
- $cells[] = '<label>' . get_string('score', 'lesson') . '</label>:';
- $cells[] = $answer->score;
- $table->data[] = new html_table_row($cells);
- $cells = array();
- $cells[] = '<label>' . get_string('jump', 'lesson') . '</label>:';
- $cells[] = $this->get_jump_name($answer->jumpto);
- $table->data[] = new html_table_row($cells);
- if ($i === 1){
- $table->data[count($table->data)-1]->cells[0]->style = 'width:20%;';
- }
- $i++;
- }
- return $table;
- }
- public function stats(array &$pagestats, $tries) {
- $temp = $this->lesson->get_last_attempt($tries);
- if ($this->properties->qoption) {
- $userresponse = explode(",", $temp->useranswer);
- foreach ($userresponse as $response) {
- if (isset($pagestats[$temp->pageid][$response])) {
- $pagestats[$temp->pageid][$response]++;
- } else {
- $pagestats[$temp->pageid][$response] = 1;
- }
- }
- } else {
- if (isset($pagestats[$temp->pageid][$temp->answerid])) {
- $pagestats[$temp->pageid][$temp->answerid]++;
- } else {
- $pagestats[$temp->pageid][$temp->answerid] = 1;
- }
- }
- if (isset($pagestats[$temp->pageid]["total"])) {
- $pagestats[$temp->pageid]["total"]++;
- } else {
- $pagestats[$temp->pageid]["total"] = 1;
- }
- return true;
- }
- public function report_answers($answerpage, $answerdata, $useranswer, $pagestats, &$i, &$n) {
- $answers = $this->get_used_answers();
- $formattextdefoptions = new stdClass;
- $formattextdefoptions->para = false; //I'll use it widely in this page
- $formattextdefoptions->context = $answerpage->context;
- foreach ($answers as $answer) {
- $answertext = format_text($answer->answer,$answer->answerformat,$formattextdefoptions);
- $correctresponsetext = html_writer::div(get_string('correctresponse', 'lesson'), 'badge badge-success');
- if ($this->properties->qoption) {
- if ($useranswer == null) {
- $userresponse = array();
- } else {
- $userresponse = explode(",", $useranswer->useranswer);
- }
- if (in_array($answer->id, $userresponse)) {
- // make checked
- $checkboxelement = "<input readonly=\"readonly\" disabled=\"disabled\" name=\"answer[$i]\" checked=\"checked\" type=\"checkbox\" value=\"1\" />";
- if (!isset($answerdata->response)) {
- if ($answer->response == null) {
- if ($useranswer->correct) {
- $answerdata->response = get_string("thatsthecorrectanswer", "lesson");
- } else {
- $answerdata->response = get_string("thatsthewronganswer", "lesson");
- }
- } else {
- $answerdata->response = $answer->response;
- }
- }
- if (!isset($answerdata->score)) {
- if ($this->lesson->custom) {
- $answerdata->score = get_string("pointsearned", "lesson").": ".$answer->score;
- } elseif ($useranswer->correct) {
- $answerdata->score = get_string("receivedcredit", "lesson");
- } else {
- $answerdata->score = get_string("didnotreceivecredit", "lesson");
- }
- }
- } else {
- // unchecked
- $checkboxelement = "<input type=\"checkbox\" readonly=\"readonly\" name=\"answer[$i]\" value=\"0\" disabled=\"disabled\" />";
- }
- $answercontent = html_writer::label($checkboxelement . ' ' . $answertext, null);
- if (($answer->score > 0 && $this->lesson->custom) || ($this->lesson->jumpto_is_correct($this->properties->id, $answer->jumpto) && !$this->lesson->custom)) {
- $data = html_writer::div($answercontent, 'text-success') . $correctresponsetext;
- } else {
- $data = $answercontent;
- }
- } else {
- if ($useranswer != null and $answer->id == $useranswer->answerid) {
- // make checked
- $checkboxelement = "<input readonly=\"readonly\" disabled=\"disabled\" name=\"answer[$i]\" checked=\"checked\" type=\"checkbox\" value=\"1\" />";
- if ($answer->response == null) {
- if ($useranswer->correct) {
- $answerdata->response = get_string("thatsthecorrectanswer", "lesson");
- } else {
- $answerdata->response = get_string("thatsthewronganswer", "lesson");
- }
- } else {
- $answerdata->response = $answer->response;
- }
- if ($this->lesson->custom) {
- $answerdata->score = get_string("pointsearned", "lesson").": ".$answer->score;
- } elseif ($useranswer->correct) {
- $answerdata->score = get_string("receivedcredit", "lesson");
- } else {
- $answerdata->score = get_string("didnotreceivecredit", "lesson");
- }
- } else {
- // unchecked
- $checkboxelement = "<input type=\"checkbox\" readonly=\"readonly\" name=\"answer[$i]\" value=\"0\" disabled=\"disabled\" />";
- }
- $answercontent = html_writer::label($checkboxelement . ' ' . $answertext, null);
- if (($answer->score > 0 && $this->lesson->custom) || ($this->lesson->jumpto_is_correct($this->properties->id, $answer->jumpto) && !$this->lesson->custom)) {
- $data = html_writer::div($answercontent, 'text-success') . $correctresponsetext;
- } else {
- $data = $answercontent;
- }
- }
- if (isset($pagestats[$this->properties->id][$answer->id])) {
- $percent = $pagestats[$this->properties->id][$answer->id] / $pagestats[$this->properties->id]["total"] * 100;
- $percent = round($percent, 2);
- $percent .= "% ".get_string("checkedthisone", "lesson");
- } else {
- $percent = get_string("noonecheckedthis", "lesson");
- }
- $answerdata->answers[] = array($data, $percent);
- $answerpage->answerdata = $answerdata;
- }
- return $answerpage;
- }
- }
- class lesson_add_page_form_multichoice extends lesson_add_page_form_base {
- public $qtype = 'multichoice';
- public $qtypestring = 'multichoice';
- protected $answerformat = LESSON_ANSWER_HTML;
- protected $responseformat = LESSON_ANSWER_HTML;
- public function custom_definition() {
- $this->_form->addElement('checkbox', 'qoption', get_string('options', 'lesson'), get_string('multianswer', 'lesson'));
- $this->_form->setDefault('qoption', 0);
- $this->_form->addHelpButton('qoption', 'multianswer', 'lesson');
- for ($i = 0; $i < $this->_customdata['lesson']->maxanswers; $i++) {
- $this->_form->addElement('header', 'answertitle'.$i, get_string('answer').' '.($i+1));
- $this->add_answer($i, null, ($i<2), $this->get_answer_format());
- $this->add_response($i);
- $this->add_jumpto($i, null, ($i == 0 ? LESSON_NEXTPAGE : LESSON_THISPAGE));
- $this->add_score($i, null, ($i===0)?1:0);
- }
- }
- }
- class lesson_display_answer_form_multichoice_singleanswer extends moodleform {
- public function definition() {
- global $USER, $OUTPUT;
- $mform = $this->_form;
- $answers = $this->_customdata['answers'];
- $lessonid = $this->_customdata['lessonid'];
- $contents = $this->_customdata['contents'];
- if (array_key_exists('attempt', $this->_customdata)) {
- $attempt = $this->_customdata['attempt'];
- } else {
- $attempt = new stdClass();
- $attempt->answerid = null;
- }
- // Disable shortforms.
- $mform->setDisableShortforms();
- $mform->addElement('header', 'pageheader');
- $mform->addElement('html', $OUTPUT->container($contents, 'contents'));
- $hasattempt = false;
- $disabled = '';
- if (isset($USER->modattempts[$lessonid]) && !empty($USER->modattempts[$lessonid])) {
- $hasattempt = true;
- $disabled = array('disabled' => 'disabled');
- }
- $options = new stdClass;
- $options->para = false;
- $options->noclean = true;
- $mform->addElement('hidden', 'id');
- $mform->setType('id', PARAM_INT);
- $mform->addElement('hidden', 'pageid');
- $mform->setType('pageid', PARAM_INT);
- $i = 0;
- foreach ($answers as $answer) {
- $mform->addElement('html', '<div class="answeroption">');
- $answer->answer = preg_replace('#>$#', '> ', $answer->answer);
- $mform->addElement('radio','answerid',null,format_text($answer->answer, $answer->answerformat, $options),$answer->id, $disabled);
- $mform->setType('answer'.$i, PARAM_INT);
- if ($hasattempt && $answer->id == $USER->modattempts[$lessonid]->answerid) {
- $mform->setDefault('answerid', $USER->modattempts[$lessonid]->answerid);
- }
- $mform->addElement('html', '</div>');
- $i++;
- }
- if ($hasattempt) {
- $this->add_action_buttons(null, get_string("nextpage", "lesson"));
- } else {
- $this->add_action_buttons(null, get_string("submit", "lesson"));
- }
- }
- }
- class lesson_display_answer_form_multichoice_multianswer extends moodleform {
- public function definition() {
- global $USER, $OUTPUT;
- $mform = $this->_form;
- $answers = $this->_customdata['answers'];
- $lessonid = $this->_customdata['lessonid'];
- $contents = $this->_customdata['contents'];
- // Disable shortforms.
- $mform->setDisableShortforms();
- $mform->addElement('header', 'pageheader');
- $mform->addElement('html', $OUTPUT->container($contents, 'contents'));
- $hasattempt = false;
- $disabled = '';
- $useranswers = array();
- if (isset($USER->modattempts[$lessonid]) && !empty($USER->modattempts[$lessonid])) {
- $hasattempt = true;
- $disabled = array('disabled' => 'disabled');
- $useranswers = explode(',', $USER->modattempts[$lessonid]->useranswer);
- }
- $options = new stdClass;
- $options->para = false;
- $options->noclean = true;
- $mform->addElement('hidden', 'id');
- $mform->setType('id', PARAM_INT);
- $mform->addElement('hidden', 'pageid');
- $mform->setType('pageid', PARAM_INT);
- foreach ($answers as $answer) {
- $mform->addElement('html', '<div class="answeroption">');
- $answerid = 'answer['.$answer->id.']';
- if ($hasattempt && in_array($answer->id, $useranswers)) {
- $answerid = 'answer_'.$answer->id;
- $mform->addElement('hidden', 'answer['.$answer->id.']', $answer->answer);
- $mform->setType('answer['.$answer->id.']', PARAM_NOTAGS);
- $mform->setDefault($answerid, true);
- $mform->setDefault('answer['.$answer->id.']', true);
- }
- // NOTE: our silly checkbox supports only value '1' - we can not use it like the radiobox above!!!!!!
- $answer->answer = preg_replace('#>$#', '> ', $answer->answer);
- $mform->addElement('checkbox', $answerid, null, format_text($answer->answer, $answer->answerformat, $options), $disabled);
- $mform->setType($answerid, PARAM_INT);
- $mform->addElement('html', '</div>');
- }
- if ($hasattempt) {
- $this->add_action_buttons(null, get_string("nextpage", "lesson"));
- } else {
- $this->add_action_buttons(null, get_string("submit", "lesson"));
- }
- }
- }