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

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 
getByID($treeNodeID)

No description

exportTranslations(Translations $translations)

No description

static 
getNodeByName($name)

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 10
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 15
isError()

No description

in ConcreteObject at line 25
getError()

No description

in ConcreteObject at line 30
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 42
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 31
abstract loadDetails()

No description

at line 40
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 42
abstract deleteDetails()

No description

at line 44
abstract getTreeNodeTypeName()

No description

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

No description

Parameters

$format

at line 58
getListFormatter()

No description

at line 63
getPermissionObjectIdentifier()

No description

at line 68
getTreeNodeID()

No description

at line 73
getTreeNodeParentID()

No description

at line 78
getTreeNodeParentObject()

No description

at line 83
setTree(Tree $tree)

No description

Parameters

Tree $tree

at line 88
getDateLastModified()

No description

at line 93
getDateCreated()

No description

at line 98
getTreeObject()

No description

at line 107
setTreeNodeName($treeNodeName)

No description

Parameters

$treeNodeName

at line 114
getTreeNodeName()

No description

at line 119
getTreeID()

No description

at line 124
getTreeNodeTypeID()

No description

at line 129
getTreeNodeTypeObject()

No description

at line 138
getTreeNodeTypeHandle()

No description

at line 151
Node[] getChildNodes()

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

Return Value

Node[]

at line 156
overrideParentTreeNodePermissions()

No description

at line 161
getTreeNodePermissionsNodeID()

No description

at line 166
getTreeNodeChildCount()

No description

at line 179
getChildNodesLoaded()

No description

at line 189
transformNode(mixed $treeNodeType)

Transforms a node to another node.

Parameters

mixed $treeNodeType

at line 201
getTreeNodeParentArray()

Returns an array of all parents of this tree node.

at line 226
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 241
getTreeNodeMenu()

No description

at line 246
getJSONObject()

No description

at line 251
getTreeNodeJSON()

No description

at line 304
export(SimpleXMLElement $x)

No description

Parameters

SimpleXMLElement $x

at line 320
duplicate($parent = false)

No description

Parameters

$parent

at line 328
getTreeNodeDisplayPath()

No description

at line 346
setChildPermissionsToOverride()

No description

at line 354
setPermissionsToOverride()

No description

at line 359
setTreeNodePermissionsToGlobal()

No description

at line 380
setTreeNodePermissionsToOverride()

No description

at line 411
getAllChildNodeIDs()

No description

at line 427
setTreeNodeTreeID($treeID)

No description

Parameters

$treeID

at line 441
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 467
move(Node $newParent)

Move this node under another node.

Parameters

Node $newParent

The new parent node

Exceptions

MoveException

at line 503
updateDateModified()

Update the Date Modified to the current time.

at line 510
saveChildOrder($orderedIDs)

No description

Parameters

$orderedIDs

at line 529
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 578
static importNode(SimpleXMLElement $sx, $parent = false)

No description

Parameters

SimpleXMLElement $sx
$parent

at line 583
importChildren(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 594
populateChildren()

No description

at line 602
populateDirectChildrenOnly()

No description

at line 627
delete()

No description

at line 665
static getByID($treeNodeID)

No description

Parameters

$treeNodeID

at line 694
exportTranslations(Translations $translations)

internal  
 

No description

Parameters

Translations $translations

at line 707
static getNodeByName($name)

No description

Parameters

$name

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

No description

Parameters

$treeNodeTypeHandle
$level
$returnNodeObjects
$includeThisNode
$maxDepth

at line 730
static getNodesOfType($treeNodeTypeHandle)

No description

Parameters

$treeNodeTypeHandle

at line 752
protected duplicateChildren(Node $node)

No description

Parameters

Node $node

at line 763
protected rescanChildrenDisplayOrder()

No description

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

No description

Parameters

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