Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
image_icon Class Reference

Data structure representing an activity icon. More...

Inheritance diagram for image_icon:
pix_icon renderable templatable

Public Member Functions

 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.
 
 export_for_template (renderer_base $output)
 Export this data so it can be used as the context for a mustache template.
 

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.
 

Detailed Description

Data structure representing an activity icon.

The difference is that activity icons will always render with the standard icon system (no font icons).

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ export_for_pix()

pix_icon::export_for_pix ( )
inherited

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)
inherited

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: