core\output\external Class Reference

Inheritance diagram for core\output\external:

Static Public Member Functions
static	load_fontawesome_icon_map ()
	Return a mapping of icon names to icons.
static	load_fontawesome_icon_map_is_deprecated ()
	The load_fontawesome_icon_map function has been replaced with.
static	load_fontawesome_icon_map_parameters ()
	Returns description of load_icon_map() parameters.
static	load_fontawesome_icon_map_returns ()
	Returns description of load_icon_map() result value.
static	load_template ($component, $template, $themename, $includecomments=false)
	Return a mustache template, and all the strings it requires.
static	load_template_parameters ()
	Returns description of load_template() parameters.
static	load_template_returns ()
	Returns description of load_template() result value.
static	load_template_with_dependencies (string $component, string $template, string $themename, bool $includecomments=false, string $lang=null)
	Return a mustache template, and all the child templates and strings it requires.
static	load_template_with_dependencies_parameters ()
	Returns description of load_template_with_dependencies() parameters.
static	load_template_with_dependencies_returns ()
	Returns description of load_template_with_dependencies() result value.

Member Function Documentation

load_fontawesome_icon_map()

static core\output\external::load_fontawesome_icon_map ( )

static

Return a mapping of icon names to icons.

Deprecated

since Moodle 3.10

Return values

array

the mapping

load_fontawesome_icon_map_is_deprecated()

static core\output\external::load_fontawesome_icon_map_is_deprecated ( )

static

The load_fontawesome_icon_map function has been replaced with.

See also

load_fontawesome_map\execute()

Return values

bool

load_fontawesome_icon_map_parameters()

static core\output\external::load_fontawesome_icon_map_parameters ( )

static

Returns description of load_icon_map() parameters.

Return values

external_function_parameters

load_fontawesome_icon_map_returns()

static core\output\external::load_fontawesome_icon_map_returns ( )

static

Returns description of load_icon_map() result value.

Return values

core_external\external_description

load_template()

static core\output\external::load_template ( $component, $template, $themename, $includecomments = false )

static

Return a mustache template, and all the strings it requires.

Parameters

string	$component	The component that holds the template.
string	$templatename	The name of the template.
string	$themename	The name of the current theme.

Return values

string

the template

load_template_parameters()

static core\output\external::load_template_parameters ( )

static

Returns description of load_template() parameters.

Return values

external_function_parameters

load_template_returns()

static core\output\external::load_template_returns ( )

static

Returns description of load_template() result value.

Return values

core_external\external_description

load_template_with_dependencies()

static core\output\external::load_template_with_dependencies ( string $component, string $template, string $themename, bool $includecomments = false, string $lang = null )

static

Return a mustache template, and all the child templates and strings it requires.

Parameters

string	$component	The component that holds the template.
string	$template	The name of the template.
string	$themename	The name of the current theme.
bool	$includecomments	Whether to strip comments from the template source.
string	$lang	moodle translation language, null means use current.

Return values

string

the template

load_template_with_dependencies_parameters()

static core\output\external::load_template_with_dependencies_parameters ( )

static

Returns description of load_template_with_dependencies() parameters.

Return values

external_function_parameters

load_template_with_dependencies_returns()

static core\output\external::load_template_with_dependencies_returns ( )

static

Returns description of load_template_with_dependencies() result value.

Return values

core_external\external_description

---

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

• lib/classes/output/external.php