Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Generates the output for simple calculated questions. More...
Public Member Functions | |
__call ($method, $arguments) | |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief. | |
add_action_handler (component_action $action, $id=null) | |
Adds a JS action for the element with the provided id. | |
clear_wrong (question_attempt $qa) | |
Output hidden form fields to clear any wrong parts of the student's response. | |
correct_response (question_attempt $qa) | |
Gereate an automatic description of the correct response to this question. | |
feedback (question_attempt $qa, question_display_options $options) | |
Generate the display of the outcome part of the question. | |
formulation_and_controls (question_attempt $qa, question_display_options $options) | |
Generate the display of the formulation part of the question. | |
formulation_heading () | |
In the question output there are some class="accesshide" headers to help screen-readers. | |
get_compact_logo_url ($maxwidth=300, $maxheight=300) | |
Return the site's compact logo URL, if any. | |
get_logo_url ($maxwidth=null, $maxheight=200) | |
Return the site's logo URL, if any. | |
has_started () | |
Returns true is output has already started, and false if not. | |
head_code (question_attempt $qa) | |
Return any HTML that needs to be included in the page's <head> when this question is used. | |
image_url ($imagename, $component='moodle') | |
Return the moodle_url for an image. | |
manual_comment (question_attempt $qa, question_display_options $options) | |
Display any extra question-type specific content that should be visible when grading, if appropriate. | |
pix_url ($imagename, $component='moodle') | |
Return the direct URL for an image from the pix folder. | |
render (renderable $widget) | |
Renders the provided widget and returns the HTML to display it. | |
render_from_template ($templatename, $context) | |
Renders a template by name with the given context. | |
should_display_main_logo ($headinglevel=1) | |
Whether we should display the main logo. | |
should_display_navbar_logo () | |
Whether we should display the logo in the navbar. | |
specific_feedback (question_attempt $qa) | |
Generate the specific feedback. | |
Static Public Member Functions | |
static | prepare_classes ($classes) |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value. | |
Protected Member Functions | |
feedback_class ($fraction) | |
feedback_image ($fraction, $selected=true) | |
Return an appropriate icon (green tick, red cross, etc.) for a grade. | |
general_feedback (question_attempt $qa) | |
Gereate the general feedback. | |
get_mustache () | |
Return an instance of the mustache class. | |
hint (question_attempt $qa, question_hint $hint) | |
Gereate the specific feedback. | |
num_parts_correct (question_attempt $qa) | |
Gereate a brief statement of how many sub-parts of this question the student got right. | |
Protected Attributes | |
xhtml_container_stack | $opencontainers |
The xhtml_container_stack to use. | |
renderer_base core_renderer | $output |
A reference to the current renderer. | |
moodle_page | $page |
The Moodle page the renderer has been created to assist with. | |
string | $target |
The requested rendering target. | |
array | $templatecache = [] |
$templatecache The mustache template cache. | |
Generates the output for simple calculated questions.
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
string | $method | |
array | $arguments |
mixed |
|
inherited |
Adds a JS action for the element with the provided id.
This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()
component_action | $action | |
string | $id |
string | id of element, either original submitted or random new if not supplied |
|
inherited |
Output hidden form fields to clear any wrong parts of the student's response.
This method will only be called if the question is in read-only mode.
question_attempt | $qa | the question attempt to display. |
string | HTML fragment. |
Reimplemented in qtype_ddtoimage_renderer_base.
|
inherited |
Gereate an automatic description of the correct response to this question.
Not all question types can do this. If it is not possible, this method should just return an empty string.
question_attempt | $qa | the question attempt to display. |
string | HTML fragment. |
Reimplemented from qtype_numerical_renderer.
|
inherited |
Generate the display of the outcome part of the question.
This is the area that contains the various forms of feedback. This function generates the content of this area belonging to the question type.
Subclasses will normally want to override the more specific methods {specific_feedback()}, {general_feedback()} and {correct_response()} that this method calls.
question_attempt | $qa | the question attempt to display. |
question_display_options | $options | controls what should and should not be displayed. |
string | HTML fragment. |
|
protectedinherited |
Return an appropriate icon (green tick, red cross, etc.) for a grade.
float | $fraction | grade on a scale 0..1. |
bool | $selected | whether to show a big or small icon. (Deprecated) |
string | html fragment. |
|
inherited |
Generate the display of the formulation part of the question.
This is the area that contains the quetsion text, and the controls for students to input their answers. Some question types also embed bits of feedback, for example ticks and crosses, in this area.
question_attempt | $qa | the question attempt to display. |
question_display_options | $options | controls what should and should not be displayed. |
string | HTML fragment. |
Reimplemented from qtype_renderer.
|
inherited |
In the question output there are some class="accesshide" headers to help screen-readers.
This method returns the text to use for the heading above the formulation_and_controls section.
string | to use as the heading. |
Reimplemented in qtype_description_renderer.
|
protectedinherited |
Gereate the general feedback.
This is feedback is shown ot all students.
question_attempt | $qa | the question attempt to display. |
string | HTML fragment. |
|
inherited |
Return the site's compact logo URL, if any.
int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
int | $maxheight | The maximum height, or null when the maximum height does not matter. |
moodle_url|false |
|
inherited |
Return the site's logo URL, if any.
int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
int | $maxheight | The maximum height, or null when the maximum height does not matter. |
moodle_url|false |
|
protectedinherited |
|
inherited |
Returns true is output has already started, and false if not.
boolean | true if the header has been printed. |
|
inherited |
Return any HTML that needs to be included in the page's <head> when this question is used.
$qa | the question attempt that will be displayed on the page. |
string | HTML fragment. |
|
protectedinherited |
Gereate the specific feedback.
This is feedback that varies according to the response the student gave.
question_attempt | $qa | the question attempt to display. |
string | HTML fragment. |
Reimplemented in qtype_ddmarker_renderer.
|
inherited |
Return the moodle_url for an image.
The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.
There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')
string | $imagename | the pathname of the image |
string | $component | full plugin name (aka component) or 'theme' |
moodle_url |
|
inherited |
Display any extra question-type specific content that should be visible when grading, if appropriate.
question_attempt | $qa | a question attempt. |
question_display_options | $options | controls what should and should not be displayed. |
string | HTML fragment. |
Reimplemented in qtype_essay_renderer.
|
protectedinherited |
Gereate a brief statement of how many sub-parts of this question the student got right.
question_attempt | $qa | the question attempt to display. |
string | HTML fragment. |
Reimplemented in qtype_multichoice_multi_renderer.
|
inherited |
Return the direct URL for an image from the pix folder.
Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
string | $imagename | the name of the icon. |
string | $component | specification of one plugin like in get_string() |
moodle_url |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
mixed | $classes | Space-separated string or array of classes |
string | HTML class attribute value |
|
inherited |
Renders the provided widget and returns the HTML to display it.
renderable | $widget | instance with renderable interface |
string |
Reimplemented from renderer_base.
Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.
|
inherited |
Renders a template by name with the given context.
The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string
array | stdClass | $context | Context containing data for the template. |
string|boolean |
|
inherited |
Whether we should display the main logo.
int | $headinglevel | The heading level we want to check against. |
bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
bool |
|
inherited |
Generate the specific feedback.
This is feedback that varies according to the response the student gave.
question_attempt | $qa | the question attempt to display. |
string | HTML fragment. |
Reimplemented from qtype_renderer.
|
protectedinherited |
A reference to the current renderer.
The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer