Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/admin/tool/templatelibrary/classes/ -> external.php (source)

[Source view]

Differences Between: [Versions 400 and 402] [Versions 400 and 403]

This is the external API for this tool.

Copyright: 2015 Damyon Wiese
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 140 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

external:: (6 methods):
  list_templates_parameters()
  list_templates()
  list_templates_returns()
  load_canonical_template_parameters()
  load_canonical_template()
  load_canonical_template_returns()


Class: external  - X-Ref

This is the external API for this tool.

list_templates_parameters()   X-Ref
Returns description of list_templates() parameters.

return: external_function_parameters

list_templates($component, $search, $themename = '')   X-Ref
Loads the list of templates.

return: array[string]
param: string $component Limit the search to a component.
param: string $search The search string.
param: string $themename The name of theme

list_templates_returns()   X-Ref
Returns description of list_templates() result value.

return: external_description

load_canonical_template_parameters()   X-Ref
Returns description of load_canonical_template() parameters.

return: external_function_parameters

load_canonical_template($component, $template)   X-Ref
Return a mustache template.
Note - this function differs from the function core_output_load_template
because it will never return a theme overridden version of a template.

return: string the template, false if template doesn't exist.
param: string $component The component that holds the template.
param: string $template The name of the template.

load_canonical_template_returns()   X-Ref
Returns description of load_canonical_template() result value.

return: external_description