Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
qtype_essay_format_plain_renderer Class Reference

An essay format renderer for essays where the student should use a plain input box, but with a normal, proportional font. More...

Inheritance diagram for qtype_essay_format_plain_renderer:
qtype_essay_format_renderer_base plugin_renderer_base renderer_base qtype_essay_format_monospaced_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.
 
 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.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 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.
 
 response_area_input ($name, $qa, $step, $lines, $context)
 
 response_area_input ($name, question_attempt $qa, question_attempt_step $step, $lines, $context)
 Render the students respone when the question is in read-only mode.
 
 response_area_read_only ($name, $qa, $step, $lines, $context)
 
 response_area_read_only ($name, question_attempt $qa, question_attempt_step $step, $lines, $context)
 Render the students respone when the question is in read-only mode.
 
 set_displayoptions (question_display_options $displayoptions)
 Question number setter.
 
 should_display_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

 class_name ()
 
 get_mustache ()
 Return an instance of the mustache class.
 
 textarea ($response, $lines, $attributes)
 

Protected Attributes

question_display_options $displayoptions
 Question display options instance for any necessary information for rendering the question.
 
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

An essay format renderer for essays where the student should use a plain input box, but with a normal, proportional font.

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

Member Function Documentation

◆ class_name()

qtype_essay_format_plain_renderer::class_name ( )
protected
Return values
stringspecific class name to add to the input element.

Reimplemented from qtype_essay_format_renderer_base.

Reimplemented in qtype_essay_format_monospaced_renderer.

◆ response_area_input()

qtype_essay_format_renderer_base::response_area_input ( $name,
question_attempt $qa,
question_attempt_step $step,
$lines,
$context )
abstractinherited

Render the students respone when the question is in read-only mode.

Parameters
string$namethe variable name this input edits.
question_attempt$qathe question attempt being display.
question_attempt_step$stepthe current step.
int$linesapproximate size of input box to display.
object$contextthe context teh output belongs to.
Return values
stringhtml to display the response for editing.

◆ response_area_read_only()

qtype_essay_format_renderer_base::response_area_read_only ( $name,
question_attempt $qa,
question_attempt_step $step,
$lines,
$context )
abstractinherited

Render the students respone when the question is in read-only mode.

Parameters
string$namethe variable name this input edits.
question_attempt$qathe question attempt being display.
question_attempt_step$stepthe current step.
int$linesapproximate size of input box to display.
object$contextthe context teh output belongs to.
Return values
stringhtml to display the response.

◆ set_displayoptions()

qtype_essay_format_renderer_base::set_displayoptions ( question_display_options $displayoptions)
inherited

Question number setter.

Parameters
question_display_options$displayoptions

◆ textarea()

qtype_essay_format_plain_renderer::textarea ( $response,
$lines,
$attributes )
protected
Return values
stringthe HTML for the textarea.

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