class.ilObjTaxonomy.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once "./Services/Object/classes/class.ilObject2.php";

class ilObjTaxonomy extends ilObject2
{
        const SORT_ALPHABETICAL = 0;
        const SORT_MANUAL = 1;
        protected $node_mapping = array();
        protected $item_sorting = false;
        
        function __construct($a_id = 0)
        {
                $this->type = "tax";
                parent::__construct($a_id, false);
        }

        function initType()
        {
                $this->type = "tax";
        }
        
        function setSortingMode($a_val)
        {
                $this->sorting_mode = $a_val;
        }
        
        function getSortingMode()
        {
                return $this->sorting_mode;
        }
        
        function setItemSorting($a_val)
        {
                $this->item_sorting = $a_val;
        }
        
        function getItemSorting()
        {
                return $this->item_sorting;
        }
        
        function getTree()
        {
                if ($this->getId() > 0)
                {
                        include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
                        $tax_tree = new ilTaxonomyTree($this->getId());
                        return $tax_tree;
                }
                return false;
        }
        
        function getNodeMapping()
        {
                return $this->node_mapping;
        }
        
        
        function doCreate()
        {
                global $ilDB;
                
                // create tax data record
                $ilDB->manipulate("INSERT INTO tax_data ".
                        "(id, sorting_mode, item_sorting) VALUES (".
                        $ilDB->quote($this->getId(), "integer").",".
                        $ilDB->quote((int) $this->getSortingMode(), "integer").",".
                        $ilDB->quote((int) $this->getItemSorting(), "integer").
                        ")");
                
                // create the taxonomy tree
                include_once("./Services/Taxonomy/classes/class.ilTaxonomyNode.php");
                $node = new ilTaxonomyNode();
                $node->setType("");     // empty type
                $node->setTitle("Root node for taxonomy ".$this->getId());
                $node->setTaxonomyId($this->getId());
                $node->create();
                include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
                $tax_tree = new ilTaxonomyTree($this->getId());
                $tax_tree->addTree($this->getId(), $node->getId());
        }
        
        function doCloneObject($a_new_obj, $a_target_id, $a_copy_id = null)
        {
                global $log, $lng;
                
                $a_new_obj->setTitle($this->getTitle());
                $a_new_obj->setDescription($this->getDescription());
                $a_new_obj->setSortingMode($this->getSortingMode());

                $this->node_mapping = array();
                
                $this->cloneNodes($a_new_obj, $a_new_obj->getTree()->readRootId(),
                        $this->getTree()->readRootId());
        }

        function cloneNodes($a_new_obj, $a_target_parent, $a_source_parent)
        {
                include_once("./Services/Taxonomy/classes/class.ilTaxonomyNode.php");
                
                // get all childs
                $nodes = $this->getTree()->getChilds($a_source_parent);
                foreach ($nodes as $node)
                {
                        switch ($node["type"])
                        {
                                case "taxn":
                                        $tax_node = new ilTaxonomyNode($node["child"]);
                                        $new_node = $tax_node->copy($a_new_obj->getId());
                                        break;
                        }

                        ilTaxonomyNode::putInTree($a_new_obj->getId(),
                                $new_node, $a_target_parent);
                        
                        $this->node_mapping[$node["child"]] = $new_node->getId();

                        // handle childs
                        $this->cloneNodes($a_new_obj, $new_node->getId(), $node["child"]);
                }

        }
        

        function doDelete()
        {
                global $ilDB;

                // delete usages
                self::deleteUsagesOfTaxonomy($this->getId());

                // get all nodes
                $tree = $this->getTree();
                $subtree = $tree->getSubTreeIds($tree->readRootId());
                $subtree[] = $tree->readRootId();
                
                // get root node data (important: must happen before we
                // delete the nodes
                $root_node_data = $tree->getNodeData($tree->readRootId());
                
                // delete all nodes
                include_once("./Services/Taxonomy/classes/class.ilTaxonomyNode.php");
                foreach ($subtree as $node_id)
                {
                        // delete node (this also deletes its assignments)
                        $node = new ilTaxonomyNode($node_id);
                        $node->delete();
                }
                
                // delete the tree
                $tree->deleteTree($root_node_data);

                // delete taxonoymy properties record
                $ilDB->manipulate("DELETE FROM tax_data WHERE ".
                        " id = ".$ilDB->quote($this->getId(), "integer")
                        );
                
        }


        function doRead()
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT * FROM tax_data ".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer")
                        );
                $rec  = $ilDB->fetchAssoc($set);
                $this->setSortingMode($rec["sorting_mode"]);
                $this->setItemSorting($rec["item_sorting"]);
        }

        function doUpdate()
        {
                global $ilDB;
                
                $ilDB->manipulate($t = "UPDATE tax_data SET ".
                        " sorting_mode = ".$ilDB->quote((int) $this->getSortingMode(), "integer").", ".
                        " item_sorting = ".$ilDB->quote((int) $this->getItemSorting(), "integer").
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer")
                        );
        }
        
        static function loadLanguageModule()
        {
                global $lng;
                
                $lng->loadLanguageModule("tax");
        }
        
        
        static function saveUsage($a_tax_id, $a_obj_id)
        {
                global $ilDB;

                if ($a_tax_id > 0 &&  $a_obj_id > 0)
                {
                        $ilDB->replace("tax_usage",
                                array("tax_id" => array("integer", $a_tax_id),
                                        "obj_id" => array("integer", $a_obj_id)
                                        ),
                                array()
                                );
                }
        }
        
        static function getUsageOfObject($a_obj_id, $a_include_titles = false)
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT tax_id FROM tax_usage ".
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")
                        );
                $tax = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        if (!$a_include_titles)
                        {
                                $tax[] = $rec["tax_id"];
                        }
                        else
                        {
                                $tax[] = array("tax_id" => $rec["tax_id"],
                                        "title" => ilObject::_lookupTitle($rec["tax_id"])
                                        );
                        }
                }
                return $tax;
        }
        
        static function deleteUsagesOfTaxonomy($a_id)
        {
                global $ilDB;
                
                $ilDB->manipulate("DELETE FROM tax_usage WHERE ".
                        " tax_id = ".$ilDB->quote($a_id, "integer")
                        );
                
        }
        
        
        static function getSubTreeItems($a_comp, $a_obj_id, $a_item_type, $a_tax_id, $a_node)
        {
                include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
                $tree = new ilTaxonomyTree($a_tax_id);

                $sub_nodes = $tree->getSubTreeIds($a_node);
                $sub_nodes[] = $a_node;
                include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
                
                $tn_ass = new ilTaxNodeAssignment($a_comp, $a_obj_id, $a_item_type, $a_tax_id);
                $items = $tn_ass->getAssignmentsOfNode($sub_nodes);
                
                return $items;
        }
        
        static protected function lookup($a_field, $a_id)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT ".$a_field." FROM tax_data ".
                        " WHERE id = ".$ilDB->quote($a_id, "integer")
                        );
                $rec = $ilDB->fetchAssoc($set);

                return $rec[$a_field];
        }
        
        public static function lookupSortingMode($a_id)
        {
                return self::lookup("sorting_mode", $a_id);
        }
}
?>