Data structure representing a help icon. More...

Inheritance diagram for help_icon:

Public Member Functions
	__construct ($identifier, $component, $a=null)
	Constructor.

	diag_strings ()
	Verifies that both help strings exists, shows debug warnings if not.

	export_for_template (renderer_base $output)
	Export this data so it can be used as the context for a mustache template.

Public Attributes
mixed	$a = null
	An object, string or number that can be used within translation strings.

string	$component
	Component name, the same as in get_string()

string	$identifier
	lang pack identifier (without the "_help" suffix), both get_string($identifier, $component) and get_string($identifier.

string	$linktext = null
	Extra descriptive text next to the icon.

Detailed Description

Data structure representing a help icon.

Constructor & Destructor Documentation

Constructor.

Parameters

string	$identifier	string for help page title, string with _help suffix is used for the actual help text. string with _link suffix is used to create a link to further info (if it exists)
string	$component
string \| object \| array \| int	$a	An object, string or number that can be used within translation strings

help_icon::export_for_template ( renderer_base $output )

Export this data so it can be used as the context for a mustache template.

Parameters

renderer_base $output Used to do a final render of any components that need to be rendered for export.

Return values

stdClass

Implements templatable.

string help_icon::$identifier

lang pack identifier (without the "_help" suffix), both get_string($identifier, $component) and get_string($identifier.

'_help', $component) must exist.

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