Implements the plugin renderer. More...

Inheritance diagram for tool_task_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.

	adhoc_task_run ()
	Displays a notification on ad hoc task run request.

	adhoc_tasks_class_table (string $classname, array $tasks, ?array $params=[])
	This function will render a table with all the adhoc tasks for the class.

	adhoc_tasks_simple_table (array $tasks)
	This function will render a plain adhoc tasks table.

	adhoc_tasks_summary_table (array $summary)
	This function will render a table with the summary of all adhoc tasks.

	component_name (string $component)
	Nicely display the name of a component, with its disabled status and internal name.

	cron_disabled ()
	Displays a warning on the page if cron is disabled.

	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.

	last_run_time (scheduled_task $task)
	Standard display of a tasks last run time.

	link_back ($taskclassname='')
	Renders a link back to the scheduled tasks page (used from the 'run now' screen).

	next_run_time (scheduled_task $task)
	Standard display of a tasks next run time.

	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.

	scheduled_tasks_table ($tasks, $lastchanged='')
	This function will render one beautiful table with all the scheduled tasks.

	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.

	time_cell (string $current, string $default)
	Get a table cell to show one time, comparing it to the default.

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

Implements the plugin renderer.

Copyright: 2014 Damyon Wiese

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

string id of element, either original submitted or random new if not supplied

◆ adhoc_task_run()

tool_task_renderer::adhoc_task_run ( )

Displays a notification on ad hoc task run request.

Return values

string HTML notification block for task initiated message

◆ adhoc_tasks_class_table()

tool_task_renderer::adhoc_tasks_class_table	(	string	$classname,
		array	$tasks,
		?array	$params = [] )

This function will render a table with all the adhoc tasks for the class.

Parameters

string	$classname
array	$tasks	- list of all adhoc tasks.
array \| null	$params

Return values

string HTML to output.

◆ adhoc_tasks_simple_table()

tool_task_renderer::adhoc_tasks_simple_table ( array $tasks )

This function will render a plain adhoc tasks table.

Parameters

array $tasks - list of adhoc tasks.

Return values

string HTML to output.

◆ adhoc_tasks_summary_table()

tool_task_renderer::adhoc_tasks_summary_table ( array $summary )

This function will render a table with the summary of all adhoc tasks.

Parameters

array $summary

Return values

string HTML to output.

◆ component_name()

tool_task_renderer::component_name ( string $component )

Nicely display the name of a component, with its disabled status and internal name.

Parameters

string $component component name, e.g. 'core' or 'mod_forum'.

Return values

string HTML.

◆ cron_disabled()

tool_task_renderer::cron_disabled ( )

Displays a warning on the page if cron is disabled.

Return values

string HTML code for information about cron being disabled

Exceptions

moodle_exception

◆ 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	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The 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	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The 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

boolean true 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	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ last_run_time()

tool_task_renderer::last_run_time ( scheduled_task $task )

Standard display of a tasks last run time.

Parameters

scheduled_task $task

Return values

string HTML.

◆ link_back()

tool_task_renderer::link_back ( $taskclassname = '' )

Renders a link back to the scheduled tasks page (used from the 'run now' screen).

Parameters

string $taskclassname if specified, the list of tasks will scroll to show this task.

Return values

string HTML code

◆ next_run_time()

tool_task_renderer::next_run_time ( scheduled_task $task )

Standard display of a tasks next run time.

Parameters

scheduled_task $task

Return values

string HTML.

◆ 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	$imagename	the name of the icon.
string	$component	specification 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 $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

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

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

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

◆ 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 $context Context containing data for the template.

Return values

string|boolean

◆ scheduled_tasks_table()

tool_task_renderer::scheduled_tasks_table	(		$tasks,
			$lastchanged = '' )

This function will render one beautiful table with all the scheduled tasks.

Parameters

core\task\scheduled_task[]	$tasks	- list of all scheduled tasks.
string	$lastchanged	(optional) the last task edited. Gets highlighted in teh table.

Return values

string HTML to output.

◆ 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 $headinglevel The 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

◆ time_cell()

tool_task_renderer::time_cell	(	string	$current,
		string	$default )

protected

Get a table cell to show one time, comparing it to the default.

Parameters

string	$current	the current setting.
string	$default	the default setting from the db/tasks.php file.

Return values

html_table_cell for use in the table.

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:

admin/tool/task/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ adhoc_task_run()

◆ adhoc_tasks_class_table()

◆ adhoc_tasks_simple_table()

◆ adhoc_tasks_summary_table()

◆ component_name()

◆ cron_disabled()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ has_started()

◆ image_url()

◆ last_run_time()

◆ link_back()

◆ next_run_time()

◆ pix_url()

◆ prepare_classes()

◆ render()

◆ render_from_template()

◆ scheduled_tasks_table()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ time_cell()

Member Data Documentation

◆ $output