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

Traits

Properties

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

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

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

No description

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

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).

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

setPermissionsToOverride()

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

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

loadError($error)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

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

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

abstract loadDetails()

No description

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

abstract deleteDetails()

No description

abstract getTreeNodeTypeName()

No description

getTreeNodeTypeDisplayName($format = 'html')

No description

Parameters

$format

getListFormatter()

No description

getPermissionObjectIdentifier()

No description

getTreeNodeID()

No description

getTreeNodeParentID()

No description

getTreeNodeParentObject()

No description

setTree(Tree $tree)

No description

Parameters

Tree $tree

getDateLastModified()

No description

getDateCreated()

No description

getTreeObject()

No description

setTreeNodeName($treeNodeName)

No description

Parameters

$treeNodeName

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).

Return Value

Node[]

overrideParentTreeNodePermissions()

No description

getTreeNodePermissionsNodeID()

No description

getTreeNodeChildCount()

No description

getChildNodesLoaded()

No description

transformNode(mixed $treeNodeType)

Transforms a node to another node.

Parameters

mixed $treeNodeType

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.

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

getTreeNodeMenu()

No description

getJSONObject()

No description

getTreeNodeJSON()

No description

export(SimpleXMLElement $x)

No description

Parameters

SimpleXMLElement $x

duplicate($parent = false)

No description

Parameters

$parent

getTreeNodeDisplayPath()

No description

setChildPermissionsToOverride()

No description

setPermissionsToOverride()

No description

setTreeNodePermissionsToGlobal()

No description

setTreeNodePermissionsToOverride()

No description

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

getAllChildNodeIDs()

No description

setTreeNodeTreeID($treeID)

No description

Parameters

$treeID

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

move(Node $newParent)

Move this node under another node.

Parameters

Node $newParent

The new parent node

Exceptions

MoveException

updateDateModified()

Update the Date Modified to the current time.

saveChildOrder($orderedIDs)

No description

Parameters

$orderedIDs

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

Add a new node.

Parameters

Node|null|false $parent

the parent node

Return Value

Node

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

No description

Parameters

SimpleXMLElement $sx
$parent

importChildren(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

populateChildren()

No description

populateDirectChildrenOnly()

No description

delete()

No description

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

No description

Parameters

int|mixed $treeNodeID

Return Value

Node|null

exportTranslations(Translations $translations)

internal  
 

No description

Parameters

Translations $translations

static getNodeByName($name, $parentId = null)

No description

Parameters

$name
$parentId

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

No description

Parameters

$treeNodeTypeHandle
$level
$returnNodeObjects
$includeThisNode
$maxDepth

static getNodesOfType($treeNodeTypeHandle)

No description

Parameters

$treeNodeTypeHandle

protected duplicateChildren(Node $node)

No description

Parameters

Node $node

protected rescanChildrenDisplayOrder()

No description

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

No description

Parameters

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