ilTree Class Reference

Tree class data representation in hierachical trees using the Nested Set Model with Gaps by Joe Celco. More...

Inheritance diagram for ilTree:

Collaboration diagram for ilTree:

Public Member Functions
	__construct ($a_tree_id, $a_root_id=0)
	Constructor public. More...
	initTreeImplementation ()
	Init tree implementation. More...
	getTreeImplementation ()
	Get tree implementation. More...
	useCache ($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 ()
	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 ()
	setTableNames ($a_table_tree, $a_table_obj_data, $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 ($a_column_name)
	set column containing primary key in reference table public More...
	setObjectTablePK ($a_column_name)
	set column containing primary key in object table public More...
	setTreeTablePK ($a_column_name)
	set column containing primary key in tree table public More...
	buildJoin ()
	build join depending on table settings private More...
	getRelation ($a_node_a, $a_node_b)
	Get relation of two nodes. More...
	getRelationOfNodes ($a_node_a_arr, $a_node_b_arr)
	get relation of two nodes by node data More...
	getChildIds ($a_node)
	Get node child ids type $ilDB. More...
	getChilds ($a_node_id, $a_order="", $a_direction="ASC")
	get child nodes of given node public More...
	getFilteredChilds ($a_filter, $a_node, $a_order="", $a_direction="ASC")
	get child nodes of given node (exclude filtered obj_types) public More...
	getChildsByType ($a_node_id, $a_type)
	get child nodes of given node by object type public More...
	getChildsByTypeFilter ($a_node_id, $a_types, $a_order="", $a_direction="ASC")
	get child nodes of given node by object type public More...
	insertNodeFromTrash ($a_source_id, $a_target_id, $a_tree_id, $a_pos=IL_LAST_NODE, $a_reset_deleted_date=false)
	Insert node from trash deletes trash entry. More...
	insertNode ($a_node_id, $a_parent_id, $a_pos=IL_LAST_NODE, $a_reset_deletion_date=false)
	insert new node with node_id under parent node with parent_id public More...
	getFilteredSubTree ($a_node_id, $a_filter=array())
	get filtered subtree More...
	getSubTreeIds ($a_ref_id)
	Get all ids of subnodes. More...
	getSubTree ($a_node, $a_with_data=true, $a_type="")
	get all nodes in the subtree under specified node More...
	getSubTreeTypes ($a_node, $a_filter=0)
	get types of nodes in the subtree under specified node More...
	deleteTree ($a_node)
	delete node and the whole subtree under this node public More...
	validateParentRelations ()
	Validate parent relations of tree. More...
	getPathFull ($a_endnode_id, $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 ($a_node_ids)
	Preload depth/parent. More...
	getPathId ($a_endnode_id, $a_startnode_id=0)
	get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode public More...
	getNodePathForTitlePath ($titlePath, $a_startnode_id=null)
	Converts a path consisting of object titles into a path consisting of tree nodes. More...
	getNodePath ($a_endnode_id, $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 public More...
	checkTreeChilds ($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 public. More...
	getDepth ($a_node_id)
	return depth of a node in tree private More...
	getNodeTreeData ($a_node_id)
	return all columns of tabel tree More...
	getNodeData ($a_node_id, $a_tree_pk=null)
	get all information of a node. More...
	fetchNodeData ($a_row)
	get data of parent node from tree and object_data private More...
	isInTree ($a_node_id)
	get all information of a node. More...
	getParentNodeData ($a_node_id)
	get data of parent node from tree and object_data public More...
	isGrandChild ($a_startnode_id, $a_querynode_id)
	checks if a node is in the path of an other node public More...
	addTree ($a_tree_id, $a_node_id=-1)
	create a new tree to do: ??? More...
	getNodeDataByType ($a_type)
	get nodes by type More...
	removeTree ($a_tree_id)
	remove an existing tree More...
	moveToTrash ($a_node_id, $a_set_deleted=false, $a_deleted_by=0)
	Move node to trash bin. More...
	isDeleted ($a_node_id)
	This is a wrapper for isSaved() with a more useful name. More...
	isSaved ($a_node_id)
	Use method isDeleted check if node is saved. More...
	preloadDeleted ($a_node_ids)
	Preload deleted information. More...
	getSavedNodeData ($a_parent_id)
	get data saved/deleted nodes More...
	getSavedNodeObjIds (array $a_obj_ids)
	get object id of saved/deleted nodes More...
	getParentId ($a_node_id)
	get parent id of given node public More...
	getLeftValue ($a_node_id)
	get left value of given node public More...
	getChildSequenceNumber ($a_node, $type="")
	get sequence number of node in sibling sequence public More...
	readRootId ()
	read root id from database More...
	getRootId ()
	get the root id of tree public More...
	setRootId ($a_root_id)
	getTreeId ()
	get tree id public More...
	setTreeId ($a_tree_id)
	set tree id public More...
	fetchSuccessorNode ($a_node_id, $a_type="")
	get node data of successor node More...
	fetchPredecessorNode ($a_node_id, $a_type="")
	get node data of predecessor node More...
	renumber ($node_id=1, $i=1)
	Wrapper for renumber. More...
	__renumber ($node_id=1, $i=1)
	This method is private. More...
	checkForParentType ($a_ref_id, $a_type, $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 ($a_node)
	Check for deleteTree() compares a subtree of a given node by checking lft, rgt against parent relation. More...
	__getSubTreeByParentRelation ($a_node_id, &$parent_childs)
	type $ilDB More...
	__validateSubtrees (&$lft_childs, $parent_childs)
	moveTree ($a_source_id, $a_target_id, $a_location=self::POS_LAST_NODE)
	Move Tree Implementation. More...
	getRbacSubtreeInfo ($a_endnode_id)
	This method is used for change existing objects and returns all necessary information for this action. More...
	getSubTreeQuery ($a_node_id, $a_fields=array(), $a_types='', $a_force_join_reference=false)
	Get tree subtree query. More...
	getTrashSubTreeQuery ($a_node_id, $a_fields=[], $a_types='', $a_force_join_reference=false)
	getSubTreeFilteredByObjIds ($a_node_id, array $a_obj_ids, array $a_fields=array())
	get all node ids in the subtree under specified node id, filter by object ids More...
	deleteNode ($a_tree_id, $a_node_id)
	lookupTrashedObjectTypes ()
	Lookup object types in trash type $ilDB. More...
	isRepositoryTree ()
	check if current tree instance operates on repository tree table More...

Static Public Member Functions
static	lookupTreesForNode (int $node_id)
static	_removeEntry ($a_tree, $a_child, $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
	$ilias
	$log
	$root_id
	$tree_id
	$table_tree
	$table_obj_data
	$table_obj_reference
	$ref_pk
	$obj_pk
	$tree_pk
	$gap

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

Protected Attributes
	$depth_cache = array()
	$parent_cache = array()
	$in_tree_cache = array()

Private Attributes
	$tree_impl = null

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilTree::__construct	(		$a_tree_id,
			$a_root_id = 0
	)

Constructor public.

Parameters

integer	$a_tree_id	tree_id
integer	$a_root_id	root_id (optional)

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, ilLogLevel\DEBUG, ilLoggerFactory\getLogger(), and initTreeImplementation().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // set db
        $this->ilDB = $ilDB;

        $this->lang_code = "en";

        // CREATE LOGGER INSTANCE
        $this->log = ilLoggerFactory::getLogger('tree');

        if (!isset($a_tree_id) or (func_num_args() == 0)) {
            $this->log->error("No tree_id given!");
            $this->log->logStack(ilLogLevel::DEBUG);
            throw new InvalidArgumentException("No tree_id given!");
        }

        if (func_num_args() > 2) {
            $this->log->error("Wrong parameter count!");
            throw new InvalidArgumentException("Wrong parameter count!");
        }

        //init variables
        if (empty($a_root_id)) {
            $a_root_id = ROOT_FOLDER_ID;
        }

        $this->tree_id = $a_tree_id;
        $this->root_id = $a_root_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;

        // If cache is activated, cache object translations to improve performance
        $this->translation_cache = array();
        $this->parent_type_cache = array();

        // By default, we create gaps in the tree sequence numbering for 50 nodes
        $this->gap = 50;
        
        
        // init tree implementation
        $this->initTreeImplementation();
    }

Here is the call graph for this function:

Member Function Documentation

__checkDelete()

ilTree::__checkDelete

(

$a_node

)

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

private

Parameters

array

node data from ilTree::getNodeData()

Returns

boolean

Exceptions

ilInvalidTreeStructureException

Deprecated:

since 4.4.0

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

References $DIC, $ilDB, $message, $query, $res, __getSubTreeByParentRelation(), __validateSubtrees(), and getTreeImplementation().

Referenced by deleteTree().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        
        $query = $this->getTreeImplementation()->getSubTreeQuery($a_node, array(), false);
        $this->log->debug($query);
        $res = $ilDB->query($query);
        
        $counter = (int) $lft_childs = array();
        while ($row = $ilDB->fetchObject($res)) {
            $lft_childs[$row->child] = $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->log->error($message);
            throw new ilInvalidTreeStructureException($message);
        }

        // GET SUBTREE BY PARENT RELATION
        $parent_childs = array();
        $this->__getSubTreeByParentRelation($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	(		$a_node_id,
		&	$parent_childs
	)

type $ilDB

Parameters

type	$a_node_id
type	$parent_childs

Returns

boolean

Exceptions

ilInvalidTreeStructureException

Deprecated:

since 4.4.0

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

References $DIC, $ilDB, $message, $query, and $res.

Referenced by __checkDelete().

    {
        global $DIC;

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

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

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

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

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

Here is the caller graph for this function:

__isMainTree()

ilTree::__isMainTree

(

)

Check if operations are done on main tree.

private

Returns

boolean

Definition at line 2540 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().

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

Here is the caller graph for this function:

__renumber()

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

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) private

Parameters

integer	node_id where to start (usually the root node)
integer	first left value of start node (usually 1)

Returns

integer current left value of recursive call

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

References $DIC, $i, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and isRepositoryTree().

Referenced by renumber().

    {
        global $DIC;

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

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

        $childs = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $childs[] = $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 = $ilDB->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 = $ilDB->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	(	&	$lft_childs,
			$parent_childs
	)

Parameters

$lft_childs
$parent_childs

Returns

bool

Exceptions

ilInvalidTreeStructureException

Deprecated:

since 4.4.0

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

References $message.

Referenced by __checkDelete().

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

        $this->log->debug('left childs ' . print_r($lft_childs, true));
        $this->log->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->log->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->log->error($message);
                throw new ilInvalidTreeStructureException($message);
            }
            if ($key == ROOT_FOLDER_ID) {
                $message = '(ROOT_FOLDER) Tree is corrupted! Tried to delete root folder';
                $this->log->error($message);
                throw new ilInvalidTreeStructureException($message);
            }
        }
        return true;
    }

Here is the caller graph for this function:

_removeEntry()

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

static

STATIC METHOD Removes a single entry from a tree.

The tree structure is NOT updated!

public

Parameters

integer	tree id
integer	child id
string	db_table name. default is 'tree' (optional)

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, $res, and ilLoggerFactory\getLogger().

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if ($a_db_table === 'tree') {
            if ($a_tree == 1 and $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 = $ilDB->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	(		$a_tree_id,
			$a_node_id = -1
	)

create a new tree to do: ???

Parameters

integer	a_tree_id: obj_id of object where tree belongs to
integer	a_node_id: root node of tree (optional; default is tree_id itself)

Returns

boolean true on success

Exceptions

InvalidArgumentException

public

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

References $DIC, $ilDB, $message, $query, $res, and __isMainTree().

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // 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->log->error($message);
            throw new InvalidArgumentException($message);
        }

        if (!isset($a_tree_id)) {
            $message = "No tree_id given!";
            $this->log->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 = $ilDB->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 465 of file class.ilTree.php.

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

    {
        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	(		$a_ref_id,
			$a_type,
			$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');.

public

Parameters

integer	ref_id
string	type

Returns

mixed false if item is not in tree, int (object ref_id) > 0 if path container course, int 0 if pathc does not contain the object type

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

References $a_type, __isMainTree(), getPathFull(), isCacheUsed(), and isInTree().

    {
        // #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 $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 false;
        }
        
        $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] = $node["child"];
                }
                return $node["child"];
            }
        }
        
        if ($do_cache) {
            $this->parent_type_cache[$cache_key] = false;
        }
        return 0;
    }

Here is the call graph for this function:

checkTree()

ilTree::checkTree

(

)

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

Returns

boolean true if tree is ok; otherwise throws error object

Exceptions

ilInvalidTreeStructureException

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

References $DIC, $ilDB, $message, $query, and $res.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $types = array('integer');
        $query = 'SELECT lft,rgt FROM ' . $this->table_tree . ' ' .
            'WHERE ' . $this->tree_pk . ' = %s ';
        
        $res = $ilDB->queryF($query, $types, array($this->tree_id));
        while ($row = $ilDB->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->log->error($message);
            throw new ilInvalidTreeStructureException($message);
        }

        return true;
    }

checkTreeChilds()

ilTree::checkTreeChilds

(

$a_no_zero_child = true

)

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

Parameters

bool

$a_no_zero_child

Returns

bool

Exceptions

ilInvalidTreeStructureException

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

References $DIC, $ilDB, $message, $obj_pk, and $query.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                'WHERE ' . $this->tree_pk . ' = %s ' .
                'ORDER BY lft';
        $r1 = $ilDB->queryF($query, array('integer'), array($this->tree_id));
        
        while ($row = $ilDB->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->log->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 = $ilDB->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->log->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
                if ($r2->numRows() > 1) {
                    $message = "More Object-to-Reference entries found for ID " . $row["child"] . "!";
                    $this->log->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }

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

                $query = 'SELECT * FROM ' . $this->table_obj_data . ' WHERE ' . $this->obj_pk . ' = %s';
                $r3 = $ilDB->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->log->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
                if ($r3->numRows() > 1) {
                    $message = "More childs found for ID " . $obj_ref[$this->obj_pk] . "!";
                    $this->log->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
            } else {
                // get only object data
                $query = 'SELECT * FROM ' . $this->table_obj_data . ' WHERE ' . $this->obj_pk . ' = %s';
                $r2 = $ilDB->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->log->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
                if ($r2->numRows() > 1) {
                    $message = "More childs found for ID " . $row["child"] . "!";
                    $this->log->error($message);
                    throw new ilInvalidTreeStructureException($message);
                }
            }
        }

        return true;
    }

deleteNode()

ilTree::deleteNode	(		$a_tree_id,
			$a_node_id
	)

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

References $DIC, $ilDB, and $query.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        
        $query = 'DELETE FROM tree where ' .
                'child = ' . $ilDB->quote($a_node_id, 'integer') . ' ' .
                'AND tree = ' . $ilDB->quote($a_tree_id, 'integer');
        $ilDB->manipulate($query);

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

deleteTree()

ilTree::deleteTree

(

$a_node

)

delete node and the whole subtree under this node public

Parameters

array

node_data of a node

Exceptions

InvalidArgumentException
ilInvalidTreeStructureException

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

References $DIC, $ilDB, __checkDelete(), __isMainTree(), ilLogLevel\ERROR, getTreeImplementation(), and resetInTreeCache().

Referenced by ilWorkspaceTree\cascadingDelete().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->log->debug('Delete tree with node ' . $a_node);
        
        if (!is_array($a_node)) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException(__METHOD__ . ': Wrong datatype for node data!');
        }
        
        $this->log->debug($this->tree_pk);
        
        if ($this->__isMainTree()) {
            // @todo normally this part is not executed, since the subtree is first
            // moved to trash and then deleted.
            if (!$this->__checkDelete($a_node)) {
                $this->log->logStack(ilLogLevel::ERROR);
                throw new ilInvalidTreeStructureException('Deletion canceled due to invalid tree structure.' . print_r($a_node, true));
            }
        }

        $this->getTreeImplementation()->deleteTree($a_node['child']);
        
        $this->resetInTreeCache();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchNodeData()

ilTree::fetchNodeData

(

$a_row

)

get data of parent node from tree and object_data private

Parameters

object

db db result object containing node_data

Returns

array 2-dim (int/str) node_data TODO: select description twice for compability. Please use 'desc' in future only

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

References $data, $DIC, $ilBench, $ilDB, $lng, $query, $res, ilContainerReference\_lookupTitle(), ilObject\DESC_LENGTH, isCacheUsed(), and ilUtil\shortenText().

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

    {
        global $DIC;

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

        //$ilBench->start("Tree", "fetchNodeData_getRow");
        $data = $a_row;
        $data["desc"] = $a_row["description"];  // for compability
        //$ilBench->stop("Tree", "fetchNodeData_getRow");

        // multilingual support systemobjects (sys) & categories (db)
        //$ilBench->start("Tree", "fetchNodeData_readDefinition");
        if (is_object($objDefinition)) {
            $translation_type = $objDefinition->getTranslationType($data["type"]);
        }
        //$ilBench->stop("Tree", "fetchNodeData_readDefinition");

        if ($translation_type == "sys") {
            //$ilBench->start("Tree", "fetchNodeData_getLangData");
            if ($data["type"] == "rolf" and $data["obj_id"] != ROLE_FOLDER_ID) {
                $data["description"] = $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");
            }
            //$ilBench->stop("Tree", "fetchNodeData_getLangData");
        } elseif ($translation_type == "db") {

            // Try to retrieve object translation from cache
            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
                //$ilBench->start("Tree", "fetchNodeData_getTranslation");
                $query = 'SELECT title,description FROM object_translation ' .
                    'WHERE obj_id = %s ' .
                    'AND lang_code = %s ' .
                    'AND NOT lang_default = %s';

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

                if ($row) {
                    $data["title"] = $row->title;
                    $data["description"] = ilUtil::shortenText($row->description, ilObject::DESC_LENGTH, true);
                    $data["desc"] = $row->description;
                }
                //$ilBench->stop("Tree", "fetchNodeData_getTranslation");

                // 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] = array();
                    $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 ($data['type'] == 'crsr' or $data['type'] == 'catr' or $data['type'] == 'grpr' or $data['type'] === 'prgr') {
            include_once('./Services/ContainerReference/classes/class.ilContainerReference.php');
            $data['title'] = ilContainerReference::_lookupTitle($data['obj_id']);
        }

        return $data ? $data : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchPredecessorNode()

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

get node data of predecessor node

public

Parameters

integer

node id

Returns

array node data array

Exceptions

InvalidArgumentException

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

References $a_type, $DIC, $ilDB, $message, $query, $res, buildJoin(), and fetchNodeData().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->log->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 = $ilDB->queryF($query, array('integer','integer'), array(
            $a_node_id,
            $this->tree_id));

        $curr_node = $ilDB->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';
            $ilDB->setLimit(1);
            $res = $ilDB->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';
            $ilDB->setLimit(1);
            $res = $ilDB->queryF($query, array('integer','integer'), array(
                $curr_node['lft'],
                $this->tree_id));
        }
        
        if ($res->numRows() < 1) {
            return false;
        } else {
            $row = $ilDB->fetchAssoc($res);
            return $this->fetchNodeData($row);
        }
    }

Here is the call graph for this function:

fetchSuccessorNode()

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

get node data of successor node

public

Parameters

integer

node id

Returns

array node data array

Exceptions

InvalidArgumentException

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

References $a_type, $DIC, $ilDB, $message, $query, $res, buildJoin(), and fetchNodeData().

Referenced by ilSCORMPresentationGUI\finishSahs().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->log->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 = $ilDB->queryF($query, array('integer','integer'), array(
            $a_node_id,
            $this->tree_id));
        $curr_node = $ilDB->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 ';
            $ilDB->setLimit(1);
            $res = $ilDB->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 ';
            $ilDB->setLimit(1);
            $res = $ilDB->queryF($query, array('integer','integer'), array(
                $curr_node['lft'],
                $this->tree_id));
        }

        if ($res->numRows() < 1) {
            return false;
        } else {
            $row = $ilDB->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 (   $a_obj_ids )

protected

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

Parameters

array

$a_obj_ids

object ids

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

References $DIC, and isCacheUsed().

Referenced by getChilds().

    {
        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($id);
                $this->translation_cache[$id . '.']['description'] = $ilObjDataCache->lookupDescription($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

(

$a_node

)

Get node child ids type $ilDB.

Parameters

type

$a_node

Returns

type

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

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                'WHERE parent = ' . $ilDB->quote($a_node, 'integer') . ' ' .
                'AND tree = ' . $ilDB->quote($this->tree_id, 'integer' . ' ' .
                'ORDER BY lft');
        $res = $ilDB->query($query);
        
        $childs = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $childs[] = $row->child;
        }
        return $childs;
    }

getChilds()

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

get child nodes of given node public

Parameters

integer	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

Exceptions

InvalidArgumentException

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

References $DIC, $ilBench, $ilDB, $ilUser, $message, $query, $res, $rows, __isMainTree(), buildJoin(), fetchNodeData(), fetchTranslationFromObjectDataCache(), and isCacheUsed().

Referenced by getFilteredChilds(), ilObjWorkspaceFolderTableGUI\getItems(), ilWorkspaceContentGUI\getItems(), and ilSkillTree\getMaxOrderNr().

    {
        global $DIC;

        $ilBench = $DIC['ilBench'];
        $ilDB = $DIC['ilDB'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilUser = $DIC['ilUser'];
        
        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

        // init childs
        $childs = array();

        // 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,
            $ilDB->quote($a_node_id, 'integer'),
            $ilDB->quote($this->tree_id, 'integer')
        );

        $res = $ilDB->query($query);
        
        if (!$count = $res->numRows()) {
            return array();
        }

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

        // preload object translation information
        if ($this->__isMainTree() && $this->isCacheUsed() && is_object($ilObjDataCache) &&
            is_object($ilUser) && $this->lang_code == $ilUser->getLanguage() && !$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	(		$a_node_id,
			$a_type
	)

get child nodes of given node by object type public

Parameters

integer	node_id
string	object type

Returns

array with node data of all childs or empty array

Exceptions

InvalidArgumentException

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

References $a_type, $DIC, $ilDB, $message, $query, $res, buildJoin(), and fetchNodeData().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id) or !isset($a_type)) {
            $message = "Missing parameter! node_id:" . $a_node_id . " type:" . $a_type;
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

        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.
            $ilDB->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 ",
                $ilDB->quote($a_node_id, 'integer'),
                $ilDB->quote($this->tree_id, 'integer'),
                $ilDB->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",
                $ilDB->quote($a_node_id, 'integer'),
                $ilDB->quote($this->tree_id, 'integer'),
                $ilDB->quote($a_type, 'text')
            );
        }
        $res = $ilDB->query($query);
        
        // init childs
        $childs = array();
        while ($row = $ilDB->fetchAssoc($res)) {
            $childs[] = $this->fetchNodeData($row);
        }
        
        return $childs ? $childs : array();
    }

Here is the call graph for this function:

getChildsByTypeFilter()

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

get child nodes of given node by object type public

Parameters

integer	node_id
array	array of object type

Returns

array with node data of all childs or empty array

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, $res, buildJoin(), fetchNodeData(), and ilUtil\quoteArray().

Referenced by ilSkillTree\getMaxOrderNr().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id) or !$a_types) {
            $message = "Missing parameter! node_id:" . $a_node_id . " type:" . $a_types;
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }
    
        $filter = ' ';
        if ($a_types) {
            $filter = 'AND ' . $this->table_obj_data . '.type IN(' . implode(',', ilUtil::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 = ' . $ilDB->quote($a_node_id, 'integer') . ' ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = ' . $ilDB->quote($this->tree_id, 'integer') . ' ' .
            $filter .
            $order_clause;
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $childs[] = $this->fetchNodeData($row);
        }
        
        return $childs ? $childs : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildSequenceNumber()

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

get sequence number of node in sibling sequence public

Parameters

array

node

Returns

integer sequence number

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, $res, $type, and buildJoin().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node)) {
            $message = "No node_id given!";
            $this->log->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 = $ilDB->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 = $ilDB->queryF($query, array('integer','integer','integer'), array(
                $a_node['lft'],
                $a_node['parent'],
                $this->tree_id));
        }
        $row = $ilDB->fetchAssoc($res);
        return $row["cnt"];
    }

Here is the call graph for this function:

getDepth()

ilTree::getDepth

(

$a_node_id

)

return depth of a node in tree private

Parameters

integer

node_id of parent's node_id

Returns

integer depth of node in tree

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($a_node_id) {
            if ($this->__isMainTree()) {
                $query = 'SELECT depth FROM ' . $this->table_tree . ' ' .
                    'WHERE child = %s ';
                $res = $ilDB->queryF($query, array('integer'), array($a_node_id));
                $row = $ilDB->fetchObject($res);
            } else {
                $query = 'SELECT depth FROM ' . $this->table_tree . ' ' .
                'WHERE child = %s ' .
                'AND ' . $this->tree_pk . ' = %s ';
                $res = $ilDB->queryF($query, array('integer','integer'), array($a_node_id,$this->tree_id));
                $row = $ilDB->fetchObject($res);
            }

            return $row->depth;
        } else {
            return 1;
        }
    }

Here is the call graph for this function:

getDepthCache()

ilTree::getDepthCache

(

)

Get depth cache.

Returns

type

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

References $depth_cache.

    {
        return (array) $this->depth_cache;
    }

getFilteredChilds()

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

get child nodes of given node (exclude filtered obj_types) public

Parameters

array	objects to filter (e.g array('rolf'))
integer	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 621 of file class.ilTree.php.

References getChilds().

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

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

Here is the call graph for this function:

getFilteredSubTree()

ilTree::getFilteredSubTree	(		$a_node_id,
			$a_filter = array()
	)

get filtered subtree

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

E.g getFilteredSubTreeNodes()

public

Parameters

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

References getNodeData(), and getSubTree().

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

Here is the call graph for this function:

getGap()

ilTree::getGap

(

)

Get default gap *.

Returns

int

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

References $gap.

    {
        return $this->gap;
    }

getLeftValue()

ilTree::getLeftValue

(

$a_node_id

)

get left value of given node public

Parameters

integer

node id

Returns

integer left value

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, and $res.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

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

getMaximumDepth()

ilTree::getMaximumDepth

(

)

Return the current maximum depth in the tree public.

Returns

integer max depth level of tree

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

References $DIC, $ilDB, $query, $res, and $table_tree.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT MAX(depth) depth FROM ' . $this->table_tree;
        $res = $ilDB->query($query);
        
        $row = $ilDB->fetchAssoc($res);
        return $row['depth'];
    }

getNodeData()

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

get all information of a node.

get data of a specific node from tree and object_data public

Parameters

integer

node id

Returns

array 2-dim (int/str) node_data

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, $res, $tree_id, $tree_pk, __isMainTree(), buildJoin(), ilLogLevel\ERROR, and fetchNodeData().

Referenced by ilLMChapterImportForm\__construct(), ilWorkspaceTree\cascadingDelete(), ilLMTree\getCompleteTree(), getFilteredSubTree(), ilPortfolioPageTableGUI\getItems(), ilWorkspaceTree\getObjectsFromType(), getSubTreeFilteredByObjIds(), getSubTreeTypes(), ilTestTaxonomyTree\initOrderedTreeIndex(), and ilExSubmissionObjectGUI\setSelectedBlogObject().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id)) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException("No node_id given!");
        }
        if ($this->__isMainTree()) {
            if ($a_node_id < 1) {
                $message = 'No valid parameter given! $a_node_id: %s' . $a_node_id;

                $this->log->error($message);
                throw new InvalidArgumentException($message);
            }
        }

        // BEGIN WebDAV: Pass tree id to this method
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            'WHERE ' . $this->table_tree . '.child = %s ' .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = %s ';
        $res = $ilDB->queryF($query, array('integer','integer'), array(
            $a_node_id,
            $a_tree_pk === null ? $this->tree_id : $a_tree_pk));
        // END WebDAV: Pass tree id to this method
        $row = $ilDB->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:

getNodeDataByType()

ilTree::getNodeDataByType

(

$a_type

)

get nodes by type

Parameters

integer	a_tree_id: obj_id of object where tree belongs to
integer	a_type_id: type of object public

Exceptions

InvalidArgumentException

Returns

array

Deprecated:

since 4.4.0

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

References $a_type, $data, $DIC, $ilDB, $query, $res, buildJoin(), ilLogLevel\ERROR, and fetchNodeData().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_type) or (!is_string($a_type))) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Type not given or wrong datatype');
        }

        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
            $this->buildJoin() .
            'WHERE ' . $this->table_obj_data . '.type = ' . $this->ilDB->quote($a_type, 'text') .
            'AND ' . $this->table_tree . '.' . $this->tree_pk . ' = ' . $this->ilDB->quote($this->tree_id, 'integer');

        $res = $ilDB->query($query);
        $data = array();
        while ($row = $ilDB->fetchAssoc($res)) {
            $data[] = $this->fetchNodeData($row);
        }

        return $data;
    }

Here is the call graph for this function:

getNodePath()

ilTree::getNodePath	(		$a_endnode_id,
			$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.

public

Parameters

integer	node_id of endnode
integer	node_id of startnode (optional)

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 1247 of file class.ilTree.php.

References $data, $DIC, $i, $ilDB, $query, $res, and getPathId().

Referenced by getNodePathForTitlePath().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

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

        
        $types = array();
        $data = array();
        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 ' . $ilDB->in('t.child', $data, false, 'integer') . ' ' .
            'ORDER BY t.depth ';
            
        $res = $ilDB->queryF($query, $types, $data);

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

Here is the call graph for this function:

Here is the caller graph for this function:

getNodePathForTitlePath()

ilTree::getNodePathForTitlePath	(		$titlePath,
			$a_startnode_id = null
	)

Converts a path consisting of object titles into a path consisting of tree nodes.

The comparison is non-case sensitive.

Note: this function returns the same result as getNodePath, but takes a title path as parameter.

public

Parameters

Array	Path array with object titles. e.g. array('ILIAS','English','Course A')
ref_id	Startnode of the relative path. Specify null, if the title path is an absolute path. Specify a ref id, if the title path is a relative path starting at this ref id.

Returns

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

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

References $DIC, $i, $ilDB, $log, $obj_pk, $rows, ilDBConstants\FETCHMODE_ASSOC, getNodePath(), ilStr\strToLower(), and UtfNormal\toNFC().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $log = $DIC['log'];
        //$log->write('getNodePathForTitlePath('.implode('/',$titlePath));
        
        // handle empty title path
        if ($titlePath == null || count($titlePath) == 0) {
            if ($a_startnode_id == 0) {
                return null;
            } else {
                return $this->getNodePath($a_startnode_id);
            }
        }

        // fetch the node path up to the startnode
        if ($a_startnode_id != null && $a_startnode_id != 0) {
            // Start using the node path to the root of the relative path
            $nodePath = $this->getNodePath($a_startnode_id);
            $parent = $a_startnode_id;
        } else {
            // Start using the root of the tree
            $nodePath = array();
            $parent = 0;
        }

        
        // Convert title path into Unicode Normal Form C
        // This is needed to ensure that we can compare title path strings with
        // strings from the database.
        require_once('include/Unicode/UtfNormal.php');
        include_once './Services/Utilities/classes/class.ilStr.php';
        $inClause = 'd.title IN (';
        for ($i = 0; $i < count($titlePath); $i++) {
            $titlePath[$i] = ilStr::strToLower(UtfNormal::toNFC($titlePath[$i]));
            if ($i > 0) {
                $inClause .= ',';
            }
            $inClause .= $ilDB->quote($titlePath[$i], 'text');
        }
        $inClause .= ')';

        // Fetch all rows that are potential path elements
        if ($this->table_obj_reference) {
            $joinClause = 'JOIN ' . $this->table_obj_reference . '  r ON t.child = r.' . $this->ref_pk . ' ' .
                'JOIN ' . $this->table_obj_data . ' d ON r.' . $this->obj_pk . ' = d.' . $this->obj_pk;
        } else {
            $joinClause = 'JOIN ' . $this->table_obj_data . '  d ON t.child = d.' . $this->obj_pk;
        }
        // The ORDER BY clause in the following SQL statement ensures that,
        // in case of a multiple objects with the same title, always the Object
        // with the oldest ref_id is chosen.
        // This ensure, that, if a new object with the same title is added,
        // WebDAV clients can still work with the older object.
        $q = 'SELECT t.depth, t.parent, t.child, d.' . $this->obj_pk . ' obj_id, d.type, d.title ' .
            'FROM ' . $this->table_tree . '  t ' .
            $joinClause . ' ' .
            'WHERE ' . $inClause . ' ' .
            'AND t.depth <= ' . (count($titlePath) + count($nodePath)) . ' ' .
            'AND t.tree = 1 ' .
            'ORDER BY t.depth, t.child ASC';
        $r = $ilDB->query($q);
        
        $rows = array();
        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $row['title'] = UtfNormal::toNFC($row['title']);
            $row['ref_id'] = $row['child'];
            $rows[] = $row;
        }

        // Extract the path elements from the fetched rows
        for ($i = 0; $i < count($titlePath); $i++) {
            $pathElementFound = false;
            foreach ($rows as $row) {
                if ($row['parent'] == $parent &&
                ilStr::strToLower($row['title']) == $titlePath[$i]) {
                    // FIXME - We should test here, if the user has
                    // 'visible' permission for the object.
                    $nodePath[] = $row;
                    $parent = $row['child'];
                    $pathElementFound = true;
                    break;
                }
            }
            // Abort if we haven't found a path element for the current depth
            if (!$pathElementFound) {
                //$log->write('ilTree.getNodePathForTitlePath('.var_export($titlePath,true).','.$a_startnode_id.'):null');
                return null;
            }
        }
        // Return the node path
        //$log->write('ilTree.getNodePathForTitlePath('.var_export($titlePath,true).','.$a_startnode_id.'):'.var_export($nodePath,true));
        return $nodePath;
    }

Here is the call graph for this function:

getNodeTreeData()

ilTree::getNodeTreeData

(

$a_node_id

)

return all columns of tabel tree

Parameters

type

$a_node_id

Returns

array of table column => values

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $query, $res, ilLogLevel\ERROR, and ilDBConstants\FETCHMODE_ASSOC.

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$a_node_id) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Missing or empty parameter $a_node_id: ' . $a_node_id);
        }
        
        $query = 'SELECT * FROM ' . $this->table_tree . ' ' .
                'WHERE child = ' . $ilDB->quote($a_node_id, 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            return $row;
        }
        return array();
    }

Here is the caller graph for this function:

getObjectDataTable()

ilTree::getObjectDataTable

(

)

Get object data table.

Returns

type

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

References $table_obj_data.

Referenced by getSubTreeFilteredByObjIds().

    {
        return $this->table_obj_data;
    }

Here is the caller graph for this function:

getParentCache()

ilTree::getParentCache

(

)

Get parent cache.

Returns

type

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

References $parent_cache.

    {
        return (array) $this->parent_cache;
    }

getParentId()

ilTree::getParentId

(

$a_node_id

)

get parent id of given node public

Parameters

integer

node id

Returns

integer parent id

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, $res, and __isMainTree().

Referenced by moveTree(), and ilWorkspaceContentGUI\render().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_node_id)) {
            $message = "No node_id given!";
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

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

        $row = $ilDB->fetchObject($res);
        return $row->parent;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentNodeData()

ilTree::getParentNodeData

(

$a_node_id

)

get data of parent node from tree and object_data public

Parameters

integer

node id

Returns

array

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $ilLog, $query, $res, and fetchNodeData().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        if (!isset($a_node_id)) {
            $ilLog->logStack();
            throw new InvalidArgumentException(__METHOD__ . ': No node_id given!');
        }

        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 = $ilDB->queryF($query, array('integer','integer','integer'), array(
            $a_node_id,
            $this->tree_id,
            $this->tree_id));
        $row = $ilDB->fetchAssoc($res);
        return $this->fetchNodeData($row);
    }

Here is the call graph for this function:

getPathFull()

ilTree::getPathFull	(		$a_endnode_id,
			$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.

public

Parameters

integer	node_id of endnode
integer	node_id of startnode (optional)

Returns

array ordered path info (id,title,parent) from start to end

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

References $DIC, $i, $ilDB, __isMainTree(), buildJoin(), ilDBConstants\FETCHMODE_ASSOC, fetchNodeData(), and getPathId().

Referenced by checkForParentType(), ilTestTaxonomyTree\getPathNodes(), and ilSkillTree\getSkillTreePath().

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

        // We retrieve the full path in a single query to improve performance
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

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

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

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

            // Update cache
            if ($this->__isMainTree()) {
                #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Storing in tree cache '.$row['child']);
                $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	(		$a_endnode_id,
			$a_startnode_id = 0
	)

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

Parameters

integer	node_id of endnode
integer	node_id of startnode (optional)

Returns

array all path ids from startnode to endnode

Exceptions

InvalidArgumentException

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

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

Referenced by getNodePath(), getPathFull(), and ilSkillTree\getTopParentNodeId().

    {
        if (!$a_endnode_id) {
            $this->log->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])) {
            //echo "<br>getPathIdhit";
            return $this->path_id_cache[$a_endnode_id][$a_startnode_id];
        }
        //echo "<br>miss";

        $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

(

$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.

Parameters

ref_id

ref_id of source node

Returns

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

References getTreeImplementation().

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

Here is the call graph for this function:

getRelation()

ilTree::getRelation	(		$a_node_a,
			$a_node_b
	)

Get relation of two nodes.

Parameters

int	$a_node_a
int	$a_node_b

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

References getNodeTreeData(), and getRelationOfNodes().

Referenced by isGrandChild().

    {
        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	(		$a_node_a_arr,
			$a_node_b_arr
	)

get relation of two nodes by node data

Parameters

array	$a_node_a_arr
array	$a_node_b_arr

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

References getTreeImplementation().

Referenced by getRelation().

    {
        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

(

)

get the root id of tree public

Returns

integer root node id

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

References $root_id.

Referenced by ilWorkspaceTree\getObjectsFromType(), and ilTestTaxonomyTree\initOrderedTreeIndex().

    {
        return $this->root_id;
    }

Here is the caller graph for this function:

getSavedNodeData()

ilTree::getSavedNodeData

(

$a_parent_id

)

get data saved/deleted nodes

Returns

array data

Parameters

integer

id of parent object of saved object public

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $message, $query, $res, buildJoin(), and fetchNodeData().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($a_parent_id)) {
            $message = "No node_id given!";
            $this->log->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 = $ilDB->queryF($query, array('integer','integer'), array(
            0,
            $a_parent_id));

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

        return $saved ? $saved : array();
    }

Here is the call graph for this function:

getSavedNodeObjIds()

ilTree::getSavedNodeObjIds

(

array

$a_obj_ids

)

get object id of saved/deleted nodes

Returns

array data

Parameters

array

object ids to check public

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

References $DIC, $ilDB, $query, $res, and buildJoin().

    {
        global $DIC;

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

        return $saved ? $saved : array();
    }

Here is the call graph for this function:

getSubTree()

ilTree::getSubTree	(		$a_node,
			$a_with_data = true,
			$a_type = ""
	)

get all nodes in the subtree under specified node

public

Parameters

array	node_data
boolean	with data: default is true otherwise this function return only a ref_id array

Returns

array 2-dim (int/array) key, node_data of each subtree node including the specified node

Exceptions

InvalidArgumentException

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

References $a_type, $DIC, $ilDB, $query, $res, __isMainTree(), ilLogLevel\ERROR, fetchNodeData(), and getTreeImplementation().

Referenced by ilWorkspaceTree\cascadingDelete(), ilLMTree\getCompleteTree(), getFilteredSubTree(), ilWorkspaceTree\getObjectsFromType(), and ilTestTaxonomyTree\initOrderedTreeIndex().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!is_array($a_node)) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException(__METHOD__ . ': wrong datatype for node data given');
        }

        /*
        if($a_node['lft'] < 1 or $a_node['rgt'] < 2)
        {
            $GLOBALS['DIC']['ilLog']->logStack();
            $message = sprintf('%s: Invalid node given! $a_node["lft"]: %s $a_node["rgt"]: %s',
                                   __METHOD__,
                                   $a_node['lft'],
                                   $a_node['rgt']);

            throw new InvalidArgumentException($message);
        }
        */
        
        $query = $this->getTreeImplementation()->getSubTreeQuery($a_node, $a_type);
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            if ($a_with_data) {
                $subtree[] = $this->fetchNodeData($row);
            } else {
                $subtree[] = $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 ? $subtree : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubTreeFilteredByObjIds()

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

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

Parameters

int	$a_node_id
array	$a_obj_ids
array	$a_fields

Returns

array

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $node = $this->getNodeData($a_node_id);
        if (!sizeof($node)) {
            return;
        }
        
        $res = array();
        
        $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 " . $ilDB->in($this->getObjectDataTable() . "." . $this->obj_pk, $a_obj_ids, "", "integer");
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        
        return $res;
    }

Here is the call graph for this function:

getSubTreeIds()

ilTree::getSubTreeIds

(

$a_ref_id

)

Get all ids of subnodes.

Returns

Parameters

object

$a_ref_id

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

References getTreeImplementation().

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

Here is the call graph for this function:

getSubTreeQuery()

ilTree::getSubTreeQuery	(		$a_node_id,
			$a_fields = array(),
			$a_types = '',
			$a_force_join_reference = false
	)

Get tree subtree query.

Parameters

type	$a_node_id
type	$a_types
type	$a_force_join_reference

Returns

type

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

References getNodeTreeData(), and getTreeImplementation().

    {
        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:

getSubTreeTypes()

ilTree::getSubTreeTypes	(		$a_node,
			$a_filter = 0
	)

get types of nodes in the subtree under specified node

public

Parameters

array	node_id
array	object types to filter e.g array('rolf')

Returns

array 2-dim (int/array) key, node_data of each subtree node including the specified node

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

References getNodeData().

    {
        $a_filter = $a_filter ? $a_filter : array();

        foreach ($this->getSubtree($this->getNodeData($a_node)) as $node) {
            if (in_array($node["type"], $a_filter)) {
                continue;
            }
            $types["$node[type]"] = $node["type"];
        }
        return $types ? $types : array();
    }

Here is the call graph for this function:

getTableReference()

ilTree::getTableReference

(

)

Get reference table if available.

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

References $table_obj_reference.

Referenced by getSubTreeFilteredByObjIds().

    {
        return $this->table_obj_reference;
    }

Here is the caller graph for this function:

getTrashSubTreeQuery()

ilTree::getTrashSubTreeQuery	(		$a_node_id,
			$a_fields = [],
			$a_types = '',
			$a_force_join_reference = false
	)

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

References getNodeTreeData(), and getTreeImplementation().

    {
        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

(

)

get tree id public

Returns

integer tree id

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

References $tree_id.

Referenced by ilWorkspaceExplorer\__construct().

    {
        return $this->tree_id;
    }

Here is the caller graph for this function:

getTreeImplementation()

ilTree::getTreeImplementation

(

)

Get tree implementation.

Returns

ilTreeImplementation $impl

Definition at line 260 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().

    {
        return $this->tree_impl;
    }

Here is the caller graph for this function:

getTreePk()

ilTree::getTreePk

(

)

Get tree primary key.

Returns

string column of pk

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

References $tree_pk.

    {
        return $this->tree_pk;
    }

getTreeTable()

ilTree::getTreeTable

(

)

Get tree table name.

Returns

string tree table name

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

References $table_tree.

Referenced by getSubTreeFilteredByObjIds().

    {
        return $this->table_tree;
    }

Here is the caller graph for this function:

initLangCode()

ilTree::initLangCode

(

)

Store user language.

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

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

References $DIC, Vendor\Package\$e, and $ilUser.

    {
        global $DIC;

        // lang_code is only required in $this->fetchnodedata
        try {
            $ilUser = $DIC['ilUser'];
            $this->lang_code = $ilUser->getCurrentLanguage();
        } catch (\InvalidArgumentException $e) {
            $this->lang_code = "en";
        }
    }

initTreeImplementation()

ilTree::initTreeImplementation

(

)

Init tree implementation.

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

References $DIC, and __isMainTree().

Referenced by __construct(), and setTableNames().

    {
        global $DIC;

        if (!$DIC->isDependencyAvailable('settings') || $DIC->settings()->getModule() != 'common') {
            include_once './Services/Administration/classes/class.ilSetting.php';
            $setting = new ilSetting('common');
        } else {
            $setting = $DIC->settings();
        }
        
        if ($this->__isMainTree()) {
            if ($setting->get('main_tree_impl', 'ns') == 'ns') {
                #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Using nested set.');
                include_once './Services/Tree/classes/class.ilNestedSetTree.php';
                $this->tree_impl = new ilNestedSetTree($this);
            } else {
                #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Using materialized path.');
                include_once './Services/Tree/classes/class.ilMaterializedPathTree.php';
                $this->tree_impl = new ilMaterializedPathTree($this);
            }
        } else {
            #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Using netsted set for non main tree.');
            include_once './Services/Tree/classes/class.ilNestedSetTree.php';
            $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	(		$a_node_id,
			$a_parent_id,
			$a_pos = IL_LAST_NODE,
			$a_reset_deletion_date = false
	)

insert new node with node_id under parent node with parent_id public

Parameters

integer	node_id
integer	parent_id
integer	IL_LAST_NODE | IL_FIRST_NODE | node id of preceding child

Exceptions

InvalidArgumentException

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

References $DIC, $GLOBALS, $ilDB, $message, __isMainTree(), ilObject\_resetDeletedDate(), ilLogLevel\ERROR, getTreeImplementation(), and isInTree().

Referenced by insertNodeFromTrash(), and ilWorkspaceTree\insertObject().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        //echo "+$a_node_id+$a_parent_id+";
        // CHECK node_id and parent_id > 0 if in main tree
        if ($this->__isMainTree()) {
            if ($a_node_id <= 1 or $a_parent_id <= 0) {
                $message = sprintf(
                    'Invalid parameters! $a_node_id: %s $a_parent_id: %s',
                    $a_node_id,
                    $a_parent_id
                );
                $this->log->logStack(ilLogLevel::ERROR, $message);
                throw new InvalidArgumentException($message);
            }
        }


        if (!isset($a_node_id) or !isset($a_parent_id)) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException("Missing parameter! " .
                "node_id: " . $a_node_id . " parent_id: " . $a_parent_id);
        }
        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($GLOBALS['DIC']["ilAppEventHandler"]) && $this->__isMainTree()) {
            $GLOBALS['DIC']['ilAppEventHandler']->raise(
                "Services/Tree",
                "insertNode",
                array(
                        '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	(		$a_source_id,
			$a_target_id,
			$a_tree_id,
			$a_pos = IL_LAST_NODE,
			$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.

Parameters

type	$a_source_id
type	$a_target_id
type	$a_tree_id

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $query, __isMainTree(), ilLoggerFactory\getLogger(), IL_LAST_NODE, ilLogLevel\INFO, insertNode(), and isInTree().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->__isMainTree()) {
            if ($a_source_id <= 1 or $a_target_id <= 0) {
                ilLoggerFactory::getLogger('tree')->logStack(ilLogLevel::INFO);
                throw new InvalidArgumentException('Invalid parameter given for ilTree::insertNodeFromTrash');
            }
        }
        if (!isset($a_source_id) or !isset($a_target_id)) {
            ilLoggerFactory::getLogger('tree')->logStack(ilLogLevel::INFO);
            throw new InvalidArgumentException('Missing parameter for ilTree::insertNodeFromTrash');
        }
        if ($this->isInTree($a_source_id)) {
            ilLoggerFactory::getLogger('tree')->error('Node already in tree');
            ilLoggerFactory::getLogger('tree')->logStack(ilLogLevel::INFO);
            throw new InvalidArgumentException('Node already in tree.');
        }
        
        $query = 'DELETE from tree ' .
                'WHERE tree = ' . $ilDB->quote($a_tree_id, 'integer') . ' ' .
                'AND child = ' . $ilDB->quote($a_source_id, 'integer');
        $ilDB->manipulate($query);
        
        $this->insertNode($a_source_id, $a_target_id, IL_LAST_NODE, $a_reset_deleted_date);
    }

Here is the call graph for this function:

isCacheUsed()

ilTree::isCacheUsed

(

)

Check if cache is active.

Returns

bool

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

References __isMainTree().

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

    {
        return $this->__isMainTree() and $this->use_cache;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isDeleted()

ilTree::isDeleted

(

$a_node_id

)

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

Parameters

int

$a_node_id

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

References isSaved().

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

Here is the call graph for this function:

isGrandChild()

ilTree::isGrandChild	(		$a_startnode_id,
			$a_querynode_id
	)

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

Parameters

integer	object id of start node
integer	object id of query node

Returns

integer number of entries

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

References getRelation().

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

Here is the call graph for this function:

isInTree()

ilTree::isInTree

(

$a_node_id

)

get all information of a node.

get data of a specific node from tree and object_data public

Parameters

integer

node id

Returns

boolean true, if node id is in tree

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

References $DIC, $ilDB, $query, $res, __isMainTree(), and isCacheUsed().

Referenced by checkForParentType(), insertNode(), and insertNodeFromTrash().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (!isset($a_node_id)) {
            return false;
            #$this->ilErr->raiseError(get_class($this)."::getNodeData(): No node_id given! ",$this->ilErr->WARNING);
        }
        // is in tree cache
        if ($this->isCacheUsed() && isset($this->in_tree_cache[$a_node_id])) {
            #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Using in tree cache '.$a_node_id);
            //echo "<br>in_tree_hit";
            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 = $ilDB->queryF($query, array('integer','integer'), array(
            $a_node_id,
            $this->tree_id));

        if ($res->numRows() > 0) {
            if ($this->__isMainTree()) {
                #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Storing in tree cache '.$a_node_id.' = true');
                $this->in_tree_cache[$a_node_id] = true;
            }
            return true;
        } else {
            if ($this->__isMainTree()) {
                #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': Storing in tree cache '.$a_node_id.' = false');
                $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 2841 of file class.ilTree.php.

Referenced by __renumber().

    {
        if ($this->table_tree == 'tree') {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

isSaved()

ilTree::isSaved

(

$a_node_id

)

Use method isDeleted check if node is saved.

Deprecated:

since 4.4.0

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

References $DIC, $ilDB, $query, $res, __isMainTree(), and isCacheUsed().

Referenced by isDeleted().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        // is saved cache
        if ($this->isCacheUsed() && isset($this->is_saved_cache[$a_node_id])) {
            //echo "<br>issavedhit";
            return $this->is_saved_cache[$a_node_id];
        }

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

        if ($row[$this->tree_pk] < 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 type $ilDB.

Returns

type

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

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT DISTINCT(o.type) ' . $ilDB->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 < ' . $ilDB->quote(0, 'integer') . ' ' .
                'AND child = -tree ' .
                'GROUP BY o.type';
        $res = $ilDB->query($query);
        
        $types_deleted = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $types_deleted[] = $row->type;
        }
        return $types_deleted;
    }

lookupTreesForNode()

static ilTree::lookupTreesForNode ( int  $node_id )

static

Parameters

int

$node_id

Returns

array

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

References $DIC, $query, $res, ilDBConstants\FETCHMODE_OBJECT, 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[] = $row->tree;
        }
        return $trees;
    }

Here is the caller graph for this function:

moveToTrash()

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

Move node to trash bin.

Parameters

int	$a_node_id
bool	$a_set_deleted
	int	deleted_by user_id

Returns

bool

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $query, $res, ilLogLevel\ERROR, ilDBConstants\FETCHMODE_ASSOC, getNodeTreeData(), getTreeImplementation(), and ilObject\setDeletedDates().

    {
        global $DIC;

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

        if (!$a_node_id) {
            $this->log->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 = $ilDB->query($query);

        $subnodes = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $subnodes[] = $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:

moveTree()

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

Move Tree Implementation.

public

Parameters

int	source ref_id
int	target ref_id
int	location IL_LAST_NODE or IL_FIRST_NODE (IL_FIRST_NODE not implemented yet)

Returns

bool

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

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

    {
        $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
                        )
            );
        }
        return true;
    }

Here is the call graph for this function:

preloadDeleted()

ilTree::preloadDeleted

(

$a_node_ids

)

Preload deleted information.

Parameters

array

nodfe ids

Returns

bool

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

References $DIC, $ilDB, $query, $res, __isMainTree(), and isCacheUsed().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

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

        $res = $ilDB->query($query);
        while ($row = $ilDB->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

(

$a_node_ids

)

Preload depth/parent.

Parameters

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

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

Here is the call graph for this function:

readRootId()

ilTree::readRootId

(

)

read root id from database

Parameters

root_id

public

Returns

int new root id

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

References $DIC, $ilDB, $query, $res, and $root_id.

Referenced by ilWorkspaceTree\__construct(), ilTestTaxonomyTree\__construct(), ilWorkspaceExplorer\__construct(), ilSCORMExplorer\__construct(), ilObjQuestionPoolGUI\buildQuestionBrowserTableGUI(), ilWorkspaceTree\cascadingDelete(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilSAHSPresentationGUI\explorer(), ilSCORMPresentationGUI\explorer(), ilLMTree\getCompleteTree(), ilPortfolioPageTableGUI\getItems(), and ilSkillTree\getMaxOrderNr().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT child FROM ' . $this->table_tree . ' ' .
            'WHERE parent = %s ' .
            'AND ' . $this->tree_pk . ' = %s ';
        $res = $ilDB->queryF($query, array('integer','integer'), array(
            0,
            $this->tree_id));
        $row = $ilDB->fetchObject($res);
        $this->root_id = $row->child;
        return $this->root_id;
    }

Here is the caller graph for this function:

removeTree()

ilTree::removeTree

(

$a_tree_id

)

remove an existing tree

Parameters

integer

a_tree_id: tree to be removed

Returns

boolean true on success public

Exceptions

InvalidArgumentException

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

References $DIC, $ilDB, $query, __isMainTree(), and ilLogLevel\ERROR.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        // OPERATION NOT ALLOWED ON MAIN TREE
        if ($this->__isMainTree()) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Operation not allowed on main tree');
        }
        if (!$a_tree_id) {
            $this->log->logStack(ilLogLevel::ERROR);
            throw new InvalidArgumentException('Missing parameter tree id');
        }

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

Here is the call graph for this function:

renumber()

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

Wrapper for renumber.

This method locks the table tree (recursive) public

Parameters

integer	node_id where to start (usually the root node)
integer	first left value of start node (usually 1)

Returns

integer current left value of recursive call

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

References $DIC, $i, $ilDB, __isMainTree(), and __renumber().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

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

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

Here is the call graph for this function:

resetInTreeCache()

ilTree::resetInTreeCache

(

)

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

Referenced by deleteTree().

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

Here is the caller graph for this function:

setObjectTablePK()

ilTree::setObjectTablePK

(

$a_column_name

)

set column containing primary key in object table public

Parameters

string

column name

Returns

boolean true, when successfully set

Exceptions

InvalidArgumentException

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

References $message.

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

    {
        if (!isset($a_column_name)) {
            $message = "No column name given!";
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

        $this->obj_pk = $a_column_name;
        return true;
    }

Here is the caller graph for this function:

setReferenceTablePK()

ilTree::setReferenceTablePK

(

$a_column_name

)

set column containing primary key in reference table public

Parameters

string

column name

Returns

boolean true, when successfully set

Exceptions

InvalidArgumentException

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

References $message.

Referenced by ilWorkspaceTree\__construct().

    {
        if (!isset($a_column_name)) {
            $message = "No column name given!";
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

        $this->ref_pk = $a_column_name;
        return true;
    }

Here is the caller graph for this function:

setRootId()

ilTree::setRootId

(

$a_root_id

)

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

Referenced by ilWorkspaceExplorer\__construct(), and ilWorkspaceTree\createTreeForUser().

    {
        $this->root_id = $a_root_id;
    }

Here is the caller graph for this function:

setTableNames()

ilTree::setTableNames	(		$a_table_tree,
			$a_table_obj_data,
			$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!

Parameters

string	table name of tree table
string	table name of object_data table
string	table name of object_reference table (optional) public

Returns

boolean

Exceptions

InvalidArgumentException

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

References $message, and initTreeImplementation().

Referenced by ilECSCmsTree\__construct(), ilTaxonomyTree\__construct(), ilSkillTree\__construct(), ilSCORM2004Tree\__construct(), ilWorkspaceTree\__construct(), ilLMTree\__construct(), and ilSCORMTree\__construct().

    {
        if (!isset($a_table_tree) or !isset($a_table_obj_data)) {
            $message = "Missing parameter! " .
                                "tree table: " . $a_table_tree . " object data table: " . $a_table_obj_data;
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

        $this->table_tree = $a_table_tree;
        $this->table_obj_data = $a_table_obj_data;
        $this->table_obj_reference = $a_table_obj_reference;
        
        $this->initTreeImplementation();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTreeId()

ilTree::setTreeId

(

$a_tree_id

)

set tree id public

Returns

integer tree id

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

    {
        $this->tree_id = $a_tree_id;
    }

setTreeTablePK()

ilTree::setTreeTablePK

(

$a_column_name

)

set column containing primary key in tree table public

Parameters

string

column name

Returns

boolean true, when successfully set

Exceptions

InvalidArgumentException

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

References $message.

Referenced by ilSkillTree\__construct(), ilTaxonomyTree\__construct(), ilSCORM2004Tree\__construct(), ilWorkspaceTree\__construct(), ilLMTree\__construct(), and ilSCORMTree\__construct().

    {
        if (!isset($a_column_name)) {
            $message = "No column name given!";
            $this->log->error($message);
            throw new InvalidArgumentException($message);
        }

        $this->tree_pk = $a_column_name;
        return true;
    }

Here is the caller graph for this function:

useCache()

ilTree::useCache

(

$a_use = true

)

Use Cache (usually activated)

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

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

    {
        $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 998 of file class.ilTree.php.

References getTreeImplementation().

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

Here is the call graph for this function:

Field Documentation

$depth_cache

ilTree::$depth_cache = array()

protected

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

Referenced by getDepthCache().

$gap

ilTree::$gap

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

Referenced by getGap().

$ilias

ilTree::$ilias

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

$in_tree_cache

ilTree::$in_tree_cache = array()

protected

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

$log

ilTree::$log

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

Referenced by getNodePathForTitlePath().

$obj_pk

ilTree::$obj_pk

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

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

$parent_cache

ilTree::$parent_cache = array()

protected

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

Referenced by getParentCache().

$ref_pk

ilTree::$ref_pk

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

Referenced by ilWorkspaceTree\lookupNodeId().

$root_id

ilTree::$root_id

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

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

$table_obj_data

ilTree::$table_obj_data

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

Referenced by getObjectDataTable().

$table_obj_reference

ilTree::$table_obj_reference

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

Referenced by getTableReference().

$table_tree

ilTree::$table_tree

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

Referenced by getMaximumDepth(), and getTreeTable().

$tree_id

ilTree::$tree_id

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

Referenced by getNodeData(), and getTreeId().

$tree_impl

ilTree::$tree_impl = null

private

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

Referenced by getTreeImplementation().

$tree_pk

ilTree::$tree_pk

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

Referenced by getNodeData(), and getTreePk().

POS_FIRST_NODE

const ilTree::POS_FIRST_NODE = -1

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

Referenced by ilNestedSetTree\insertNode().

POS_LAST_NODE

const ilTree::POS_LAST_NODE = -2

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

RELATION_CHILD

const ilTree::RELATION_CHILD = 1

Definition at line 33 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 36 of file class.ilTree.php.

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

RELATION_NONE

const ilTree::RELATION_NONE = 5

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

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

RELATION_PARENT

const ilTree::RELATION_PARENT = 2

Definition at line 34 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 35 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 26 of file class.ilTree.php.

TREE_TYPE_NESTED_SET

const ilTree::TREE_TYPE_NESTED_SET = 'ns'

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

---

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

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