Docs For Class JMenuNode

Description

A Node for JAdminCssMenu

see: JAdminCssMenu
since: 1.5

Located in /administrator/modules/mod_menu/menu.php (line 318)

JObject
   |
   --JMenuNode

Variable Summary

boolean $active

string $class

string $id

string $link

string $target

string $title

array $_children

JMenuNode $_parent

Method Summary

JMenuNode __construct (string $title, [string $link = null], [string $class = null], [boolean $active = false], [string $target = null], [string $titleicon = null])

void addChild (JMenuNode &$child)

array &getChildren ()

mixed &getParent ()

boolean hasChildren ()

boolean hasParent ()

void setParent ([JMenuNode &$parent = null])

Variables

boolean $active = false (line 360)

Active Node?

access: public

string $class = null (line 353)

CSS Class for node

access: public

string $id = null (line 332)

Node Id

access: public

string $link = null (line 339)

Node Link

access: public

string $target = null (line 346)

Link Target

access: public

string $title = null (line 325)

Node Title

access: public

array $_children = array() (line 374)

Array of Children

access: protected

JMenuNode $_parent = null (line 367)

Parent node

access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 386)

Constructor for the class.

access: public

JMenuNode __construct (string $title, [string $link = null], [string $class = null], [boolean $active = false], [string $target = null], [string $titleicon = null])

string $title: The title of the node
string $link: The node link
string $class: The CSS class for the node
boolean $active: True if node is active, false otherwise
string $target: The link target
string $titleicon: The title icon for the node

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

addChild (line 421)

Add child to this node

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

access: public

void addChild (JMenuNode &$child)

JMenuNode &$child: The child to be added

getChildren (line 457)

Get the children of this node

return: The children
access: public

array &getChildren ()

getParent (line 467)

Get the parent of this node

return: JMenuNode object with the parent or null for no parent
access: public

mixed &getParent ()

hasChildren (line 477)

Test if this node has children

return: True if there are children
access: public

boolean hasChildren ()

hasParent (line 487)

Test if this node has a parent

return: True if there is a parent
access: public

boolean hasParent ()

setParent (line 435)

Set the parent of a this node

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

access: public

void setParent ([JMenuNode &$parent = null])

JMenuNode &$parent: The JMenuNode for parent to be set or null

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()