Inheritance diagram for core_webservice_renderer:

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.

Detailed Description

Copyright: 2009 Jerome Mouneyrac jerom.nosp@m.e@mo.nosp@m.odle..nosp@m.com

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

Member Function Documentation

◆ __call()

plugin_renderer_base::__call	(		$method,
			$arguments )

inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters

string	$method
array	$arguments

Return values

mixed

◆ add_action_handler()

renderer_base::add_action_handler	(	component_action	$action,
			$id = null )

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()

Parameters

component_action	$action
string	$id

Return values

string id of element, either original submitted or random new if not supplied

◆ admin_authorised_user_list()

core_webservice_renderer::admin_authorised_user_list	(		$users,
			$serviceid )

Display list of authorised users for the given external service.

Parameters

array	$users	authorised users
int	$serviceid	service id

Return values

string#$html

◆ admin_authorised_user_selector()

core_webservice_renderer::admin_authorised_user_selector ( & $options )

Display the authorised user selector.

Parameters

stdClass $options It contains alloweduserselector, potentialuserselector and serviceid

Return values

string html

◆ admin_remove_service_confirmation()

core_webservice_renderer::admin_remove_service_confirmation ( $service )

Display a confirmation page to remove a service.

Parameters

stdClass $service It needs service id + service name properties.

Return values

string html

◆ admin_remove_service_function_confirmation()

core_webservice_renderer::admin_remove_service_function_confirmation	(		$function,
			$service )

Display a confirmation page to remove a function from a service.

Parameters

stdClass	$function	It needs function id + function name properties.
stdClass	$service	It needs service id + service name properties.

Return values

string html

◆ admin_service_function_list()

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)

Parameters

array	$functions	list of functions
stdClass	$service	the given service

Return values

string the table html + add operation html

◆ colored_box_with_pre_tag()

core_webservice_renderer::colored_box_with_pre_tag	(	$title,
		$content,
		$rgb = 'FEEBE5' )

Return the html of a coloured box with content.

Parameters

string	$title	- the title of the box
string	$content	- the content to displayed
string	$rgb	- the background color of the box

Return values

string HTML code

◆ description_in_indented_xml_format()

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

Parameters

  
    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.

  
  

Return values

  
    string the html to diplay

◆ detailed_description_html()

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 } )

Parameters

stdClass $params a part of parameter/return description

Return values

string the html to display

◆ documentation_html()

core_webservice_renderer::documentation_html	(	$functions,
		$printableformat,
		$activatedprotocol,
		$authparams,
		$parenturl = '/webservice/wsdoc.php' )

Displays all the documentation.

Todo: MDL-76078 - Incorrect inter-communication, core cannot have plugin dependencies like this.

Parameters

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)

Return values

string the html to diplay

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url	(		$maxwidth = 300,
			$maxheight = 300 )

inherited

Return the site's compact logo URL, if any.

Parameters

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.

Return values

moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url	(		$maxwidth = null,
			$maxheight = 200 )

inherited

Return the site's logo URL, if any.

Parameters

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.

Return values

moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since: 2.9

Return values

Mustache_Engine

◆ has_started()

renderer_base::has_started ( )

inherited

Returns true is output has already started, and false if not.

Return values

boolean true if the header has been printed.

◆ image_url()

renderer_base::image_url	(		$imagename,
			$component = 'moodle' )

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')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ pix_url()

renderer_base::pix_url	(		$imagename,
			$component = 'moodle' )

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.

Deprecated: since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

Renders the provided widget and returns the HTML to display it.

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_from_template()

renderer_base::render_from_template	(		$templatename,
			$context )

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

Since: 2.9

Parameters

array | stdClass $context Context containing data for the template.

Return values

string|boolean

◆ rest_param_description_html()

core_webservice_renderer::rest_param_description_html	(		$paramdescription,
			$paramstring )

Return indented REST param description.

Todo: MDL-76078 - Incorrect inter-communication, core cannot have plugin dependencies like this.

Parameters

external_description	$paramdescription	the description structure of the web service function parameters
string	$paramstring	parameter

Return values

string the html to diplay

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated: since Moodle 4.0

Todo: final deprecation. To be removed in Moodle 4.4 MDL-73165.

Parameters

int $headinglevel The heading level we want to check against.

Return values

bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

◆ user_reset_token_confirmation()

core_webservice_renderer::user_reset_token_confirmation ( $token )

Display Reset token confirmation box.

Parameters

stdClass $token token to reset

Return values

string html

◆ user_webservice_tokens_box()

core_webservice_renderer::user_webservice_tokens_box	(	$tokens,
		$userid,
		$documentation = false )

Display user tokens with buttons to reset them.

Parameters

stdClass	$tokens	user tokens
int	$userid	user id
bool	$documentation	if true display a link to the API documentation

Return values

string html code

◆ xmlrpc_param_description_html()

core_webservice_renderer::xmlrpc_param_description_html	(		$paramdescription,
			$indentation = "" )

Create indented XML-RPC param description.

Todo: MDL-76078 - Incorrect inter-communication, core cannot have plugin dependencies like this.

Parameters

external_description	$paramdescription	the description structure of the web service function parameters
string	$indentation	Indentation in the generated HTML code; should contain only spaces.

Return values

string the html to diplay

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output

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

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

webservice/renderer.php

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ admin_authorised_user_list()

◆ admin_authorised_user_selector()

◆ admin_remove_service_confirmation()

◆ admin_remove_service_function_confirmation()

◆ admin_service_function_list()

◆ colored_box_with_pre_tag()

◆ description_in_indented_xml_format()

◆ detailed_description_html()

◆ documentation_html()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ has_started()

◆ image_url()

◆ pix_url()

◆ prepare_classes()

◆ render()

◆ render_from_template()

◆ rest_param_description_html()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ user_reset_token_confirmation()

◆ user_webservice_tokens_box()

◆ xmlrpc_param_description_html()

Member Data Documentation

◆ $output