Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe Tree

Fonctions membres publiques

 __construct ()
 
 getRoot ()
 
 getCurrent ()
 
 setCurrent ($node)
 
 getParent ($setCurrent=true)
 
 reset ($clear=false)
 
 addChild (Node $node, $setCurrent=false)
 
 getIconClass ()
 
 getCss ()
 

Attributs protégés

 $root = null
 
 $current = null
 
 $css = array()
 

Description détaillée

Menu Tree class to represent a menu tree hierarchy

Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor

Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $root.

Documentation des fonctions membres

◆ addChild()

addChild ( Node  $node,
  $setCurrent = false 
)

Method to add a child

Paramètres
Node$nodeThe node to process
bool$setCurrentSet this new child as the current node for further working
Renvoie
Node The newly added node
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

◆ getCss()

getCss ( )

Get the CSS declarations for this tree

Renvoie
string[]
Depuis
3.8.0
Obsolète:
4.0

Références $css.

◆ getCurrent()

getCurrent ( )

Get the current node

Renvoie
Node
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $current.

◆ getIconClass()

getIconClass ( )

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

Renvoie
string CSS class name
Depuis
3.8.0
Obsolète:
4.0

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

◆ getParent()

getParent (   $setCurrent = true)

Method to get the parent and set it as active optionally

Paramètres
bool$setCurrentSet that parent as the current node for further working
Renvoie
Node
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

◆ getRoot()

getRoot ( )

Get the root node

Renvoie
Node
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $root.

◆ reset()

reset (   $clear = false)

Method to reset the working pointer to the root node and optionally clear all menu nodes

Paramètres
bool$clearWhether to clear the existing menu items or just reset the pointer to root element
Renvoie
Node The root node
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $current, et $root.

◆ setCurrent()

setCurrent (   $node)

Get the current node

Paramètres
Node$nodeThe node to be set as current
Renvoie
void
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Documentation des champs

◆ $css

$css = array()
protected

◆ $current

$current = null
protected

◆ $root

$root = null
protected

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