Node
abstract class Node extends ConcreteObject implements ObjectInterface, AssignableObjectInterface (View source)
Traits
Properties
$error | from ConcreteObject | ||
protected | $childNodes | ||
protected | $childNodesLoaded | ||
protected | $treeNodeIsSelected | ||
protected | $tree |
Methods
No description
No description
Returns the display name for this tree node (localized and escaped accordingly to $format).
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Return the list of child nodes (call populateDirectChildrenOnly() before calling this method).
No description
No description
No description
No description
Transforms a node to another node.
Returns an array of all parents of this tree node.
Recursively searches for a children node and marks it as selected.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Update the Date Modified to the current time.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
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
abstract
loadDetails()
No description
abstract string
getTreeNodeDisplayName(string $format = 'html')
Returns the display name for this tree node (localized and escaped accordingly to $format).
abstract
deleteDetails()
No description
abstract
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
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)
internal |
No description
static
getNodeByName($name)
No description
getHierarchicalNodesOfType($treeNodeTypeHandle, $level = 1, $returnNodeObjects = false, $includeThisNode = true, $maxDepth = null)
No description
static
getNodesOfType($treeNodeTypeHandle)
No description
protected
duplicateChildren(Node $node)
No description
protected
rescanChildrenDisplayOrder()
No description
protected
populateRecursiveNodes($treeNodeTypeID, $nodes, $nodeRow, $level, $returnNodeObjects = false, $includeThisNode = true, $maxDepth = null)
No description