1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Tree
  7. \
  8. Node
  9. \
  10. Type
  11. \
  12. FileFolder

FileFolder

class FileFolder extends Category (View source)

Traits

AssignableObjectTrait

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

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

from Category
string
getTreeNodeDisplayName(string $format = 'html')

Returns the display name for this tree node (localized and escaped accordingly to $format).

from Category
deleteDetails()

No description

from Category
getTreeNodeTypeName()

No description

getTreeNodeTypeDisplayName($format = 'html')

No description

from Node
getListFormatter()

No description

from Category
getPermissionObjectIdentifier()

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

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
overrideParentTreeNodePermissions()

No description

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

from Category
getTreeNodeDisplayPath()

No description

from Node
setChildPermissionsToOverride()

No description

from Node
setPermissionsToOverride()

No description

from Node
setTreeNodePermissionsToGlobal()

No description

from Node
setTreeNodePermissionsToOverride()

No description

from Node
getAllChildNodeIDs()

No description

from Node
setTreeNodeTreeID($treeID)

No description

from Node
MoveException|null
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.

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

No description

from Category
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

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
getTreeNodeTranslationContext()

No description

from Category
getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

getFolderItemList(User $u = null, Request $request)

No description

FileFolder|null
getChildFolderByName(string $name, bool $create = false)

Get the first child folder this folder that has a specific name.

FileFolder|null
getChildFolderByPath(array $names, bool $create = false)

Get a descendent folder of this folder given its path.

Details

in ConcreteObject at line 10
loadError($error)

Parameters

$error

in ConcreteObject at line 15
isError()

in ConcreteObject at line 25
getError()

in ConcreteObject at line 30
setPropertiesFromArray($arr)

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

Parameters

$file

in ConcreteObject at line 42
static uncamelcase($string)

Parameters

$string

in AssignableObjectTrait at line 14
assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

in Category at line 57
loadDetails()

in Category at line 41
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

in Category at line 62
deleteDetails()

at line 29
getTreeNodeTypeName()

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

Parameters

$format

in Category at line 95
getListFormatter()

in Node at line 63
getPermissionObjectIdentifier()

in Node at line 68
getTreeNodeID()

in Node at line 73
getTreeNodeParentID()

in Node at line 78
getTreeNodeParentObject()

in Node at line 83
setTree(Tree $tree)

Parameters

Tree $tree

in Node at line 88
getDateLastModified()

in Node at line 93
getDateCreated()

in Node at line 98
getTreeObject()

in Node at line 107
setTreeNodeName($treeNodeName)

Parameters

$treeNodeName

at line 50
getTreeNodeName()

in Node at line 119
getTreeID()

in Node at line 124
getTreeNodeTypeID()

in Node at line 129
getTreeNodeTypeObject()

in Node at line 138
getTreeNodeTypeHandle()

in Node at line 151
Node[] getChildNodes()

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

Return Value

Node[]

in Node at line 156
overrideParentTreeNodePermissions()

in Node at line 161
getTreeNodePermissionsNodeID()

in Node at line 166
getTreeNodeChildCount()

in Node at line 179
getChildNodesLoaded()

in Node at line 189
transformNode(mixed $treeNodeType)

Transforms a node to another node.

Parameters

mixed $treeNodeType

in Node at line 201
getTreeNodeParentArray()

Returns an array of all parents of this tree node.

in 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 34
getTreeNodeMenu()

in Node at line 246
getJSONObject()

at line 39
getTreeNodeJSON()

in Node at line 304
export(SimpleXMLElement $x)

Parameters

SimpleXMLElement $x

in Category at line 67
duplicate($parent = false)

Parameters

$parent

in Node at line 328
getTreeNodeDisplayPath()

in Node at line 346
setChildPermissionsToOverride()

in Node at line 354
setPermissionsToOverride()

in Node at line 359
setTreeNodePermissionsToGlobal()

in Node at line 380
setTreeNodePermissionsToOverride()

in Node at line 411
getAllChildNodeIDs()

in Node at line 427
setTreeNodeTreeID($treeID)

Parameters

$treeID

in Node 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

in Node at line 467
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

in Node at line 495
updateDateModified()

Update the Date Modified to the current time.

in Node at line 502
saveChildOrder($orderedIDs)

Parameters

$orderedIDs

in Category at line 100
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

in Category at line 108
static importNode(SimpleXMLElement $sx, $parent = false)

Parameters

SimpleXMLElement $sx
$parent

in Node at line 575
importChildren(SimpleXMLElement $sx)

Parameters

SimpleXMLElement $sx

in Node at line 586
populateChildren()

in Node at line 594
populateDirectChildrenOnly()

in Node at line 619
delete()

in Node at line 656
static getByID($treeNodeID)

Parameters

$treeNodeID

at line 142
exportTranslations(Translations $translations)

Parameters

Translations $translations

in Node at line 698
static getNodeByName($name)

Parameters

$name

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

Parameters

$treeNodeTypeHandle
$level
$returnNodeObjects
$includeThisNode
$maxDepth

in Node at line 721
static getNodesOfType($treeNodeTypeHandle)

Parameters

$treeNodeTypeHandle

in Node at line 743
protected duplicateChildren(Node $node)

Parameters

Node $node

in Node at line 754
protected rescanChildrenDisplayOrder()

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

Parameters

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

in Category at line 11
getTreeNodeTranslationContext()

at line 14
getPermissionResponseClassName()

at line 19
getPermissionAssignmentClassName()

at line 24
getPermissionObjectKeyCategoryHandle()

at line 59
getFolderItemList(User $u = null, Request $request)

Parameters

User $u
Request $request

at line 96
FileFolder|null getChildFolderByName(string $name, bool $create = false)

Get the first child folder this folder that has a specific name.

Parameters

string $name The name of the child folder
bool $create Should the child folder be created if it does not exist?

Return Value

FileFolder|null return NULL if no child folder has the specified name and $create is false

at line 127
FileFolder|null getChildFolderByPath(array $names, bool $create = false)

Get a descendent folder of this folder given its path.

Parameters

array $names The names of the child folders (1st item: child folder, 2nd item: grand-child folder, ...)
bool $create Should the descendent folders be created if they don't exist?

Return Value

FileFolder|null return NULL if the descendent folder has not been found and $create is false