Plugin/Events/Quickicon: Difference between revisions

Latest revision as of 17:20, 15 July 2014

Events of Quickicon

onGetIcons

Description

This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.

Parameters

context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.

Return Value

A list of icon definition associative arrays, consisting of the keys link, image, text and access.

Example:

$return = array(
	array(
		'link' => 'index.php?option=com_joomlaupdate',
		'image' => 'joomla',
		'icon' => 'header/icon-48-download.png',
		'text' => JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),
		'id' => 'plg_quickicon_joomlaupdate',
		'group' => 'MOD_QUICKICON_MAINTENANCE'
	)
);

Called in files

administrator/modules/mod_quickicon/helper.php

@@ Line 1: / Line 1: @@
-{{page|needs completion|This page need completing to be a useful doc reference.}}
 Events of Quickicon
@@ Line 9: / Line 7: @@
 === Parameters ===
+*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module  (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
 === Return Value ===
+A list of icon definition associative arrays, consisting of the keys link, image, text and access.
+'''Example''':
+<source lang="php">
+$return = array(
+	array(
+		'link' => 'index.php?option=com_joomlaupdate',
+		'image' => 'joomla',
+		'icon' => 'header/icon-48-download.png',
+		'text' => JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),
+		'id' => 'plg_quickicon_joomlaupdate',
+		'group' => 'MOD_QUICKICON_MAINTENANCE'
+	)
+);
+</source>
 === Called in files ===
+* <code>administrator/modules/mod_quickicon/helper.php</code>
 <noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>