Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
tool_task_renderer Class Reference

Implements the plugin renderer. More...

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

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

Member Function Documentation

◆ adhoc_task_run()

tool_task_renderer::adhoc_task_run ( )

Displays a notification on ad hoc task run request.

Return values
stringHTML 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
stringHTML 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
stringHTML 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
stringHTML 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$componentcomponent name, e.g. 'core' or 'mod_forum'.
Return values
stringHTML.

◆ cron_disabled()

tool_task_renderer::cron_disabled ( )

Displays a warning on the page if cron is disabled.

Return values
stringHTML code for information about cron being disabled
Exceptions
moodle_exception

◆ 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
stringHTML.

◆ 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$taskclassnameif specified, the list of tasks will scroll to show this task.
Return values
stringHTML 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
stringHTML.

◆ 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
stringHTML to output.

◆ 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$currentthe current setting.
string$defaultthe default setting from the db/tasks.php file.
Return values
html_table_cellfor use in the table.

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