TreeTrait
Table of Contents
Methods
- deleteTreeNode() : Result
- insertTreeNode() : Result
- moveSubtree() : Result
- moveSubtreeTo() : Result
- moveTreeNode() : Result
- reorderChildren() : Result
Methods
deleteTreeNode()
public
deleteTreeNode(int $id, TreeConfig $config) : Result
Parameters
- $id : int
- $config : TreeConfig
Return values
ResultinsertTreeNode()
public
insertTreeNode(int $id, TreeConfig $config) : Result
Parameters
- $id : int
- $config : TreeConfig
Return values
ResultmoveSubtree()
public
moveSubtree(int $id, int|null $newParentId, TreeConfig $config) : Result
Parameters
- $id : int
- $newParentId : int|null
-
null moves to the root level
- $config : TreeConfig
Return values
ResultmoveSubtreeTo()
public
moveSubtreeTo(int $id, int|null $newParentId, int $afterId, TreeConfig $config[, TreeMoveExpectation|null $expectation = null ]) : Result
Parameters
- $id : int
- $newParentId : int|null
-
null is the root level
- $afterId : int
-
-1 first child, 0 last child, >0 after that sibling
- $config : TreeConfig
- $expectation : TreeMoveExpectation|null = null
-
expected state of the move (null skips the check)
Return values
ResultmoveTreeNode()
public
moveTreeNode(int $id, int $direction, TreeConfig $config) : Result
Parameters
- $id : int
- $direction : int
- $config : TreeConfig
Return values
ResultreorderChildren()
public
reorderChildren(int|null $parentId, array<int, int> $orderedIds, TreeConfig $config) : Result
Parameters
- $parentId : int|null
-
null is the root level
- $orderedIds : array<int, int>
-
child ids in the new order
- $config : TreeConfig