Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?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/>.

/**
 * Question type class for the drag-and-drop onto image question type.
 *
 * @package    qtype_ddimageortext
 * @copyright  2009 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


defined('MOODLE_INTERNAL') || die();

require_once($CFG->dirroot . '/question/type/ddimageortext/questiontypebase.php');

/**
 * The drag-and-drop onto image question type class.
 *
 * @copyright  2009 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class qtype_ddimageortext extends qtype_ddtoimage_base {

    protected function make_choice($dragdata) {
        return new qtype_ddimageortext_drag_item($dragdata->label, $dragdata->no,
                                        $dragdata->draggroup, $dragdata->infinite, $dragdata->id);
    }

    protected function make_place($dropzonedata) {
        return new qtype_ddimageortext_drop_zone($dropzonedata->label, $dropzonedata->no,
                                                    $dropzonedata->group,
                                                    $dropzonedata->xleft, $dropzonedata->ytop);
    }

    protected function make_hint($hint) {
        return question_hint_with_parts::load_from_record($hint);
    }

> public function save_defaults_for_new_questions(stdClass $fromform): void { public function save_question_options($formdata) { > parent::save_defaults_for_new_questions($fromform); global $DB, $USER; > $this->set_default_value('shuffleanswers', $fromform->shuffleanswers); $context = $formdata->context; > } >
$options = $DB->get_record('qtype_ddimageortext', array('questionid' => $formdata->id)); if (!$options) { $options = new stdClass(); $options->questionid = $formdata->id; $options->correctfeedback = ''; $options->partiallycorrectfeedback = ''; $options->incorrectfeedback = ''; $options->id = $DB->insert_record('qtype_ddimageortext', $options); } $options->shuffleanswers = !empty($formdata->shuffleanswers); $options = $this->save_combined_feedback_helper($options, $formdata, $context, true); $this->save_hints($formdata, true); $DB->update_record('qtype_ddimageortext', $options); $DB->delete_records('qtype_ddimageortext_drops', array('questionid' => $formdata->id)); foreach (array_keys($formdata->drops) as $dropno) { if ($formdata->drops[$dropno]['choice'] == 0) { continue; } $drop = new stdClass(); $drop->questionid = $formdata->id; $drop->no = $dropno + 1; $drop->xleft = $formdata->drops[$dropno]['xleft']; $drop->ytop = $formdata->drops[$dropno]['ytop']; $drop->choice = $formdata->drops[$dropno]['choice']; $drop->label = $formdata->drops[$dropno]['droplabel']; $DB->insert_record('qtype_ddimageortext_drops', $drop); } // An array of drag no -> drag id. $olddragids = $DB->get_records_menu('qtype_ddimageortext_drags', array('questionid' => $formdata->id), '', 'no, id'); foreach (array_keys($formdata->drags) as $dragno) { $info = file_get_draft_area_info($formdata->dragitem[$dragno]); if ($info['filecount'] > 0 || (trim($formdata->draglabel[$dragno]) != '')) { $draftitemid = $formdata->dragitem[$dragno]; $drag = new stdClass(); $drag->questionid = $formdata->id; $drag->no = $dragno + 1; $drag->draggroup = $formdata->drags[$dragno]['draggroup']; $drag->infinite = empty($formdata->drags[$dragno]['infinite']) ? 0 : 1; $drag->label = $formdata->draglabel[$dragno]; if (isset($olddragids[$dragno + 1])) { $drag->id = $olddragids[$dragno + 1]; unset($olddragids[$dragno + 1]); $DB->update_record('qtype_ddimageortext_drags', $drag); } else { $drag->id = $DB->insert_record('qtype_ddimageortext_drags', $drag); } if ($formdata->drags[$dragno]['dragitemtype'] == 'image') { file_save_draft_area_files($draftitemid, $formdata->context->id, 'qtype_ddimageortext', 'dragimage', $drag->id, array('subdirs' => 0, 'maxbytes' => 0, 'maxfiles' => 1)); } else { // Delete any existing files for draggable text item type. $fs = get_file_storage(); $fs->delete_area_files($formdata->context->id, 'qtype_ddimageortext', 'dragimage', $drag->id); } } } if (!empty($olddragids)) { list($sql, $params) = $DB->get_in_or_equal(array_values($olddragids)); $DB->delete_records_select('qtype_ddimageortext_drags', "id $sql", $params); } file_save_draft_area_files($formdata->bgimage, $formdata->context->id, 'qtype_ddimageortext', 'bgimage', $formdata->id, array('subdirs' => 0, 'maxbytes' => 0, 'maxfiles' => 1)); } public function move_files($questionid, $oldcontextid, $newcontextid) { global $DB; $fs = get_file_storage(); parent::move_files($questionid, $oldcontextid, $newcontextid); $fs->move_area_files_to_new_context($oldcontextid, $newcontextid, 'qtype_ddimageortext', 'bgimage', $questionid); $dragids = $DB->get_records_menu('qtype_ddimageortext_drags', array('questionid' => $questionid), 'id', 'id,1'); foreach ($dragids as $dragid => $notused) { $fs->move_area_files_to_new_context($oldcontextid, $newcontextid, 'qtype_ddimageortext', 'dragimage', $dragid); } $this->move_files_in_combined_feedback($questionid, $oldcontextid, $newcontextid); $this->move_files_in_hints($questionid, $oldcontextid, $newcontextid); } /** * Delete all the files belonging to this question. * @param int $questionid the question being deleted. * @param int $contextid the context the question is in. */ protected function delete_files($questionid, $contextid) { global $DB; $fs = get_file_storage(); parent::delete_files($questionid, $contextid); $dragids = $DB->get_records_menu('qtype_ddimageortext_drags', array('questionid' => $questionid), 'id', 'id,1'); foreach ($dragids as $dragid => $notused) { $fs->delete_area_files($contextid, 'qtype_ddimageortext', 'dragimage', $dragid); } $this->delete_files_in_combined_feedback($questionid, $contextid); $this->delete_files_in_hints($questionid, $contextid); } public function export_to_xml($question, qformat_xml $format, $extra = null) { $fs = get_file_storage(); $contextid = $question->contextid; $output = ''; if ($question->options->shuffleanswers) { $output .= " <shuffleanswers/>\n"; } $output .= $format->write_combined_feedback($question->options, $question->id, $question->contextid); $files = $fs->get_area_files($contextid, 'qtype_ddimageortext', 'bgimage', $question->id); $output .= " ".$this->write_files($files, 2)."\n";; foreach ($question->options->drags as $drag) { $files = $fs->get_area_files($contextid, 'qtype_ddimageortext', 'dragimage', $drag->id); $output .= " <drag>\n"; $output .= " <no>{$drag->no}</no>\n"; $output .= $format->writetext($drag->label, 3)."\n"; $output .= " <draggroup>{$drag->draggroup}</draggroup>\n"; if ($drag->infinite) { $output .= " <infinite/>\n"; } $output .= $this->write_files($files, 3); $output .= " </drag>\n"; } foreach ($question->options->drops as $drop) { $output .= " <drop>\n"; $output .= $format->writetext($drop->label, 3); $output .= " <no>{$drop->no}</no>\n"; $output .= " <choice>{$drop->choice}</choice>\n"; $output .= " <xleft>{$drop->xleft}</xleft>\n"; $output .= " <ytop>{$drop->ytop}</ytop>\n"; $output .= " </drop>\n"; } return $output; } public function import_from_xml($data, $question, qformat_xml $format, $extra=null) { if (!isset($data['@']['type']) || $data['@']['type'] != 'ddimageortext') { return false; } $question = $format->import_headers($data); $question->qtype = 'ddimageortext'; $question->shuffleanswers = array_key_exists('shuffleanswers', $format->getpath($data, array('#'), array())); $filexml = $format->getpath($data, array('#', 'file'), array()); $question->bgimage = $format->import_files_as_draft($filexml); $drags = $data['#']['drag']; $question->drags = array(); foreach ($drags as $dragxml) { $dragno = $format->getpath($dragxml, array('#', 'no', 0, '#'), 0); $dragindex = $dragno - 1; $question->drags[$dragindex] = array(); $question->draglabel[$dragindex] = $format->getpath($dragxml, array('#', 'text', 0, '#'), '', true); $question->drags[$dragindex]['infinite'] = array_key_exists('infinite', $dragxml['#']); $question->drags[$dragindex]['draggroup'] = $format->getpath($dragxml, array('#', 'draggroup', 0, '#'), 1); $filexml = $format->getpath($dragxml, array('#', 'file'), array()); $question->dragitem[$dragindex] = $format->import_files_as_draft($filexml); if (count($filexml)) { $question->drags[$dragindex]['dragitemtype'] = 'image'; } else { $question->drags[$dragindex]['dragitemtype'] = 'word'; } } $drops = $data['#']['drop']; $question->drops = array(); foreach ($drops as $dropxml) { $dropno = $format->getpath($dropxml, array('#', 'no', 0, '#'), 0); $dropindex = $dropno - 1; $question->drops[$dropindex] = array(); $question->drops[$dropindex]['choice'] = $format->getpath($dropxml, array('#', 'choice', 0, '#'), 0); $question->drops[$dropindex]['droplabel'] = $format->getpath($dropxml, array('#', 'text', 0, '#'), '', true); $question->drops[$dropindex]['xleft'] = $format->getpath($dropxml, array('#', 'xleft', 0, '#'), ''); $question->drops[$dropindex]['ytop'] = $format->getpath($dropxml, array('#', 'ytop', 0, '#'), ''); } $format->import_combined_feedback($question, $data, true); $format->import_hints($question, $data, true, false, $format->get_format($question->questiontextformat)); return $question; } }