Inheritance diagram for core_webservice_renderer:

Collaboration diagram for core_webservice_renderer:

Public Member Functions
	admin_authorised_user_selector (&$options)
	admin_authorised_user_list ($users, $serviceid)
	admin_remove_service_function_confirmation ($function, $service)
	admin_remove_service_confirmation ($service)
	admin_delete_token_confirmation ($token)
	admin_service_function_list ($functions, $service)
	user_reset_token_confirmation ($token)
	user_webservice_tokens_box ($tokens, $userid, $documentation=false)
	detailed_description_html ($params)
	description_in_indented_xml_format ($returndescription, $indentation="")
	xmlrpc_param_description_html ($paramdescription, $indentation="")
	colored_box_with_pre_tag ($title, $content, $rgb= 'FEEBE5')
	rest_param_description_html ($paramdescription, $paramstring)
	documentation_html ($functions, $printableformat, $activatedprotocol, $authparams, $parenturl= '/webservice/wsdoc.php')

Detailed Description

Definition at line 30 of file renderer.php.

Member Function Documentation

admin_authorised_user_list	(	$	users,
		$	serviceid
	)

Display list of authorised user

Parameters:

array $users

Returns:: string $html

Definition at line 106 of file renderer.php.

Here is the call graph for this function:

admin_authorised_user_selector ( &$ options )

Display the authorised user selector

Parameters:

object $options

Returns:: string html

Definition at line 37 of file renderer.php.

Here is the call graph for this function:

admin_delete_token_confirmation ( $ token )

Display a confirmation page to delete a token

Parameters:

object $token

Returns:: string html

Definition at line 173 of file renderer.php.

Here is the call graph for this function:

admin_remove_service_confirmation ( $ service )

Display a confirmation page to remove a service

Parameters:

object $service

Returns:: string html

Definition at line 154 of file renderer.php.

Here is the call graph for this function:

admin_remove_service_function_confirmation	(	$	function,
		$	service
	)

Display a confirmation page to remove a function from a service

Parameters:

object	$function
object	$service

Returns:: string html

Definition at line 136 of file renderer.php.

Here is the call graph for this function:

admin_service_function_list	(	$	functions,
		$	service
	)

Display list of function for a given service If the service is build-in do not display remove/add operation (read-only)

Parameters:

array	$functions
object	$service

Returns:: string the table html + add operation html

Definition at line 197 of file renderer.php.

Here is the call graph for this function:

colored_box_with_pre_tag	(	$	title,
		$	content,
		$	rgb = `'FEEBE5'`
	)

Return the html of a colored 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

Returns:: <type>

Definition at line 546 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

description_in_indented_xml_format	(	$	returndescription,
		$	indentation = `""`
	)

Return a description object in indented xml format (for REST response) It is indented in order to be displayed into

tag

Parameters:

object	$returndescription
string	$indentation	composed by space only

Returns:: string the html to diplay

description object is a list

description object is an object

description object is a primary type (string, integer)

Definition at line 445 of file renderer.php.

Here is the caller graph for this function:

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 moodle_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:

object $params a part of parameter/return description

Returns:: string the html to display

retrieve the description of the description object

description object is a list

description object is an object

description object is a primary type (string, integer)

Definition at line 372 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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

This display all the documentation

Parameters:

array	$functions	contains all decription objects
array	$authparam	keys contains 'tokenid'
boolean	$printableformat	true if we want to display the documentation in a printable format
array	$activatedprotocol
string	$parenturl	url of the calling page - needed for the print button url: '/admin/documentation.php' or '/webservice/wsdoc.php' (default)

Returns:: string the html to diplay

Some general information

Print button

each functions will be displayed into a collapsible region

function global description

function arguments documentation

a argument documentation

general structure of the argument

xml-rpc structure of the argument in PHP format

POST format for the REST protocol for the argument

function response documentation

function response description

general structure of the response

xml-rpc structure of the response in PHP format

XML response for the REST protocol

function errors documentation for REST protocol

close the table and return the documentation

Definition at line 618 of file renderer.php.

Here is the call graph for this function:

rest_param_description_html	(	$	paramdescription,
		$	paramstring
	)

Return indented REST param description

Parameters:

object	$paramdescription
string	$indentation	composed by space only

Returns:: string the html to diplay

description object is a list

description object is an object

description object is a primary type (string, integer)

Definition at line 570 of file renderer.php.

Here is the caller graph for this function:

user_reset_token_confirmation ( $ token )

Display Reset token confirmation box

Parameters:

object $token to reset

Returns:: string html

Definition at line 257 of file renderer.php.

Here is the call graph for this function:

user_webservice_tokens_box	(	$	tokens,
		$	userid,
		$	documentation = `false`
	)

Display user tokens with buttons to reset them

Parameters:

object	$tokens
int	$userid

Returns:: string html code

Definition at line 280 of file renderer.php.

Here is the call graph for this function:

xmlrpc_param_description_html	(	$	paramdescription,
		$	indentation = `""`
	)

Create indented XML-RPC param description

Parameters:

object	$paramdescription
string	$indentation	composed by space only

Returns:: string the html to diplay

description object is a list

description object is an object

description object is a primary type (string, integer)

Definition at line 494 of file renderer.php.

Here is the caller graph for this function:

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

C:/xampp/htdocs/moodle/webservice/renderer.php

Public Member Functions

Detailed Description

Member Function Documentation