Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_question_bank_renderer Class Reference

This renderer outputs parts of the question bank. More...

Inheritance diagram for core_question_bank_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.
 
 extra_horizontal_navigation ($active=null)
 Display additional navigation if needed.
 
 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.
 
 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.
 
 qbank_chooser ($real, $fake, $course, $hiddenparams)
 Build the HTML for the question chooser javascript popup.
 
 qtype_icon ($qtype)
 Output the icon for a question type.
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it.
 
 render_bulk_actions_ui ($displaydata)
 Render bulk actions ui.
 
 render_category_condition ($displaydata)
 Render category condition.
 
 render_category_condition_advanced ($displaydata)
 Render category condition advanced.
 
 render_column_header ($qbankheaderdata)
 Render the column headers.
 
 render_column_sort ($sortdata)
 Render the column sort elements.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_hidden_condition_advanced ($displaydata)
 Render hidden condition advanced.
 
 render_qbank_chooser (renderable $qbankchooser)
 Render a qbank_chooser.
 
 render_question_pagination ($displaydata)
 Render question pagination.
 
 render_showtext_checkbox ($displaydata)
 Render the showtext option.
 
 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.
 
 qbank_chooser_qtype ($qtype, $classes=array())
 Return the HTML for the specified question type, adding any required classes.
 
 qbank_chooser_title ($title, $identifier=null)
 Return the title for the question bank chooser.
 
 qbank_chooser_types ($types)
 Build the HTML for a specified set of question types.
 

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

This renderer outputs parts of the question bank.

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

Member Function Documentation

◆ __call()

plugin_renderer_base::__call ( $method,
$arguments )
inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters
string$method
array$arguments
Return values
mixed

◆ add_action_handler()

renderer_base::add_action_handler ( component_action $action,
$id = null )
inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters
component_action$action
string$id
Return values
stringid of element, either original submitted or random new if not supplied

◆ extra_horizontal_navigation()

core_question_bank_renderer::extra_horizontal_navigation ( $active = null)

Display additional navigation if needed.

Parameters
string$active
Return values
string

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url ( $maxwidth = 300,
$maxheight = 300 )
inherited

Return the site's compact logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url ( $maxwidth = null,
$maxheight = 200 )
inherited

Return the site's logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )
protectedinherited

Return an instance of the mustache class.

Since
2.9
Return values
Mustache_Engine

◆ has_started()

renderer_base::has_started ( )
inherited

Returns true is output has already started, and false if not.

Return values
booleantrue if the header has been printed.

◆ image_url()

renderer_base::image_url ( $imagename,
$component = 'moodle' )
inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters
string$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ pix_url()

renderer_base::pix_url ( $imagename,
$component = 'moodle' )
inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated
since Moodle 3.3
Parameters
string$imagenamethe name of the icon.
string$componentspecification of one plugin like in get_string()
Return values
moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes)
staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters
mixed$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ qbank_chooser()

core_question_bank_renderer::qbank_chooser ( $real,
$fake,
$course,
$hiddenparams )

Build the HTML for the question chooser javascript popup.

Parameters
array$realA set of real question types
array$fakeA set of fake question types
object$courseThe course that will be displayed
array$hiddenparamsAny hidden parameters to add to the form
Return values
stringThe composed HTML for the questionbank chooser
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ qbank_chooser_qtype()

core_question_bank_renderer::qbank_chooser_qtype ( $qtype,
$classes = array() )
protected

Return the HTML for the specified question type, adding any required classes.

Parameters
object$qtypeAn object containing the title, and link. An icon, and help text may optionally be specified. If the module contains subtypes in the types option, then these will also be displayed.
array$classesAdditional classes to add to the encompassing div element
Return values
stringThe composed HTML for the question type
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ qbank_chooser_title()

core_question_bank_renderer::qbank_chooser_title ( $title,
$identifier = null )
protected

Return the title for the question bank chooser.

Parameters
string$titleThe language string identifier
string$identifierThe component identifier
Return values
stringThe composed HTML for the title
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ qbank_chooser_types()

core_question_bank_renderer::qbank_chooser_types ( $types)
protected

Build the HTML for a specified set of question types.

Parameters
array$typesA set of question types as used by the qbank_chooser_module function
Return values
stringThe composed HTML for the module
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ qtype_icon()

core_question_bank_renderer::qtype_icon ( $qtype)

Output the icon for a question type.

Parameters
string$qtypethe question type.
Return values
stringHTML fragment.

◆ render()

plugin_renderer_base::render ( renderable $widget)
inherited

Renders the provided widget and returns the HTML to display it.

Parameters
renderable$widgetinstance with renderable interface
Return values
string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_bulk_actions_ui()

core_question_bank_renderer::render_bulk_actions_ui ( $displaydata)

Render bulk actions ui.

Parameters
array$displaydata
Return values
bool|string

◆ render_category_condition()

core_question_bank_renderer::render_category_condition ( $displaydata)

Render category condition.

Parameters
array$displaydata
Return values
bool|string

◆ render_category_condition_advanced()

core_question_bank_renderer::render_category_condition_advanced ( $displaydata)

Render category condition advanced.

Parameters
array$displaydata
Return values
bool|string

◆ render_column_header()

core_question_bank_renderer::render_column_header ( $qbankheaderdata)

Render the column headers.

Parameters
array$qbankheaderdata
Return values
bool|string

◆ render_column_sort()

core_question_bank_renderer::render_column_sort ( $sortdata)

Render the column sort elements.

Parameters
array$sortdata
Return values
bool|string

◆ render_from_template()

renderer_base::render_from_template ( $templatename,
$context )
inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since
2.9
Parameters
array | stdClass$contextContext containing data for the template.
Return values
string|boolean

◆ render_hidden_condition_advanced()

core_question_bank_renderer::render_hidden_condition_advanced ( $displaydata)

Render hidden condition advanced.

Parameters
array$displaydata
Return values
bool|string

◆ render_qbank_chooser()

core_question_bank_renderer::render_qbank_chooser ( renderable $qbankchooser)

Render a qbank_chooser.

Parameters
renderable$qbankchooserThe chooser.
Return values
string
Deprecated
since Moodle 4.0
See also
qbank_editquestion\output\renderer
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ render_question_pagination()

core_question_bank_renderer::render_question_pagination ( $displaydata)

Render question pagination.

Parameters
array$displaydata
Return values
bool|string

◆ render_showtext_checkbox()

core_question_bank_renderer::render_showtext_checkbox ( $displaydata)

Render the showtext option.

It's not a checkbox any more! [Name your API after the purpose, not the implementation!]

Parameters
array$displaydata
Return values
string

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1)
inherited

Whether we should display the main logo.

Deprecated
since Moodle 4.0
Todo
final deprecation. To be removed in Moodle 4.4 MDL-73165.
Parameters
int$headinglevelThe heading level we want to check against.
Return values
bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )
inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values
bool

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output
protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer


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