edit_ordering_form.php

<?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/>.

/**
 * Defines the editing form for the multiple choice question type.
 *
 * @package    qtype
 * @subpackage ordering
 * @copyright  2007 Jamie Pratt
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


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


/**
 * Ordering editing form definition
 * (originally based on mutiple choice form)
 *
 * @copyright  2007 Jamie Pratt
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class qtype_ordering_edit_form extends question_edit_form {

    const NUM_ANS_ROWS  = 2;
    const NUM_ANS_COLS  = 60;
    const NUM_ANS_START = 6;
    const NUM_ANS_ADD   = 2;

    public function qtype() {
        return 'ordering';
    }

    /**
     * Add question-type specific form fields.
     *
     * @param object $mform the form being built.
     */
    public function definition_inner($mform) {

        // cache this plugins name
        $plugin = 'qtype_ordering';

        // selecttype
        $name = 'selecttype';
        $label = get_string($name, $plugin);
        $options = array(
            0 => get_string('selectall', $plugin),
            1 => get_string('selectrandom', $plugin),
            2 => get_string('selectcontiguous', $plugin)
        );
        $mform->addElement('select', $name, $label, $options);
        $mform->addHelpButton($name, $name, $plugin);
        $mform->setDefault($name, 0);

        // selectcount
        $name = 'selectcount';
        $label = get_string($name, $plugin);
        $options = array(0 => get_string('all'));
        for ($i=3; $i <= 20; $i++) {
            $options[$i] = $i;
        }
        $mform->addElement('select', $name, $label, $options);
        $mform->disabledIf($name, 'selecttype', 'eq', 0);
        $mform->addHelpButton($name, $name, $plugin);
        $mform->setDefault($name, 0);

        // answers (=items)
        $elements = array();

        $name = 'answerheader';
        $label = get_string($name, $plugin);
        $elements[] =& $mform->createElement('header', $name, $label);

        $name = 'answer';
        $label = get_string($name, $plugin);
        $options = array('rows' => self::NUM_ANS_ROWS, 'cols' => self::NUM_ANS_COLS);
        $elements[] =& $mform->createElement('textarea', $name, $label, $options);

        if (empty($this->question->options)){
            $start = 0;
        } else {
            $start = count($this->question->options->answers);
        }
        if ($start < self::NUM_ANS_START) {
            $start = self::NUM_ANS_START;
        }
        $options = array('answerheader' => array('expanded' => true));
        $buttontext = get_string('addmoreanswers', $plugin, self::NUM_ANS_ADD);
        $this->repeat_elements($elements, $start, $options, 'countanswers', 'addanswers', self::NUM_ANS_ADD, $buttontext);

        // feedback
        $this->add_ordering_feedback_fields();
    }

    public function data_preprocessing($question) {

        $question = parent::data_preprocessing($question);
        //$question = $this->data_preprocessing_answers($question, true);

        // feedback
        $question = $this->data_preprocessing_ordering_feedback($question);

        // answers and fractions
        $question->answer     = array();
        $question->fraction   = array();
        if (isset($question->options->answers)) {
            $i = 0;
            foreach ($question->options->answers as $answer) {
                if (trim($answer->answer)=='') {
                    continue; // skip empty answers
                }
                $question->answer[$i]   = $answer->answer;
                $question->fraction[$i] = ($i + 1);
                $i++;
            }

        }

        // selecttype
        if (isset($question->options->selecttype)) {
            $question->selecttype = $question->options->selecttype;
        } else {
            $question->selecttype = 0;
        }

        // selectcount
        if (isset($question->options->selectcount)) {
            $question->selectcount = $question->options->selectcount;
        } else {
            $question->selectcount = max(3, count($question->answer));
        }

        return $question;
    }

    public function validation($data, $files) {
        $errors = array();
        $plugin = 'qtype_ordering';

        $answercount = 0;
        foreach ($data['answer'] as $answer){
            if (trim($answer)=='') {
                continue; // skip empty answer
            }
            $answercount++;
        }

        switch ($answercount) {
            case 0: $errors['answer[0]'] = get_string('notenoughanswers', $plugin, 2);
            case 1: $errors['answer[1]'] = get_string('notenoughanswers', $plugin, 2);
        }

        return $errors;
    }


    protected function add_ordering_feedback_fields($withshownumpartscorrect = false) {
        if (method_exists($this, 'add_combined_feedback_fields')) {
            // Moodle >= 2.1
            $this->add_combined_feedback_fields($withshownumpartscorrect);
        } else {
            // Moodle 2.0
            $mform = $this->_form;
            $names = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
            foreach ($names as $name) {
                $label = get_string($name, 'qtype_multichoice'); // borrow string from standard core
                $mform->addElement('editor', $name, $label, array('rows' => 10), $this->editoroptions);
                $mform->setType($name, PARAM_RAW);
            }
        }
    }

    protected function data_preprocessing_ordering_feedback($question, $withshownumcorrect = false) {
        if (method_exists($this, 'data_preprocessing_combined_feedback')) {
            // Moodle >= 2.1
            $question = $this->data_preprocessing_combined_feedback($question, $withshownumcorrect);
        } else {
            // Moodle 2.0
            $names = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
            foreach ($names as $name) {
                $draftid = file_get_submitted_draft_itemid($name);

                if (isset($question->id)) {
                    $itemid = $question->id;
                } else {
                    $itemid = null;
                }

                if (isset($question->options->$name)) {
                    $text = $question->options->$name;
                } else {
                    $text = '';
                }

                $text = file_prepare_draft_area($draftid, $this->context->id, 'qtype_ordering',
                                                $name, $itemid, $this->fileoptions, $text);

                $format = $name.'format';
                if (isset($question->options->$format)) {
                    $format = $question->options->$format;
                } else {
                    $format = 0;
                }

                $question->$name = array('text'   => $text,
                                         'format' => $format,
                                         'itemid' => $draftid);
            }
        }
        return $question;
    }
}