CSHierarchyNode
in package
Hierarchy node class
Tags
Table of Contents
- __construct() : void
- Creates a hierarchy node
- addSubnode() : void
- Adds a sub node to this hierarchy node
- getObjectId() : int
- Returns the object id mapped to this node.
- getSubnodes() : array<string|int, mixed>
- Returns all sub nodes of the current hierarchy node
- getTemplateId() : int
- Returns the template id mapped to this node.
Methods
__construct()
Creates a hierarchy node
public
__construct(int $iTemplateId, int $iObjectId[, bool $bRecursive = false ]) : void
Parameters
- $iTemplateId : int
-
The template id mapped to this hierarchy node
- $iObjectId : int
-
The object id mapped to this hierarchy node
- $bRecursive : bool = false
-
Defines whether this hierarchy node is recursive
Tags
Return values
void —addSubnode()
Adds a sub node to this hierarchy node
public
addSubnode(CSHierarchyNode $oNode) : void
Parameters
- $oNode : CSHierarchyNode
-
The hierarchy node to add as sub node
Tags
Return values
void —getObjectId()
Returns the object id mapped to this node.
public
getObjectId() : int
Tags
Return values
int —Mapped object id
getSubnodes()
Returns all sub nodes of the current hierarchy node
public
getSubnodes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —List of sub nodes
getTemplateId()
Returns the template id mapped to this node.
public
getTemplateId() : int
Tags
Return values
int —Mapped template id