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

Renderer for behat tool web features. More...

Inheritance diagram for tool_behat_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.
 
 generic_info ()
 Generic info about the tool.
 
 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_error ($msg)
 Renders an error message adding the generic info about the tool purpose and setup.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_stepsdefinitions ($stepsdefinitions, $form)
 Renders the list of available steps according to the submitted filters.
 
 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

 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.
 

Detailed Description

Renderer for behat tool web features.

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

Member Function Documentation

◆ generic_info()

tool_behat_renderer::generic_info ( )

Generic info about the tool.

Return values
string

◆ render_error()

tool_behat_renderer::render_error ( $msg)

Renders an error message adding the generic info about the tool purpose and setup.

Parameters
string$msgThe error message
Return values
stringHTML

◆ render_stepsdefinitions()

tool_behat_renderer::render_stepsdefinitions ( $stepsdefinitions,
$form )

Renders the list of available steps according to the submitted filters.

Parameters
mixed$stepsdefinitionsAvailable steps array.
moodleform$form
Return values
stringHTML code

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