Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
qbehaviour_interactive_renderer Class Reference

Interactive behaviour renderer. More...

Inheritance diagram for qbehaviour_interactive_renderer:
qbehaviour_renderer plugin_renderer_base renderer_base qbehaviour_interactivecountback_renderer

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.
 
 controls (question_attempt $qa, question_display_options $options)
 Generate some HTML (which may be blank) that appears in the question formulation area, afer the question type generated output.
 
 feedback (question_attempt $qa, question_display_options $options)
 Generate some HTML (which may be blank) that appears in the outcome area, after the question-type generated output.
 
 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.
 
 get_page ()
 Returns the moodle page object.
 
 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 questions using this model are used.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 manual_comment (question_attempt $qa, question_display_options $options)
 Display the manual comment, and a link to edit it, if appropriate.
 
 manual_comment_fields (question_attempt $qa, question_display_options $options)
 
 manual_comment_view (question_attempt $qa, question_display_options $options)
 
 mark_out_of_max (question_attempt $qa, core_question_renderer $qoutput, question_display_options $options)
 Generate the display of the marks for this question out of the available marks.
 
 mark_summary (question_attempt $qa, core_question_renderer $qoutput, question_display_options $options)
 Generate the display of the marks for this question.
 
 marked_out_of_max (question_attempt $qa, core_question_renderer $qoutput, question_display_options $options)
 Generate the display of the available marks for this question.
 
 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.
 

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

 get_mustache ()
 Return an instance of the mustache class.
 
 submit_button (question_attempt $qa, question_display_options $options)
 Several behaviours need a submit button, so put the common code here.
 

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.
 

Detailed Description

Interactive behaviour renderer.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ controls()

qbehaviour_interactive_renderer::controls ( question_attempt $qa,
question_display_options $options )

Generate some HTML (which may be blank) that appears in the question formulation area, afer the question type generated output.

For example. immediatefeedback and interactive mode use this to show the Submit button, and CBM use this to display the certainty choices.

Parameters
question_attempt$qaa question attempt.
question_display_options$optionscontrols what should and should not be displayed.
Return values
stringHTML fragment.

Reimplemented from qbehaviour_renderer.

◆ feedback()

qbehaviour_interactive_renderer::feedback ( question_attempt $qa,
question_display_options $options )

Generate some HTML (which may be blank) that appears in the outcome area, after the question-type generated output.

For example, the CBM models use this to display an explanation of the score adjustment that was made based on the certainty selected.

Parameters
question_attempt$qaa question attempt.
question_display_options$optionscontrols what should and should not be displayed.
Return values
stringHTML fragment.

Reimplemented from qbehaviour_renderer.

◆ head_code()

qbehaviour_renderer::head_code ( question_attempt $qa)
inherited

Return any HTML that needs to be included in the page's <head> when questions using this model are used.

Parameters
$qathe question attempt that will be displayed on the page.
Return values
stringHTML fragment.

◆ manual_comment()

qbehaviour_renderer::manual_comment ( question_attempt $qa,
question_display_options $options )
inherited

Display the manual comment, and a link to edit it, if appropriate.

Parameters
question_attempt$qaa question attempt.
question_display_options$optionscontrols what should and should not be displayed.
Return values
stringHTML fragment.

◆ mark_out_of_max()

qbehaviour_renderer::mark_out_of_max ( question_attempt $qa,
core_question_renderer $qoutput,
question_display_options $options )
inherited

Generate the display of the marks for this question out of the available marks.

Parameters
question_attempt$qathe question attempt to display.
core_question_renderer$qoutputthe renderer for standard parts of questions.
question_display_options$optionscontrols what should and should not be displayed.
Return values
HTMLfragment.

Reimplemented in qbehaviour_deferredcbm_renderer.

◆ mark_summary()

qbehaviour_renderer::mark_summary ( question_attempt $qa,
core_question_renderer $qoutput,
question_display_options $options )
inherited

Generate the display of the marks for this question.

Parameters
question_attempt$qathe question attempt to display.
core_question_renderer$qoutputthe renderer for standard parts of questions.
question_display_options$optionscontrols what should and should not be displayed.
Return values
HTMLfragment.

◆ marked_out_of_max()

qbehaviour_renderer::marked_out_of_max ( question_attempt $qa,
core_question_renderer $qoutput,
question_display_options $options )
inherited

Generate the display of the available marks for this question.

Parameters
question_attempt$qathe question attempt to display.
core_question_renderer$qoutputthe renderer for standard parts of questions.
question_display_options$optionscontrols what should and should not be displayed.
Return values
HTMLfragment.

Reimplemented in qbehaviour_deferredcbm_renderer.

◆ submit_button()

qbehaviour_renderer::submit_button ( question_attempt $qa,
question_display_options $options )
protectedinherited

Several behaviours need a submit button, so put the common code here.

The button is disabled if the question is displayed read-only.

Parameters
question_display_options$optionscontrols what should and should not be displayed.
Return values
stringHTML fragment.

The documentation for this class was generated from the following file: