pix_icon Class Reference

Data structure representing an icon. More...

Inheritance diagram for 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 = 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 icon.

Copyright

2010 Petr Skoda

License

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

Since

Moodle 2.0

Constructor & Destructor Documentation

__construct()

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
array	$attributes	html 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

$output

Used 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:

• lib/outputcomponents.php