Référence de la classe CssMenu

Fonctions membres publiques
	__construct (CMSApplication $application)
	load ($params, $enabled)
	renderSubmenu ($layoutFile, $node)
	getIconClass ($node)
	getCounter ()

Fonctions membres protégées
	check ($node, Registry $params)
	preprocess ($parent)

Attributs protégés
	$root
	$nodes = []
	$params
	$enabled
	$application
	$counter = 0

Description détaillée

Tree based class to render the admin menu

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct

(

CMSApplication

$application

)

CssMenu constructor.

Paramètres

CMSApplication

$application

The application

Depuis

4.0.0

Documentation des fonctions membres

check()

check (   $node, Registry  $params  )

protected

Check the flat list of menu items for important links

Paramètres

AdministratorMenuItem	$node	The menu items array
Registry	$params	Module options

Renvoie

boolean Whether to show recovery menu

Depuis

3.8.0

Références $items, $menutype, $message, $params, $uri, Text\_(), Uri\getInstance(), Table\getInstance(), et Text\sprintf().

getCounter()

getCounter

(

)

Create unique identifier

Renvoie

string

Depuis

4.0.0

Références counter.

getIconClass()

getIconClass

(

$node

)

Method to get the CSS class name for an icon identifier or create one if a custom image path is passed as the identifier

Paramètres

AdministratorMenuItem

$node

Node to get icon data from

Renvoie

string CSS class name

Depuis

3.8.0

Références $class, $html, et null.

load()

load	(		$params,
			$enabled
	)

Populate the menu items in the menu tree object

Paramètres

Registry	$params	Menu configuration parameters
bool	$enabled	Whether the menu should be enabled or disabled

Renvoie

AdministratorMenuItem Root node of the menu tree

Depuis

3.7.0

Références $enabled, $heading, $menutype, $name, $params, $root, $uri, Uri\getInstance(), MenusHelper\getMenuItems(), et MenusHelper\loadPreset().

preprocess()

preprocess (   $parent )

protected

Filter and perform other preparatory tasks for loaded menu items based on access rights and module configurations for display

Paramètres

AdministratorMenuItem

$parent

A menu item to process

Renvoie

array

Depuis

3.8.0

Trigger onPreprocessMenuItems for the current level of backend menu items. $children is an array of AdministratorMenuItem objects. A plugin can traverse the whole tree, but new nodes will only be run through this method if their parents have not been processed yet.

If component is passed in the link via option variable, we set $item->element to this value for further processing. It is needed for links from menu items of third party extensions link to Joomla! core components like com_categories, com_fields...

Références $c, $item, $language, $last, $option, $parts, $query, $this, $uri, $user, Joomla\CMS\MVC\Model\$workflow, Text\_(), elseif, MenusHelper\getMenuItems(), ComponentHelper\getParams(), ComponentHelper\isEnabled(), Associations\isEnabled(), JPATH_ADMINISTRATOR, null, et ArrayHelper\sortObjects().

renderSubmenu()

renderSubmenu	(		$layoutFile,
			$node
	)

Method to render a given level of a menu using provided layout file

Paramètres

string	$layoutFile	The layout file to be used to render
AdministratorMenuItem	$node	Node to render the children of

Renvoie

void

Depuis

3.8.0

Documentation des champs

$application

$application

protected

$counter

$counter = 0

protected

$enabled

$enabled

protected

$nodes

$nodes = []

protected

$params

$params

protected

$root

$root

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• CssMenu.php