Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/webservice/ -> renderer.php (source)
Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]
(no description)
| File Size: | 837 lines (40 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
core_webservice_renderer:: (14 methods):
admin_authorised_user_selector()
admin_authorised_user_list()
admin_remove_service_function_confirmation()
admin_remove_service_confirmation()
admin_delete_token_confirmation()
admin_service_function_list()
user_reset_token_confirmation()
user_webservice_tokens_box()
detailed_description_html()
description_in_indented_xml_format()
xmlrpc_param_description_html()
colored_box_with_pre_tag()
rest_param_description_html()
documentation_html()
Class: core_webservice_renderer - X-Ref
Web service documentation renderer.| admin_authorised_user_selector(&$options) X-Ref |
| Display the authorised user selector param: stdClass $options It contains alloweduserselector, potentialuserselector and serviceid return: string html |
| admin_authorised_user_list($users, $serviceid) X-Ref |
| Display list of authorised users param: array $users authorised users param: int $serviceid service id return: string $html |
| admin_remove_service_function_confirmation($function, $service) X-Ref |
| Display a confirmation page to remove a function from a service param: stdClass $function It needs function id + function name properties. param: stdClass $service It needs service id + service name properties. return: string html |
| admin_remove_service_confirmation($service) X-Ref |
| Display a confirmation page to remove a service param: stdClass $service It needs service id + service name properties. return: string html |
| admin_delete_token_confirmation($token) X-Ref |
| Display a confirmation page to delete a token param: stdClass $token Required properties: id (token id), firstname (user firstname), lastname (user lastname), name (service name) return: string html |
| admin_service_function_list($functions, $service) X-Ref |
| Display a list of functions for a given service If the service is built-in, do not display remove/add operation (read-only) param: array $functions list of functions param: stdClass $service the given service return: string the table html + add operation html |
| user_reset_token_confirmation($token) X-Ref |
| Display Reset token confirmation box param: stdClass $token token to reset return: string html |
| user_webservice_tokens_box($tokens, $userid, $documentation = false) X-Ref |
| Display user tokens with buttons to reset them param: stdClass $tokens user tokens param: int $userid user id param: bool $documentation if true display a link to the API documentation return: string html code |
| detailed_description_html($params) X-Ref |
| 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 } ) param: stdClass $params a part of parameter/return description return: string the html to display |
| description_in_indented_xml_format($returndescription, $indentation = "") X-Ref |
| Return a description object in indented xml format (for REST response) It is indented to be output within <pre> tags param: external_description $returndescription the description structure of the web service function returned value param: string $indentation Indentation in the generated HTML code; should contain only spaces. return: string the html to diplay |
| xmlrpc_param_description_html($paramdescription, $indentation = "") X-Ref |
| Create indented XML-RPC param description param: external_description $paramdescription the description structure of the web service function parameters param: string $indentation Indentation in the generated HTML code; should contain only spaces. return: string the html to diplay |
| colored_box_with_pre_tag($title, $content, $rgb = 'FEEBE5') X-Ref |
| Return the html of a coloured box with content param: string $title - the title of the box param: string $content - the content to displayed param: string $rgb - the background color of the box return: string HTML code |
| rest_param_description_html($paramdescription, $paramstring) X-Ref |
| Return indented REST param description param: external_description $paramdescription the description structure of the web service function parameters param: string $paramstring parameter return: string the html to diplay |
| documentation_html($functions, $printableformat, $activatedprotocol,$authparams, $parenturl = '/webservice/wsdoc.php') X-Ref |
| Displays all the documentation param: array $functions external_description of all the web service functions param: boolean $printableformat true if we want to display the documentation in a printable format param: array $activatedprotocol the currently enabled protocol param: array $authparams url parameters (it contains 'tokenid' and sometimes 'print') param: string $parenturl url of the calling page - needed for the print button url: return: string the html to diplay |
