ilTree Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTree:

Collaboration diagram for ilTree:

Public Member Functions
	__construct (int $a_tree_id, int $a_root_id=0, ilDBInterface $db=null)
	initTreeImplementation ()
	Init tree implementation. More...
	getTreeImplementation ()
	Get tree implementation. More...
	useCache (bool $a_use=true)
	Use Cache (usually activated) More...
	isCacheUsed ()
	Check if cache is active. More...
	getDepthCache ()
	Get depth cache. More...
	getParentCache ()
	Get parent cache. More...
	initLangCode ()
	Do not use it Store user language. More...
	getTreeTable ()
	Get tree table name. More...
	getObjectDataTable ()
	Get object data table. More...
	getTreePk ()
	Get tree primary key. More...
	getTableReference ()
	Get reference table if available. More...
	getGap ()
	Get default gap. More...
	resetInTreeCache ()
	reset in tree cache More...
	setTableNames (string $a_table_tree, string $a_table_obj_data, string $a_table_obj_reference="")
	set table names The primary key of the table containing your object_data must be 'obj_id' You may use a reference table. More...
	setReferenceTablePK (string $a_column_name)
	set column containing primary key in reference table More...
	setObjectTablePK (string $a_column_name)
	set column containing primary key in object table More...
	setTreeTablePK (string $a_column_name)
	set column containing primary key in tree table More...
	buildJoin ()
	build join depending on table settings private More...
	getRelation (int $a_node_a, int $a_node_b)
	Get relation of two nodes. More...
	getRelationOfNodes (array $a_node_a_arr, array $a_node_b_arr)
	get relation of two nodes by node data More...
	getChildIds (int $a_node)
	getChilds (int $a_node_id, string $a_order="", string $a_direction="ASC")
	get child nodes of given node More...
	getFilteredChilds (array $a_filter, int $a_node, string $a_order="", string $a_direction="ASC")
	get child nodes of given node (exclude filtered obj_types) More...
	getChildsByType (int $a_node_id, string $a_type)
	get child nodes of given node by object type More...
	getChildsByTypeFilter (int $a_node_id, array $a_types, string $a_order="", string $a_direction="ASC")
	get child nodes of given node by object type More...
	insertNodeFromTrash (int $a_source_id, int $a_target_id, int $a_tree_id, int $a_pos=self::POS_LAST_NODE, bool $a_reset_deleted_date=false)
	Insert node from trash deletes trash entry. More...
	insertNode (int $a_node_id, int $a_parent_id, int $a_pos=self::POS_LAST_NODE, bool $a_reset_deletion_date=false)
	insert new node with node_id under parent node with parent_id More...
	getFilteredSubTree (int $a_node_id, array $a_filter=[])
	get filtered subtree get all subtree nodes beginning at a specific node excluding specific object types and their child nodes. More...
	getSubTreeIds (int $a_ref_id)
	Get all ids of subnodes. More...
	getSubTree (array $a_node, bool $a_with_data=true, array $a_type=[])
	get all nodes in the subtree under specified node More...
	deleteTree (array $a_node)
	delete node and the whole subtree under this node More...
	validateParentRelations ()
	Validate parent relations of tree. More...
	getPathFull (int $a_endnode_id, int $a_startnode_id=0)
	get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode. More...
	preloadDepthParent (array $a_node_ids)
	Preload depth/parent. More...
	getPathId (int $a_endnode_id, int $a_startnode_id=0)
	get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode More...
	getNodePath (int $a_endnode_id, int $a_startnode_id=0)
	Returns the node path for the specified object reference. More...
	checkTree ()
	check consistence of tree all left & right values are checked if they are exists only once More...
	checkTreeChilds (bool $a_no_zero_child=true)
	check, if all childs of tree nodes exist in object table More...
	getMaximumDepth ()
	Return the current maximum depth in the tree. More...
	getDepth (int $a_node_id)
	return depth of a node in tree More...
	getNodeTreeData (int $a_node_id)
	return all columns of tabel tree More...
	getNodeData (int $a_node_id, ?int $a_tree_pk=null)
	get all information of a node. More...
	fetchNodeData (array $a_row)
	get data of parent node from tree and object_data More...
	isInTree (?int $a_node_id)
	get all information of a node. More...
	getParentNodeData (int $a_node_id)
	get data of parent node from tree and object_data More...
	isGrandChild (int $a_startnode_id, int $a_querynode_id)
	checks if a node is in the path of an other node More...
	addTree (int $a_tree_id, int $a_node_id=-1)
	create a new tree to do: ??? More...
	removeTree (int $a_tree_id)
	remove an existing tree More...
	moveToTrash (int $a_node_id, bool $a_set_deleted=false, int $a_deleted_by=0)
	Move node to trash bin. More...
	isDeleted (int $a_node_id)
	This is a wrapper for isSaved() with a more useful name. More...
	isSaved (int $a_node_id)
	Use method isDeleted. More...
	preloadDeleted (array $a_node_ids)
	Preload deleted information. More...
	getSavedNodeData (int $a_parent_id)
	get data saved/deleted nodes More...
	getSavedNodeObjIds (array $a_obj_ids)
	get object id of saved/deleted nodes More...
	getParentId (int $a_node_id)
	get parent id of given node More...
	getLeftValue (int $a_node_id)
	get left value of given node More...
	getChildSequenceNumber (array $a_node, string $type="")
	get sequence number of node in sibling sequence More...
	readRootId ()
	getRootId ()
	setRootId (int $a_root_id)
	getTreeId ()
	setTreeId (int $a_tree_id)
	fetchSuccessorNode (int $a_node_id, string $a_type="")
	get node data of successor node More...
	fetchPredecessorNode (int $a_node_id, string $a_type="")
	get node data of predecessor node More...
	renumber (int $node_id=1, int $i=1)
	Wrapper for renumber. More...
	checkForParentType (int $a_ref_id, string $a_type, bool $a_exclude_source_check=false)
	Check for parent type e.g check if a folder (ref_id 3) is in a parent course obj => checkForParentType(3,'crs');. More...
	__isMainTree ()
	Check if operations are done on main tree. More...
	__checkDelete (array $a_node)
	Check for deleteTree() compares a subtree of a given node by checking lft, rgt against parent relation. More...
	__getSubTreeByParentRelation (int $a_node_id, array &$parent_childs)
	__validateSubtrees (array &$lft_childs, array $parent_childs)
	moveTree (int $a_source_id, int $a_target_id, int $a_location=self::POS_LAST_NODE)
	Move Tree Implementation public. More...
	getRbacSubtreeInfo (int $a_endnode_id)
	This method is used for change existing objects and returns all necessary information for this action. More...
	getSubTreeQuery (int $a_node_id, array $a_fields=[], array $a_types=[], bool $a_force_join_reference=false)
	Get tree subtree query. More...
	getTrashSubTreeQuery (int $a_node_id, array $a_fields=[], array $a_types=[], bool $a_force_join_reference=false)
	getSubTreeFilteredByObjIds (int $a_node_id, array $a_obj_ids, array $a_fields=[])
	get all node ids in the subtree under specified node id, filter by object ids More...
	deleteNode (int $a_tree_id, int $a_node_id)
	lookupTrashedObjectTypes ()
	Lookup object types in trash. More...
	isRepositoryTree ()
	check if current tree instance operates on repository tree table More...

Static Public Member Functions
static	lookupTreesForNode (int $node_id)
static	_removeEntry (int $a_tree, int $a_child, string $a_db_table="tree")
	STATIC METHOD Removes a single entry from a tree. More...

Data Fields
const	TREE_TYPE_MATERIALIZED_PATH = 'mp'
const	TREE_TYPE_NESTED_SET = 'ns'
const	POS_LAST_NODE = -2
const	POS_FIRST_NODE = -1
const	RELATION_CHILD = 1
const	RELATION_PARENT = 2
const	RELATION_SIBLING = 3
const	RELATION_EQUALS = 4
const	RELATION_NONE = 5

Protected Member Functions
	getLangCode ()
	fetchTranslationFromObjectDataCache (array $a_obj_ids)
	Get translation data from object cache (trigger in object cache on preload) More...

Protected Attributes
const	DEFAULT_LANGUAGE = 'en'
const	DEFAULT_GAP = 50
ilLogger	$logger
ilDBInterface	$db
ilAppEventHandler	$eventHandler
int	$root_id
	points to root node (may be a subtree) More...
int	$tree_id
	to use different trees in one db-table More...
string	$table_tree
	table name of tree table More...
string	$table_obj_data
	table name of object_data table More...
string	$table_obj_reference
	table name of object_reference table More...
string	$ref_pk
	column name containing primary key in reference table More...
string	$obj_pk
	column name containing primary key in object table More...
string	$tree_pk
	column name containing tree id in tree table More...
bool	$use_cache
array	$oc_preloaded = []
array	$depth_cache = []
array	$parent_cache = []
array	$in_tree_cache = []
array	$translation_cache = []
array	$parent_type_cache = []
array	$is_saved_cache = []

Private Member Functions
	__renumber (int $node_id=1, int $i=1)
	This method is private. More...

Private Attributes
string	$lang_code
int	$gap
	Size of the gaps to be created in the nested sets sequence numbering of the tree nodes. More...
ilTreeImplementation	$tree_impl = null
array	$path_id_cache = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Tree class data representation in hierachical trees using the Nested Set Model with Gaps by Joe Celco.

Author

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 29 of file class.ilTree.php.

Constructor & Destructor Documentation

__construct()

ilTree::__construct	(	int	$a_tree_id,
		int	$a_root_id = 0,
		ilDBInterface	$db = null
	)

Exceptions

InvalidArgumentException

Definition at line 133 of file class.ilTree.php.

References $DIC, ilLogLevel\ERROR, ilLoggerFactory\getLogger(), initTreeImplementation(), ILIAS\Repository\logger(), and ROOT_FOLDER_ID.

      {
        global $DIC;

        $this->db = $db ?? $DIC->database();
        $this->logger = ilLoggerFactory::getLogger('tree');
        //$this->logger = $DIC->logger()->tree();
        if (isset($DIC['ilAppEventHandler'])) {
            $this->eventHandler = $DIC['ilAppEventHandler'];
        }

        $this->lang_code = self::DEFAULT_LANGUAGE;

        if (func_num_args() > 3) {
            $this->logger->error("Wrong parameter count!");
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException("Wrong parameter count!");
        }

        if ($a_root_id > 0) {
            $this->root_id = $a_root_id;
        } else {
            $this->root_id = ROOT_FOLDER_ID;
        }

        $this->tree_id = $a_tree_id;
        $this->table_tree = 'tree';
        $this->table_obj_data = 'object_data';
        $this->table_obj_reference = 'object_reference';
        $this->ref_pk = 'ref_id';
        $this->obj_pk = 'obj_id';
        $this->tree_pk = 'tree';

        $this->use_cache = true;

        // By default, we create gaps in the tree sequence numbering for 50 nodes
        $this->gap = self::DEFAULT_GAP;

        // init tree implementation
        $this->initTreeImplementation();
    }

Here is the call graph for this function:

Member Function Documentation

__checkDelete()

ilTree::__checkDelete

(

array

$a_node

)

Check for deleteTree() compares a subtree of a given node by checking lft, rgt against parent relation.

Exceptions

ilInvalidTreeStructureException

Deprecated:

since 4.4.0

Definition at line 1947 of file class.ilTree.php.

References $message, $res, __getSubTreeByParentRelation(), __validateSubtrees(), getTreeImplementation(), ILIAS\Repository\int(), and ILIAS\Repository\logger().

Referenced by deleteTree().

                                                : bool
    {
        $query = $this->getTreeImplementation()->getSubTreeQuery($a_node, [], false);
        $this->logger->debug($query);
        $res = $this->db->query($query);

        $counter = (int) $lft_childs = [];
        while ($row = $this->db->fetchObject($res)) {
            $lft_childs[$row->child] = (int) $row->parent;
            ++$counter;
        }

        // CHECK FOR DUPLICATE CHILD IDS
        if ($counter != count($lft_childs)) {
            $message = 'Duplicate entries for "child" in maintree! $a_node_id: ' . $a_node['child'];

            $this->logger->error($message);
            throw new ilInvalidTreeStructureException($message);
        }

        // GET SUBTREE BY PARENT RELATION
        $parent_childs = [];
        $this->__getSubTreeByParentRelation((int)$a_node['child'], $parent_childs);
        $this->__validateSubtrees($lft_childs, $parent_childs);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__getSubTreeByParentRelation()

ilTree::__getSubTreeByParentRelation	(	int	$a_node_id,
		array &	$parent_childs
	)

Exceptions

ilInvalidTreeStructureException

Deprecated:

since 4.4.0

Definition at line 1979 of file class.ilTree.php.

References $message, $res, ILIAS\Repository\int(), and ILIAS\Repository\logger().

Referenced by __checkDelete().

                                                                                       : bool
    {
        // GET PARENT ID
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE child = %s ' .
            'AND tree = %s ';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            $a_node_id,
            $this->tree_id
        ));

        $counter = 0;
        while ($row = $this->db->fetchObject($res)) {
            $parent_childs[$a_node_id] = (int) $row->parent;
            ++$counter;
        }
        // MULTIPLE ENTRIES
        if ($counter > 1) {
            $message = 'Multiple entries in maintree! $a_node_id: ' . $a_node_id;

            $this->logger->error($message);
            throw new ilInvalidTreeStructureException($message);
        }

        // GET ALL CHILDS
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE parent = %s ';
        $res = $this->db->queryF($query, array('integer'), array($a_node_id));

        while ($row = $this->db->fetchObject($res)) {
            // RECURSION
            $this->__getSubTreeByParentRelation((int) $row->child, $parent_childs);
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__isMainTree()

ilTree::__isMainTree

(

)

Check if operations are done on main tree.

Definition at line 1936 of file class.ilTree.php.

Referenced by addTree(), checkForParentType(), deleteTree(), getChilds(), getDepth(), getNodeData(), getParentId(), getPathFull(), getPathId(), getSubTree(), initTreeImplementation(), insertNode(), insertNodeFromTrash(), isCacheUsed(), isInTree(), isSaved(), moveTree(), preloadDeleted(), preloadDepthParent(), removeTree(), and renumber().

                                  : bool
    {
        return $this->table_tree === 'tree';
    }

Here is the caller graph for this function:

__renumber()

ilTree::__renumber ( int  $node_id = 1, int  $i = 1  )

private

This method is private.

Always call ilTree->renumber() since it locks the tree table renumber left/right values and close the gaps in numbers (recursive)

Definition at line 1786 of file class.ilTree.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and isRepositoryTree().

Referenced by renumber().

                                                             : int
    {
        if ($this->isRepositoryTree()) {
            $query = 'UPDATE ' . $this->table_tree . ' SET lft = %s WHERE child = %s';
            $this->db->manipulateF(
                $query,
                array('integer', 'integer'),
                array(
                    $i,
                    $node_id
                )
            );
        } else {
            $query = 'UPDATE ' . $this->table_tree . ' SET lft = %s WHERE child = %s AND tree = %s';
            $this->db->manipulateF(
                $query,
                array('integer', 'integer', 'integer'),
                array(
                    $i,
                    $node_id,
                    $this->tree_id
                )
            );
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE parent = ' . $this->db->quote($node_id, 'integer') . ' ' .
            'ORDER BY lft';
        $res = $this->db->query($query);

        $childs = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $childs[] = (int) $row->child;
        }

        foreach ($childs as $child) {
            $i = $this->__renumber($child, $i + 1);
        }
        $i++;

        // Insert a gap at the end of node, if the node has children
        if (count($childs) > 0) {
            $i += $this->gap * 2;
        }

        if ($this->isRepositoryTree()) {
            $query = 'UPDATE ' . $this->table_tree . ' SET rgt = %s WHERE child = %s';
            $res = $this->db->manipulateF(
                $query,
                array('integer', 'integer'),
                array(
                    $i,
                    $node_id
                )
            );
        } else {
            $query = 'UPDATE ' . $this->table_tree . ' SET rgt = %s WHERE child = %s AND tree = %s';
            $res = $this->db->manipulateF($query, array('integer', 'integer', 'integer'), array(
                $i,
                $node_id,
                $this->tree_id
            ));
        }
        return $i;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__validateSubtrees()

ilTree::__validateSubtrees	(	array &	$lft_childs,
		array	$parent_childs
	)

Parameters

array	$lft_childs
array	$parent_childs

Returns

bool

Exceptions

ilInvalidTreeStructureException

Deprecated:

since 4.4.0

Definition at line 2022 of file class.ilTree.php.

References ILIAS\LTI\ToolProvider\$key, $message, ILIAS\Repository\logger(), and ROOT_FOLDER_ID.

Referenced by __checkDelete().

                                                                                : bool
    {
        // SORT BY KEY
        ksort($lft_childs);
        ksort($parent_childs);

        $this->logger->debug('left childs ' . print_r($lft_childs, true));
        $this->logger->debug('parent childs ' . print_r($parent_childs, true));

        if (count($lft_childs) != count($parent_childs)) {
            $message = '(COUNT) Tree is corrupted! Left/Right subtree does not comply with parent relation';
            $this->logger->error($message);
            throw new ilInvalidTreeStructureException($message);
        }

        foreach ($lft_childs as $key => $value) {
            if ($parent_childs[$key] != $value) {
                $message = '(COMPARE) Tree is corrupted! Left/Right subtree does not comply with parent relation';
                $this->logger->error($message);
                throw new ilInvalidTreeStructureException($message);
            }
            if ($key == ROOT_FOLDER_ID) {
                $message = '(ROOT_FOLDER) Tree is corrupted! Tried to delete root folder';
                $this->logger->error($message);
                throw new ilInvalidTreeStructureException($message);
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_removeEntry()

static ilTree::_removeEntry ( int  $a_tree, int  $a_child, string  $a_db_table = "tree"  )

static

STATIC METHOD Removes a single entry from a tree.

The tree structure is NOT updated!

Exceptions

InvalidArgumentException

Definition at line 1906 of file class.ilTree.php.

References $DIC, $message, $res, ilLoggerFactory\getLogger(), ilDBInterface\manipulateF(), and ROOT_FOLDER_ID.

Referenced by ilValidator\purgeObjects(), and ilSystemCheckTrash\removeSelectedFromSystem().

                                                                                               : void
    {
        global $DIC;

        $db = $DIC->database();

        if ($a_db_table === 'tree') {
            if ($a_tree == 1 && $a_child == ROOT_FOLDER_ID) {
                $message = sprintf(
                    'Tried to delete root node! $a_tree: %s $a_child: %s',
                    $a_tree,
                    $a_child
                );
                ilLoggerFactory::getLogger('tree')->error($message);
                throw new InvalidArgumentException($message);
            }
        }

        $query = 'DELETE FROM ' . $a_db_table . ' ' .
            'WHERE tree = %s ' .
            'AND child = %s ';
        $res = $db->manipulateF($query, array('integer', 'integer'), array(
            $a_tree,
            $a_child
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addTree()

ilTree::addTree	(	int	$a_tree_id,
		int	$a_node_id = -1
	)

create a new tree to do: ???

Definition at line 1297 of file class.ilTree.php.

References $DIC, $message, $res, __isMainTree(), and ILIAS\Repository\logger().

Referenced by ilWorkspaceTree\createTreeForUser(), and ilSCORMPackageParser\handlerBeginTag().

                                                                : bool
    {
        global $DIC;

        // FOR SECURITY addTree() IS NOT ALLOWED ON MAIN TREE
        if ($this->__isMainTree()) {
            $message = sprintf(
                'Operation not allowed on main tree! $a_tree_if: %s $a_node_id: %s',
                $a_tree_id,
                $a_node_id
            );
            $this->logger->error($message);
            throw new InvalidArgumentException($message);
        }

        if ($a_node_id <= 0) {
            $a_node_id = $a_tree_id;
        }

        $query = 'INSERT INTO ' . $this->table_tree . ' (' .
            $this->tree_pk . ', child,parent,lft,rgt,depth) ' .
            'VALUES ' .
            '(%s,%s,%s,%s,%s,%s)';
        $res = $this->db->manipulateF(
            $query,
            array('integer', 'integer', 'integer', 'integer', 'integer', 'integer'),
            array(
                $a_tree_id,
                $a_node_id,
                0,
                1,
                2,
                1
            )
        );

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildJoin()

ilTree::buildJoin

(

)

build join depending on table settings private

Returns

string

Definition at line 385 of file class.ilTree.php.

Referenced by fetchPredecessorNode(), fetchSuccessorNode(), ilSCORMTree\getChilds(), getChilds(), getChildsByType(), getChildsByTypeFilter(), getChildSequenceNumber(), getNodeData(), getPathFull(), getSavedNodeData(), getSavedNodeObjIds(), and getSubTreeFilteredByObjIds().

                               : string
    {
        if ($this->table_obj_reference) {
            // Use inner join instead of left join to improve performance
            return "JOIN " . $this->table_obj_reference . " ON " . $this->table_tree . ".child=" . $this->table_obj_reference . "." . $this->ref_pk . " " .
                "JOIN " . $this->table_obj_data . " ON " . $this->table_obj_reference . "." . $this->obj_pk . "=" . $this->table_obj_data . "." . $this->obj_pk . " ";
        } else {
            // Use inner join instead of left join to improve performance
            return "JOIN " . $this->table_obj_data . " ON " . $this->table_tree . ".child=" . $this->table_obj_data . "." . $this->obj_pk . " ";
        }
    }

Here is the caller graph for this function:

checkForParentType()

ilTree::checkForParentType	(	int	$a_ref_id,
		string	$a_type,
		bool	$a_exclude_source_check = false
	)

Check for parent type e.g check if a folder (ref_id 3) is in a parent course obj => checkForParentType(3,'crs');.

Definition at line 1856 of file class.ilTree.php.

References $path, __isMainTree(), getPathFull(), ILIAS\Repository\int(), isCacheUsed(), and isInTree().

Referenced by ilEventParticipants\__read(), ilAppointmentPresentationGUI\addContainerInfo(), ilObjSessionGUI\eventsListObject(), ilStudyProgrammeRepositorySearchGUI\fillAutoCompleteToolbar(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ilObjFolderGUI\forwardToTimingsView(), ilContainerSortingSettings\getInheritedSettings(), ilLPStatusCollection\getMembers(), ilObjSurvey\getNotificationTargetUserIds(), ilBookingReservationsTableGUI\getParentGroupCourse(), ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), ilObjSessionGUI\initContainer(), ilObjectRolePermissionTableGUI\initFilter(), ilRepositoryExplorer\isVisible(), ilObjectGUI\isVisible(), ilObjSessionGUI\modifyItemGUI(), ilObjFolderGUI\modifyItemGUI(), ilObject\selfOrParentWithRatingEnabled(), ilObjBlogGUI\setSettingsSubTabs(), and ilObjGroup\translateViewMode().

                                                                                                           : int
    {
        // #12577
        $cache_key = $a_ref_id . '.' . $a_type . '.' . ((int) $a_exclude_source_check);

        // Try to return a cached result
        if ($this->isCacheUsed() &&
            array_key_exists($cache_key, $this->parent_type_cache)) {
            return (int) $this->parent_type_cache[$cache_key];
        }

        // Store up to 1000 results in cache
        $do_cache = ($this->__isMainTree() && count($this->parent_type_cache) < 1000);

        // ref_id is not in tree
        if (!$this->isInTree($a_ref_id)) {
            if ($do_cache) {
                $this->parent_type_cache[$cache_key] = false;
            }
            return 0;
        }

        $path = array_reverse($this->getPathFull($a_ref_id));

        // remove first path entry as it is requested node
        if ($a_exclude_source_check) {
            array_shift($path);
        }

        foreach ($path as $node) {
            // found matching parent
            if ($node["type"] == $a_type) {
                if ($do_cache) {
                    $this->parent_type_cache[$cache_key] = (int) $node["child"];
                }
                return (int) $node["child"];
            }
        }

        if ($do_cache) {
            $this->parent_type_cache[$cache_key] = false;
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTree()

ilTree::checkTree

(

)

check consistence of tree all left & right values are checked if they are exists only once

Todo:

remove exception for "check-method"

Definition at line 933 of file class.ilTree.php.

References $message, $res, and ILIAS\Repository\logger().

Referenced by ilObjContentObject\checkTree().

                               : bool
    {
        $types = array('integer');
        $query = 'SELECT lft,rgt FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->tree_pk . ' = %s ';

        $res = $this->db->queryF($query, $types, array($this->tree_id));
        $lft = $rgt = [];
        while ($row = $this->db->fetchObject($res)) {
            $lft[] = $row->lft;
            $rgt[] = $row->rgt;
        }

        $all = array_merge($lft, $rgt);
        $uni = array_unique($all);

        if (count($all) != count($uni)) {
            $message = 'Tree is corrupted!';
            $this->logger->error($message);
            throw new ilInvalidTreeStructureException($message);
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTreeChilds()

ilTree::checkTreeChilds

(

bool

$a_no_zero_child = true

)

check, if all childs of tree nodes exist in object table

Exceptions

ilInvalidTreeStructureException

Definition at line 961 of file class.ilTree.php.

References $message, $obj_pk, and ILIAS\Repository\logger().

Referenced by ilObjContentObject\checkTree().

                                                                 : bool
    {
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->tree_pk . ' = %s ' .
            'ORDER BY lft';
        $r1 = $this->db->queryF($query, array('integer'), array($this->tree_id));

        while ($row = $this->db->fetchAssoc($r1)) {
            //echo "tree:".$row[$this->tree_pk].":lft:".$row["lft"].":rgt:".$row["rgt"].":child:".$row["child"].":<br>";
            if (($row["child"] == 0) && $a_no_zero_child) {
                $message = "Tree contains child with ID 0!";
                $this->logger->error($message);
                throw new ilInvalidTreeStructureException($message);
            }

            if ($this->table_obj_reference) {
                // get object reference data
                $query = 'SELECT * FROM ' . $this->table_obj_reference . ' WHERE ' . $this->ref_pk . ' = %s ';
                $r2 = $this->db->queryF($query, array('integer'), array($row['child']));

                //echo "num_childs:".$r2->numRows().":<br>";
                if ($r2->numRows() == 0) {
                    $message = "No Object-to-Reference entry found for ID " . $row["child"] . "!";
                    $this->logger->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
                if ($r2->numRows() > 1) {
                    $message = "More Object-to-Reference entries found for ID " . $row["child"] . "!";
                    $this->logger->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }

                // get object data
                $obj_ref = $this->db->fetchAssoc($r2);

                $query = 'SELECT * FROM ' . $this->table_obj_data . ' WHERE ' . $this->obj_pk . ' = %s';
                $r3 = $this->db->queryF($query, array('integer'), array($obj_ref[$this->obj_pk]));
                if ($r3->numRows() == 0) {
                    $message = " No child found for ID " . $obj_ref[$this->obj_pk] . "!";
                    $this->logger->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
                if ($r3->numRows() > 1) {
                    $message = "More childs found for ID " . $obj_ref[$this->obj_pk] . "!";
                    $this->logger->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
            } else {
                // get only object data
                $query = 'SELECT * FROM ' . $this->table_obj_data . ' WHERE ' . $this->obj_pk . ' = %s';
                $r2 = $this->db->queryF($query, array('integer'), array($row['child']));
                //echo "num_childs:".$r2->numRows().":<br>";
                if ($r2->numRows() == 0) {
                    $message = "No child found for ID " . $row["child"] . "!";
                    $this->logger->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
                if ($r2->numRows() > 1) {
                    $message = "More childs found for ID " . $row["child"] . "!";
                    $this->logger->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteNode()

ilTree::deleteNode	(	int	$a_tree_id,
		int	$a_node_id
	)

Definition at line 2154 of file class.ilTree.php.

                                                              : void
    {
        $query = 'DELETE FROM tree where ' .
            'child = ' . $this->db->quote($a_node_id, 'integer') . ' ' .
            'AND tree = ' . $this->db->quote($a_tree_id, 'integer');
        $this->db->manipulate($query);

        $this->eventHandler->raise(
            "Services/Tree",
            "deleteNode",
            [
                'tree' => $this->table_tree,
                'node_id' => $a_node_id,
                'tree_id' => $a_tree_id
            ]
        );
    }

deleteTree()

ilTree::deleteTree

(

array

$a_node

)

delete node and the whole subtree under this node

Definition at line 767 of file class.ilTree.php.

References __checkDelete(), __isMainTree(), ilLogLevel\ERROR, getTreeImplementation(), ILIAS\Repository\logger(), and resetInTreeCache().

Referenced by ilWorkspaceTree\cascadingDelete(), ilObjContentObjectGUI\confirmedDelete(), ilObjTaxonomy\doDelete(), ilObjContentObject\fixTree(), ilRepUtil\removeObjectsFromSystem(), ilValidator\restoreDeletedObjects(), and ilValidator\restoreSubTrees().

                                             : void
    {
        if ($this->__isMainTree()) {
            // moved to trash and then deleted.
            if (!$this->__checkDelete($a_node)) {
                $this->logger->logStack(ilLogLevel::ERROR);
                throw new ilInvalidTreeStructureException('Deletion canceled due to invalid tree structure.' . print_r(
                    $a_node,
                    true
                ));
            }
        }
        $this->getTreeImplementation()->deleteTree((int) $a_node['child']);
        $this->resetInTreeCache();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchNodeData()

ilTree::fetchNodeData

(

array

$a_row

)

get data of parent node from tree and object_data

Definition at line 1121 of file class.ilTree.php.

References $data, $DIC, ILIAS\LTI\ToolProvider\$key, $lang_code, $lng, $res, ilContainerReference\_lookupTitle(), ilObject\DESC_LENGTH, isCacheUsed(), ROLE_FOLDER_ID, and ilStr\shortenTextExtended().

Referenced by fetchPredecessorNode(), fetchSuccessorNode(), ilSCORMTree\getChilds(), getChilds(), getChildsByType(), getChildsByTypeFilter(), getNodeData(), getParentNodeData(), getPathFull(), getSavedNodeData(), and getSubTree().

                                               : array
    {
        global $DIC;

        $objDefinition = $DIC['objDefinition'];
        $lng = $DIC['lng'];

        $data = $a_row;
        $data["desc"] = (string) ($a_row["description"] ?? '');  // for compability

        // multilingual support systemobjects (sys) & categories (db)
        $translation_type = '';
        if (is_object($objDefinition)) {
            $translation_type = $objDefinition->getTranslationType($data["type"] ?? '');
        }

        if ($translation_type == "sys") {
            if ($data["type"] == "rolf" && $data["obj_id"] != ROLE_FOLDER_ID) {
                $data["description"] = (string) $lng->txt("obj_" . $data["type"] . "_local_desc") . $data["title"] . $data["desc"];
                $data["desc"] = $lng->txt("obj_" . $data["type"] . "_local_desc") . $data["title"] . $data["desc"];
                $data["title"] = $lng->txt("obj_" . $data["type"] . "_local");
            } else {
                $data["title"] = $lng->txt("obj_" . $data["type"]);
                $data["description"] = $lng->txt("obj_" . $data["type"] . "_desc");
                $data["desc"] = $lng->txt("obj_" . $data["type"] . "_desc");
            }
        } elseif ($translation_type == "db") {
            // Try to retrieve object translation from cache
            $lang_code = ''; // This did never work, because it was undefined before
            if ($this->isCacheUsed() &&
                array_key_exists($data["obj_id"] . '.' . $lang_code, $this->translation_cache)) {
                $key = $data["obj_id"] . '.' . $lang_code;
                $data["title"] = $this->translation_cache[$key]['title'];
                $data["description"] = $this->translation_cache[$key]['description'];
                $data["desc"] = $this->translation_cache[$key]['desc'];
            } else {
                // Object translation is not in cache, read it from database
                $query = 'SELECT title,description FROM object_translation ' .
                    'WHERE obj_id = %s ' .
                    'AND lang_code = %s ';

                $res = $this->db->queryF($query, array('integer', 'text'), array(
                    $data['obj_id'],
                    $this->lang_code
                ));
                $row = $this->db->fetchObject($res);

                if ($row) {
                    $data["title"] = (string) $row->title;
                    $data["description"] = ilStr::shortenTextExtended((string) $row->description, ilObject::DESC_LENGTH, true);
                    $data["desc"] = (string) $row->description;
                }

                // Store up to 1000 object translations in cache
                if ($this->isCacheUsed() && count($this->translation_cache) < 1000) {
                    $key = $data["obj_id"] . '.' . $lang_code;
                    $this->translation_cache[$key] = [];
                    $this->translation_cache[$key]['title'] = $data["title"];
                    $this->translation_cache[$key]['description'] = $data["description"];
                    $this->translation_cache[$key]['desc'] = $data["desc"];
                }
            }
        }

        // TODO: Handle this switch by module.xml definitions
        if (isset($data['type']) && ($data['type'] == 'crsr' || $data['type'] == 'catr' || $data['type'] == 'grpr' || $data['type'] === 'prgr')) {
            $data['title'] = ilContainerReference::_lookupTitle((int) $data['obj_id']);
        }
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchPredecessorNode()

ilTree::fetchPredecessorNode	(	int	$a_node_id,
		string	$a_type = ""
	)

get node data of predecessor node

Exceptions

InvalidArgumentException

Todo:

move to tree implementation and throw NotImplementedException for materialized path implementation fix return false

Definition at line 1705 of file class.ilTree.php.

References $message, $res, buildJoin(), fetchNodeData(), and ILIAS\Repository\logger().

                                                                             : ?array
    {
        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->logger->error($message);
            throw new InvalidArgumentException($message);
        }

        // get lft value for current node
        $query = 'SELECT lft FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->table_tree . '.child = %s ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            $a_node_id,
            $this->tree_id
        ));

        $curr_node = $this->db->fetchAssoc($res);

        if ($a_type) {
            $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                $this->buildJoin() .
                'WHERE lft < %s ' .
                'AND ' . $this->table_obj_data . '.type = %s ' .
                'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ' .
                'ORDER BY lft DESC';
            $this->db->setLimit(1, 0);
            $res = $this->db->queryF($query, array('integer', 'text', 'integer'), array(
                $curr_node['lft'],
                $a_type,
                $this->tree_id
            ));
        } else {
            $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                $this->buildJoin() .
                'WHERE lft < %s ' .
                'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ' .
                'ORDER BY lft DESC';
            $this->db->setLimit(1, 0);
            $res = $this->db->queryF($query, array('integer', 'integer'), array(
                $curr_node['lft'],
                $this->tree_id
            ));
        }

        if ($res->numRows() < 1) {
            return null;
        } else {
            $row = $this->db->fetchAssoc($res);
            return $this->fetchNodeData($row);
        }
    }

Here is the call graph for this function:

fetchSuccessorNode()

ilTree::fetchSuccessorNode	(	int	$a_node_id,
		string	$a_type = ""
	)

get node data of successor node

Exceptions

InvalidArgumentException

Todo:

move to tree implementation and throw NotImplementedException for materialized path implementation fix return false

Definition at line 1653 of file class.ilTree.php.

References $res, buildJoin(), and fetchNodeData().

Referenced by ilObjContentObject\hasSuccessorPage().

                                                                           : ?array
    {
        // get lft value for current node
        $query = 'SELECT lft FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->table_tree . '.child = %s ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            $a_node_id,
            $this->tree_id
        ));
        $curr_node = $this->db->fetchAssoc($res);

        if ($a_type) {
            $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                $this->buildJoin() .
                'WHERE lft > %s ' .
                'AND ' . $this->table_obj_data . '.type = %s ' .
                'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ' .
                'ORDER BY lft ';
            $this->db->setLimit(1, 0);
            $res = $this->db->queryF($query, array('integer', 'text', 'integer'), array(
                $curr_node['lft'],
                $a_type,
                $this->tree_id
            ));
        } else {
            $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                $this->buildJoin() .
                'WHERE lft > %s ' .
                'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ' .
                'ORDER BY lft ';
            $this->db->setLimit(1, 0);
            $res = $this->db->queryF($query, array('integer', 'integer'), array(
                $curr_node['lft'],
                $this->tree_id
            ));
        }

        if ($res->numRows() < 1) {
            return null;
        } else {
            $row = $this->db->fetchAssoc($res);
            return $this->fetchNodeData($row);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchTranslationFromObjectDataCache()

ilTree::fetchTranslationFromObjectDataCache ( array  $a_obj_ids )

protected

Get translation data from object cache (trigger in object cache on preload)

Parameters

array

$a_obj_ids

object ids

Todo:

handle dependency

Definition at line 1197 of file class.ilTree.php.

References $DIC, $id, and isCacheUsed().

Referenced by getChilds().

                                                                            : void
    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];

        if ($this->isCacheUsed() && is_array($a_obj_ids) && is_object($ilObjDataCache)) {
            foreach ($a_obj_ids as $id) {
                $this->translation_cache[$id . '.']['title'] = $ilObjDataCache->lookupTitle((int) $id);
                $this->translation_cache[$id . '.']['description'] = $ilObjDataCache->lookupDescription((int) $id);
                $this->translation_cache[$id . '.']['desc'] =
                    $this->translation_cache[$id . '.']['description'];
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildIds()

ilTree::getChildIds

(

int

$a_node

)

Parameters

int

$a_node

Returns

int[]

Definition at line 421 of file class.ilTree.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

                                            : array
    {
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE parent = ' . $this->db->quote($a_node, 'integer') . ' ' .
            'AND tree = ' . $this->db->quote($this->tree_id, 'integer' . ' ' .
                'ORDER BY lft');
        $res = $this->db->query($query);

        $childs = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $childs[] = (int) $row->child;
        }
        return $childs;
    }

Here is the call graph for this function:

getChilds()

ilTree::getChilds	(	int	$a_node_id,
		string	$a_order = "",
		string	$a_direction = "ASC"
	)

get child nodes of given node

Todo:

remove dependency to ilObjUser and use $this->lang_code

Definition at line 440 of file class.ilTree.php.

References $DIC, $r, $res, __isMainTree(), buildJoin(), fetchNodeData(), fetchTranslationFromObjectDataCache(), ILIAS\Repository\int(), and isCacheUsed().

Referenced by ilContainerGUI\cloneNodes(), ilObject\collectDeletionDependencies(), ilStructureObject\delete_rec(), ilNewsItem\getAggregatedChildNewsData(), getFilteredChilds(), ilContainer\getInitialSubitems(), ilObjWorkspaceFolderTableGUI\getItems(), ilAdminSubItemsTableGUI\getItems(), ilWorkspaceContentGUI\getItems(), ilSkillTree\getMaxOrderNr(), ilClassificationBlockGUI\getSubItemIds(), ilTaggingClassificationProvider\getSubTreeTags(), ilTaxonomyClassificationExplorerGUI\getTreeComponent(), ilObjWorkspaceFolder\gotItems(), ILIAS\Skill\Node\SkillTreeNodeManager\saveChildsOrder(), ilObjContentObjectGUI\showExportIDsOverview(), ilContainerGUI\showLinkListObject(), and ilContainerXmlWriter\writeSubitems().

                                                                                                : array
    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilUser = $DIC['ilUser'];

        // init childs
        $childs = [];

        // number of childs
        $count = 0;

        // init order_clause
        $order_clause = "";

        // set order_clause if sort order parameter is given
        if (!empty($a_order)) {
            $order_clause = "ORDER BY " . $a_order . " " . $a_direction;
        } else {
            $order_clause = "ORDER BY " . $this->table_tree . ".lft";
        }

        $query = sprintf(
            'SELECT * FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            "WHERE parent = %s " .
            "AND " . $this->table_tree . "." . $this->tree_pk . " = %s " .
            $order_clause,
            $this->db->quote($a_node_id, 'integer'),
            $this->db->quote($this->tree_id, 'integer')
        );

        $res = $this->db->query($query);

        if (!$count = $res->numRows()) {
            return [];
        }

        // get rows and object ids
        $rows = [];
        $obj_ids = [];
        while ($r = $this->db->fetchAssoc($res)) {
            $rows[] = $r;
            $obj_ids[] = (int) $r["obj_id"];
        }

        // preload object translation information
        if ($this->__isMainTree() && $this->isCacheUsed() && is_object($ilObjDataCache) &&
            is_object($ilUser) && $this->lang_code == $ilUser->getLanguage() && !isset($this->oc_preloaded[$a_node_id])) {
            //                  $ilObjDataCache->preloadTranslations($obj_ids, $this->lang_code);
            $ilObjDataCache->preloadObjectCache($obj_ids, $this->lang_code);
            $this->fetchTranslationFromObjectDataCache($obj_ids);
            $this->oc_preloaded[$a_node_id] = true;
        }

        foreach ($rows as $row) {
            $childs[] = $this->fetchNodeData($row);

            // Update cache of main tree
            if ($this->__isMainTree()) {
                #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Storing in tree cache '.$row['child'].' = true');
                $this->in_tree_cache[$row['child']] = $row['tree'] == 1;
            }
        }
        $childs[$count - 1]["last"] = true;
        return $childs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildsByType()

ilTree::getChildsByType	(	int	$a_node_id,
		string	$a_type
	)

get child nodes of given node by object type

Todo:

check the perfomance optimization and remove

Definition at line 538 of file class.ilTree.php.

References $res, buildJoin(), and fetchNodeData().

Referenced by ilEventItems\_getItemsOfContainer(), ilItemGroupItems\_getItemsOfContainer(), ilContainerGUI\cloneNodes(), ilSessionAppointment\lookupLastSessionByCourse(), ilSessionAppointment\lookupNextSessionByCourse(), assQuestionGUI\outPageSelector(), and ilStructureObjectGUI\putInTree().

                                                                   : array
    {
        if ($a_type == 'rolf' && $this->table_obj_reference) {
            // Performance optimization: A node can only have exactly one
            // role folder as its child. Therefore we don't need to sort the
            // results, and we can let the database know about the expected limit.
            $this->db->setLimit(1, 0);
            $query = sprintf(
                "SELECT * FROM " . $this->table_tree . " " .
                $this->buildJoin() .
                "WHERE parent = %s " .
                "AND " . $this->table_tree . "." . $this->tree_pk . " = %s " .
                "AND " . $this->table_obj_data . ".type = %s ",
                $this->db->quote($a_node_id, 'integer'),
                $this->db->quote($this->tree_id, 'integer'),
                $this->db->quote($a_type, 'text')
            );
        } else {
            $query = sprintf(
                "SELECT * FROM " . $this->table_tree . " " .
                $this->buildJoin() .
                "WHERE parent = %s " .
                "AND " . $this->table_tree . "." . $this->tree_pk . " = %s " .
                "AND " . $this->table_obj_data . ".type = %s " .
                "ORDER BY " . $this->table_tree . ".lft",
                $this->db->quote($a_node_id, 'integer'),
                $this->db->quote($this->tree_id, 'integer'),
                $this->db->quote($a_type, 'text')
            );
        }
        $res = $this->db->query($query);

        // init childs
        $childs = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $childs[] = $this->fetchNodeData($row);
        }
        return $childs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildsByTypeFilter()

ilTree::getChildsByTypeFilter	(	int	$a_node_id,
		array	$a_types,
		string	$a_order = "",
		string	$a_direction = "ASC"
	)

get child nodes of given node by object type

Definition at line 581 of file class.ilTree.php.

References $res, buildJoin(), fetchNodeData(), and ilArrayUtil\quoteArray().

Referenced by ilCheckSumOfWorkspaceFileSizesJob\calculateRecursive(), and ilCollectWorkspaceFilesJob\recurseFolder().

     : array {
        $filter = ' ';
        if ($a_types) {
            $filter = 'AND ' . $this->table_obj_data . '.type IN(' . implode(',', ilArrayUtil::quoteArray($a_types)) . ') ';
        }

        // set order_clause if sort order parameter is given
        if (!empty($a_order)) {
            $order_clause = "ORDER BY " . $a_order . " " . $a_direction;
        } else {
            $order_clause = "ORDER BY " . $this->table_tree . ".lft";
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            'WHERE parent = ' . $this->db->quote($a_node_id, 'integer') . ' ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = ' . $this->db->quote(
                $this->tree_id,
                'integer'
            ) . ' ' .
            $filter .
            $order_clause;

        $res = $this->db->query($query);

        $childs = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $childs[] = $this->fetchNodeData($row);
        }

        return $childs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildSequenceNumber()

ilTree::getChildSequenceNumber	(	array	$a_node,
		string	$type = ""
	)

get sequence number of node in sibling sequence

Exceptions

InvalidArgumentException

Todo:

move to tree implementation and throw NotImplementedException for materialized path implementation

Definition at line 1572 of file class.ilTree.php.

References $message, $res, buildJoin(), and ILIAS\Repository\logger().

Referenced by ilStructureObject\_getPresentationTitle().

                                                                            : int
    {
        if (!isset($a_node)) {
            $message = "No node_id given!";
            $this->logger->error($message);
            throw new InvalidArgumentException($message);
        }

        if ($type) {
            $query = 'SELECT count(*) cnt FROM ' . $this->table_tree . ' ' .
                $this->buildJoin() .
                'WHERE lft <= %s ' .
                'AND type = %s ' .
                'AND parent = %s ' .
                'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ';

            $res = $this->db->queryF($query, array('integer', 'text', 'integer', 'integer'), array(
                $a_node['lft'],
                $type,
                $a_node['parent'],
                $this->tree_id
            ));
        } else {
            $query = 'SELECT count(*) cnt FROM ' . $this->table_tree . ' ' .
                $this->buildJoin() .
                'WHERE lft <= %s ' .
                'AND parent = %s ' .
                'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ';

            $res = $this->db->queryF($query, array('integer', 'integer', 'integer'), array(
                $a_node['lft'],
                $a_node['parent'],
                $this->tree_id
            ));
        }
        $row = $this->db->fetchAssoc($res);
        return (int) $row["cnt"];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDepth()

ilTree::getDepth

(

int

$a_node_id

)

return depth of a node in tree

Definition at line 1045 of file class.ilTree.php.

References $DIC, $res, and __isMainTree().

                                            : int
    {
        global $DIC;

        if ($a_node_id) {
            if ($this->__isMainTree()) {
                $query = 'SELECT depth FROM ' . $this->table_tree . ' ' .
                    'WHERE child = %s ';
                $res = $this->db->queryF($query, array('integer'), array($a_node_id));
                $row = $this->db->fetchObject($res);
            } else {
                $query = 'SELECT depth FROM ' . $this->table_tree . ' ' .
                    'WHERE child = %s ' .
                    'AND ' . $this->tree_pk . ' = %s ';
                $res = $this->db->queryF($query, array('integer', 'integer'), array($a_node_id, $this->tree_id));
                $row = $this->db->fetchObject($res);
            }
            return (int) ($row->depth ?? 0);
        }
        return 1;
    }

Here is the call graph for this function:

getDepthCache()

ilTree::getDepthCache

(

)

Get depth cache.

Definition at line 251 of file class.ilTree.php.

References $depth_cache.

                                   : array
    {
        return $this->depth_cache;
    }

getFilteredChilds()

ilTree::getFilteredChilds	(	array	$a_filter,
		int	$a_node,
		string	$a_order = "",
		string	$a_direction = "ASC"
	)

get child nodes of given node (exclude filtered obj_types)

Parameters

string[]	objects to filter (e.g array('rolf'))
int	node_id
string	sort order of returned childs, optional (possible values: 'title','desc','last_update' or 'type')
string	sort direction, optional (possible values: 'DESC' or 'ASC'; defalut is 'ASC')

Returns

array with node data of all childs or empty array

Definition at line 517 of file class.ilTree.php.

References getChilds().

     : array {
        $childs = $this->getChilds($a_node, $a_order, $a_direction);

        $filtered = [];
        foreach ($childs as $child) {
            if (!in_array($child["type"], $a_filter)) {
                $filtered[] = $child;
            }
        }
        return $filtered;
    }

Here is the call graph for this function:

getFilteredSubTree()

ilTree::getFilteredSubTree	(	int	$a_node_id,
		array	$a_filter = []
	)

get filtered subtree get all subtree nodes beginning at a specific node excluding specific object types and their child nodes.

E.g getFilteredSubTreeNodes()

Definition at line 706 of file class.ilTree.php.

References getNodeData(), and getSubTree().

                                                                            : array
    {
        $node = $this->getNodeData($a_node_id);

        $first = true;
        $depth = 0;
        $filtered = [];
        foreach ($this->getSubTree($node) as $subnode) {
            if ($depth && $subnode['depth'] > $depth) {
                continue;
            }
            if (!$first && in_array($subnode['type'], $a_filter)) {
                $depth = $subnode['depth'];
                $first = false;
                continue;
            }
            $depth = 0;
            $first = false;
            $filtered[] = $subnode;
        }
        return $filtered;
    }

Here is the call graph for this function:

getGap()

ilTree::getGap

(

)

Get default gap.

Definition at line 322 of file class.ilTree.php.

References $gap.

                            : int
    {
        return $this->gap;
    }

getLangCode()

ilTree::getLangCode ( )

protected

Definition at line 264 of file class.ilTree.php.

References $lang_code.

                                    : string
    {
        return $this->lang_code;
    }

getLeftValue()

ilTree::getLeftValue

(

int

$a_node_id

)

get left value of given node

Exceptions

InvalidArgumentException

Todo:

move to tree implementation and throw NotImplementedException for materialized path implementation

Definition at line 1546 of file class.ilTree.php.

References $DIC, $message, $res, and ILIAS\Repository\logger().

                                                : int
    {
        global $DIC;

        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->logger->error($message);
            throw new InvalidArgumentException($message);
        }

        $query = 'SELECT lft FROM ' . $this->table_tree . ' ' .
            'WHERE child = %s ' .
            'AND ' . $this->tree_pk . ' = %s ';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            $a_node_id,
            $this->tree_id
        ));
        $row = $this->db->fetchObject($res);
        return (int) $row->lft;
    }

Here is the call graph for this function:

getMaximumDepth()

ilTree::getMaximumDepth

(

)

Return the current maximum depth in the tree.

Definition at line 1031 of file class.ilTree.php.

References $DIC, $res, and $table_tree.

                                     : int
    {
        global $DIC;

        $query = 'SELECT MAX(depth) depth FROM ' . $this->table_tree;
        $res = $this->db->query($query);

        $row = $this->db->fetchAssoc($res);
        return (int) $row['depth'];
    }

getNodeData()

ilTree::getNodeData	(	int	$a_node_id,
		?int	$a_tree_pk = null
	)

get all information of a node.

get data of a specific node from tree and object_data

Exceptions

InvalidArgumentException

Definition at line 1094 of file class.ilTree.php.

References $message, $res, $tree_id, $tree_pk, __isMainTree(), buildJoin(), fetchNodeData(), and ILIAS\Repository\logger().

Referenced by ilPersonalSkillExplorerGUI\__construct(), ilCourseObjectiveMaterials\_getAssignableMaterials(), ilCourseObjectiveQuestion\_getAssignableTests(), ilObjSCORMLearningModule\_getTrackingItems(), ilWorkspaceTree\cascadingDelete(), ilObjContentObject\checkStructure(), ilObjContentObjectGUI\confirmedDelete(), ilRepUtil\deleteObjects(), ilRepUtil\deleteObjectType(), ilObjTaxonomy\doDelete(), ilObjSessionGUI\eventsListObject(), ilSessionOverviewGUI\exportCSV(), ilObjContentObject\fixTree(), ilRepositoryExplorer\formatHeader(), ilSessionOverviewTableGUI\gatherEvents(), ilNewsItem\getAggregatedNewsData(), ilStructureObject\getChapterList(), ilGlobalVirtualSkillTree\getChildsOfNode(), ilLMTree\getCompleteTree(), ilPortfolioPageGUI\getCoursesOfUser(), ilObjPortfolioGUI\getCreateInfoMessage(), ilSessionMaterialsTableGUI\getDataFromDb(), ilFavouritesDBRepository\getFavouritesOfUser(), getFilteredSubTree(), ilContainer\getInitialSubitems(), ilPortfolioPageTableGUI\getItems(), ilBadgeUserTableGUI\getItems(), ilWorkspaceTree\getObjectsFromType(), getSubTreeFilteredByObjIds(), ilTaggingClassificationProvider\getSubTreeTags(), ilTaxonomyClassificationExplorerGUI\getTreeComponent(), ilTreeExplorerGUI\getTreeComponent(), ilPCVerificationGUI\getValidWorkspaceCertificateNodeByIdMap(), ilObjPortfolioGUI\initBlogForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilPCFileListGUI\initEditForm(), ilTestTaxonomyTree\initOrderedTreeIndex(), ilPCFileListGUI\insertNewFileItem(), ilPCFileItemGUI\insertNewItemAfter(), ilPCFileItemGUI\insertNewItemBefore(), assQuestionGUI\outPageSelector(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilRepUtil\removeObjectsFromSystem(), ilRepositorySelectorInputGUI\render(), ilValidator\restoreSubTrees(), and ilExSubmissionObjectGUI\setSelectedBlogObject().

                                                                       : array
    {
        if ($this->__isMainTree()) {
            if ($a_node_id < 1) {
                $message = 'No valid parameter given! $a_node_id: %s' . $a_node_id;
                $this->logger->error($message);
                throw new InvalidArgumentException($message);
            }
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            'WHERE ' . $this->table_tree . '.child = %s ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            $a_node_id,
            $a_tree_pk === null ? $this->tree_id : $a_tree_pk
        ));
        $row = $this->db->fetchAssoc($res);
        $row[$this->tree_pk] = $this->tree_id;

        return $this->fetchNodeData($row);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNodePath()

ilTree::getNodePath	(	int	$a_endnode_id,
		int	$a_startnode_id = 0
	)

Returns the node path for the specified object reference.

Note: this function returns the same result as getNodePathForTitlePath, but takes ref-id's as parameters. This function differs from getPathFull, in the following aspects:

• The title of an object is not translated into the language of the user
• This function is significantly faster than getPathFull.

  Returns

  array ordered path info (depth,parent,child,obj_id,type,title) or null, if the node_id can not be converted into a node path.

Definition at line 896 of file class.ilTree.php.

References $data, $res, and getPathId().

                                                                           : array
    {
        $pathIds = $this->getPathId($a_endnode_id, $a_startnode_id);

        // Abort if no path ids were found
        if (count($pathIds) == 0) {
            return [];
        }

        $types = [];
        $data = [];
        for ($i = 0; $i < count($pathIds); $i++) {
            $types[] = 'integer';
            $data[] = $pathIds[$i];
        }

        $query = 'SELECT t.depth,t.parent,t.child,d.obj_id,d.type,d.title ' .
            'FROM ' . $this->table_tree . ' t ' .
            'JOIN ' . $this->table_obj_reference . ' r ON r.ref_id = t.child ' .
            'JOIN ' . $this->table_obj_data . ' d ON d.obj_id = r.obj_id ' .
            'WHERE ' . $this->db->in('t.child', $data, false, 'integer') . ' ' .
            'ORDER BY t.depth ';

        $res = $this->db->queryF($query, $types, $data);

        $titlePath = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $titlePath[] = $row;
        }
        return $titlePath;
    }

Here is the call graph for this function:

getNodeTreeData()

ilTree::getNodeTreeData

(

int

$a_node_id

)

return all columns of tabel tree

Exceptions

InvalidArgumentException

Definition at line 1071 of file class.ilTree.php.

References $DIC, $res, ilLogLevel\ERROR, ilDBConstants\FETCHMODE_ASSOC, and ILIAS\Repository\logger().

Referenced by getRelation(), getSubTreeQuery(), getTrashSubTreeQuery(), and moveToTrash().

                                                   : array
    {
        global $DIC;

        if (!$a_node_id) {
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Missing or empty parameter $a_node_id: ' . $a_node_id);
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE child = ' . $this->db->quote($a_node_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            return $row;
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectDataTable()

ilTree::getObjectDataTable

(

)

Get object data table.

Definition at line 298 of file class.ilTree.php.

References $table_obj_data.

Referenced by getSubTreeFilteredByObjIds().

                                        : string
    {
        return $this->table_obj_data;
    }

Here is the caller graph for this function:

getParentCache()

ilTree::getParentCache

(

)

Get parent cache.

Definition at line 259 of file class.ilTree.php.

References $parent_cache.

                                    : array
    {
        return $this->parent_cache;
    }

getParentId()

ilTree::getParentId

(

int

$a_node_id

)

get parent id of given node

Exceptions

InvalidArgumentException

Definition at line 1514 of file class.ilTree.php.

References $DIC, $res, and __isMainTree().

Referenced by ilOrgUnitExtension\__construct(), ilConditionHandler\_getPersistedConditionsOfTrigger(), ilObjItemGroupGUI\_goto(), ilObjPollGUI\_goto(), ilConditionHandler\_isReferenceHandlingOptional(), ilSurveyExecutionGUI\backToRepository(), ilObjSessionGUI\cancelEditObject(), ilPCQuestionGUI\createQuestionPool(), ilSurveyEditorGUI\createQuestionPool(), ilObjSessionGUI\createRecurringSessions(), ilAdministrationCommandGUI\cut(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilObjMediaPoolGUI\executeCommand(), ilObjSessionGUI\executeCommand(), ilFavouritesDBRepository\getFavouritesOfUser(), ilRepositorySelectorInputGUI\getHighlightedNode(), ilObjectLP\getLPMemberships(), ilObjSessionGUI\getTabs(), ilObjItemGroupGUI\gotoParent(), ilObjSessionGUI\handleFileUpload(), ilConditionSelector\isNodeVisible(), ilAdministrationCommandGUI\link(), ilObjItemGroupGUI\listMaterials(), ilObjSessionGUI\materialsObject(), moveTree(), ilObjTaxonomyGUI\pasteItems(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjSessionGUI\redirectToParentContentPageObject(), ilWorkspaceContentGUI\render(), ilObjBlogGUI\renderFullScreen(), ilRepUtil\restoreObjects(), ilObjMediaPoolGUI\returnFromItem(), ilObjItemGroupGUI\setTabs(), ilObjSessionGUI\showJoinRequestButton(), ilAdministrationCommandGUI\showPasteTree(), and ilObjSessionGUI\unregisterObject().

                                               : ?int
    {
        global $DIC;
        if ($this->__isMainTree()) {
            $query = 'SELECT parent FROM ' . $this->table_tree . ' ' .
                'WHERE child = %s ';
            $res = $this->db->queryF(
                $query,
                ['integer'],
                [$a_node_id]
            );
        } else {
            $query = 'SELECT parent FROM ' . $this->table_tree . ' ' .
                'WHERE child = %s ' .
                'AND ' . $this->tree_pk . ' = %s ';
            $res = $this->db->queryF($query, array('integer', 'integer'), array(
                $a_node_id,
                $this->tree_id
            ));
        }

        if ($row = $this->db->fetchObject($res)) {
            return (int) $row->parent;
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentNodeData()

ilTree::getParentNodeData

(

int

$a_node_id

)

get data of parent node from tree and object_data

Definition at line 1252 of file class.ilTree.php.

References $DIC, $res, and fetchNodeData().

Referenced by ilObjIndividualAssessment\getParentContainerIdByType(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), and ilObjStudyProgramme\setProgressesCompletedIfParentIsProgrammeInLPCompletedMode().

                                                     : array
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];

        if ($this->table_obj_reference) {
            // Use inner join instead of left join to improve performance
            $innerjoin = "JOIN " . $this->table_obj_reference . " ON v.child=" . $this->table_obj_reference . "." . $this->ref_pk . " " .
                "JOIN " . $this->table_obj_data . " ON " . $this->table_obj_reference . "." . $this->obj_pk . "=" . $this->table_obj_data . "." . $this->obj_pk . " ";
        } else {
            // Use inner join instead of left join to improve performance
            $innerjoin = "JOIN " . $this->table_obj_data . " ON v.child=" . $this->table_obj_data . "." . $this->obj_pk . " ";
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' s, ' . $this->table_tree . ' v ' .
            $innerjoin .
            'WHERE s.child = %s ' .
            'AND s.parent = v.child ' .
            'AND s.' . $this->tree_pk . ' = %s ' .
            'AND v.' . $this->tree_pk . ' = %s';
        $res = $this->db->queryF($query, array('integer', 'integer', 'integer'), array(
            $a_node_id,
            $this->tree_id,
            $this->tree_id
        ));
        $row = $this->db->fetchAssoc($res);
        if (is_array($row)) {
            return $this->fetchNodeData($row);
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPathFull()

ilTree::getPathFull	(	int	$a_endnode_id,
		int	$a_startnode_id = 0
	)

get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode.

This function chooses the algorithm to be used.

Definition at line 797 of file class.ilTree.php.

References $q, $r, __isMainTree(), buildJoin(), ilDBConstants\FETCHMODE_ASSOC, fetchNodeData(), and getPathId().

Referenced by ilContainerGUI\_buildPath(), ilObjContentObject\_checkPreconditionsOfPage(), ilNewsItem\_getDefaultVisibilityForRefId(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilLocatorGUI\addAdministrationItems(), ilLocatorGUI\addContextItems(), ilObjMediaPoolGUI\addLocatorItems(), ilLocatorGUI\addRepositoryItems(), ilSurveySyncTableGUI\buildPath(), ilRepositoryTrashGUI\buildPath(), ilSurveyEvaluationGUI\cancelEvaluationAccess(), checkForParentType(), ilSurveyEvaluationGUI\evaluation(), ilClassificationBlockGUI\filterContainer(), ilFeedWriter\getContextPath(), ilPortfolioPageGUI\getCoursesOfUser(), ilRecommendedContentRoleTableGUI\getItems(), ilObjTaxonomyAdministration\getPath(), ilTestTaxonomyTree\getPathNodes(), ilTaxMDGUI\getSelectableTaxonomies(), ilSkillTree\getSkillTreePath(), and ilObjCategoryGUI\getTaxonomiesForRefId().

                                                                           : array
    {
        $pathIds = $this->getPathId($a_endnode_id, $a_startnode_id);

        // We retrieve the full path in a single query to improve performance
        // Abort if no path ids were found
        if (count($pathIds) == 0) {
            return [];
        }

        $inClause = 'child IN (';
        for ($i = 0; $i < count($pathIds); $i++) {
            if ($i > 0) {
                $inClause .= ',';
            }
            $inClause .= $this->db->quote($pathIds[$i], 'integer');
        }
        $inClause .= ')';

        $q = 'SELECT * ' .
            'FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() . ' ' .
            'WHERE ' . $inClause . ' ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = ' . $this->db->quote(
                $this->tree_id,
                'integer'
            ) . ' ' .
            'ORDER BY depth';
        $r = $this->db->query($q);

        $pathFull = [];
        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $pathFull[] = $this->fetchNodeData($row);

            // Update cache
            if ($this->__isMainTree()) {
                $this->in_tree_cache[$row['child']] = $row['tree'] == 1;
            }
        }
        return $pathFull;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPathId()

ilTree::getPathId	(	int	$a_endnode_id,
		int	$a_startnode_id = 0
	)

get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode

Returns

int[] all path ids from startnode to endnode

Definition at line 866 of file class.ilTree.php.

References __isMainTree(), ilLogLevel\ERROR, getTreeImplementation(), isCacheUsed(), and ILIAS\Repository\logger().

Referenced by ilSolutionExplorer\__construct(), ilObjStyleSheet\_getStandardStyles(), ilObjectLP\findMembershipsByPath(), ilWorkspaceFolderUserSettings\getEffectiveSortation(), getNodePath(), getPathFull(), ilRepositoryExplorerGUI\getTopNodeForRefId(), ilSkillTree\getTopParentNodeId(), ilObjectLP\handleMove(), and ilSkillNotifications\sendMail().

                                                                         : array
    {
        if (!$a_endnode_id) {
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException(__METHOD__ . ': No endnode given!');
        }

        // path id cache
        if ($this->isCacheUsed() && isset($this->path_id_cache[$a_endnode_id][$a_startnode_id])) {
            return $this->path_id_cache[$a_endnode_id][$a_startnode_id];
        }

        $pathIds = $this->getTreeImplementation()->getPathIds($a_endnode_id, $a_startnode_id);

        if ($this->__isMainTree()) {
            $this->path_id_cache[$a_endnode_id][$a_startnode_id] = $pathIds;
        }
        return $pathIds;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRbacSubtreeInfo()

ilTree::getRbacSubtreeInfo

(

int

$a_endnode_id

)

This method is used for change existing objects and returns all necessary information for this action.

The former use of ilTree::getSubtree needs to much memory.

Definition at line 2083 of file class.ilTree.php.

References getTreeImplementation().

                                                         : array
    {
        return $this->getTreeImplementation()->getSubtreeInfo($a_endnode_id);
    }

Here is the call graph for this function:

getRelation()

ilTree::getRelation	(	int	$a_node_a,
		int	$a_node_b
	)

Get relation of two nodes.

Todo:

add unit test

Definition at line 401 of file class.ilTree.php.

References getNodeTreeData(), and getRelationOfNodes().

Referenced by isGrandChild().

                                                             : int
    {
        return $this->getRelationOfNodes(
            $this->getNodeTreeData($a_node_a),
            $this->getNodeTreeData($a_node_b)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRelationOfNodes()

ilTree::getRelationOfNodes	(	array	$a_node_a_arr,
		array	$a_node_b_arr
	)

get relation of two nodes by node data

Definition at line 412 of file class.ilTree.php.

References getTreeImplementation().

Referenced by getRelation().

                                                                                : int
    {
        return $this->getTreeImplementation()->getRelation($a_node_a_arr, $a_node_b_arr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRootId()

ilTree::getRootId

(

)

Definition at line 1627 of file class.ilTree.php.

References $root_id.

Referenced by ilObjMediaPoolGUI\addLocatorItems(), ilObjContentObject\checkStructure(), ilObjPortfolioBase\createBlogInPersonalWorkspace(), ilObjMediaPool\createFolder(), ilObjContentObject\fixTree(), ilWorkspaceTree\getObjectsFromType(), ilPCVerificationGUI\getValidWorkspaceCertificateNodeByIdMap(), ilTestTaxonomyTree\initOrderedTreeIndex(), ILIAS\MediaPool\Tree\MediaPoolTree\insertInMepTree(), assQuestionGUI\outPageSelector(), ilStructureObjectGUI\putInTree(), ilLMObject\putInTree(), and ilObjPortfolioGUI\saveBlog().

                               : int
    {
        return $this->root_id;
    }

Here is the caller graph for this function:

getSavedNodeData()

ilTree::getSavedNodeData

(

int

$a_parent_id

)

get data saved/deleted nodes

Exceptions

InvalidArgumentException

Definition at line 1463 of file class.ilTree.php.

References $DIC, $message, $res, buildJoin(), fetchNodeData(), and ILIAS\Repository\logger().

Referenced by ilRepositoryTrashGUI\showTrashTable().

                                                      : array
    {
        global $DIC;

        if (!isset($a_parent_id)) {
            $message = "No node_id given!";
            $this->logger->error($message);
            throw new InvalidArgumentException($message);
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            'WHERE ' . $this->table_tree . '.' . $this->tree_pk . ' < %s ' .
            'AND ' . $this->table_tree . '.parent = %s';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            0,
            $a_parent_id
        ));

        $saved = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $saved[] = $this->fetchNodeData($row);
        }

        return $saved;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSavedNodeObjIds()

ilTree::getSavedNodeObjIds

(

array

$a_obj_ids

)

get object id of saved/deleted nodes

Definition at line 1493 of file class.ilTree.php.

References $DIC, $res, buildJoin(), and ILIAS\Repository\int().

                                                        : array
    {
        global $DIC;

        $query = 'SELECT ' . $this->table_obj_data . '.obj_id FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            'WHERE ' . $this->table_tree . '.' . $this->tree_pk . ' < ' . $this->db->quote(0, 'integer') . ' ' .
            'AND ' . $this->db->in($this->table_obj_data . '.obj_id', $a_obj_ids, false, 'integer');
        $res = $this->db->query($query);
        $saved = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $saved[] = (int) $row['obj_id'];
        }

        return $saved;
    }

Here is the call graph for this function:

getSubTree()

ilTree::getSubTree	(	array	$a_node,
		bool	$a_with_data = true,
		array	$a_type = []
	)

get all nodes in the subtree under specified node

Todo:

remove the in cache exception for lm tree

refactor $a_type to string[]

Definition at line 744 of file class.ilTree.php.

References $res, __isMainTree(), fetchNodeData(), getTreeImplementation(), and ILIAS\Repository\int().

Referenced by ilPersonalSkillExplorerGUI\__construct(), ilCourseObjectiveMaterials\_getAssignableMaterials(), ilCourseObjectiveQuestion\_getAssignableTests(), ilObjSCORMLearningModule\_getTrackingItems(), ilWorkspaceTree\cascadingDelete(), ilObjContentObject\checkStructure(), ilRepUtil\deleteObjects(), ilRepUtil\deleteObjectType(), ilObjSessionGUI\eventsListObject(), ilObjContentObject\fixTree(), ilNewsItem\getAggregatedNewsData(), ilStructureObject\getChapterList(), ilLMTree\getCompleteTree(), ilObjPortfolioGUI\getCreateInfoMessage(), ilSessionMaterialsTableGUI\getDataFromDb(), getFilteredSubTree(), ilContainer\getInitialSubitems(), ilBadgeUserTableGUI\getItems(), ilWorkspaceTree\getObjectsFromType(), ilTaggingClassificationProvider\getSubTreeTags(), ilObjPortfolioGUI\initBlogForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilTestTaxonomyTree\initOrderedTreeIndex(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilRepUtil\removeObjectsFromSystem(), and ilValidator\restoreSubTrees().

                                                                                           : array
    {
        $query = $this->getTreeImplementation()->getSubTreeQuery($a_node, $a_type);

        $res = $this->db->query($query);
        $subtree = [];
        while ($row = $this->db->fetchAssoc($res)) {
            if ($a_with_data) {
                $subtree[] = $this->fetchNodeData($row);
            } else {
                $subtree[] = (int) $row['child'];
            }
            // the lm_data "hack" should be removed in the trunk during an alpha
            if ($this->__isMainTree() || $this->table_tree == "lm_tree") {
                $this->in_tree_cache[$row['child']] = true;
            }
        }
        return $subtree;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubTreeFilteredByObjIds()

ilTree::getSubTreeFilteredByObjIds	(	int	$a_node_id,
		array	$a_obj_ids,
		array	$a_fields = []
	)

get all node ids in the subtree under specified node id, filter by object ids

Parameters

int[]	$a_obj_ids
string[]	$a_fields

Definition at line 2125 of file class.ilTree.php.

References $res, buildJoin(), getNodeData(), getObjectDataTable(), getTableReference(), getTreeImplementation(), and getTreeTable().

Referenced by ilClassificationBlockGUI\filterContainer(), and ilClassificationBlockGUI\getSubItemIds().

                                                                                                      : array
    {
        $node = $this->getNodeData($a_node_id);
        if (!count($node)) {
            return [];
        }

        $res = [];

        $query = $this->getTreeImplementation()->getSubTreeQuery($node, [], true, array($this->ref_pk));

        $fields = '*';
        if (count($a_fields)) {
            $fields = implode(',', $a_fields);
        }

        $query = "SELECT " . $fields .
            " FROM " . $this->getTreeTable() .
            " " . $this->buildJoin() .
            " WHERE " . $this->getTableReference() . "." . $this->ref_pk . " IN (" . $query . ")" .
            " AND " . $this->db->in($this->getObjectDataTable() . "." . $this->obj_pk, $a_obj_ids, false, "integer");
        $set = $this->db->query($query);
        while ($row = $this->db->fetchAssoc($set)) {
            $res[] = $row;
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubTreeIds()

ilTree::getSubTreeIds

(

int

$a_ref_id

)

Get all ids of subnodes.

Parameters

int

$a_ref_id

Returns

int[]

Definition at line 734 of file class.ilTree.php.

References getTreeImplementation().

Referenced by ilObjTaxonomy\doDelete(), ilObjTaxonomy\getSubTreeItems(), and ilObjectLP\handleMove().

                                                : array
    {
        return $this->getTreeImplementation()->getSubTreeIds($a_ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubTreeQuery()

ilTree::getSubTreeQuery	(	int	$a_node_id,
		array	$a_fields = [],
		array	$a_types = [],
		bool	$a_force_join_reference = false
	)

Get tree subtree query.

Definition at line 2091 of file class.ilTree.php.

References getNodeTreeData(), and getTreeImplementation().

     : string {
        return $this->getTreeImplementation()->getSubTreeQuery(
            $this->getNodeTreeData($a_node_id),
            $a_types,
            $a_force_join_reference,
            $a_fields
        );
    }

Here is the call graph for this function:

getTableReference()

ilTree::getTableReference

(

)

Get reference table if available.

Definition at line 314 of file class.ilTree.php.

References $table_obj_reference.

Referenced by getSubTreeFilteredByObjIds().

                                       : string
    {
        return $this->table_obj_reference;
    }

Here is the caller graph for this function:

getTrashSubTreeQuery()

ilTree::getTrashSubTreeQuery	(	int	$a_node_id,
		array	$a_fields = [],
		array	$a_types = [],
		bool	$a_force_join_reference = false
	)

Definition at line 2105 of file class.ilTree.php.

References getNodeTreeData(), and getTreeImplementation().

     : string {
        return $this->getTreeImplementation()->getTrashSubTreeQuery(
            $this->getNodeTreeData($a_node_id),
            $a_types,
            $a_force_join_reference,
            $a_fields
        );
    }

Here is the call graph for this function:

getTreeId()

ilTree::getTreeId

(

)

Definition at line 1637 of file class.ilTree.php.

References $tree_id.

Referenced by ilWorkspaceTree\exists(), ilSkillTree\getChildsByTypeFilter(), ilSkillTree\initChildsData(), and ILIAS\Skill\Node\SkillDeletionManager\updateProfileCompletions().

                               : int
    {
        return $this->tree_id;
    }

Here is the caller graph for this function:

getTreeImplementation()

ilTree::getTreeImplementation

(

)

Get tree implementation.

Returns

ilTreeImplementation $impl

Definition at line 227 of file class.ilTree.php.

References $tree_impl.

Referenced by __checkDelete(), deleteTree(), getPathId(), getRbacSubtreeInfo(), getRelationOfNodes(), getSubTree(), getSubTreeFilteredByObjIds(), getSubTreeIds(), getSubTreeQuery(), getTrashSubTreeQuery(), insertNode(), moveToTrash(), moveTree(), and validateParentRelations().

                                           : ilTreeImplementation
    {
        return $this->tree_impl;
    }

Here is the caller graph for this function:

getTreePk()

ilTree::getTreePk

(

)

Get tree primary key.

Definition at line 306 of file class.ilTree.php.

References $tree_pk.

                               : string
    {
        return $this->tree_pk;
    }

getTreeTable()

ilTree::getTreeTable

(

)

Get tree table name.

Definition at line 290 of file class.ilTree.php.

References $table_tree.

Referenced by getSubTreeFilteredByObjIds().

                                  : string
    {
        return $this->table_tree;
    }

Here is the caller graph for this function:

initLangCode()

ilTree::initLangCode

(

)

Do not use it Store user language.

This function is used by the "main" tree only (during initialisation).

Todo:

remove this dependency to user language from tree class

Definition at line 275 of file class.ilTree.php.

References $DIC.

                                  : void
    {
        global $DIC;

        if ($DIC->offsetExists('ilUser')) {
            $this->lang_code = $DIC->user()->getCurrentLanguage() ?
                $DIC->user()->getCurrentLanguage() : self::DEFAULT_LANGUAGE;
        } else {
            $this->lang_code = self::DEFAULT_LANGUAGE;
        }
    }

initTreeImplementation()

ilTree::initTreeImplementation

(

)

Init tree implementation.

Definition at line 202 of file class.ilTree.php.

References $DIC, and __isMainTree().

Referenced by __construct(), and setTableNames().

                                            : void
    {
        global $DIC;

        if (!$DIC->isDependencyAvailable('settings') || $DIC->settings()->getModule() != 'common') {
            $setting = new ilSetting('common');
        } else {
            $setting = $DIC->settings();
        }

        if ($this->__isMainTree()) {
            if ($setting->get('main_tree_impl', 'ns') == 'ns') {
                $this->tree_impl = new ilNestedSetTree($this);
            } else {
                $this->tree_impl = new ilMaterializedPathTree($this);
            }
        } else {
            $this->tree_impl = new ilNestedSetTree($this);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNode()

ilTree::insertNode	(	int	$a_node_id,
		int	$a_parent_id,
		int	$a_pos = self::POS_LAST_NODE,
		bool	$a_reset_deletion_date = false
	)

insert new node with node_id under parent node with parent_id

Exceptions

InvalidArgumentException

Definition at line 656 of file class.ilTree.php.

References $message, __isMainTree(), ilObject\_resetDeletedDate(), ilLogLevel\ERROR, getTreeImplementation(), isInTree(), and ILIAS\Repository\logger().

Referenced by ilObjMediaPoolGUI\addMobsToPool(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilObjMediaPoolGUI\executeCommand(), ilObjMediaPoolGUI\handleUploadResult(), ILIAS\MediaPool\Tree\MediaPoolTree\insertInMepTree(), insertNodeFromTrash(), ilWorkspaceTree\insertObject(), and ilObjFolder\putInTree().

     : void {
        // CHECK node_id and parent_id > 0 if in main tree
        if ($this->__isMainTree()) {
            if ($a_node_id <= 1 || $a_parent_id <= 0) {
                $message = sprintf(
                    'Invalid parameters! $a_node_id: %s $a_parent_id: %s',
                    $a_node_id,
                    $a_parent_id
                );
                $this->logger->logStack(ilLogLevel::ERROR, $message);
                throw new InvalidArgumentException($message);
            }
        }
        if ($this->isInTree($a_node_id)) {
            throw new InvalidArgumentException("Node " . $a_node_id . " already in tree " .
                $this->table_tree . "!");
        }

        $this->getTreeImplementation()->insertNode($a_node_id, $a_parent_id, $a_pos);

        $this->in_tree_cache[$a_node_id] = true;

        // reset deletion date
        if ($a_reset_deletion_date) {
            ilObject::_resetDeletedDate($a_node_id);
        }
        if (isset($this->eventHandler) && ($this->eventHandler instanceof ilAppEventHandler) && $this->__isMainTree()) {
            $this->eventHandler->raise(
                'Services/Tree',
                'insertNode',
                [
                    'tree' => $this->table_tree,
                    'node_id' => $a_node_id,
                    'parent_id' => $a_parent_id
                ]
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNodeFromTrash()

ilTree::insertNodeFromTrash	(	int	$a_source_id,
		int	$a_target_id,
		int	$a_tree_id,
		int	$a_pos = self::POS_LAST_NODE,
		bool	$a_reset_deleted_date = false
	)

Insert node from trash deletes trash entry.

If we have database query exceptions we could wrap insertNode in try/catch and rollback if the insert failed.

Todo:

use atom query for deletion and creating or use an update statement.

Definition at line 625 of file class.ilTree.php.

References __isMainTree(), ilLoggerFactory\getLogger(), insertNode(), isInTree(), ILIAS\Repository\logger(), and ilLogLevel\WARNING.

Referenced by ilRepUtil\insertSavedNodes().

     : void {
        if ($this->__isMainTree()) {
            if ($a_source_id <= 1 || $a_target_id <= 0) {
                $this->logger->logStack(ilLogLevel::WARNING);
                throw new InvalidArgumentException('Invalid parameter given for ilTree::insertNodeFromTrash');
            }
        }
        if ($this->isInTree($a_source_id)) {
            ilLoggerFactory::getLogger('tree')->error('Node already in tree');
            ilLoggerFactory::getLogger('tree')->logStack(ilLogLevel::WARNING);
            throw new InvalidArgumentException('Node already in tree.');
        }

        $query = 'DELETE from tree ' .
            'WHERE tree = ' . $this->db->quote($a_tree_id, 'integer') . ' ' .
            'AND child = ' . $this->db->quote($a_source_id, 'integer');
        $this->db->manipulate($query);

        $this->insertNode($a_source_id, $a_target_id, self::POS_LAST_NODE, $a_reset_deleted_date);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isCacheUsed()

ilTree::isCacheUsed

(

)

Check if cache is active.

Definition at line 243 of file class.ilTree.php.

References $use_cache, and __isMainTree().

Referenced by checkForParentType(), fetchNodeData(), fetchTranslationFromObjectDataCache(), getChilds(), getPathId(), isInTree(), isSaved(), preloadDeleted(), and preloadDepthParent().

                                 : bool
    {
        return $this->__isMainTree() && $this->use_cache;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isDeleted()

ilTree::isDeleted

(

int

$a_node_id

)

This is a wrapper for isSaved() with a more useful name.

Definition at line 1399 of file class.ilTree.php.

References isSaved().

Referenced by ilEventItems\__read(), ilConditionHandler\_checkAllConditionsOfTarget(), ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingCourseIds(), ilObjCourseGrouping\_getGroupingItems(), ilInfoScreenGUI\addPreconditionSection(), ilRepUtil\deleteObjects(), ilClassificationBlockGUI\filterContainer(), ilObjCourse\findCoursesWithNotEnoughMembers(), ilObjGroup\findGroupsWithNotEnoughMembers(), ilMembershipNotifications\getActiveUsersforAllObjects(), ilPortfolioPageGUI\getCoursesOfUser(), ilObjCategoryReferenceListGUI\getProperties(), ilObjStudyProgramme\getReferencesTo(), ilObjTaxonomyAdministration\getRepositoryTaxonomies(), ilTaggingClassificationProvider\getSubTreeTags(), ilRepositoryTrashGUI\handleMultiReferences(), ilObjCategoryReferenceListGUI\initItem(), ilObjGroupReferenceListGUI\initItem(), and ilObjCourseReferenceListGUI\initItem().

                                             : bool
    {
        return $this->isSaved($a_node_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isGrandChild()

ilTree::isGrandChild	(	int	$a_startnode_id,
		int	$a_querynode_id
	)

checks if a node is in the path of an other node

Definition at line 1288 of file class.ilTree.php.

References getRelation().

Referenced by ilObjectLP\findMembershipsByPath(), ilObjectLP\handleMove(), ILIAS\COPage\Link\LinkManager\handleRepositoryLinksOnCopy(), ilObjTaxonomyGUI\pasteItems(), and ilContainerGUI\performPasteIntoMultipleObjectsObject().

                                                                          : bool
    {
        return $this->getRelation($a_startnode_id, $a_querynode_id) == self::RELATION_PARENT;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInTree()

ilTree::isInTree

(

?int

$a_node_id

)

get all information of a node.

get data of a specific node from tree and object_data

Definition at line 1217 of file class.ilTree.php.

References $res, __isMainTree(), and isCacheUsed().

Referenced by ilEventItems\__read(), ilObjContentObject\_checkPreconditionsOfPage(), ilNewsItem\_getDefaultVisibilityForRefId(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilStructureObject\_getPresentationTitle(), ilObjStyleSheet\_getStandardStyles(), ilInfoScreenGUI\addMetaDataSections(), checkForParentType(), ilObjContentObject\checkStructure(), ilObjContentObjectGUI\confirmedDelete(), ilObjContentObject\fixTree(), ilFavouritesDBRepository\getFavouritesOfUser(), ilMediaPoolPageUsagesTableGUI\getItems(), ilMediaObjectUsagesTableGUI\getItems(), ilNavigationHistory\getItems(), ilObjContentObject\hasSuccessorPage(), ilInternalLinkGUI\init(), ILIAS\MediaPool\Tree\MediaPoolTree\insertInMepTree(), insertNode(), insertNodeFromTrash(), assQuestionGUI\outPageSelector(), ilContainerStartObjects\read(), and ilSkillNotifications\sendMail().

                                             : bool
    {
        if (is_null($a_node_id) || !$a_node_id) {
            return false;
        }
        // is in tree cache
        if ($this->isCacheUsed() && isset($this->in_tree_cache[$a_node_id])) {
            return $this->in_tree_cache[$a_node_id];
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->table_tree . '.child = %s ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s';

        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            $a_node_id,
            $this->tree_id
        ));

        if ($res->numRows() > 0) {
            if ($this->__isMainTree()) {
                $this->in_tree_cache[$a_node_id] = true;
            }
            return true;
        } else {
            if ($this->__isMainTree()) {
                $this->in_tree_cache[$a_node_id] = false;
            }
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryTree()

ilTree::isRepositoryTree

(

)

check if current tree instance operates on repository tree table

Definition at line 2196 of file class.ilTree.php.

Referenced by __renumber().

                                      : bool
    {
        return $this->table_tree == 'tree';
    }

Here is the caller graph for this function:

isSaved()

ilTree::isSaved

(

int

$a_node_id

)

Use method isDeleted.

Deprecated:

since 4.4.0

Definition at line 1408 of file class.ilTree.php.

References $res, $tree_pk, __isMainTree(), and isCacheUsed().

Referenced by ilPortfolioExercise\getAssignmentsOfPortfolio(), and isDeleted().

                                           : bool
    {
        if ($this->isCacheUsed() && isset($this->is_saved_cache[$a_node_id])) {
            return $this->is_saved_cache[$a_node_id];
        }

        $query = 'SELECT ' . $this->tree_pk . ' FROM ' . $this->table_tree . ' ' .
            'WHERE child = %s ';
        $res = $this->db->queryF($query, array('integer'), array($a_node_id));
        $row = $this->db->fetchAssoc($res);

        $tree_id = $row[$this->tree_pk] ?? 0;
        if ($tree_id < 0) {
            if ($this->__isMainTree()) {
                $this->is_saved_cache[$a_node_id] = true;
            }
            return true;
        } else {
            if ($this->__isMainTree()) {
                $this->is_saved_cache[$a_node_id] = false;
            }
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupTrashedObjectTypes()

ilTree::lookupTrashedObjectTypes

(

)

Lookup object types in trash.

Returns

string[]

Definition at line 2176 of file class.ilTree.php.

References $res, and ilDBConstants\FETCHMODE_OBJECT.

                                              : array
    {
        $query = 'SELECT DISTINCT(o.type) ' . $this->db->quoteIdentifier('type') .
            ' FROM tree t JOIN object_reference r ON child = r.ref_id ' .
            'JOIN object_data o on r.obj_id = o.obj_id ' .
            'WHERE tree < ' . $this->db->quote(0, 'integer') . ' ' .
            'AND child = -tree ' .
            'GROUP BY o.type';
        $res = $this->db->query($query);

        $types_deleted = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $types_deleted[] = (string) $row->type;
        }
        return $types_deleted;
    }

lookupTreesForNode()

static ilTree::lookupTreesForNode ( int  $node_id )

static

Parameters

int

$node_id

Returns

int[]

Definition at line 182 of file class.ilTree.php.

References $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), ilDBInterface\query(), ilDBInterface\quote(), and ilDBConstants\T_INTEGER.

Referenced by ilRepUtil\removeObjectsFromSystem(), and ilRepUtil\restoreObjects().

                                                           : array
    {
        global $DIC;

        $db = $DIC->database();

        $query = 'select tree from tree ' .
            'where child = ' . $db->quote($node_id, \ilDBConstants::T_INTEGER);
        $res = $db->query($query);

        $trees = [];
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            $trees[] = (int) $row->tree;
        }
        return $trees;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveToTrash()

ilTree::moveToTrash	(	int	$a_node_id,
		bool	$a_set_deleted = false,
		int	$a_deleted_by = 0
	)

Move node to trash bin.

Exceptions

InvalidArgumentException

Todo:

remove ilUser dependency

Definition at line 1361 of file class.ilTree.php.

References $DIC, $res, ilLogLevel\ERROR, ilDBConstants\FETCHMODE_ASSOC, getNodeTreeData(), getTreeImplementation(), ILIAS\Repository\int(), ILIAS\Repository\logger(), and ilObject\setDeletedDates().

Referenced by ilRepUtil\deleteObjects().

                                                                                                   : bool
    {
        global $DIC;

        $user = $DIC->user();
        if (!$a_deleted_by) {
            $a_deleted_by = $user->getId();
        }

        if (!$a_node_id) {
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('No valid parameter given! $a_node_id: ' . $a_node_id);
        }

        $query = $this->getTreeImplementation()->getSubTreeQuery($this->getNodeTreeData($a_node_id), [], false);
        $res = $this->db->query($query);

        $subnodes = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $subnodes[] = (int) $row['child'];
        }

        if (!count($subnodes)) {
            // Possibly already deleted
            return false;
        }

        if ($a_set_deleted) {
            ilObject::setDeletedDates($subnodes, $a_deleted_by);
        }
        // netsted set <=> mp
        $this->getTreeImplementation()->moveToTrash($a_node_id);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveTree()

ilTree::moveTree	(	int	$a_source_id,
		int	$a_target_id,
		int	$a_location = self::POS_LAST_NODE
	)

Move Tree Implementation public.

Parameters

int	source ref_id
int	target ref_id
int	location ilTree::POS_LAST_NODE or ilTree::POS_FIRST_NODE

Returns

int

Definition at line 2060 of file class.ilTree.php.

References $GLOBALS, __isMainTree(), getParentId(), and getTreeImplementation().

Referenced by ilObjTaxonomyGUI\pasteItems(), and ilContainerGUI\performPasteIntoMultipleObjectsObject().

                                                                                                     : void
    {
        $old_parent_id = $this->getParentId($a_source_id);
        $this->getTreeImplementation()->moveTree($a_source_id, $a_target_id, $a_location);
        if (isset($GLOBALS['DIC']["ilAppEventHandler"]) && $this->__isMainTree()) {
            $GLOBALS['DIC']['ilAppEventHandler']->raise(
                "Services/Tree",
                "moveTree",
                array(
                    'tree' => $this->table_tree,
                    'source_id' => $a_source_id,
                    'target_id' => $a_target_id,
                    'old_parent_id' => $old_parent_id
                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

preloadDeleted()

ilTree::preloadDeleted

(

array

$a_node_ids

)

Preload deleted information.

Definition at line 1436 of file class.ilTree.php.

References $res, __isMainTree(), and isCacheUsed().

                                                     : void
    {
        if (!is_array($a_node_ids) || !$this->isCacheUsed()) {
            return;
        }

        $query = 'SELECT ' . $this->tree_pk . ', child FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->db->in("child", $a_node_ids, false, "integer");

        $res = $this->db->query($query);
        while ($row = $this->db->fetchAssoc($res)) {
            if ($row[$this->tree_pk] < 0) {
                if ($this->__isMainTree()) {
                    $this->is_saved_cache[$row["child"]] = true;
                }
            } else {
                if ($this->__isMainTree()) {
                    $this->is_saved_cache[$row["child"]] = false;
                }
            }
        }
    }

Here is the call graph for this function:

preloadDepthParent()

ilTree::preloadDepthParent

(

array

$a_node_ids

)

Preload depth/parent.

Parameters

int[]

Definition at line 843 of file class.ilTree.php.

References $DIC, $res, __isMainTree(), ILIAS\Repository\int(), and isCacheUsed().

                                                         : void
    {
        global $DIC;

        if (!$this->__isMainTree() || !$this->isCacheUsed()) {
            return;
        }

        $res = $this->db->query('SELECT t.depth, t.parent, t.child ' .
            'FROM ' . $this->table_tree . ' t ' .
            'WHERE ' . $this->db->in("child", $a_node_ids, false, "integer") .
            'AND ' . $this->tree_pk . ' = ' . $this->db->quote($this->tree_id, "integer"));
        while ($row = $this->db->fetchAssoc($res)) {
            $this->depth_cache[$row["child"]] = (int) $row["depth"];
            $this->parent_cache[$row["child"]] = (int) $row["parent"];
        }
    }

Here is the call graph for this function:

readRootId()

ilTree::readRootId

(

)

Definition at line 1611 of file class.ilTree.php.

References $res, $root_id, and ILIAS\Repository\int().

Referenced by ilWorkspaceTree\__construct(), ilSCORMExplorer\__construct(), ilLMTree\__construct(), ilContainerSelectionExplorer\__construct(), ilTaxonomyTableGUI\__construct(), ilLMExplorerGUI\__construct(), ilTestTaxonomyTree\__construct(), ilSolutionExplorer\__construct(), ilObjContentObject\_checkPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilObjSCORMLearningModule\_getTrackingItems(), ilObjMediaPoolGUI\afterConstructor(), ilWorkspaceTree\cascadingDelete(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilObjSkillTreeGUI\delete(), ilObjTaxonomy\doDelete(), ilSCORMPresentationGUI\explorer(), ilStructureObject\getChapterList(), ilGlobalVirtualSkillTree\getChildsOfNode(), ilLMTree\getCompleteTree(), ilObjPortfolioGUI\getCreateInfoMessage(), ilPortfolioPageTableGUI\getItems(), ilSkillTree\getMaxOrderNr(), ilTaxonomyClassificationExplorerGUI\getTreeComponent(), ilTreeExplorerGUI\getTreeComponent(), ilObjPortfolioGUI\initBlogForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilObjTaxonomyGUI\listNodes(), ilObjTaxonomyGUI\pasteItems(), ilObjPortfolioGUI\saveBlog(), ilContentStyleSettingsGUI\saveScope(), ilGroupAddToGroupActionGUI\selectGroup(), ilGroupAddToGroupActionGUI\selectParent(), ilObjContentObjectGUI\showExportIDsOverview(), ilObjContentObjectGUI\showLMGlossarySelector(), and ilObjWorkspaceFolderGUI\showMoveIntoObjectTree().

                                : int
    {
        $query = 'SELECT child FROM ' . $this->table_tree . ' ' .
            'WHERE parent = %s ' .
            'AND ' . $this->tree_pk . ' = %s ';
        $res = $this->db->queryF($query, array('integer', 'integer'), array(
            0,
            $this->tree_id
        ));
        $this->root_id = 0;
        if ($row = $this->db->fetchObject($res)) {
            $this->root_id = (int) $row->child;
        }
        return $this->root_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeTree()

ilTree::removeTree

(

int

$a_tree_id

)

remove an existing tree

Definition at line 1339 of file class.ilTree.php.

References __isMainTree(), ilLogLevel\ERROR, and ILIAS\Repository\logger().

                                              : bool
    {
        if ($this->__isMainTree()) {
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Operation not allowed on main tree');
        }
        if (!$a_tree_id) {
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Missing parameter tree id');
        }

        $query = 'DELETE FROM ' . $this->table_tree .
            ' WHERE ' . $this->tree_pk . ' = %s ';
        $this->db->manipulateF($query, array('integer'), array($a_tree_id));
        return true;
    }

Here is the call graph for this function:

renumber()

ilTree::renumber	(	int	$node_id = 1,
		int	$i = 1
	)

Wrapper for renumber.

This method locks the table tree (recursive)

Definition at line 1762 of file class.ilTree.php.

References $db, __isMainTree(), and __renumber().

Referenced by ilObjContentObject\fixTree(), and ilValidator\initGapsInTree().

                                                          : int
    {
        $renumber_callable = function (ilDBInterface $db) use ($node_id, $i, &$return) {
            $return = $this->__renumber($node_id, $i);
        };

        // LOCKED ###################################
        if ($this->__isMainTree()) {
            $ilAtomQuery = $this->db->buildAtomQuery();
            $ilAtomQuery->addTableLock($this->table_tree);

            $ilAtomQuery->addQueryCallable($renumber_callable);
            $ilAtomQuery->run();
        } else {
            $renumber_callable($this->db);
        }
        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetInTreeCache()

ilTree::resetInTreeCache

(

)

reset in tree cache

Definition at line 330 of file class.ilTree.php.

Referenced by deleteTree().

                                      : void
    {
        $this->in_tree_cache = array();
    }

Here is the caller graph for this function:

setObjectTablePK()

ilTree::setObjectTablePK

(

string

$a_column_name

)

set column containing primary key in object table

Definition at line 367 of file class.ilTree.php.

Referenced by ilECSCmsTree\__construct(), and ilWorkspaceTree\__construct().

                                                           : void
    {
        $this->obj_pk = $a_column_name;
    }

Here is the caller graph for this function:

setReferenceTablePK()

ilTree::setReferenceTablePK

(

string

$a_column_name

)

set column containing primary key in reference table

Definition at line 359 of file class.ilTree.php.

Referenced by ilWorkspaceTree\__construct().

                                                              : void
    {
        $this->ref_pk = $a_column_name;
    }

Here is the caller graph for this function:

setRootId()

ilTree::setRootId

(

int

$a_root_id

)

Definition at line 1632 of file class.ilTree.php.

Referenced by ilWorkspaceTree\createTreeForUser().

                                             : void
    {
        $this->root_id = $a_root_id;
    }

Here is the caller graph for this function:

setTableNames()

ilTree::setTableNames	(	string	$a_table_tree,
		string	$a_table_obj_data,
		string	$a_table_obj_reference = ""
	)

set table names The primary key of the table containing your object_data must be 'obj_id' You may use a reference table.

If no reference table is specified the given tree table is directly joined with the given object_data table. The primary key in object_data table and its foreign key in reference table must have the same name!

Definition at line 343 of file class.ilTree.php.

References initTreeImplementation().

Referenced by ILIAS\MediaPool\Tree\MediaPoolTree\__construct(), ilTaxonomyTree\__construct(), ilECSCmsTree\__construct(), ilWorkspaceTree\__construct(), ilLMTree\__construct(), ilSCORM2004Tree\__construct(), ilSkillTree\__construct(), ilSCORMTree\__construct(), ilObjContentObject\_checkPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilObjMediaPool\_getPoolTree(), ilObjContentObject\hasSuccessorPage(), and ilStructureObjectGUI\putInTree().

     : void {
        $this->table_tree = $a_table_tree;
        $this->table_obj_data = $a_table_obj_data;
        $this->table_obj_reference = $a_table_obj_reference;

        // reconfigure tree implementation
        $this->initTreeImplementation();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTreeId()

ilTree::setTreeId

(

int

$a_tree_id

)

Definition at line 1642 of file class.ilTree.php.

                                             : void
    {
        $this->tree_id = $a_tree_id;
    }

setTreeTablePK()

ilTree::setTreeTablePK

(

string

$a_column_name

)

set column containing primary key in tree table

Definition at line 375 of file class.ilTree.php.

Referenced by ILIAS\MediaPool\Tree\MediaPoolTree\__construct(), ilTaxonomyTree\__construct(), ilWorkspaceTree\__construct(), ilLMTree\__construct(), ilSCORM2004Tree\__construct(), ilSkillTree\__construct(), ilSCORMTree\__construct(), ilObjContentObject\_checkPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilObjMediaPool\_getPoolTree(), ilObjContentObject\hasSuccessorPage(), and ilStructureObjectGUI\putInTree().

                                                         : void
    {
        $this->tree_pk = $a_column_name;
    }

Here is the caller graph for this function:

useCache()

ilTree::useCache

(

bool

$a_use = true

)

Use Cache (usually activated)

Definition at line 235 of file class.ilTree.php.

Referenced by ilECSCmsTree\__construct(), ilLMTree\__construct(), and ilRepUtil\deleteObjects().

                                                : void
    {
        $this->use_cache = $a_use;
    }

Here is the caller graph for this function:

validateParentRelations()

ilTree::validateParentRelations

(

)

Validate parent relations of tree.

Returns

int[] array of failure nodes

Definition at line 787 of file class.ilTree.php.

References getTreeImplementation().

                                             : array
    {
        return $this->getTreeImplementation()->validateParentRelations();
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilTree::$db

protected

Definition at line 47 of file class.ilTree.php.

Referenced by ilWorkspaceTree\createReference(), ilWorkspaceTree\deleteReference(), ilWorkspaceTree\exists(), ilLMTree\getLastActivePage(), ilSkillTree\initChildsData(), ilWorkspaceTree\lookupNodeId(), ilWorkspaceTree\lookupObjectId(), ilWorkspaceTree\lookupOwner(), and renumber().

$depth_cache

array ilTree::$depth_cache = []

protected

Definition at line 119 of file class.ilTree.php.

Referenced by getDepthCache().

$eventHandler

ilAppEventHandler ilTree::$eventHandler

protected

Definition at line 48 of file class.ilTree.php.

$gap

int ilTree::$gap

private

Size of the gaps to be created in the nested sets sequence numbering of the tree nodes.

Having gaps in the tree greatly improves performance on all operations that add or remove tree nodes. Setting this to zero will leave no gaps in the tree. Setting this to a value larger than zero will create gaps in the tree. Each gap leaves room in the sequence numbering for the specified number of nodes. (The gap is expressed as the number of nodes. Since each node consumes two sequence numbers, specifying a gap of 1 will leave space for 2 sequence numbers.) A gap is created, when a new child is added to a node, and when not enough room between node.rgt and the child with the highest node.rgt value of the node is available. A gap is closed, when a node is removed and when (node.rgt - node.lft) is bigger than gap * 2.

Definition at line 114 of file class.ilTree.php.

Referenced by getGap().

$in_tree_cache

array ilTree::$in_tree_cache = []

protected

Definition at line 121 of file class.ilTree.php.

$is_saved_cache

array ilTree::$is_saved_cache = []

protected

Definition at line 124 of file class.ilTree.php.

$lang_code

string ilTree::$lang_code

private

Definition at line 54 of file class.ilTree.php.

Referenced by fetchNodeData(), and getLangCode().

$logger

ilLogger ilTree::$logger

protected

Definition at line 46 of file class.ilTree.php.

$obj_pk

string ilTree::$obj_pk

protected

column name containing primary key in object table

Definition at line 89 of file class.ilTree.php.

Referenced by checkTreeChilds(), and ilWorkspaceTree\lookupObjectId().

$oc_preloaded

array ilTree::$oc_preloaded = []

protected

Definition at line 118 of file class.ilTree.php.

$parent_cache

array ilTree::$parent_cache = []

protected

Definition at line 120 of file class.ilTree.php.

Referenced by getParentCache().

$parent_type_cache

array ilTree::$parent_type_cache = []

protected

Definition at line 123 of file class.ilTree.php.

$path_id_cache

array ilTree::$path_id_cache = []

private

Definition at line 128 of file class.ilTree.php.

$ref_pk

string ilTree::$ref_pk

protected

column name containing primary key in reference table

Definition at line 84 of file class.ilTree.php.

Referenced by ilWorkspaceTree\lookupNodeId().

$root_id

int ilTree::$root_id

protected

points to root node (may be a subtree)

Definition at line 59 of file class.ilTree.php.

Referenced by ilWorkspaceTree\cascadingDelete(), ilWorkspaceTree\createTreeForUser(), getRootId(), and readRootId().

$table_obj_data

string ilTree::$table_obj_data

protected

table name of object_data table

Definition at line 74 of file class.ilTree.php.

Referenced by getObjectDataTable().

$table_obj_reference

string ilTree::$table_obj_reference

protected

table name of object_reference table

Definition at line 79 of file class.ilTree.php.

Referenced by getTableReference().

$table_tree

string ilTree::$table_tree

protected

table name of tree table

Definition at line 69 of file class.ilTree.php.

Referenced by getMaximumDepth(), and getTreeTable().

$translation_cache

array ilTree::$translation_cache = []

protected

Definition at line 122 of file class.ilTree.php.

$tree_id

int ilTree::$tree_id

protected

to use different trees in one db-table

Definition at line 64 of file class.ilTree.php.

Referenced by getNodeData(), and getTreeId().

$tree_impl

ilTreeImplementation ilTree::$tree_impl = null

private

Definition at line 126 of file class.ilTree.php.

Referenced by getTreeImplementation().

$tree_pk

string ilTree::$tree_pk

protected

column name containing tree id in tree table

Definition at line 94 of file class.ilTree.php.

Referenced by getNodeData(), getTreePk(), and isSaved().

$use_cache

bool ilTree::$use_cache

protected

Definition at line 116 of file class.ilTree.php.

Referenced by ilLMTree\isCacheUsed(), and isCacheUsed().

DEFAULT_GAP

const ilTree::DEFAULT_GAP = 50

protected

Definition at line 44 of file class.ilTree.php.

DEFAULT_LANGUAGE

const ilTree::DEFAULT_LANGUAGE = 'en'

protected

Definition at line 43 of file class.ilTree.php.

POS_FIRST_NODE

const ilTree::POS_FIRST_NODE = -1

Definition at line 35 of file class.ilTree.php.

Referenced by ilObjContentObjectGUI\confirmedDelete(), ilObjContentObjectGUI\delete(), ILIAS\Skill\Node\SkillDeletionManager\deleteNode(), ilObjSkillTreeGUI\deleteNodes(), ILIAS\Skill\Node\SkillDeletionManager\deleteTree(), ilObjContentObject\executeDragDrop(), ilStructureObjectGUI\insertChapter(), ilObjContentObjectGUI\insertChapter(), ilStructureObjectGUI\insertChapterClip(), ilObjContentObjectGUI\insertChapterClip(), ilNestedSetTree\insertNode(), ilStructureObjectGUI\insertPage(), ilStructureObjectGUI\insertPageClip(), ilLMPageObject\insertPagesFromTemplate(), ilObjContentObjectGUI\moveChapter(), ILIAS\Skill\Node\SkillTreeNodeManager\putIntoTree(), ilLMObjectGUI\putInTree(), ilTaxonomyNode\putInTree(), ilStructureObjectGUI\putInTree(), ilLMObject\putInTree(), ilObjContentObject\removeAutoGlossary(), and ilStructureObjectGUI\subchap().

POS_LAST_NODE

const ilTree::POS_LAST_NODE = -2

Definition at line 34 of file class.ilTree.php.

Referenced by ilLMObject\clipboardCopy(), ilObjContentObject\copyAllPagesAndChapters(), ilLearningModuleDataSet\importRecord(), ILIAS\Skill\Node\SkillTreeNodeManager\insertItemsFromClip(), ilNestedSetTree\insertNode(), ilRepUtil\insertSavedNodes(), ILIAS\Skill\Node\SkillTreeNodeManager\pasteTree(), ilStructureObjectGUI\putInTree(), ilBasicSkillGUI\saveItem(), ilSkillCategoryGUI\saveItem(), ilBasicSkillTemplateGUI\saveItem(), ilSkillTemplateReferenceGUI\saveItem(), and ilSkillTemplateCategoryGUI\saveItem().

RELATION_CHILD

const ilTree::RELATION_CHILD = 1

Definition at line 37 of file class.ilTree.php.

Referenced by ilObjRole\adjustPermissions(), ilSoapUtils\findMappedReferenceForNode(), ilMaterializedPathTree\getRelation(), and ilNestedSetTree\getRelation().

RELATION_EQUALS

const ilTree::RELATION_EQUALS = 4

Definition at line 40 of file class.ilTree.php.

Referenced by ilObjRole\adjustPermissions(), ilMaterializedPathTree\getRelation(), and ilNestedSetTree\getRelation().

RELATION_NONE

const ilTree::RELATION_NONE = 5

Definition at line 41 of file class.ilTree.php.

Referenced by ilObjRole\adjustPermissions(), ilMaterializedPathTree\getRelation(), and ilNestedSetTree\getRelation().

RELATION_PARENT

const ilTree::RELATION_PARENT = 2

Definition at line 38 of file class.ilTree.php.

Referenced by ilObjRole\adjustPermissions(), ilMaterializedPathTree\getRelation(), ilNestedSetTree\getRelation(), and ilAdvancedMDRecord\isFilteredByScope().

RELATION_SIBLING

const ilTree::RELATION_SIBLING = 3

Definition at line 39 of file class.ilTree.php.

Referenced by ilObjRole\adjustPermissions(), ilMaterializedPathTree\getRelation(), and ilNestedSetTree\getRelation().

TREE_TYPE_MATERIALIZED_PATH

const ilTree::TREE_TYPE_MATERIALIZED_PATH = 'mp'

Definition at line 31 of file class.ilTree.php.

TREE_TYPE_NESTED_SET

const ilTree::TREE_TYPE_NESTED_SET = 'ns'

Definition at line 32 of file class.ilTree.php.

---

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

• Services/Tree/classes/class.ilTree.php