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.
/question/type/essay/ -> question.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

Essay question definition class.

Copyright: 2009 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 320 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

qtype_essay_question:: (14 methods):
  make_behaviour()
  get_format_renderer()
  get_expected_data()
  summarise_response()
  un_summarise_response()
  get_correct_response()
  is_complete_response()
  get_validation_error()
  is_gradable_response()
  is_same_response()
  check_file_access()
  get_question_definition_for_external_rendering()
  check_input_word_count()
  get_word_count_message_for_review()


Class: qtype_essay_question  - X-Ref

Represents an essay question.

make_behaviour(question_attempt $qa, $preferredbehaviour)   X-Ref
No description

get_format_renderer(moodle_page $page)   X-Ref

param: moodle_page the page we are outputting to.
return: qtype_essay_format_renderer_base the response-format-specific renderer.

get_expected_data()   X-Ref
No description

summarise_response(array $response)   X-Ref
No description

un_summarise_response(string $summary)   X-Ref
No description

get_correct_response()   X-Ref
No description

is_complete_response(array $response)   X-Ref
No description

get_validation_error(array $response)   X-Ref
Return null if is_complete_response() returns true
otherwise, return the minmax-limit error message

param: array $response
return: string

is_gradable_response(array $response)   X-Ref
No description

is_same_response(array $prevresponse, array $newresponse)   X-Ref
No description

check_file_access($qa, $options, $component, $filearea, $args, $forcedownload)   X-Ref
No description

get_question_definition_for_external_rendering(question_attempt $qa, question_display_options $options)   X-Ref
Return the question settings that define this question as structured data.

param: question_attempt $qa the current attempt for which we are exporting the settings.
param: question_display_options $options the question display options which say which aspects of the question
return: mixed structure representing the question settings. In web services, this will be JSON-encoded.

check_input_word_count($responsestring)   X-Ref
Check the input word count and return a message to user
when the number of words are outside the boundary settings.

param: string $responsestring
return: string|null

get_word_count_message_for_review(array $response)   X-Ref
If this question uses word counts, then return a display of the current
count, and whether it is within limit, for when the question is being reviewed.

param: array $response responses, as returned by
return: string If relevant to this question, a display of the word count.