Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
core\output\icon_system Class Reference
Inheritance diagram for core\output\icon_system:
core\output\icon_system_font core\output\icon_system_standard core\output\icon_system_fontawesome theme_classic\output\icon_system_fontawesome

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_standard, and core\output\icon_system_fontawesome.

◆ 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$typeEither a specific type, or null to get the default type.
Return values
core

◆ 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_standard, and core\output\icon_system_fontawesome.


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