1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Tree
  7. \
  8. Node
  9. \
  10. Node

Node

abstract class Node extends ConcreteObject implements ObjectInterface, AssignableObjectInterface (View source)

Traits

AssignableObjectTrait

Properties

$error from  ConcreteObject
protected $childNodes
protected $childNodesLoaded
protected $treeNodeIsSelected
protected $tree

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

from  AssignableObjectTrait
loadDetails()

No description

string
getTreeNodeDisplayName(string $format = 'html')

Returns the display name for this tree node (localized and escaped accordingly to $format).

deleteDetails()

No description

getTreeNodeTypeName()

No description

getTreeNodeTypeDisplayName($format = 'html')

No description

getListFormatter()

No description

getPermissionObjectIdentifier()

No description

getTreeNodeID()

No description

getTreeNodeParentID()

No description

getTreeNodeParentObject()

No description

setTree(Tree $tree)

No description

getDateLastModified()

No description

getDateCreated()

No description

getTreeObject()

No description

setTreeNodeName($treeNodeName)

No description

getTreeNodeName()

No description

getTreeID()

No description

getTreeNodeTypeID()

No description

getTreeNodeTypeObject()

No description

getTreeNodeTypeHandle()

No description

Node[]
getChildNodes()

Return the list of child nodes (call populateDirectChildrenOnly() before calling this method).

overrideParentTreeNodePermissions()

No description

getTreeNodePermissionsNodeID()

No description

getTreeNodeChildCount()

No description

getChildNodesLoaded()

No description

transformNode(mixed $treeNodeType)

Transforms a node to another node.

getTreeNodeParentArray()

Returns an array of all parents of this tree node.

selectChildrenNodesByID(int $nodeID, bool $loadMissingChildren = false)

Recursively searches for a children node and marks it as selected.

getTreeNodeMenu()

No description

getJSONObject()

No description

getTreeNodeJSON()

No description

export(SimpleXMLElement $x)

No description

duplicate($parent = false)

No description

getTreeNodeDisplayPath()

No description

setChildPermissionsToOverride()

No description

setPermissionsToOverride()

No description

setTreeNodePermissionsToGlobal()

No description

setTreeNodePermissionsToOverride()

No description

updateTreeNodePermissionsID(array $treeNodeParentIDs, int $newPermissionsTreeNodeID)

Set the child nodes of a list of tree nodes to inherit permissions from the specified tree node ID (provided that they previously had the same inheritance ID as this node).

getAllChildNodeIDs()

No description

setTreeNodeTreeID($treeID)

No description

MoveException|null
checkMove(Node $newParent)

Check if this node can be moved under another parent.

move(Node $newParent)

Move this node under another node.

updateDateModified()

Update the Date Modified to the current time.

saveChildOrder($orderedIDs)

No description

static Node
add(Node|null|false $parent = false)

Add a new node.

static 
importNode(SimpleXMLElement $sx, $parent = false)

No description

importChildren(SimpleXMLElement $sx)

No description

populateChildren()

No description

populateDirectChildrenOnly()

No description

delete()

No description

static Node|null
getByID(int|mixed $treeNodeID)

No description

exportTranslations(Translations $translations)

No description

static 
getNodeByName($name, $parentId = null)

No description

getHierarchicalNodesOfType($treeNodeTypeHandle, $level = 1, $returnNodeObjects = false, $includeThisNode = true, $maxDepth = null)

No description

static 
getNodesOfType($treeNodeTypeHandle)

No description

duplicateChildren(Node $node)

No description

rescanChildrenDisplayOrder()

No description

populateRecursiveNodes($treeNodeTypeID, $nodes, $nodeRow, $level, $returnNodeObjects = false, $includeThisNode = true, $maxDepth = null)

No description

Details

in ConcreteObject at line 11
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 16
isError()

No description

in ConcreteObject at line 26
getError()

No description

in ConcreteObject at line 31
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 38
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 43
static uncamelcase($string)

No description

Parameters

$string

in AssignableObjectTrait at line 14
assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

at line 30
abstract loadDetails()

No description

at line 39
abstract string getTreeNodeDisplayName(string $format = 'html')

Returns the display name for this tree node (localized and escaped accordingly to $format).

Parameters

string $format

= 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

at line 41
abstract deleteDetails()

No description

at line 43
abstract getTreeNodeTypeName()

No description

at line 45
getTreeNodeTypeDisplayName($format = 'html')

No description

Parameters

$format

at line 57
getListFormatter()

No description

at line 62
getPermissionObjectIdentifier()

No description

at line 67
getTreeNodeID()

No description

at line 72
getTreeNodeParentID()

No description

at line 77
getTreeNodeParentObject()

No description

at line 82
setTree(Tree $tree)

No description

Parameters

Tree $tree

at line 87
getDateLastModified()

No description

at line 92
getDateCreated()

No description

at line 97
getTreeObject()

No description

at line 106
setTreeNodeName($treeNodeName)

No description

Parameters

$treeNodeName

at line 113
getTreeNodeName()

No description

at line 118
getTreeID()

No description

at line 123
getTreeNodeTypeID()

No description

at line 128
getTreeNodeTypeObject()

No description

at line 137
getTreeNodeTypeHandle()

No description

at line 150
Node[] getChildNodes()

Return the list of child nodes (call populateDirectChildrenOnly() before calling this method).

Return Value

Node[]

at line 155
overrideParentTreeNodePermissions()

No description

at line 160
getTreeNodePermissionsNodeID()

No description

at line 165
getTreeNodeChildCount()

No description

at line 178
getChildNodesLoaded()

No description

at line 188
transformNode(mixed $treeNodeType)

Transforms a node to another node.

Parameters

mixed $treeNodeType

at line 200
getTreeNodeParentArray()

Returns an array of all parents of this tree node.

at line 225
selectChildrenNodesByID(int $nodeID, bool $loadMissingChildren = false)

Recursively searches for a children node and marks it as selected.

Parameters

int $nodeID

ID of the children to be selected
bool $loadMissingChildren

if set to true, it will fetch, as needed, the children of the current node, that have not been loaded yet

at line 240
getTreeNodeMenu()

No description

at line 245
getJSONObject()

No description

at line 250
getTreeNodeJSON()

No description

at line 303
export(SimpleXMLElement $x)

No description

Parameters

SimpleXMLElement $x

at line 319
duplicate($parent = false)

No description

Parameters

$parent

at line 327
getTreeNodeDisplayPath()

No description

at line 345
setChildPermissionsToOverride()

No description

at line 353
setPermissionsToOverride()

No description

at line 358
setTreeNodePermissionsToGlobal()

No description

at line 376
setTreeNodePermissionsToOverride()

No description

at line 408
protected updateTreeNodePermissionsID(array $treeNodeParentIDs, int $newPermissionsTreeNodeID)

Set the child nodes of a list of tree nodes to inherit permissions from the specified tree node ID (provided that they previously had the same inheritance ID as this node).

Parameters

array $treeNodeParentIDs

An array of tree node parent IDs to check
int $newPermissionsTreeNodeID

the ID of the new tree node the nodes should inherit permissions from

at line 439
getAllChildNodeIDs()

No description

at line 455
setTreeNodeTreeID($treeID)

No description

Parameters

$treeID

at line 469
MoveException|null checkMove(Node $newParent)

Check if this node can be moved under another parent.

Parameters

Node $newParent

the new parent node

Return Value

MoveException|null

return a MoveException in case of problems, null in case of success

at line 495
move(Node $newParent)

Move this node under another node.

Parameters

Node $newParent

The new parent node

Exceptions

MoveException

at line 537
updateDateModified()

Update the Date Modified to the current time.

at line 544
saveChildOrder($orderedIDs)

No description

Parameters

$orderedIDs

at line 563
static Node add(Node|null|false $parent = false)

Add a new node.

Parameters

Node|null|false $parent

the parent node

Return Value

Node

at line 612
static importNode(SimpleXMLElement $sx, $parent = false)

No description

Parameters

SimpleXMLElement $sx
$parent

at line 617
importChildren(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 628
populateChildren()

No description

at line 636
populateDirectChildrenOnly()

No description

at line 661
delete()

No description

at line 704
static Node|null getByID(int|mixed $treeNodeID)

No description

Parameters

int|mixed $treeNodeID

Return Value

Node|null

at line 740
exportTranslations(Translations $translations)

internal  
 

No description

Parameters

Translations $translations

at line 753
static getNodeByName($name, $parentId = null)

No description

Parameters

$name
$parentId

at line 774
getHierarchicalNodesOfType($treeNodeTypeHandle, $level = 1, $returnNodeObjects = false, $includeThisNode = true, $maxDepth = null)

No description

Parameters

$treeNodeTypeHandle
$level
$returnNodeObjects
$includeThisNode
$maxDepth

at line 783
static getNodesOfType($treeNodeTypeHandle)

No description

Parameters

$treeNodeTypeHandle

at line 805
protected duplicateChildren(Node $node)

No description

Parameters

Node $node

at line 816
protected rescanChildrenDisplayOrder()

No description

at line 828
protected populateRecursiveNodes($treeNodeTypeID, $nodes, $nodeRow, $level, $returnNodeObjects = false, $includeThisNode = true, $maxDepth = null)

No description

Parameters

$treeNodeTypeID
$nodes
$nodeRow
$level
$returnNodeObjects
$includeThisNode
$maxDepth