Node

A Node for MenuTree

see \Joomla\CMS\Menu\Tree
since

3.8.0

Methods

__construct

Constructor

__construct() 
since

3.8.0

addChild

Add child to this node

addChild(\Joomla\CMS\Menu\Node $child) : \Joomla\CMS\Menu\Node

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

since

3.8.0

Arguments

$child

\Joomla\CMS\Menu\NodeThe child to be added

Response

\Joomla\CMS\Menu\NodeThe new added child

get

Get an attribute value

get(string $name) : mixed
since

3.8.0

Arguments

$name

stringThe attribute name

Response

mixed

getChildren

Get the children of this node

getChildren() : array<mixed,\Joomla\CMS\Menu\Node>
since

3.8.0

Response

array<mixed,\Joomla\CMS\Menu\Node>The children

getLevel

Find the current node depth in the tree hierarchy

getLevel() : integer
since

3.8.0

Response

integerThe node level in the hierarchy, where ROOT == 0, First level menu item == 1, and so on.

getParam

Get the param value from the node params

getParam(string $key) : mixed
since

3.8.0

Arguments

$key

stringThe param name

Response

mixed

getParent

Get the parent of this node

getParent() : \Joomla\CMS\Menu\Node
since

3.8.0

Response

\Joomla\CMS\Menu\NodeThe Node object's parent or null for no parent

hasChildren

Test if this node has children

hasChildren() : boolean
since

3.8.0

Response

boolean

hasParent

Test if this node has a parent

hasParent() : boolean
since

3.8.0

Response

booleanTrue if there is a parent

isRoot

Check whether the object instance node is the root node

isRoot() : boolean
since

3.8.0

Response

boolean

removeChild

Remove a child from this node

removeChild(\Joomla\CMS\Menu\Node $child) : void

If the child exists it is unset

since

3.8.0

Arguments

$child

\Joomla\CMS\Menu\NodeThe child to be added

setActive

Set the active state on or off

setActive(boolean $active) : void
since

3.8.0

Arguments

$active

booleanThe new active state

setParams

set the params array

setParams(\Joomla\Registry\Registry $params) : void
since

3.8.0

Arguments

$params

\Joomla\Registry\RegistryThe params attributes

Properties

id

Node Id

since

3.8.0

Type(s)

string

class

CSS Class for node

since

3.8.0

Type(s)

string

active

Whether this node is active

since

3.8.0

Type(s)

boolean

params

Additional custom node params

since

3.8.0

Type(s)

\Joomla\Registry\Registry

parent

Parent node object

since

3.8.0

Type(s)

\Joomla\CMS\Menu\Node

children

Array of Children node objects

since

3.8.0

Type(s)

array<mixed,\Joomla\CMS\Menu\Node>