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. | |
admin_authorised_user_list ($users, $serviceid) | |
Display list of authorised users for the given external service. | |
admin_authorised_user_selector (&$options) | |
Display the authorised user selector. | |
admin_remove_service_confirmation ($service) | |
Display a confirmation page to remove a service. | |
admin_remove_service_function_confirmation ($function, $service) | |
Display a confirmation page to remove a function from a service. | |
admin_service_function_list ($functions, $service) | |
Display a list of functions for a given service If the service is built-in, do not display remove/add operation (read-only) | |
colored_box_with_pre_tag ($title, $content, $rgb='FEEBE5') | |
Return the html of a coloured box with content. | |
description_in_indented_xml_format ($returndescription, $indentation="") | |
Return a description object in indented xml format (for REST response) It is indented to be output within. | |
detailed_description_html ($params) | |
Return documentation for a ws description object ws description object can be 'external_multiple_structure', 'external_single_structure' or 'external_value'. | |
documentation_html ($functions, $printableformat, $activatedprotocol, $authparams, $parenturl='/webservice/wsdoc.php') | |
Displays all the documentation. | |
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. | |
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. | |
rest_param_description_html ($paramdescription, $paramstring) | |
Return indented REST param description. | |
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. | |
user_reset_token_confirmation ($token) | |
Display Reset token confirmation box. | |
user_webservice_tokens_box ($tokens, $userid, $documentation=false) | |
Display user tokens with buttons to reset them. | |
xmlrpc_param_description_html ($paramdescription, $indentation="") | |
Create indented XML-RPC param description. | |
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. | |
|
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 |
core_webservice_renderer::admin_authorised_user_list | ( | $users, | |
$serviceid ) |
Display list of authorised users for the given external service.
array | $users | authorised users |
int | $serviceid | service id |
string\$html |
core_webservice_renderer::admin_authorised_user_selector | ( | & | $options | ) |
Display the authorised user selector.
stdClass | $options | It contains alloweduserselector, potentialuserselector and serviceid |
string | html |
core_webservice_renderer::admin_remove_service_confirmation | ( | $service | ) |
Display a confirmation page to remove a service.
stdClass | $service | It needs service id + service name properties. |
string | html |
core_webservice_renderer::admin_remove_service_function_confirmation | ( | $function, | |
$service ) |
Display a confirmation page to remove a function from a service.
stdClass | $function | It needs function id + function name properties. |
stdClass | $service | It needs service id + service name properties. |
string | html |
core_webservice_renderer::admin_service_function_list | ( | $functions, | |
$service ) |
Display a list of functions for a given service If the service is built-in, do not display remove/add operation (read-only)
array | $functions | list of functions |
stdClass | $service | the given service |
string | the table html + add operation html |
core_webservice_renderer::colored_box_with_pre_tag | ( | $title, | |
$content, | |||
$rgb = 'FEEBE5' ) |
Return the html of a coloured box with content.
string | $title | - the title of the box |
string | $content | - the content to displayed |
string | $rgb | - the background color of the box |
string | HTML code |
core_webservice_renderer::description_in_indented_xml_format | ( | $returndescription, | |
$indentation = "" ) |
Return a description object in indented xml format (for REST response) It is indented to be output within.
tags
external_description | $returndescription | the description structure of the web service function returned value |
string | $indentation | Indentation in the generated HTML code; should contain only spaces. |
string | the html to diplay |
core_webservice_renderer::detailed_description_html | ( | $params | ) |
Return documentation for a ws description object ws description object can be 'external_multiple_structure', 'external_single_structure' or 'external_value'.
Example of documentation for core_group_create_groups function: list of ( object { courseid int //id of course name string //multilang compatible name, course unique description string //group description text enrolmentkey string //group enrol secret phrase } )
stdClass | $params | a part of parameter/return description |
string | the html to display |
core_webservice_renderer::documentation_html | ( | $functions, | |
$printableformat, | |||
$activatedprotocol, | |||
$authparams, | |||
$parenturl = '/webservice/wsdoc.php' ) |
Displays all the documentation.
array | $functions | external_description of all the web service functions |
boolean | $printableformat | true if we want to display the documentation in a printable format |
array | $activatedprotocol | the currently enabled protocol |
array | $authparams | url parameters (it contains 'tokenid' and sometimes 'print') |
string | $parenturl | url of the calling page - needed for the print button url: '/admin/documentation.php' or '/webservice/wsdoc.php' (default) |
string | the html to diplay |
|
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 |
|
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 |
|
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 |
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 |
core_webservice_renderer::rest_param_description_html | ( | $paramdescription, | |
$paramstring ) |
Return indented REST param description.
external_description | $paramdescription | the description structure of the web service function parameters |
string | $paramstring | parameter |
string | the html to diplay |
|
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 |
core_webservice_renderer::user_reset_token_confirmation | ( | $token | ) |
Display Reset token confirmation box.
stdClass | $token | token to reset |
string | html |
core_webservice_renderer::user_webservice_tokens_box | ( | $tokens, | |
$userid, | |||
$documentation = false ) |
Display user tokens with buttons to reset them.
stdClass | $tokens | user tokens |
int | $userid | user id |
bool | $documentation | if true display a link to the API documentation |
string | html code |
core_webservice_renderer::xmlrpc_param_description_html | ( | $paramdescription, | |
$indentation = "" ) |
Create indented XML-RPC param description.
external_description | $paramdescription | the description structure of the web service function parameters |
string | $indentation | Indentation in the generated HTML code; should contain only spaces. |
string | the html to diplay |
|
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