Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
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. | |
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. | |
import_setting_mappings ($datamodule, data_preset_importer $importer) | |
Rendering setting and mapping page to import a preset. | |
importing_preset (stdClass $datamodule, mod_data\local\importer\preset_importer $importer) | |
Importing a preset on a database module. | |
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_database_zero_state (\mod_data\manager $manager) | |
Renders the action bar for the zero state (no fields created) page. | |
render_defaulttemplate (\mod_data\output\defaulttemplate $template) | |
Renders the default template. | |
render_empty_database (\mod_data\manager $manager) | |
Renders the action bar for an empty database view page. | |
render_fields_action_bar (\mod_data\output\fields_action_bar $actionbar) | |
Renders the action bar for the field page. | |
render_fields_footer (manager $manager) | |
Renders the fields page footer. | |
render_fields_zero_state (\mod_data\manager $manager) | |
Renders the action bar for the zero state (no fields created) page. | |
render_from_template ($templatename, $context) | |
Renders a template by name with the given context. | |
render_presets (\mod_data\output\presets $presets) | |
Renders the presets table in the preset page. | |
render_presets_action_bar (\mod_data\output\presets_action_bar $actionbar) | |
Renders the action bar for the preset page. | |
render_templates_action_bar (\mod_data\output\templates_action_bar $actionbar) | |
Renders the action bar for the template page. | |
render_templates_zero_state (\mod_data\manager $manager) | |
Renders the action bar for the templates zero state (no fields created) page. | |
render_view_action_bar (\mod_data\output\view_action_bar $actionbar) | |
Renders the action bar for the view page. | |
should_display_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. | |
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. | |
mod_data_renderer::import_setting_mappings | ( | $datamodule, | |
data_preset_importer | $importer ) |
Rendering setting and mapping page to import a preset.
stdClass | $datamodule | Database module to import to. |
data_preset_importer | $importer | Importer instance to use for the importing. |
string |
mod_data_renderer::importing_preset | ( | stdClass | $datamodule, |
mod_data\local\importer\preset_importer | $importer ) |
Importing a preset on a database module.
stdClass | $datamodule | Database module to import to. |
mod_data\local\importer\preset_importer | $importer | Importer instance to use for the importing. |
string |
mod_data_renderer::render_database_zero_state | ( | \mod_data\manager | $manager | ) |
Renders the action bar for the zero state (no fields created) page.
mod_data\manager | $manager | The manager instance. |
string | The HTML output |
mod_data_renderer::render_defaulttemplate | ( | \mod_data\output\defaulttemplate | $template | ) |
Renders the default template.
mod_data\output\defaulttemplate | $template |
string | The HTML output |
mod_data_renderer::render_empty_database | ( | \mod_data\manager | $manager | ) |
Renders the action bar for an empty database view page.
mod_data\manager | $manager | The manager instance. |
string | The HTML output |
mod_data_renderer::render_fields_action_bar | ( | \mod_data\output\fields_action_bar | $actionbar | ) |
Renders the action bar for the field page.
mod_data\output\fields_action_bar | $actionbar |
string | The HTML output |
mod_data_renderer::render_fields_footer | ( | manager | $manager | ) |
Renders the fields page footer.
manager | $manager | the instance manager |
string | The HTML output |
mod_data_renderer::render_fields_zero_state | ( | \mod_data\manager | $manager | ) |
Renders the action bar for the zero state (no fields created) page.
mod_data\manager | $manager | The manager instance. |
string | The HTML output |
mod_data_renderer::render_presets | ( | \mod_data\output\presets | $presets | ) |
Renders the presets table in the preset page.
mod_data\output\presets | $presets |
string | The HTML output |
mod_data_renderer::render_presets_action_bar | ( | \mod_data\output\presets_action_bar | $actionbar | ) |
Renders the action bar for the preset page.
mod_data\output\presets_action_bar | $actionbar |
string | The HTML output |
mod_data_renderer::render_templates_action_bar | ( | \mod_data\output\templates_action_bar | $actionbar | ) |
Renders the action bar for the template page.
mod_data\output\templates_action_bar | $actionbar |
string | The HTML output |
mod_data_renderer::render_templates_zero_state | ( | \mod_data\manager | $manager | ) |
Renders the action bar for the templates zero state (no fields created) page.
mod_data\manager | $manager | The manager instance. |
string | The HTML output |
mod_data_renderer::render_view_action_bar | ( | \mod_data\output\view_action_bar | $actionbar | ) |
Renders the action bar for the view page.
mod_data\output\view_action_bar | $actionbar |
string | The HTML output |