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

getChildNodes()

No description

overrideParentTreeNodePermissions()

No description

getTreeNodePermissionsNodeID()

No description

getTreeNodeChildCount()

No description

getChildNodesLoaded()

No description

transformNode($treeNodeType)

Transforms a node to another node.

getTreeNodeParentArray()

Returns an array of all parents of this tree node.

JsonResponse
selectChildrenNodesByID($nodeID, $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

duplicateChildren(Node $node)

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

rescanChildrenDisplayOrder()

No description

saveChildOrder($orderedIDs)

No description

static 
add($parent = false)

No description

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

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

No description

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

No description

static 
getNodesOfType($treeNodeTypeHandle)

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 38
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 39
abstract deleteDetails()

No description

at line 40
abstract getTreeNodeTypeName()

No description

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

No description

Parameters

$format

at line 59
getListFormatter()

No description

at line 64
getPermissionObjectIdentifier()

No description

at line 69
getTreeNodeID()

No description

at line 73
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 122
getTreeNodeTypeID()

No description

at line 126
getTreeNodeTypeObject()

No description

at line 135
getTreeNodeTypeHandle()

No description

at line 142
getChildNodes()

No description

at line 146
overrideParentTreeNodePermissions()

No description

at line 150
getTreeNodePermissionsNodeID()

No description

at line 155
getTreeNodeChildCount()

No description

at line 169
getChildNodesLoaded()

No description

at line 177
transformNode($treeNodeType)

Transforms a node to another node.

Parameters

$treeNodeType

at line 189
getTreeNodeParentArray()

Returns an array of all parents of this tree node.

at line 217
JsonResponse selectChildrenNodesByID($nodeID, $loadMissingChildren = false)

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

Parameters

$nodeID
  • nodeID of the children to be selected
$loadMissingChildren
  • if set to true, it will fetch, as needed, the children of the current node, that have not been loaded yet

Return Value

JsonResponse

at line 232
getTreeNodeMenu()

No description

at line 237
getJSONObject()

No description

at line 242
getTreeNodeJSON()

No description

at line 295
export(SimpleXMLElement $x)

No description

Parameters

SimpleXMLElement $x

at line 311
duplicate($parent = false)

No description

Parameters

$parent

at line 319
getTreeNodeDisplayPath()

No description

at line 337
protected duplicateChildren(Node $node)

No description

Parameters

Node $node

at line 348
setChildPermissionsToOverride()

No description

at line 356
setPermissionsToOverride()

No description

at line 361
setTreeNodePermissionsToGlobal()

No description

at line 382
setTreeNodePermissionsToOverride()

No description

at line 413
getAllChildNodeIDs()

No description

at line 429
setTreeNodeTreeID($treeID)

No description

Parameters

$treeID

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

Move this node under another node.

Parameters

Node $newParent

The new parent node

Exceptions

MoveException

Throws a MoveException in case of errors.

at line 498
updateDateModified()

Update the Date Modified to the current time

at line 504
protected rescanChildrenDisplayOrder()

No description

at line 516
saveChildOrder($orderedIDs)

No description

Parameters

$orderedIDs

at line 528
static add($parent = false)

No description

Parameters

$parent

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

No description

Parameters

SimpleXMLElement $sx
$parent

at line 576
importChildren(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 587
populateChildren()

No description

at line 595
populateDirectChildrenOnly()

No description

at line 620
delete()

No description

at line 658
static getByID($treeNodeID)

No description

Parameters

$treeNodeID

at line 686
exportTranslations(Translations $translations)

internal  
 

No description

Parameters

Translations $translations

at line 699
static getNodeByName($name)

No description

Parameters

$name

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

No description

Parameters

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

at line 745
getHierarchicalNodesOfType($treeNodeTypeHandle, $level = 1, $returnNodeObjects = false, $includeThisNode = true)

No description

Parameters

$treeNodeTypeHandle
$level
$returnNodeObjects
$includeThisNode

at line 755
static getNodesOfType($treeNodeTypeHandle)

No description

Parameters

$treeNodeTypeHandle