Inheritance diagram for core_webservice_renderer:

Public Member Functions
	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.

	rest_param_description_html ($paramdescription, $paramstring)
	Return indented REST param description.

	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.

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

◆ 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

◆ 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

◆ 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

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

Detailed Description

Member Function Documentation

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

◆ rest_param_description_html()

◆ user_reset_token_confirmation()

◆ user_webservice_tokens_box()

◆ xmlrpc_param_description_html()