Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is 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 essay question type.
 *
 * @package    qtype
 * @subpackage essay
 * @copyright  2005 Mark Nielsen
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


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

require_once($CFG->libdir . '/questionlib.php');


/**
 * The essay question type.
 *
 * @copyright  2005 Mark Nielsen
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class qtype_essay extends question_type {
    public function is_manual_graded() {
        return true;
    }

    public function response_file_areas() {
        return array('attachments', 'answer');
    }

    public function get_question_options($question) {
        global $DB;
        $question->options = $DB->get_record('qtype_essay_options',
                array('questionid' => $question->id), '*', MUST_EXIST);
        parent::get_question_options($question);
    }

> 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; > $this->set_default_value('responseformat', $fromform->responseformat); $context = $formdata->context; > $this->set_default_value('responserequired', $fromform->responserequired); > $this->set_default_value('responsefieldlines', $fromform->responsefieldlines); $options = $DB->get_record('qtype_essay_options', array('questionid' => $formdata->id)); > $this->set_default_value('attachments', $fromform->attachments); if (!$options) { > $this->set_default_value('attachmentsrequired', $fromform->attachmentsrequired); $options = new stdClass(); > $this->set_default_value('maxbytes', $fromform->maxbytes); $options->questionid = $formdata->id; > } $options->id = $DB->insert_record('qtype_essay_options', $options); >
} $options->responseformat = $formdata->responseformat; $options->responserequired = $formdata->responserequired; $options->responsefieldlines = $formdata->responsefieldlines;
> $options->minwordlimit = isset($formdata->minwordenabled) ? $formdata->minwordlimit : null; $options->attachments = $formdata->attachments; > $options->maxwordlimit = isset($formdata->maxwordenabled) ? $formdata->maxwordlimit : null;
$options->attachmentsrequired = $formdata->attachmentsrequired;
> if ((int)$formdata->attachments === 0 && $formdata->attachmentsrequired > 0) { if (!isset($formdata->filetypeslist)) { > // Adjust the value for the field 'attachmentsrequired' when the field 'attachments' is set to 'No'. $options->filetypeslist = null; > $options->attachmentsrequired = 0; } else { > } else {
$options->filetypeslist = $formdata->filetypeslist;
> }
}
> $options->maxbytes = $formdata->maxbytes ?? 0;
$options->graderinfo = $this->import_or_save_files($formdata->graderinfo, $context, 'qtype_essay', 'graderinfo', $formdata->id); $options->graderinfoformat = $formdata->graderinfo['format']; $options->responsetemplate = $formdata->responsetemplate['text']; $options->responsetemplateformat = $formdata->responsetemplate['format']; $DB->update_record('qtype_essay_options', $options); } protected function initialise_question_instance(question_definition $question, $questiondata) { parent::initialise_question_instance($question, $questiondata); $question->responseformat = $questiondata->options->responseformat; $question->responserequired = $questiondata->options->responserequired; $question->responsefieldlines = $questiondata->options->responsefieldlines;
> $question->minwordlimit = $questiondata->options->minwordlimit; $question->attachments = $questiondata->options->attachments; > $question->maxwordlimit = $questiondata->options->maxwordlimit;
$question->attachmentsrequired = $questiondata->options->attachmentsrequired; $question->graderinfo = $questiondata->options->graderinfo; $question->graderinfoformat = $questiondata->options->graderinfoformat; $question->responsetemplate = $questiondata->options->responsetemplate; $question->responsetemplateformat = $questiondata->options->responsetemplateformat; $filetypesutil = new \core_form\filetypes_util(); $question->filetypeslist = $filetypesutil->normalize_file_types($questiondata->options->filetypeslist);
> $question->maxbytes = $questiondata->options->maxbytes;
} public function delete_question($questionid, $contextid) { global $DB; $DB->delete_records('qtype_essay_options', array('questionid' => $questionid)); parent::delete_question($questionid, $contextid); } /** * @return array the different response formats that the question type supports. * internal name => human-readable name. */ public function response_formats() { return array( 'editor' => get_string('formateditor', 'qtype_essay'), 'editorfilepicker' => get_string('formateditorfilepicker', 'qtype_essay'), 'plain' => get_string('formatplain', 'qtype_essay'), 'monospaced' => get_string('formatmonospaced', 'qtype_essay'), 'noinline' => get_string('formatnoinline', 'qtype_essay'), ); } /** * @return array the choices that should be offerd when asking if a response is required */ public function response_required_options() { return array( 1 => get_string('responseisrequired', 'qtype_essay'), 0 => get_string('responsenotrequired', 'qtype_essay'), ); } /** * @return array the choices that should be offered for the input box size. */ public function response_sizes() {
< $choices = array();
> $choices = [ > 2 => get_string('nlines', 'qtype_essay', 2), > 3 => get_string('nlines', 'qtype_essay', 3), > ];
for ($lines = 5; $lines <= 40; $lines += 5) { $choices[$lines] = get_string('nlines', 'qtype_essay', $lines); } return $choices; } /** * @return array the choices that should be offered for the number of attachments. */ public function attachment_options() { return array( 0 => get_string('no'), 1 => '1', 2 => '2', 3 => '3', -1 => get_string('unlimited'), ); } /** * @return array the choices that should be offered for the number of required attachments. */ public function attachments_required_options() { return array( 0 => get_string('attachmentsoptional', 'qtype_essay'), 1 => '1', 2 => '2', 3 => '3' );
> } } > > /** public function move_files($questionid, $oldcontextid, $newcontextid) { > * Return array of the choices that should be offered for the maximum file sizes. parent::move_files($questionid, $oldcontextid, $newcontextid); > * @return array|lang_string[]|string[] $fs = get_file_storage(); > */ $fs->move_area_files_to_new_context($oldcontextid, > public function max_file_size_options() { $newcontextid, 'qtype_essay', 'graderinfo', $questionid); > global $CFG, $COURSE; } > return get_max_upload_sizes($CFG->maxbytes, $COURSE->maxbytes);
protected function delete_files($questionid, $contextid) { parent::delete_files($questionid, $contextid); $fs = get_file_storage(); $fs->delete_area_files($contextid, 'qtype_essay', 'graderinfo', $questionid); } }