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é
Référence de la classe Node
+ Graphe d'héritage de Node:

Fonctions membres publiques

 __construct ()
 
 addChild (Node $child)
 
 removeChild (Node $child)
 
 hasParent ()
 
 getParent ()
 
 hasChildren ()
 
 getChildren ()
 
 getLevel ()
 
 isRoot ()
 
 setActive ($active)
 
 setParams (Registry $params)
 
 getParam ($key)
 
 get ($name)
 

Attributs protégés

 $id = null
 
 $class = null
 
 $active = false
 
 $params
 
 $parent = null
 
 $children = array()
 

Description détaillée

A Node for MenuTree

Voir également
Tree
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

Documentation des fonctions membres

◆ addChild()

addChild ( Node  $child)

Add child to this node

If the child already has a parent, the link is unset

Paramètres
Node$childThe child to be added
Renvoie
Node The new added child
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $hash, children, et Node\removeChild().

◆ get()

get (   $name)

Get an attribute value

Paramètres
string$nameThe attribute name
Renvoie
mixed
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $name, et null.

◆ getChildren()

getChildren ( )

Get the children of this node

Renvoie
Node[] The children
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

◆ getLevel()

getLevel ( )

Find the current node depth in the tree hierarchy

Renvoie
integer The node level in the hierarchy, where ROOT == 0, First level menu item == 1, and so on.
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

◆ getParam()

getParam (   $key)

Get the param value from the node params

Paramètres
string$keyThe param name
Renvoie
mixed
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $key, et null.

◆ getParent()

getParent ( )

Get the parent of this node

Renvoie
Node The Node object's parent or null for no parent
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

◆ hasChildren()

hasChildren ( )

Test if this node has children

Renvoie
boolean
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références children.

◆ hasParent()

hasParent ( )

Test if this node has a parent

Renvoie
boolean True if there is a parent
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références parent.

◆ isRoot()

isRoot ( )

Check whether the object instance node is the root node

Renvoie
boolean
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

◆ removeChild()

removeChild ( Node  $child)

Remove a child from this node

If the child exists it is unset

Paramètres
Node$childThe child to be added
Renvoie
void
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $hash, children, et null.

Référencé par Node\addChild().

◆ setActive()

setActive (   $active)

Set the active state on or off

Paramètres
bool$activeThe new active state
Renvoie
void
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $active.

◆ setParams()

setParams ( Registry  $params)

set the params array

Paramètres
Registry$paramsThe params attributes
Renvoie
void
Depuis
3.8.0
Obsolète:
4.0 Use Joomla

Références $params.

Documentation des champs

◆ $active

$active = false
protected

◆ $children

$children = array()
protected

◆ $class

$class = null
protected

◆ $id

◆ $params

$params
protected

◆ $parent

$parent = null
protected

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