Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
Implements the plugin renderer. More...
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. | |
Implements the plugin renderer.
tool_task_renderer::adhoc_task_run | ( | ) |
Displays a notification on ad hoc task run request.
string | HTML notification block for task initiated message |
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.
string | $classname | |
array | $tasks | - list of all adhoc tasks. |
array | null | $params |
string | HTML to output. |
tool_task_renderer::adhoc_tasks_simple_table | ( | array | $tasks | ) |
This function will render a plain adhoc tasks table.
array | $tasks | - list of adhoc tasks. |
string | HTML to output. |
tool_task_renderer::adhoc_tasks_summary_table | ( | array | $summary | ) |
This function will render a table with the summary of all adhoc tasks.
array | $summary |
string | HTML to output. |
tool_task_renderer::component_name | ( | string | $component | ) |
Nicely display the name of a component, with its disabled status and internal name.
string | $component | component name, e.g. 'core' or 'mod_forum'. |
string | HTML. |
tool_task_renderer::cron_disabled | ( | ) |
Displays a warning on the page if cron is disabled.
string | HTML code for information about cron being disabled |
moodle_exception |
tool_task_renderer::last_run_time | ( | scheduled_task | $task | ) |
Standard display of a tasks last run time.
scheduled_task | $task |
string | HTML. |
tool_task_renderer::link_back | ( | $taskclassname = '' | ) |
Renders a link back to the scheduled tasks page (used from the 'run now' screen).
string | $taskclassname | if specified, the list of tasks will scroll to show this task. |
string | HTML code |
tool_task_renderer::next_run_time | ( | scheduled_task | $task | ) |
Standard display of a tasks next run time.
scheduled_task | $task |
string | HTML. |
tool_task_renderer::scheduled_tasks_table | ( | $tasks, | |
$lastchanged = '' ) |
This function will render one beautiful table with all the scheduled tasks.
core\task\scheduled_task[] | $tasks | - list of all scheduled tasks. |
string | $lastchanged | (optional) the last task edited. Gets highlighted in teh table. |
string | HTML to output. |
|
protected |
Get a table cell to show one time, comparing it to the default.
string | $current | the current setting. |
string | $default | the default setting from the db/tasks.php file. |
html_table_cell | for use in the table. |