Inheritance diagram for ilTree:
Public Member Functions | |
| ilTree ($a_tree_id, $a_root_id=0) | |
| Constructor public. | |
| 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. | |
| setReferenceTablePK ($a_column_name) | |
| set column containing primary key in reference table public | |
| setObjectTablePK ($a_column_name) | |
| set column containing primary key in object table public | |
| setTreeTablePK ($a_column_name) | |
| set column containing primary key in tree table public | |
| buildJoin () | |
| build join depending on table settings private | |
| getLeafs () | |
| get leaf(=end) nodes of tree //TODO: Method not used yet public | |
| getChilds ($a_node_id, $a_order="", $a_direction="ASC") | |
| get child nodes of given node public | |
| getFilteredChilds ($a_filter, $a_node, $a_order="", $a_direction="ASC") | |
| get child nodes of given node (exclude filtered obj_types) public | |
| getChildsByType ($a_node_id, $a_type) | |
| get child nodes of given node by object type public | |
| insertNode ($a_node_id, $a_parent_id, $a_pos=IL_LAST_NODE) | |
| insert new node with node_id under parent node with parent_id public | |
| getSubTree ($a_node) | |
| get all nodes in the subtree under specified node | |
| getSubTreeTypes ($a_node, $a_filter=0) | |
| get types of nodes in the subtree under specified node | |
| deleteTree ($a_node) | |
| delete node and the whole subtree under this node public | |
| fetchPath ($a_endnode_id, $a_startnode_id) | |
| get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode private | |
| 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 public | |
| 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 | |
| checkTree () | |
| check consistence of tree all left & right values are checked if they are exists only once public | |
| checkTreeChilds ($a_no_zero_child=true) | |
| check, if all childs of tree nodes exist in object table | |
| getMaximumDepth () | |
| Return the maximum depth in tree public. | |
| getDepth ($a_node_id) | |
| return depth of a node in tree private | |
| calculateFlatTree () | |
| Calculates additional information for each node in tree-structure: no. | |
| getNodeData ($a_node_id) | |
| get all information of a node. | |
| fetchNodeData ($a_row) | |
| get data of parent node from tree and object_data private | |
| isInTree ($a_node_id) | |
| get all information of a node. | |
| getParentNodeData ($a_node_id) | |
| get data of parent node from tree and object_data public | |
| isGrandChild ($a_startnode_id, $a_querynode_id) | |
| checks if a node is in the path of an other node public | |
| addTree ($a_tree_id, $a_node_id=-1) | |
| create a new tree to do: ??? | |
| getNodeDataByType ($a_type) | |
| get nodes by type // TODO: method needs revision | |
| removeTree ($a_tree_id) | |
| remove an existing tree | |
| saveSubTree ($a_node_id) | |
| save subtree: copy a subtree (defined by node_id) to a new tree with $this->tree_id -node_id. | |
| isSaved ($a_node_id) | |
| check if node is saved | |
| saveNode ($a_node_id, $a_parent_id) | |
| save node: copy a node (defined by obj_id and parent) to a new tree with tree_id -obj_id.This is neccessary for link | |
| getSavedNodeData ($a_parent_id) | |
| get data saved/deleted nodes | |
| getParentId ($a_node_id) | |
| get parent id of given node public | |
| getChildSequenceNumber ($a_node, $type="") | |
| get sequence number of node in sibling sequence public | |
| readRootId () | |
| read root id from database | |
| getRootId () | |
| get the root id of tree public | |
| setRootId ($a_root_id) | |
| getTreeId () | |
| get tree id public | |
| setTreeId ($a_tree_id) | |
| set tree id public | |
| fetchSuccessorNode ($a_node_id, $a_type="") | |
| get node data of successor node | |
| fetchPredecessorNode ($a_node_id, $a_type="") | |
| get node data of predecessor node | |
| renumber ($node_id=1, $i=1) | |
| Wrapper for renumber. | |
| __renumber ($node_id=1, $i=1) | |
| This method is private. | |
| checkForParentType ($a_ref_id, $a_type) | |
| Check for parent type e.g check if a folder (ref_id 3) is in a parent course obj => checkForParentType(3,'crs');. | |
| _removeEntry ($a_tree, $a_child, $a_db_table="tree") | |
| STATIC METHOD Removes a single entry from a tree. | |
| __isMainTree () | |
| Check if operations are done on main tree. | |
| __checkDelete ($a_node) | |
| Check for deleteTree() compares a subtree of a given node by checking lft, rgt against parent relation. | |
| __getSubTreeByParentRelation ($a_node_id, &$parent_childs) | |
| __validateSubtrees (&$lft_childs, $parent_childs) | |
Data Fields | |
| $ilias | |
| $log | |
| $root_id | |
| $tree_id | |
| $table_tree | |
| $table_obj_data | |
| $table_obj_reference | |
| $ref_pk | |
| $obj_pk | |
| $tree_pk | |
Detailed Description
Definition at line 37 of file class.ilTree.php.
Member Function Documentation
| 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
Definition at line 1877 of file class.ilTree.php.
References $counter, $query, $res, $row, __getSubTreeByParentRelation(), and __validateSubtrees().
Referenced by deleteTree().
{
// get subtree by lft,rgt
$query = "SELECT * FROM ".$this->table_tree." ".
"WHERE lft >= ".$a_node['lft']." ".
"AND rgt <= ".$a_node['rgt']." ".
"AND ".$this->tree_pk." = '".$a_node[$this->tree_pk]."'";
$res = $this->ilDB->query($query);
$counter = (int) $lft_childs = array();
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$lft_childs[$row->child] = $row->parent;
++$counter;
}
// CHECK FOR DUPLICATE CHILD IDS
if($counter != count($lft_childs))
{
$message = sprintf('%s::__checkTree(): Duplicate entries for "child" in maintree! $a_node_id: %s',
get_class($this),
$a_node['child']);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
// 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:
| ilTree::__getSubTreeByParentRelation | ( | $ | a_node_id, | |
| &$ | parent_childs | |||
| ) |
Definition at line 1913 of file class.ilTree.php.
References $counter, $query, $res, and $row.
Referenced by __checkDelete().
{
// GET PARENT ID
$query = "SELECT * FROM ".$this->table_tree." ".
"WHERE child = '".$a_node_id."' ".
"AND tree = '".$this->tree_id."'";
$res = $this->ilDB->query($query);
$counter = 0;
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$parent_childs[$a_node_id] = $row->parent;
++$counter;
}
// MULTIPLE ENTRIES
if($counter > 1)
{
$message = sprintf('%s::__getSubTreeByParentRelation(): Multiple entries in maintree! $a_node_id: %s',
get_class($this),
$a_node_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
// GET ALL CHILDS
$query = "SELECT * FROM ".$this->table_tree." ".
"WHERE parent = '".$a_node_id."'";
$res = $this->ilDB->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
// RECURSION
$this->__getSubTreeByParentRelation($row->child,$parent_childs);
}
return true;
}
Here is the caller graph for this function:
| ilTree::__isMainTree | ( | ) |
Check if operations are done on main tree.
private
- Returns:
- boolean
Definition at line 1864 of file class.ilTree.php.
Referenced by addTree(), deleteTree(), getNodeData(), insertNode(), removeTree(), renumber(), saveNode(), and saveSubTree().
{
return $this->table_tree === 'tree';
}
Here is the caller graph for this function:
| 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) 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 1780 of file class.ilTree.php.
References $q, and getChilds().
Referenced by renumber().
{
$q = "UPDATE ".$this->table_tree." SET lft='".$i."' WHERE child='".$node_id."'";
$this->ilDB->query($q);
$childs = $this->getChilds($node_id);
foreach ($childs as $child)
{
$i = $this->__renumber($child["child"],$i+1);
}
$i++;
$q = "UPDATE ".$this->table_tree." SET rgt='".$i."' WHERE child='".$node_id."'";
$this->ilDB->query($q);
return $i;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilTree::__validateSubtrees | ( | &$ | lft_childs, | |
| $ | parent_childs | |||
| ) |
Definition at line 1950 of file class.ilTree.php.
Referenced by __checkDelete().
{
// SORT BY KEY
ksort($lft_childs);
ksort($parent_childs);
if(count($lft_childs) != count($parent_childs))
{
$message = sprintf('%s::__validateSubtrees(): (COUNT) Tree is corrupted! Left/Right subtree does not comply .'.
'with parent relation',
get_class($this));
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
foreach($lft_childs as $key => $value)
{
if($parent_childs[$key] != $value)
{
$message = sprintf('%s::__validateSubtrees(): (COMPARE) Tree is corrupted! Left/Right subtree does not comply '.
'with parent relation',
get_class($this));
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
if($key == ROOT_FOLDER_ID)
{
$message = sprintf('%s::__validateSubtrees(): (ROOT_FOLDER) Tree is corrupted! Tried to delete root folder',
get_class($this));
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
}
return true;
}
Here is the caller graph for this function:
| ilTree::_removeEntry | ( | $ | a_tree, | |
| $ | a_child, | |||
| $ | a_db_table = "tree" | |||
| ) |
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)
Definition at line 1836 of file class.ilTree.php.
References $ilErr, $ilLog, and $q.
Referenced by ilValidator::purgeObjects().
{
global $ilDB,$ilLog,$ilErr;
if($a_db_table === 'tree')
{
if($a_tree == 1 and $a_child == ROOT_FOLDER_ID)
{
$message = sprintf('%s::_removeEntry(): Tried to delete root node! $a_tree: %s $a_child: %s',
get_class($this),
$a_tree,
$a_child);
$ilLog->write($message,$ilLog->FATAL);
$ilErr->raiseError($message,$ilErr->WARNING);
}
}
$q = "DELETE from ".$a_db_table." WHERE tree='".$a_tree."' AND child='".$a_child."'";
$ilDB->query($q);
}
Here is the caller graph for this function:
| 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 public
Definition at line 1292 of file class.ilTree.php.
References $q, and __isMainTree().
{
// FOR SECURITY addTree() IS NOT ALLOWED ON MAIN TREE
// IF SOMEONE WILL NEED FEATURES LIKE $tree->addTree(2) ON THE MAIN TREE PLEASE CONTACT ME (smeyer@databay.de)
if($this->__isMainTree())
{
$message = sprintf('%s::addTree(): Operation not allowed on main tree! $a_tree_if: %s $a_node_id: %s',
get_class($this),
$a_tree_id,
$a_node_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
if (!isset($a_tree_id))
{
$this->ilErr->raiseError(get_class($this)."::addTree(): No tree_id given! ",$this->ilErr->WARNING);
}
if ($a_node_id <= 0)
{
$a_node_id = $a_tree_id;
}
$q = "INSERT INTO ".$this->table_tree." (".$this->tree_pk.", child, parent, lft, rgt, depth) ".
"VALUES ".
"('".$a_tree_id."','".$a_node_id."', 0, 1, 2, 1)";
$this->ilDB->query($q);
return true;
}
Here is the call graph for this function:
| ilTree::buildJoin | ( | ) |
build join depending on table settings private
- Returns:
- string
Definition at line 257 of file class.ilTree.php.
Referenced by ilSCORMTree::getChilds(), getChilds(), getChildsByType(), getChildSequenceNumber(), getLeafs(), getNodeData(), getNodeDataByType(), getSavedNodeData(), and getSubTree().
{
if ($this->table_obj_reference)
{
return "LEFT JOIN ".$this->table_obj_reference." ON ".$this->table_tree.".child=".$this->table_obj_reference.".".$this->ref_pk." ".
"LEFT JOIN ".$this->table_obj_data." ON ".$this->table_obj_reference.".".$this->obj_pk."=".$this->table_obj_data.".".$this->obj_pk." ";
}
else
{
return "LEFT 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:
| ilTree::calculateFlatTree | ( | ) |
Calculates additional information for each node in tree-structure: no.
of successors: How many successors does the node have? Every node under the concerned node in the tree counts as a successor. depth : The depth-level in tree the concerned node has. (the root node has a depth of 1!) brother : The no. of node which are on the same depth-level with the concerned node
public
- Returns:
- array array of new tree information (to be specified.... :-)
Definition at line 1030 of file class.ilTree.php.
{
if ($this->table_obj_reference)
{
$leftjoin = "LEFT JOIN ".$this->table_obj_reference." ON s.child=".$this->table_obj_reference.".".$this->ref_pk." ".
"LEFT JOIN ".$this->table_obj_data." ON ".$this->table_obj_reference.".".$this->obj_pk."=".$this->table_obj_data.".".$this->obj_pk." ";
}
else
{
$leftjoin = "LEFT JOIN ".$this->table_obj_data." ON s.child=".$this->table_obj_data.".".$this->obj_pk." ";
}
$q = "SELECT s.child,s.parent,s.lft,s.rgt,title,s.depth,".
"(s.rgt-s.lft-1)/2 AS successor,".
"((min(v.rgt)-s.rgt-(s.lft>1))/2) > 0 AS brother ".
"FROM ".$this->table_tree." v, ".$this->table_tree." s ".
$leftjoin.
"WHERE s.lft BETWEEN v.lft AND v.rgt ".
"AND (v.child != s.child OR s.lft = '1') ".
"AND s.".$this->tree_pk." = '".$this->tree_id."' ".
"AND v.".$this->tree_pk." = '".$this->tree_id."' ".
"GROUP BY s.child ".
"ORDER BY s.lft";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
{
$arr[] = array(
"title" => $row->title,
"child" => $row->child,
"successor" => $row->successor,
"depth" => $row->depth,
"brother" => $row->brother,
"lft" => $row->lft,
"rgt" => $row->rgt
);
}
return $arr;
}
| ilTree::checkForParentType | ( | $ | a_ref_id, | |
| $ | a_type | |||
| ) |
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 int ref_id of last parent type
Definition at line 1809 of file class.ilTree.php.
References $path, getPathFull(), and isInTree().
{
if(!$this->isInTree($a_ref_id))
{
return false;
}
$path = array_reverse($this->getPathFull($a_ref_id));
foreach($path as $node)
{
if($node["type"] == $a_type)
{
return $node["child"];
}
}
return 0;
}
Here is the call graph for this function:
| 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
Definition at line 879 of file class.ilTree.php.
References $lft, $q, $rgt, and $row.
{
$q = "SELECT lft,rgt FROM ".$this->table_tree." ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
{
$lft[] = $row->lft;
$rgt[] = $row->rgt;
}
$all = array_merge($lft,$rgt);
$uni = array_unique($all);
if (count($all) != count($uni))
{
$message = sprintf('%s::checkTree(): Tree is corrupted!',
get_class($this));
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
return true;
}
| ilTree::checkTreeChilds | ( | $ | a_no_zero_child = true |
) |
check, if all childs of tree nodes exist in object table
Definition at line 910 of file class.ilTree.php.
{
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."' ".
"ORDER BY lft";
$r1 = $this->ilDB->query($q);
while ($row = $r1->fetchRow(DB_FETCHMODE_ASSOC))
{
//echo "tree:".$row[$this->tree_pk].":lft:".$row["lft"].":rgt:".$row["rgt"].":child:".$row["child"].":<br>";
if (($row["child"] == 0) && $a_no_zero_child)
{
$this->ilErr->raiseError(get_class($this)."::checkTreeChilds(): Tree contains child with ID 0!",$this->ilErr->WARNING);
}
if ($this->table_obj_reference)
{
// get object reference data
$q = "SELECT * FROM ".$this->table_obj_reference." WHERE ".$this->ref_pk."='".$row["child"]."'";
$r2 = $this->ilDB->query($q);
//echo "num_childs:".$r2->numRows().":<br>";
if ($r2->numRows() == 0)
{
$this->ilErr->raiseError(get_class($this)."::checkTree(): No Object-to-Reference entry found for ID ".
$row["child"]."!",$this->ilErr->WARNING);
}
if ($r2->numRows() > 1)
{
$this->ilErr->raiseError(get_class($this)."::checkTree(): More Object-to-Reference entries found for ID ".
$row["child"]."!",$this->ilErr->WARNING);
}
// get object data
$obj_ref = $r2->fetchRow(DB_FETCHMODE_ASSOC);
$q = "SELECT * FROM ".$this->table_obj_data." WHERE ".$this->obj_pk."='".$obj_ref[$this->obj_pk]."'";
$r3 = $this->ilDB->query($q);
if ($r3->numRows() == 0)
{
$this->ilErr->raiseError(get_class($this)."::checkTree(): No child found for ID ".
$obj_ref[$this->obj_pk]."!",$this->ilErr->WARNING);
}
if ($r3->numRows() > 1)
{
$this->ilErr->raiseError(get_class($this)."::checkTree(): More childs found for ID ".
$obj_ref[$this->obj_pk]."!",$this->ilErr->WARNING);
}
}
else
{
// get only object data
$q = "SELECT * FROM ".$this->table_obj_data." WHERE ".$this->obj_pk."='".$row["child"]."'";
$r2 = $this->ilDB->query($q);
//echo "num_childs:".$r2->numRows().":<br>";
if ($r2->numRows() == 0)
{
$this->ilErr->raiseError(get_class($this)."::checkTree(): No child found for ID ".
$row["child"]."!",$this->ilErr->WARNING);
}
if ($r2->numRows() > 1)
{
$this->ilErr->raiseError(get_class($this)."::checkTree(): More childs found for ID ".
$row["child"]."!",$this->ilErr->WARNING);
}
}
}
return true;
}
| ilTree::deleteTree | ( | $ | a_node | ) |
delete node and the whole subtree under this node public
- Parameters:
-
array node_data of a node
Definition at line 686 of file class.ilTree.php.
References $q, $query, $res, $row, __checkDelete(), __isMainTree(), ilDBx::_lockTables(), and ilDBx::_unlockTables().
{
if (!is_array($a_node))
{
$this->ilErr->raiseError(get_class($this)."::deleteTree(): Wrong datatype for node_data! ",$this->ilErr->WARNING);
}
if($this->__isMainTree() and $a_node[$this->tree_pk] === 1)
{
if($a_node['lft'] <= 1 or $a_node['rgt'] <= 2)
{
$message = sprintf('%s::deleteTree(): Invalid parameters given: $a_node["lft"]: %s, $a_node["rgt"] %s',
get_class($this),
$a_node['lft'],
$a_node['rgt']);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
else if(!$this->__checkDelete($a_node))
{
$message = sprintf('%s::deleteTree(): Check delete failed: $a_node["lft"]: %s, $a_node["rgt"] %s',
get_class($this),
$a_node['lft'],
$a_node['rgt']);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
}
$diff = $a_node["rgt"] - $a_node["lft"] + 1;
// LOCKED ###########################################################
// get lft and rgt values. Don't trust parameter lft/rgt values of $a_node
if($this->__isMainTree())
{
ilDBx::_lockTables(array('tree' => 'WRITE'));
}
$query = "SELECT * FROM ".$this->table_tree." ".
"WHERE child = '".$a_node['child']."' ".
"AND ".$this->tree_pk." = '".$a_node[$this->tree_pk]."'";
$res = $this->ilDB->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$a_node['lft'] = $row->lft;
$a_node['rgt'] = $row->rgt;
$diff = $a_node["rgt"] - $a_node["lft"] + 1;
}
// delete subtree
$q = "DELETE FROM ".$this->table_tree." ".
"WHERE lft BETWEEN '".$a_node["lft"]."' AND '".$a_node["rgt"]."' ".
"AND rgt BETWEEN '".$a_node["lft"]."' AND '".$a_node["rgt"]."' ".
"AND ".$this->tree_pk." = '".$a_node[$this->tree_pk]."'";
$this->ilDB->query($q);
// close gaps
$q = "UPDATE ".$this->table_tree." SET ".
"lft = CASE ".
"WHEN lft > '".$a_node["lft"]." '".
"THEN lft - '".$diff." '".
"ELSE lft ".
"END, ".
"rgt = CASE ".
"WHEN rgt > '".$a_node["lft"]." '".
"THEN rgt - '".$diff." '".
"ELSE rgt ".
"END ".
"WHERE ".$this->tree_pk." = '".$a_node[$this->tree_pk]."'";
$this->ilDB->query($q);
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
// LOCKED ###########################################################
}
Here is the call graph for this function:
| 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 1116 of file class.ilTree.php.
References $data, $lng, $objDefinition, $q, $row, and ilUtil::stripSlashes().
Referenced by fetchPredecessorNode(), fetchSuccessorNode(), ilSCORMTree::getChilds(), getChilds(), getChildsByType(), getLeafs(), getNodeData(), getNodeDataByType(), getParentNodeData(), getPathFull(), getSavedNodeData(), getSubTree(), and saveSubTree().
{
global $objDefinition, $lng;
$data = $a_row;
$data["desc"] = $a_row["description"]; // for compability
// multilingual support systemobjects (sys) & categories (db)
if (is_object($objDefinition))
{
$translation_type = $objDefinition->getTranslationType($data["type"]);
}
if ($translation_type == "sys")
{
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");
}
}
elseif ($translation_type == "db")
{
$q = "SELECT title,description FROM object_translation ".
"WHERE obj_id = ".$data["obj_id"]." ".
"AND lang_code = '".$this->lang_code."' ".
"AND NOT lang_default = 1";
$r = $this->ilDB->query($q);
$row = $r->fetchRow(DB_FETCHMODE_OBJECT);
if ($row)
{
$data["title"] = $row->title;
$data["description"] = $row->description;
$data["desc"] = $row->description;
}
}
$data["title"] = ilUtil::stripSlashes($data["title"]);
$data["description"] = ilUtil::stripSlashes($data["description"]);
$data["desc"] = ilUtil::stripSlashes($data["desc"]);
/*
$data = array(
"ref_id" => $a_row->ref_id,
"obj_id" => $a_row->obj_id,
"type" => $a_row->type,
"title" => $a_row->title,
"description" => $a_row->description,
"owner" => $a_row->owner,
"create_date" => $a_row->create_date,
"last_update" => $a_row->last_update,
"tree" => $a_row->tree,
"child" => $a_row->child,
"parent" => $a_row->parent,
"lft" => $a_row->lft,
"rgt" => $a_row->rgt,
"depth" => $a_row->depth,
"desc" => $a_row->description
);*/
return $data ? $data : array();
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilTree::fetchPath | ( | $ | a_endnode_id, | |
| $ | a_startnode_id | |||
| ) |
get path from a given startnode to a given endnode if startnode is not given the rootnode is startnode private
- Parameters:
-
integer node_id of endnode integer node_id of startnode
- Returns:
- object query result
Definition at line 774 of file class.ilTree.php.
References $q.
Referenced by getPathFull(), and getPathId().
{
if ($this->table_obj_reference)
{
$leftjoin = "LEFT JOIN ".$this->table_obj_reference." ON T2.child=".$this->table_obj_reference.".".$this->ref_pk." ".
"LEFT JOIN ".$this->table_obj_data." ON ".$this->table_obj_reference.".".$this->obj_pk."=".
$this->table_obj_data.".".$this->obj_pk." ";
$select_obj_id = $this->table_obj_data.".obj_id,";
}
else
{
$leftjoin = "LEFT JOIN ".$this->table_obj_data." ON T2.child=".$this->table_obj_data.".".$this->obj_pk." ";
}
$q = "SELECT ".$select_obj_id.$this->table_obj_data.".title,".$this->table_obj_data.".type,T2.child,(T2.rgt - T2.lft) AS sort_col ".
"FROM ".$this->table_tree." AS T1, ".$this->table_tree." AS T2, ".$this->table_tree." AS T3 ".
$leftjoin.
"WHERE T1.child = '".$a_startnode_id."' ".
"AND T3.child = '".$a_endnode_id."' ".
"AND T2.lft BETWEEN T1.lft AND T1.rgt ".
"AND T3.lft BETWEEN T2.lft AND T2.rgt ".
"AND T1.".$this->tree_pk." = '".$this->tree_id." '".
"AND T2.".$this->tree_pk." = '".$this->tree_id." '".
"AND T3.".$this->tree_pk." = '".$this->tree_id." '".
"ORDER BY sort_col DESC";
$r = $this->ilDB->query($q);
if ($r->numRows() > 0)
{
return $r;
}
else
{
$this->ilErr->raiseError(get_class($this)."::fetchPath: No path found! startnode_id:".$a_startnode_id.", endnode_id:".$a_endnode_id,$this->ilErr->WARNING);
}
}
Here is the caller graph for this function:
| ilTree::fetchPredecessorNode | ( | $ | a_node_id, | |
| $ | a_type = "" | |||
| ) |
get node data of predecessor node
public
- Parameters:
-
integer node id
- Returns:
- array node data array
Definition at line 1705 of file class.ilTree.php.
References $q, $row, and fetchNodeData().
{
if (!isset($a_node_id))
{
$this->ilErr->raiseError(get_class($this)."::getNodeData(): No node_id given! ",$this->ilErr->WARNING);
}
// get lft value for current node
$q = "SELECT lft FROM ".$this->table_tree." ".
"WHERE ".$this->table_tree.".child = '".$a_node_id."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
$curr_node = $r->fetchRow(DB_FETCHMODE_ASSOC);
// get data of predecessor node
$type_where = ($a_type != "")
? "AND ".$this->table_obj_data.".type = '$a_type' "
: "";
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE lft < '".$curr_node["lft"]."' ".
$type_where.
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'".
"ORDER BY lft DESC LIMIT 1";
$r = $this->ilDB->query($q);
if ($r->numRows() < 1)
{
return false;
}
else
{
$row = $r->fetchRow(DB_FETCHMODE_ASSOC);
return $this->fetchNodeData($row);
}
}
Here is the call graph for this function:
| ilTree::fetchSuccessorNode | ( | $ | a_node_id, | |
| $ | a_type = "" | |||
| ) |
get node data of successor node
public
- Parameters:
-
integer node id
- Returns:
- array node data array
Definition at line 1661 of file class.ilTree.php.
References $q, $row, and fetchNodeData().
{
if (!isset($a_node_id))
{
$this->ilErr->raiseError(get_class($this)."::getNodeData(): No node_id given! ",$this->ilErr->WARNING);
}
// get lft value for current node
$q = "SELECT lft FROM ".$this->table_tree." ".
"WHERE ".$this->table_tree.".child = '".$a_node_id."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
$curr_node = $r->fetchRow(DB_FETCHMODE_ASSOC);
// get data of successor node
$type_where = ($a_type != "")
? "AND ".$this->table_obj_data.".type = '$a_type' "
: "";
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE lft > '".$curr_node["lft"]."' ".
$type_where.
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'".
"ORDER BY lft LIMIT 1";
$r = $this->ilDB->query($q);
if ($r->numRows() < 1)
{
return false;
}
else
{
$row = $r->fetchRow(DB_FETCHMODE_ASSOC);
return $this->fetchNodeData($row);
}
}
Here is the call graph for this function:
| 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
Reimplemented in ilSCORMTree.
Definition at line 300 of file class.ilTree.php.
References $count, $q, $row, buildJoin(), and fetchNodeData().
Referenced by __renumber(), and getFilteredChilds().
{
if (!isset($a_node_id))
{
$message = get_class($this)."::getChilds(): No node_id given!";
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
// 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";
}
//666
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE parent = '".$a_node_id."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."' ".
$order_clause;
$r = $this->ilDB->query($q);
$count = $r->numRows();
if ($count > 0)
{
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$childs[] = $this->fetchNodeData($row);
}
// mark the last child node (important for display)
$childs[$count - 1]["last"] = true;
return $childs;
}
else
{
return $childs;
}
}
Here is the call graph for this function:
Here is the caller graph for this function:
| 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
Definition at line 387 of file class.ilTree.php.
References $q, $row, buildJoin(), and fetchNodeData().
{
if (!isset($a_node_id) or !isset($a_type))
{
$message = get_class($this)."::getChildsByType(): Missing parameter! node_id:".$a_node_id." type:".$a_type;
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
// init childs
$childs = array();
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE parent = '".$a_node_id."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."' ".
"AND ".$this->table_obj_data.".type='".$a_type."' ".
"ORDER BY ".$this->table_tree.".lft";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$childs[] = $this->fetchNodeData($row);
}
return $childs;
}
Here is the call graph for this function:
| ilTree::getChildSequenceNumber | ( | $ | a_node, | |
| $ | type = "" | |||
| ) |
get sequence number of node in sibling sequence public
- Parameters:
-
array node
- Returns:
- integer sequence number
Definition at line 1579 of file class.ilTree.php.
References $q, $row, $type, and buildJoin().
{
if (!isset($a_node))
{
$this->ilErr->raiseError(get_class($this)."::getChildSequenceNumber(): No node_id given! ",$this->ilErr->WARNING);
}
$type_str = ($type != "")
? "AND type='$type'"
: "";
$q = "SELECT count(*) AS cnt FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE lft <=".$this->ilDB->quote($a_node["lft"])." ".
$type_str.
"AND parent=".$this->ilDB->quote($a_node["parent"])." ".
"AND ".$this->table_tree.".".$this->tree_pk."=".$this->ilDB->quote($this->tree_id);
$r = $this->ilDB->query($q);
$row = $r->fetchRow(DB_FETCHMODE_ASSOC);
return $row["cnt"];
}
Here is the call graph for this function:
| 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 1001 of file class.ilTree.php.
References $q, $res, and $row.
Referenced by insertNode().
{
if ($a_node_id)
{
$q = "SELECT depth FROM ".$this->table_tree." ".
"WHERE child = '".$a_node_id."' ".
"AND ".$this->tree_pk." = '".$this->tree_id."'";
$res = $this->ilDB->query($q);
$row = $res->fetchRow(DB_FETCHMODE_OBJECT);
return $row->depth;
}
else
{
return 1;
}
}
Here is the caller graph for this function:
| 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 365 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:
| ilTree::getLeafs | ( | ) |
get leaf(=end) nodes of tree //TODO: Method not used yet public
- Returns:
- array node data of all leaf nodes
Definition at line 276 of file class.ilTree.php.
References $q, $row, buildJoin(), and fetchNodeData().
{
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE lft = (rgt -1) ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree->id."'";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$leafs[] = $this->fetchNodeData($row);
}
return $leafs;
}
Here is the call graph for this function:
| ilTree::getMaximumDepth | ( | ) |
| ilTree::getNodeData | ( | $ | 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:
- array 2-dim (int/str) node_data
Definition at line 1079 of file class.ilTree.php.
References $q, $row, __isMainTree(), buildJoin(), and fetchNodeData().
Referenced by getSubTreeTypes().
{
if (!isset($a_node_id))
{
$this->ilErr->raiseError(get_class($this)."::getNodeData(): No node_id given! ",$this->ilErr->WARNING);
}
if($this->__isMainTree())
{
if($a_node_id < 1)
{
$message = sprintf('%s::getNodeData(): No valid parameter given! $a_node_id: %s',
get_class($this),
$a_node_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
}
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE ".$this->table_tree.".child = '".$a_node_id."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
$row = $r->fetchRow(DB_FETCHMODE_ASSOC);
$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:
| ilTree::getNodeDataByType | ( | $ | a_type | ) |
get nodes by type // TODO: method needs revision
- Parameters:
-
integer a_tree_id: obj_id of object where tree belongs to integer a_type_id: type of object public
Definition at line 1332 of file class.ilTree.php.
References $data, $left, $q, $right, $row, buildJoin(), and fetchNodeData().
{
if (!isset($a_type) or (!is_string($a_type)))
{
$this->ilErr->raiseError(get_class($this)."::getNodeDataByType(): Type not given or wrong datatype!",$this->ilErr->WARNING);
}
$data = array(); // node_data
$row = ""; // fetched row
$left = ""; // tree_left
$right = ""; // tree_right
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."'".
"AND parent = '0'";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
{
$left = $row->lft;
$right = $row->rgt;
}
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE ".$this->table_obj_data.".type = '".$a_type."' ".
"AND ".$this->table_tree.".lft BETWEEN '".$left."' AND '".$right."' ".
"AND ".$this->table_tree.".rgt BETWEEN '".$left."' AND '".$right."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$data[] = $this->fetchNodeData($row);
}
return $data;
}
Here is the call graph for this function:
| ilTree::getParentId | ( | $ | a_node_id | ) |
get parent id of given node public
- Parameters:
-
integer node id
- Returns:
- integer parent id
Definition at line 1556 of file class.ilTree.php.
{
if (!isset($a_node_id))
{
$this->ilErr->raiseError(get_class($this)."::getParentId(): No node_id given! ",$this->ilErr->WARNING);
}
$q = "SELECT parent FROM ".$this->table_tree." ".
"WHERE child='".$a_node_id."' ".
"AND ".$this->tree_pk."='".$this->tree_id."'";
$r = $this->ilDB->query($q);
$row = $r->fetchRow(DB_FETCHMODE_OBJECT);
return $row->parent;
}
| ilTree::getParentNodeData | ( | $ | a_node_id | ) |
get data of parent node from tree and object_data public
- Parameters:
-
integer node id
- Returns:
- array
Definition at line 1225 of file class.ilTree.php.
References $q, $row, and fetchNodeData().
{
if (!isset($a_node_id))
{
$this->ilErr->raiseError(get_class($this)."::getParentNodeData(): No node_id given! ",$this->ilErr->WARNING);
}
if ($this->table_obj_reference)
{
$leftjoin = "LEFT JOIN ".$this->table_obj_reference." ON v.child=".$this->table_obj_reference.".".$this->ref_pk." ".
"LEFT JOIN ".$this->table_obj_data." ON ".$this->table_obj_reference.".".$this->obj_pk."=".$this->table_obj_data.".".$this->obj_pk." ";
}
else
{
$leftjoin = "LEFT JOIN ".$this->table_obj_data." ON v.child=".$this->table_obj_data.".".$this->obj_pk." ";
}
$q = "SELECT * FROM ".$this->table_tree." s,".$this->table_tree." v ".
$leftjoin.
"WHERE s.child = '".$a_node_id."' ".
"AND s.parent = v.child ".
"AND s.lft > v.lft ".
"AND s.rgt < v.rgt ".
"AND s.".$this->tree_pk." = '".$this->tree_id."' ".
"AND v.".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
$row = $r->fetchRow(DB_FETCHMODE_ASSOC);
return $this->fetchNodeData($row);
}
Here is the call graph for this function:
| 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 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 820 of file class.ilTree.php.
References $path, $row, fetchNodeData(), and fetchPath().
Referenced by checkForParentType().
{
if (!isset($a_endnode_id))
{
$this->ilErr->raiseError(get_class($this)."::getPathFull(): No endnode_id given! ",$this->ilErr->WARNING);
}
if (empty($a_startnode_id))
{
$a_startnode_id = $this->root_id;
}
$r = $this->fetchPath($a_endnode_id, $a_startnode_id);
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$path[] = $this->fetchNodeData($row);
}
return $path ? $path : array();
}
Here is the call graph for this function:
Here is the caller graph for this function:
| 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
Definition at line 850 of file class.ilTree.php.
References $row, and fetchPath().
{
if (!isset($a_endnode_id))
{
$this->ilErr->raiseError(get_class($this)."::getPathId(): No endnode_id given! ",$this->ilErr->WARNING);
}
//if (!isset($a_startnode_id))
if ($a_startnode_id == 0)
{
$a_startnode_id = $this->root_id;
}
$r = $this->fetchPath($a_endnode_id, $a_startnode_id);
while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
{
$arr[] = $row->child;
}
return $arr;
}
Here is the call graph for this function:
| ilTree::getRootId | ( | ) |
get the root id of tree public
- Returns:
- integer root node id
Definition at line 1625 of file class.ilTree.php.
{
return $this->root_id;
}
| ilTree::getSavedNodeData | ( | $ | a_parent_id | ) |
get data saved/deleted nodes
- Returns:
- array data
- Parameters:
-
integer id of parent object of saved object public
Definition at line 1529 of file class.ilTree.php.
References $q, $row, buildJoin(), and fetchNodeData().
{
if (!isset($a_parent_id))
{
$this->ilErr->raiseError(get_class($this)."::getSavedNodeData(): No node_id given!",$this->ilErr->WARNING);
}
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE ".$this->table_tree.".".$this->tree_pk." < 0 ".
"AND ".$this->table_tree.".parent = '".$a_parent_id."' ";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$saved[] = $this->fetchNodeData($row);
}
return $saved ? $saved : array();
}
Here is the call graph for this function:
| ilTree::getSubTree | ( | $ | a_node | ) |
get all nodes in the subtree under specified node
public
- Parameters:
-
array node_data
- Returns:
- array 2-dim (int/array) key, node_data of each subtree node including the specified node
Definition at line 623 of file class.ilTree.php.
References $q, $row, buildJoin(), and fetchNodeData().
{
if (!is_array($a_node))
{
$this->ilErr->raiseError(get_class($this)."::getSubTree(): Wrong datatype for node_data! ",$this->ilErr->WARNING);
}
if($a_node['lft'] < 1 or $a_node['rgt'] < 2)
{
$message = sprintf('%s::getSubTree(): Invalid node given! $a_node["lft"]: %s $a_node["rgt"]: %s',
get_class($this),
$a_node['lft'],
$a_node['rgt']);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
$subtree = array();
$q = "SELECT * FROM ".$this->table_tree." ".
$this->buildJoin().
"WHERE ".$this->table_tree.".lft BETWEEN '".$a_node["lft"]."' AND '".$a_node["rgt"]."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."' ".
"ORDER BY ".$this->table_tree.".lft";
$r = $this->ilDB->query($q);
while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$subtree[] = $this->fetchNodeData($row);
}
return $subtree ? $subtree : array();
}
Here is the call graph for this function:
| 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 666 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:
| ilTree::getTreeId | ( | ) |
get tree id public
- Returns:
- integer tree id
Definition at line 1639 of file class.ilTree.php.
{
return $this->tree_id;
}
| ilTree::ilTree | ( | $ | a_tree_id, | |
| $ | a_root_id = 0 | |||
| ) |
Constructor public.
- Parameters:
-
integer $a_tree_id tree_id integer $a_root_id root_id (optional)
Definition at line 116 of file class.ilTree.php.
References $ilErr, $ilias, $ilLog, $ilUser, and if.
Referenced by ilAICCTree::ilAICCTree(), and ilSCORMTree::ilSCORMTree().
{
global $ilDB,$ilErr,$ilUser,$ilias,$ilLog;
// set db & error handler
(isset($ilDB)) ? $this->ilDB =& $ilDB : $this->ilDB =& $ilias->db;
if (!isset($ilErr))
{
$ilErr = new ilErrorHandling();
$ilErr->setErrorHandling(PEAR_ERROR_CALLBACK,array($ilErr,'errorHandler'));
}
else
{
$this->ilErr =& $ilErr;
}
// lang_code is only required in $this->fetchnodedata
if (!is_object($ilUser))
{
$this->lang_code = "en";
}
else
{
$this->lang_code = $ilUser->getCurrentLanguage();
}
if (!isset($a_tree_id) or (func_num_args() == 0) )
{
$this->ilErr->raiseError(get_class($this)."::Constructor(): No tree_id given!",$this->ilErr->WARNING);
}
if (func_num_args() > 2)
{
$this->ilErr->raiseError(get_class($this)."::Constructor(): Wrong parameter count!",$this->ilErr->WARNING);
}
// CREATE LOGGER INSTANCE
$this->log =& $ilLog;
//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';
}
Here is the caller graph for this function:
| ilTree::insertNode | ( | $ | a_node_id, | |
| $ | a_parent_id, | |||
| $ | a_pos = IL_LAST_NODE | |||
| ) |
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
Definition at line 423 of file class.ilTree.php.
References $left, $lft, $q, $res, $rgt, $right, __isMainTree(), ilDBx::_lockTables(), ilDBx::_unlockTables(), getDepth(), and isInTree().
{
//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('%s::insertNode(): Invalid parameters! $a_node_id: %s $a_parent_id: %s',
get_class($this),
$a_node_id,
$a_parent_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
}
if (!isset($a_node_id) or !isset($a_parent_id))
{
$this->ilErr->raiseError(get_class($this)."::insertNode(): Missing parameter! ".
"node_id: ".$a_node_id." parent_id: ".$a_parent_id,$this->ilErr->WARNING);
}
if ($this->isInTree($a_node_id))
{
$this->ilErr->raiseError(get_class($this)."::insertNode(): Node ".$a_node_id." already in tree ".
$this->table_tree."!",$this->ilErr->WARNING);
}
//
// i changed the processing here.
// mail any errors to alex.killing@gmx.de (22.5.2003)
//
switch ($a_pos)
{
case IL_FIRST_NODE:
if($this->__isMainTree())
{
ilDBx::_lockTables(array('tree' => 'WRITE'));
}
// get left value of parent
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE child = '".$a_parent_id."' ".
"AND ".$this->tree_pk." = '".$this->tree_id."'";
$res = $this->ilDB->query($q);
$r = $res->fetchRow(DB_FETCHMODE_OBJECT);
if ($r->parent == NULL)
{
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
$this->ilErr->raiseError(get_class($this)."::insertNode(): Parent with ID ".$a_parent_id." not found in ".
$this->table_tree."!",$this->ilErr->WARNING);
}
$left = $r->lft;
$lft = $left + 1;
$rgt = $left + 2;
// spread tree
$q = "UPDATE ".$this->table_tree." SET ".
"lft = CASE ".
"WHEN lft > ".$left." ".
"THEN lft + 2 ".
"ELSE lft ".
"END, ".
"rgt = CASE ".
"WHEN rgt > ".$left." ".
"THEN rgt + 2 ".
"ELSE rgt ".
"END ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."'";
$this->ilDB->query($q);
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
break;
case IL_LAST_NODE:
if($this->__isMainTree())
{
ilDBx::_lockTables(array('tree' => 'WRITE'));
}
// get right value of parent
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE child = '".$a_parent_id."' ".
"AND ".$this->tree_pk." = '".$this->tree_id."'";
$res = $this->ilDB->query($q);
$r = $res->fetchRow(DB_FETCHMODE_OBJECT);
if ($r->parent == NULL)
{
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
$this->ilErr->raiseError(get_class($this)."::insertNode(): Parent with ID ".
$a_parent_id." not found in ".$this->table_tree."!",$this->ilErr->WARNING);
}
$right = $r->rgt;
$lft = $right;
$rgt = $right + 1;
// spread tree
$q = "UPDATE ".$this->table_tree." SET ".
"lft = CASE ".
"WHEN lft > ".$right." ".
"THEN lft + 2 ".
"ELSE lft ".
"END, ".
"rgt = CASE ".
"WHEN rgt >= ".$right." ".
"THEN rgt + 2 ".
"ELSE rgt ".
"END ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."'";
$this->ilDB->query($q);
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
break;
default:
// get right value of preceeding child
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE child = '".$a_pos."' ".
"AND ".$this->tree_pk." = '".$this->tree_id."'";
$res = $this->ilDB->query($q);
$r = $res->fetchRow(DB_FETCHMODE_OBJECT);
// crosscheck parents of sibling and new node (must be identical)
if ($r->parent != $a_parent_id)
{
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
$this->ilErr->raiseError(get_class($this)."::insertNode(): Parents mismatch! ".
"new node parent: ".$a_parent_id." sibling parent: ".$r->parent,$this->ilErr->WARNING);
}
$right = $r->rgt;
$lft = $right + 1;
$rgt = $right + 2;
// update lft/rgt values
$q = "UPDATE ".$this->table_tree." SET ".
"lft = CASE ".
"WHEN lft > ".$right." ".
"THEN lft + 2 ".
"ELSE lft ".
"END, ".
"rgt = CASE ".
"WHEN rgt > ".$right." ".
"THEN rgt + 2 ".
"ELSE rgt ".
"END ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."'";
$this->ilDB->query($q);
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
break;
}
// get depth
$depth = $this->getDepth($a_parent_id) + 1;
// insert node
$q = "INSERT INTO ".$this->table_tree." (".$this->tree_pk.",child,parent,lft,rgt,depth) ".
"VALUES ".
"('".$this->tree_id."','".$a_node_id."','".$a_parent_id."','".$lft."','".$rgt."','".$depth."')";
$this->ilDB->query($q);
}
Here is the call graph for this function:
| 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 1264 of file class.ilTree.php.
References $q.
{
if (!isset($a_startnode_id) or !isset($a_querynode_id))
{
$this->ilErr->raiseError(get_class($this)."::isGrandChild(): Missing parameter! startnode: ".$a_startnode_id." querynode: ".
$a_querynode_id,$this->ilErr->WARNING);
}
$q = "SELECT * FROM ".$this->table_tree." s,".$this->table_tree." v ".
"WHERE s.child = '".$a_startnode_id."' ".
"AND v.child = '".$a_querynode_id."' ".
"AND s.".$this->tree_pk." = '".$this->tree_id."' ".
"AND v.".$this->tree_pk." = '".$this->tree_id."' ".
"AND v.lft BETWEEN s.lft AND s.rgt ".
"AND v.rgt BETWEEN s.lft AND s.rgt";
$r = $this->ilDB->query($q);
return $r->numRows();
}
| 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 1195 of file class.ilTree.php.
References $q.
Referenced by checkForParentType(), and insertNode().
{
if (!isset($a_node_id))
{
return false;
#$this->ilErr->raiseError(get_class($this)."::getNodeData(): No node_id given! ",$this->ilErr->WARNING);
}
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE ".$this->table_tree.".child = '".$a_node_id."' ".
"AND ".$this->table_tree.".".$this->tree_pk." = '".$this->tree_id."'";
$r = $this->ilDB->query($q);
if ($r->numRows() > 0)
{
return true;
}
else
{
return false;
}
}
Here is the caller graph for this function:
| ilTree::isSaved | ( | $ | a_node_id | ) |
| ilTree::readRootId | ( | ) |
read root id from database
- Parameters:
-
root_id public
- Returns:
- int new root id
Definition at line 1609 of file class.ilTree.php.
| ilTree::removeTree | ( | $ | a_tree_id | ) |
remove an existing tree
- Parameters:
-
integer a_tree_id: tree to be removed
- Returns:
- boolean true on success public
Definition at line 1378 of file class.ilTree.php.
References $q, and __isMainTree().
{
// OPERATION NOT ALLOWED ON MAIN TREE
if($this->__isMainTree())
{
$message = sprintf('%s::removeTree(): Operation not allowed on main tree! $a_tree_if: %s',
get_class($this),
$a_tree_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
if (!$a_tree_id)
{
$this->ilErr->raiseError(get_class($this)."::removeTree(): No tree_id given! Action aborted",$this->ilErr->MESSAGE);
}
$q = "DELETE FROM ".$this->table_tree." WHERE ".$this->tree_pk." = '".$a_tree_id."'";
$this->ilDB->query($q);
return true;
}
Here is the call graph for this function:
| 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 1750 of file class.ilTree.php.
References __isMainTree(), __renumber(), ilDBx::_lockTables(), and ilDBx::_unlockTables().
{
// LOCKED ###################################
if($this->__isMainTree())
{
ilDBx::_lockTables(array($this->table_tree => 'WRITE',
$this->table_obj_data => 'WRITE',
$this->table_obj_reference => 'WRITE',
'object_translation' => 'WRITE'));
}
$return = $this->__renumber($node_id,$i);
if($this->__isMainTree())
{
ilDBx::_unlockTables();
}
// LOCKED ###################################
return $return;
}
Here is the call graph for this function:
| ilTree::saveNode | ( | $ | a_node_id, | |
| $ | a_parent_id | |||
| ) |
save node: copy a node (defined by obj_id and parent) to a new tree with tree_id -obj_id.This is neccessary for link
- Parameters:
-
integer node_id integer parent_id
- Returns:
- boolean public
Definition at line 1494 of file class.ilTree.php.
References $q, and __isMainTree().
{
if($this->__isMainTree())
{
if($a_node_id <= 1 or $a_parent_id <= 0)
{
$message = sprintf('%s::saveSubTree(): No valid parameter given! $a_node_id: %s $a_parent_id: %s',
get_class($this),
$a_node_id,
$a_parent_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
}
if ($a_node_id < 1 or !isset($a_parent_id))
{
$this->ilErr->raiseError(get_class($this)."::saveNode(): Missing parameter! ".
"node_id: ".$a_node_id." parent_id: ".$a_parent_id,$this->ilErr->WARNING);
}
// SAVE NODE
$q = "INSERT INTO ".$this->table_tree." ".
"VALUES ('".-$a_node_id."','".$a_node_id."','".$a_parent_id."','1','2','1')";
$r = $this->ilDB->query($q);
return true;
}
Here is the call graph for this function:
| ilTree::saveSubTree | ( | $ | a_node_id | ) |
save subtree: copy a subtree (defined by node_id) to a new tree with $this->tree_id -node_id.
This is neccessary for undelete functionality
- Parameters:
-
integer node_id
- Returns:
- integer public
Definition at line 1407 of file class.ilTree.php.
References $lft, $q, $rgt, $row, __isMainTree(), ilDBx::_lockTables(), and fetchNodeData().
{
if (!$a_node_id)
{
$message = sprintf('%s::saveSubTree(): No valid parameter given! $a_node_id: %s',
get_class($this),
$a_node_id);
$this->log->write($message,$this->log->FATAL);
$this->ilErr->raiseError($message,$this->ilErr->WARNING);
}
// LOCKED ###############################################
if($this->__isMainTree())
{
ilDBx::_lockTables(array('tree' => 'WRITE'));
}
// GET LEFT AND RIGHT VALUE
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."' ".
"AND child = '".$a_node_id."' ";
$r = $this->ilDB->query($q);
while($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
{
$lft = $row->lft;
$rgt = $row->rgt;
}
// GET ALL SUBNODES
$q = "SELECT * FROM ".$this->table_tree." ".
"WHERE ".$this->tree_pk." = '".$this->tree_id."' ".
"AND lft >= '".$lft."' ".
"AND rgt <= '".$rgt."'";
$r = $this->ilDB->query($q);
while($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
{
$subnodes[$row["child"]] = $this->fetchNodeData($row);
}
// SAVE SUBTREE
foreach($subnodes as $node)
{
$q = "INSERT INTO ".$this->table_tree." ".
"VALUES ('".-$a_node_id."','".$node["child"]."','".$node["parent"]."','".
$node["lft"]."','".$node["rgt"]."','".$node["depth"]."')";
$r = $this->ilDB->query($q);
}
if($this->__isMainTree())
{
ilDBX::_unlockTables();
}
// LOCKED ###############################################
return true;
}
Here is the call graph for this function:
| ilTree::setObjectTablePK | ( | $ | a_column_name | ) |
set column containing primary key in object table public
- Parameters:
-
string column name
- Returns:
- boolean true, when successfully set
Definition at line 224 of file class.ilTree.php.
{
if (!isset($a_column_name))
{
$this->ilErr->raiseError(get_class($this)."::setObjectTablePK(): No column name given!",$this->ilErr->WARNING);
}
$this->obj_pk = $a_column_name;
return true;
}
| ilTree::setReferenceTablePK | ( | $ | a_column_name | ) |
set column containing primary key in reference table public
- Parameters:
-
string column name
- Returns:
- boolean true, when successfully set
Definition at line 207 of file class.ilTree.php.
{
if (!isset($a_column_name))
{
$this->ilErr->raiseError(get_class($this)."::setReferenceTablePK(): No column name given!",$this->ilErr->WARNING);
}
$this->ref_pk = $a_column_name;
return true;
}
| ilTree::setRootId | ( | $ | a_root_id | ) |
Definition at line 1629 of file class.ilTree.php.
{
$this->root_id = $a_root_id;
}
| 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
Definition at line 186 of file class.ilTree.php.
Referenced by ilAICCTree::ilAICCTree(), and ilSCORMTree::ilSCORMTree().
{
if (!isset($a_table_tree) or !isset($a_table_obj_data))
{
$this->ilErr->raiseError(get_class($this)."::setTableNames(): Missing parameter! ".
"tree table: ".$a_table_tree." object data table: ".$a_table_obj_data,$this->ilErr->WARNING);
}
$this->table_tree = $a_table_tree;
$this->table_obj_data = $a_table_obj_data;
$this->table_obj_reference = $a_table_obj_reference;
return true;
}
Here is the caller graph for this function:
| ilTree::setTreeId | ( | $ | a_tree_id | ) |
set tree id public
- Returns:
- integer tree id
Definition at line 1649 of file class.ilTree.php.
{
$this->tree_id = $a_tree_id;
}
| ilTree::setTreeTablePK | ( | $ | a_column_name | ) |
set column containing primary key in tree table public
- Parameters:
-
string column name
- Returns:
- boolean true, when successfully set
Definition at line 241 of file class.ilTree.php.
Referenced by ilAICCTree::ilAICCTree(), and ilSCORMTree::ilSCORMTree().
{
if (!isset($a_column_name))
{
$this->ilErr->raiseError(get_class($this)."::setTreeTablePK(): No column name given!",$this->ilErr->WARNING);
}
$this->tree_pk = $a_column_name;
return true;
}
Here is the caller graph for this function:
Field Documentation
| ilTree::$ilias |
Definition at line 44 of file class.ilTree.php.
Referenced by ilTree().
| ilTree::$log |
Definition at line 52 of file class.ilTree.php.
| ilTree::$obj_pk |
Definition at line 101 of file class.ilTree.php.
| ilTree::$ref_pk |
Definition at line 94 of file class.ilTree.php.
| ilTree::$root_id |
Definition at line 59 of file class.ilTree.php.
| ilTree::$table_obj_data |
Definition at line 80 of file class.ilTree.php.
| ilTree::$table_obj_reference |
Definition at line 87 of file class.ilTree.php.
| ilTree::$table_tree |
Definition at line 73 of file class.ilTree.php.
| ilTree::$tree_id |
Definition at line 66 of file class.ilTree.php.
| ilTree::$tree_pk |
Definition at line 108 of file class.ilTree.php.
The documentation for this class was generated from the following file:
- classes/class.ilTree.php
