tool_templatelibrary\external Class Reference

This is the external API for this tool. More...

Inheritance diagram for tool_templatelibrary\external:

Static Public Member Functions
static	list_templates ($component, $search, $themename='')
	Loads the list of templates.
static	list_templates_parameters ()
	Returns description of list_templates() parameters.
static	list_templates_returns ()
	Returns description of list_templates() result value.
static	load_canonical_template ($component, $template)
	Return a mustache template.
static	load_canonical_template_parameters ()
	Returns description of load_canonical_template() parameters.
static	load_canonical_template_returns ()
	Returns description of load_canonical_template() result value.

Detailed Description

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

Member Function Documentation

list_templates()

static tool_templatelibrary\external::list_templates ( $component, $search, $themename = '' )

static

Loads the list of templates.

Parameters

string	$component	Limit the search to a component.
string	$search	The search string.
string	$themename	The name of theme

Return values

array[string]

list_templates_parameters()

static tool_templatelibrary\external::list_templates_parameters ( )

static

Returns description of list_templates() parameters.

Return values

external_function_parameters

list_templates_returns()

static tool_templatelibrary\external::list_templates_returns ( )

static

Returns description of list_templates() result value.

Return values

core_external\external_description

load_canonical_template()

static tool_templatelibrary\external::load_canonical_template ( $component, $template )

static

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.

Parameters

string	$component	The component that holds the template.
string	$template	The name of the template.

Return values

string

the template, false if template doesn't exist.

load_canonical_template_parameters()

static tool_templatelibrary\external::load_canonical_template_parameters ( )

static

Returns description of load_canonical_template() parameters.

Return values

external_function_parameters

load_canonical_template_returns()

static tool_templatelibrary\external::load_canonical_template_returns ( )

static

Returns description of load_canonical_template() result value.

Return values

core_external\external_description

---

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

• admin/tool/templatelibrary/classes/external.php