core\output\icon_system Class Reference

Inheritance diagram for core\output\icon_system:

Public Member Functions
	get_amd_name ()
	The name of an AMD module extending core/icon_system. More...
	get_icon_name_map ()
	Overridable function to get a mapping of all icons. More...
	remap_icon_name ($iconname, $component)
	Overridable function to map the icon name to something else. More...
	render_pix_icon (renderer_base $output, pix_icon $icon)
	Render the pix icon according to the icon system. More...

Static Public Member Functions
static	instance ($type=null)
	Factory method. More...
static	is_valid_system ($system)
	Validate the theme config setting. More...
static	reset_caches ()
	Clears the instance cache, for use in unit tests.

Public Attributes
const	FONTAWESOME = '\\core\\output\\icon_system_fontawesome'
	@const FONTAWESOME Default icon system.
const	STANDARD = '\\core\\output\\icon_system_standard'
	@const STANDARD Default icon system.

Member Function Documentation

get_amd_name()

core\output\icon_system::get_amd_name ( )

abstract

The name of an AMD module extending core/icon_system.

Return values

string

Reimplemented in core\output\icon_system_fontawesome, and core\output\icon_system_standard.

get_icon_name_map()

core\output\icon_system::get_icon_name_map

(

)

Overridable function to get a mapping of all icons.

Default is to do no mapping.

Reimplemented in core\output\icon_system_fontawesome.

instance()

static core\output\icon_system::instance (   $type = null )

staticfinal

Factory method.

Parameters

string

$type

Either a specific type, or null to get the default type.

Return values

core::output::icon_system

is_valid_system()

static core\output\icon_system::is_valid_system (   $system )

staticfinal

Validate the theme config setting.

Parameters

string

$system

Return values

boolean

remap_icon_name()

core\output\icon_system::remap_icon_name (   $iconname,   $component  )

final

Overridable function to map the icon name to something else.

Default is to do no mapping. Map is cached in the singleton.

render_pix_icon()

core\output\icon_system::render_pix_icon ( renderer_base  $output, pix_icon  $icon  )

abstract

Render the pix icon according to the icon system.

Parameters

renderer_base	$output
pix_icon	$icon

Return values

string

Reimplemented in core\output\icon_system_fontawesome, and core\output\icon_system_standard.

---

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

• lib/classes/output/icon_system.php