core\output\pix_icon Class Reference

Inheritance diagram for core\output\pix_icon:

Public Member Functions
	__construct ( $pix, $alt, $component='moodle', ?array $attributes=null,)
	Constructor.
	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 = []
	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()

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

Constructor.

Parameters

string	$pix	short icon name
string	$alt	The alt text to use for the icon
string	$component	component name
null | array	$attributes	html attributes

Member Function Documentation

export_for_pix()

core\output\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()

core\output\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

$output

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

Return values

array

Implements core\output\templatable.

---

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

• lib/classes/output/pix_icon.php