ilTreeImplementation Interface Reference

Interface for tree implementations Currrently nested set or materialized path. More...

Inheritance diagram for ilTreeImplementation:

Collaboration diagram for ilTreeImplementation:

Public Member Functions
	getSubTreeIds (int $a_node_id)
	Get subtree ids for a specific node. More...
	getSubTreeQuery (array $a_node, array $a_types=[], bool $a_force_join_reference=true, array $a_fields=[])
	Get subtree query. More...
	getTrashSubTreeQuery (array $a_node, array $a_types, bool $a_force_join_reference=true, array $a_fields=[])
	Get subtree query for trashed tree items. More...
	getRelation (array $a_node_a, array $a_node_b)
	Get relation of two nodes. More...
	getPathIds (int $a_endnode, int $a_startnode=0)
	Get path ids from a startnode to a given endnode. More...
	insertNode (int $a_node_id, int $a_parent_id, int $a_pos)
	deleteTree (int $a_node_id)
	Delete tree. More...
	moveToTrash (int $a_node_id)
	Move subtree to trash. More...
	moveTree (int $a_source_id, int $a_target_id, int $a_position)
	Move a source subtree to target. More...
	getSubtreeInfo (int $a_endnode_id)
	Get subtree info lft, rgt, path, child, type. More...
	validateParentRelations ()
	Validate the parent relations of the tree implementation For nested set, validate the lft, rgt against child <-> parent For materialized path validate path against child <-> parent. More...

Detailed Description

Interface for tree implementations Currrently nested set or materialized path.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 12 of file interface.ilTreeImplementation.php.

Member Function Documentation

deleteTree()

ilTreeImplementation::deleteTree

(

int

$a_node_id

)

Delete tree.

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

getPathIds()

ilTreeImplementation::getPathIds	(	int	$a_endnode,
		int	$a_startnode = 0
	)

Get path ids from a startnode to a given endnode.

Parameters

int	$a_endnode
int	$a_startnode

Returns

int[]

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

getRelation()

ilTreeImplementation::getRelation	(	array	$a_node_a,
		array	$a_node_b
	)

Get relation of two nodes.

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

getSubTreeIds()

ilTreeImplementation::getSubTreeIds

(

int

$a_node_id

)

Get subtree ids for a specific node.

Returns

array node_ids

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

getSubtreeInfo()

ilTreeImplementation::getSubtreeInfo

(

int

$a_endnode_id

)

Get subtree info lft, rgt, path, child, type.

Returns

array

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

getSubTreeQuery()

ilTreeImplementation::getSubTreeQuery	(	array	$a_node,
		array	$a_types = [],
		bool	$a_force_join_reference = true,
		array	$a_fields = []
	)

Get subtree query.

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

getTrashSubTreeQuery()

ilTreeImplementation::getTrashSubTreeQuery	(	array	$a_node,
		array	$a_types,
		bool	$a_force_join_reference = true,
		array	$a_fields = []
	)

Get subtree query for trashed tree items.

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

insertNode()

ilTreeImplementation::insertNode	(	int	$a_node_id,
		int	$a_parent_id,
		int	$a_pos
	)

Exceptions

ilInvalidTreeStructureException

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

moveToTrash()

ilTreeImplementation::moveToTrash

(

int

$a_node_id

)

Move subtree to trash.

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

moveTree()

ilTreeImplementation::moveTree	(	int	$a_source_id,
		int	$a_target_id,
		int	$a_position
	)

Move a source subtree to target.

Exceptions

InvalidArgumentException

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

validateParentRelations()

ilTreeImplementation::validateParentRelations

(

)

Validate the parent relations of the tree implementation For nested set, validate the lft, rgt against child <-> parent For materialized path validate path against child <-> parent.

Returns

int[] array of failure nodes

Implemented in ilMaterializedPathTree, and ilNestedSetTree.

---

The documentation for this interface was generated from the following file:

• Services/Tree/interfaces/interface.ilTreeImplementation.php