Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250711) (9addea9f0ac)
qbehaviour_renderer Class Reference

Renderer base class for question behaviours. More...

Inheritance diagram for qbehaviour_renderer:
qbehaviour_adaptive_renderer qbehaviour_deferredcbm_renderer qbehaviour_deferredfeedback_renderer qbehaviour_immediatefeedback_renderer qbehaviour_informationitem_renderer qbehaviour_interactive_renderer qbehaviour_manualgraded_renderer qbehaviour_missing_renderer

Public Member Functions

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

Protected Member Functions

 submit_button (question_attempt $qa, question_display_options $options)
 Several behaviours need a submit button, so put the common code here.
 

Detailed Description

Renderer base class for question behaviours.

The methods in this class are mostly called from core_question_renderer which coordinates the overall output of questions.

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

Member Function Documentation

◆ controls()

qbehaviour_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 in qbehaviour_adaptive_renderer, qbehaviour_deferredcbm_renderer, qbehaviour_immediatecbm_renderer, qbehaviour_immediatefeedback_renderer, qbehaviour_informationitem_renderer, qbehaviour_interactive_renderer, and qbehaviour_missing_renderer.

◆ feedback()

qbehaviour_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 in qbehaviour_adaptive_renderer, qbehaviour_deferredcbm_renderer, and qbehaviour_interactive_renderer.

◆ head_code()

qbehaviour_renderer::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.

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 )

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 )

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 )

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 )

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 )
protected

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: