class Category extends Node (View source)

Traits

Properties

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

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

from  Node
getListFormatter()

No description

from  Node
getTreeNodeID()

No description

from  Node
getTreeNodeParentID()

No description

from  Node
getTreeNodeParentObject()

No description

from  Node
setTree(Tree $tree)

No description

from  Node
getDateLastModified()

No description

from  Node
getDateCreated()

No description

from  Node
getTreeObject()

No description

from  Node
setTreeNodeName($treeNodeName)

No description

from  Node
getTreeNodeName()

No description

from  Node
getTreeID()

No description

from  Node
getTreeNodeTypeID()

No description

from  Node
getTreeNodeTypeObject()

No description

from  Node
getTreeNodeTypeHandle()

No description

from  Node
Node[]
getChildNodes()

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

from  Node
from  Node
getTreeNodePermissionsNodeID()

No description

from  Node
getTreeNodeChildCount()

No description

from  Node
getChildNodesLoaded()

No description

from  Node
transformNode(mixed $treeNodeType)

Transforms a node to another node.

from  Node
getTreeNodeParentArray()

Returns an array of all parents of this tree node.

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

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

from  Node
getTreeNodeMenu()

No description

getJSONObject()

No description

from  Node
getTreeNodeJSON()

No description

export(SimpleXMLElement $x)

No description

from  Node
duplicate($parent = false)

No description

getTreeNodeDisplayPath()

No description

from  Node
from  Node
setPermissionsToOverride()

No description

from  Node
from  Node
from  Node
getAllChildNodeIDs()

No description

from  Node
setTreeNodeTreeID($treeID)

No description

from  Node
checkMove(Node $newParent)

Check if this node can be moved under another parent.

from  Node
move(Node $newParent)

Move this node under another node.

from  Node
updateDateModified()

Update the Date Modified to the current time.

from  Node
saveChildOrder($orderedIDs)

No description

from  Node
static Node
add($treeNodeCategoryName = '', Node|null|false $parent = false)

Add a new node.

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

No description

importChildren(SimpleXMLElement $sx)

No description

from  Node
populateChildren()

No description

from  Node
populateDirectChildrenOnly()

No description

from  Node
delete()

No description

from  Node
static 
getByID($treeNodeID)

No description

from  Node
exportTranslations(Translations $translations)

No description

from  Node
static 
getNodeByName($name)

No description

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

No description

from  Node
static 
getNodesOfType($treeNodeTypeHandle)

No description

from  Node
duplicateChildren(Node $node)

No description

from  Node
rescanChildrenDisplayOrder()

No description

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

No description

from  Node

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

loadDetails()

No description

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

deleteDetails()

No description

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

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

throws a MoveException in case of errors

updateDateModified()

Update the Date Modified to the current time.

saveChildOrder($orderedIDs)

No description

Parameters

$orderedIDs

static Node add($treeNodeCategoryName = '', Node|null|false $parent = false)

Add a new node.

Parameters

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

No description

Parameters

$treeNodeID

exportTranslations(Translations $translations)

internal  
 

No description

Parameters

Translations $translations

static getNodeByName($name)

No description

Parameters

$name

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

getTreeNodeTranslationContext()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description