Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
mod_choice_renderer Class Reference
Inheritance diagram for mod_choice_renderer:
plugin_renderer_base renderer_base

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.
 
 display_options ($options, $coursemoduleid, $vertical=false, $multiple=false)
 Returns HTML to display choices of option.
 
 display_publish_anonymous ($choices, $displaylayout)
 Generate the choice result chart.
 
 display_publish_anonymous_horizontal ($choices)
 Returns HTML to display choices result.
 
 display_publish_anonymous_vertical ($choices)
 Returns HTML to display choices result.
 
 display_publish_name_vertical ($choices)
 Returns HTML to display choices result.
 
 display_result ($choices, $forcepublish=false)
 Returns HTML to display choices result.
 
 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.
 
 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.
 

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.
 

Member Function Documentation

◆ display_options()

mod_choice_renderer::display_options ( $options,
$coursemoduleid,
$vertical = false,
$multiple = false )

Returns HTML to display choices of option.

Parameters
object$options
int$coursemoduleid
bool$vertical
Return values
string

◆ display_publish_anonymous()

mod_choice_renderer::display_publish_anonymous ( $choices,
$displaylayout )

Generate the choice result chart.

Can be displayed either in the vertical or horizontal position.

Parameters
stdClass$choicesChoices responses object.
int$displaylayoutThe constants CHOICE_DISPLAY_HORIZONTAL or CHOICE_DISPLAY_VERTICAL.
Return values
stringthe rendered chart.

◆ display_publish_anonymous_horizontal()

mod_choice_renderer::display_publish_anonymous_horizontal ( $choices)

Returns HTML to display choices result.

Deprecated
since 3.2
Parameters
object$choices
Return values
string

◆ display_publish_anonymous_vertical()

mod_choice_renderer::display_publish_anonymous_vertical ( $choices)

Returns HTML to display choices result.

Deprecated
since 3.2
Parameters
object$choices
Return values
string

◆ display_publish_name_vertical()

mod_choice_renderer::display_publish_name_vertical ( $choices)

Returns HTML to display choices result.

Parameters
object$choices
Return values
string

◆ display_result()

mod_choice_renderer::display_result ( $choices,
$forcepublish = false )

Returns HTML to display choices result.

Parameters
object$choices
bool$forcepublish
Return values
string

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