[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/admin/tool/templatelibrary/classes/ -> external.php (summary)

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: 131 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)   X-Ref
Loads the list of templates.

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

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.

param: string $component The component that holds the template.
param: string $template The name of the template.
return: string the template

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

return: external_description



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1