Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
pix_icon Class Reference
Inheritance diagram for pix_icon:
renderable templatable image_icon pix_emoticon

Public Member Functions

 __construct ($pix, $alt, $component='moodle', array $attributes=null)
 Constructor. More...
 
 export_for_pix ()
 Much simpler version of export that will produce the data required to render this pix with the pix helper in a mustache tag. More...
 
 export_for_template (renderer_base $output)
 Export this data so it can be used as the context for a mustache template. More...
 

Public Attributes

array $attributes = array()
 An array of attributes to use on the icon.
 
string $component
 The component the icon belongs to.
 
string $pix
 The icon name.
 

Constructor & Destructor Documentation

◆ __construct()

pix_icon::__construct (   $pix,
  $alt,
  $component = 'moodle',
array  $attributes = null 
)

Constructor.

Parameters
string$pixshort icon name
string$altThe alt text to use for the icon
string$componentcomponent name
array$attributeshtml attributes

Reimplemented in pix_emoticon.

Member Function Documentation

◆ export_for_pix()

pix_icon::export_for_pix ( )

Much simpler version of export that will produce the data required to render this pix with the pix helper in a mustache tag.

Return values
array

◆ export_for_template()

pix_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$outputUsed to do a final render of any components that need to be rendered for export.
Return values
array

Implements templatable.


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