Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
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. | |
analysisalert (int $courseid) | |
This function assumes that 'scheduler\is_analysed' has already failed. | |
analysisbutton (int $courseid) | |
Render the analysis request button. | |
cachealert () | |
Render the cache alert message. | |
display (\stdClass $data, filter $filter) | |
Render the page containing the Printable report. | |
get_compact_logo_url ($maxwidth=300, $maxheight=300) | |
Return the site's compact logo URL, if any. | |
get_errors_table (\stdClass $data) | |
Gets the Top Errors table. | |
get_group_table (\stdClass $data) | |
Gets the Check Errors table. | |
get_inaccessible_table (\stdClass $data) | |
Gets the Failed Activities table. | |
get_logo_url ($maxwidth=null, $maxheight=200) | |
Return the site's logo URL, if any. | |
get_ratio_table (\stdClass $data) | |
Gets the Activity Pass Ratio table. | |
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. | |
notvalidatedalert () | |
Render the "not validated" alert message. | |
pdf_renderer (\stdClass $data, filter $filter) | |
Renders the accessability report using the pdflib. | |
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. | |
render_table (array $headers, array $data, string $title, array $widths) | |
Builds the HTML for a styled table used in the pdf report. | |
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. | |
tabs (filter $filter, array $tools) | |
Render the valid tabs. | |
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. | |
render_tabtree (tabtree $tabtree) | |
Renders tabtree. | |
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. | |
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
string | $method | |
array | $arguments |
mixed |
|
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()
component_action | $action | |
string | $id |
string | id of element, either original submitted or random new if not supplied |
|
inherited |
This function assumes that 'scheduler\is_analysed' has already failed.
int | $courseid |
string |
coding_exception | |
moodle_exception |
|
inherited |
Render the analysis request button.
int | $courseid |
string |
coding_exception | |
moodle_exception |
|
inherited |
tool_brickfield\output\printable\renderer::display | ( | \stdClass | $data, |
filter | $filter ) |
Render the page containing the Printable report.
stdClass | $data | Report data. |
filter | $filter | Display filters. |
String | HTML showing charts. |
coding_exception | |
dml_exception | |
moodle_exception |
Reimplemented from tool_brickfield\output\renderer.
|
inherited |
Return the site's compact logo URL, if any.
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. |
moodle_url|false |
tool_brickfield\output\printable\renderer::get_errors_table | ( | \stdClass | $data | ) |
Gets the Top Errors table.
stdClass | $data | Report data. |
string | The HTML code of the table. |
tool_brickfield\output\printable\renderer::get_group_table | ( | \stdClass | $data | ) |
Gets the Check Errors table.
stdClass | $data | Report data. |
string | The HTML code of the table. |
tool_brickfield\output\printable\renderer::get_inaccessible_table | ( | \stdClass | $data | ) |
Gets the Failed Activities table.
stdClass | $data | Report data. |
string | The HTML code of the table. |
|
inherited |
Return the site's logo URL, if any.
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. |
moodle_url|false |
|
protectedinherited |
tool_brickfield\output\printable\renderer::get_ratio_table | ( | \stdClass | $data | ) |
Gets the Activity Pass Ratio table.
stdClass | $data | Report data. |
string | The HTML code of the table. |
|
inherited |
Returns true is output has already started, and false if not.
boolean | true if the header has been printed. |
|
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')
string | $imagename | the pathname of the image |
string | $component | full plugin name (aka component) or 'theme' |
moodle_url |
|
inherited |
tool_brickfield\output\printable\renderer::pdf_renderer | ( | \stdClass | $data, |
filter | $filter ) |
Renders the accessability report using the pdflib.
stdClass | $data | Report data. |
filter | $filter | Display filters. |
coding_exception | |
dml_exception | |
moodle_exception |
void |
|
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.
string | $imagename | the name of the icon. |
string | $component | specification of one plugin like in get_string() |
moodle_url |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
mixed | $classes | Space-separated string or array of classes |
string | HTML class attribute value |
|
inherited |
Renders the provided widget and returns the HTML to display it.
renderable | $widget | instance with renderable interface |
string |
Reimplemented from renderer_base.
Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.
|
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
array | stdClass | $context | Context containing data for the template. |
string|boolean |
tool_brickfield\output\printable\renderer::render_table | ( | array | $headers, |
array | $data, | ||
string | $title, | ||
array | $widths ) |
Builds the HTML for a styled table used in the pdf report.
array | $headers | The headers of the table. |
array | $data | The table data. |
string | $title | The title of the table. |
array | $widths | The widths of the table columns. |
string | The HTML code of the table. |
|
protectedinherited |
|
inherited |
Whether we should display the main logo.
int | $headinglevel | The heading level we want to check against. |
bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
bool |
|
inherited |
Render the valid tabs.
filter | $filter | |
array | $tools |
string |
moodle_exception |
|
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