class.ilGlossaryTerm.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilGlossaryTerm
{
        var $ilias;
        var $lng;
        var $tpl;

        var $id;
        var $glossary;
        var $term;
        var $language;
        var $glo_id;
        var $import_id;

        function __construct($a_id = 0)
        {
                global $lng, $ilias, $tpl;

                $this->lng = $lng;
                $this->ilias = $ilias;
                $this->tpl = $tpl;

                $this->id = $a_id;
                $this->type = "term";
                if ($a_id != 0)
                {
                        $this->read();
                }
        }

        function read()
        {
                global $ilDB;
                
                $q = "SELECT * FROM glossary_term WHERE id = ".
                        $ilDB->quote($this->id, "integer");
                $term_set = $ilDB->query($q);
                $term_rec = $ilDB->fetchAssoc($term_set);

                $this->setTerm($term_rec["term"]);
                $this->setImportId($term_rec["import_id"]);
                $this->setLanguage($term_rec["language"]);
                $this->setGlossaryId($term_rec["glo_id"]);

        }

        static function _getIdForImportId($a_import_id)
        {
                global $ilDB;
                
                if ($a_import_id == "")
                {
                        return 0;
                }
                
                $q = "SELECT * FROM glossary_term WHERE import_id = ".
                        $ilDB->quote($a_import_id, "text").
                        " ORDER BY create_date DESC";
                $term_set = $ilDB->query($q);
                while ($term_rec = $ilDB->fetchAssoc($term_set))
                {
                        $glo_id = ilGlossaryTerm::_lookGlossaryID($term_rec["id"]);

                        $ref_ids  = ilObject::_getAllReferences($glo_id);       // will be 0 if import of lm is in progress (new import)
                        if (count($ref_ids) == 0 || ilObject::_hasUntrashedReference($glo_id))
                        {
                                return $term_rec["id"];
                        }
                }

                return 0;
        }
        
        
        static function _exists($a_id)
        {
                global $ilDB;
                
                include_once("./Services/Link/classes/class.ilInternalLink.php");
                if (is_int(strpos($a_id, "_")))
                {
                        $a_id = ilInternalLink::_extractObjIdOfTarget($a_id);
                }

                $q = "SELECT * FROM glossary_term WHERE id = ".
                        $ilDB->quote($a_id, "integer");
                $obj_set = $ilDB->query($q);
                if ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        return true;
                }
                else
                {
                        return false;
                }

        }


        function setId($a_id)
        {
                $this->id = $a_id;
        }


        function getId()
        {
                return $this->id;
        }

        function setGlossary(&$a_glossary)
        {
                $this->glossary = $a_glossary;
                $this->setGlossaryId($a_glossary->getId());
        }


        function setGlossaryId($a_glo_id)
        {
                $this->glo_id = $a_glo_id;
        }


        function getGlossaryId()
        {
                return $this->glo_id;
        }


        function setTerm($a_term)
        {
                $this->term = $a_term;
        }


        function getTerm()
        {
                return $this->term;
        }


        function setLanguage($a_language)
        {
                $this->language = $a_language;
        }

        function getLanguage()
        {
                return $this->language;
        }


        function setImportId($a_import_id)
        {
                $this->import_id = $a_import_id;
        }


        function getImportId()
        {
                return $this->import_id;
        }


        function create()
        {
                global $ilDB;
                
                $this->setId($ilDB->nextId("glossary_term"));
                $ilDB->manipulate("INSERT INTO glossary_term (id, glo_id, term, language, import_id, create_date, last_update)".
                        " VALUES (".
                        $ilDB->quote($this->getId(), "integer").", ".
                        $ilDB->quote($this->getGlossaryId(), "integer").", ".
                        $ilDB->quote($this->term, "text").", ".
                        $ilDB->quote($this->language, "text").",".
                        $ilDB->quote($this->getImportId(), "text").",".
                        $ilDB->now().", ".
                        $ilDB->now().")");
        }


        function delete()
        {
                global $ilDB;
                
                require_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
                $defs = ilGlossaryDefinition::getDefinitionList($this->getId());
                foreach($defs as $def)
                {
                        $def_obj = new ilGlossaryDefinition($def["id"]);
                        $def_obj->delete();
                }

                // delete term references
                include_once("./Modules/Glossary/classes/class.ilGlossaryTermReferences.php");
                ilGlossaryTermReferences::deleteReferencesOfTerm($this->getId());

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


        function update()
        {
                global $ilDB;
                
                $ilDB->manipulate("UPDATE glossary_term SET ".
                        " glo_id = ".$ilDB->quote($this->getGlossaryId(), "integer").", ".
                        " term = ".$ilDB->quote($this->getTerm(), "text").", ".
                        " import_id = ".$ilDB->quote($this->getImportId(), "text").", ".
                        " language = ".$ilDB->quote($this->getLanguage(), "text").", ".
                        " last_update = ".$ilDB->now()." ".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer"));
        }

        static function _lookGlossaryID($term_id)
        {
                global $ilDB;

                $query = "SELECT * FROM glossary_term WHERE id = ".
                        $ilDB->quote($term_id, "integer");
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);

                return $obj_rec["glo_id"];
        }

        static function _lookGlossaryTerm($term_id)
        {
                global $ilDB;

                $query = "SELECT * FROM glossary_term WHERE id = ".
                        $ilDB->quote($term_id, "integer");
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);

                return $obj_rec["term"];
        }
        
        static function _lookLanguage($term_id)
        {
                global $ilDB;

                $query = "SELECT * FROM glossary_term WHERE id = ".
                        $ilDB->quote($term_id, "integer");
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);

                return $obj_rec["language"];
        }

        static function getTermList($a_glo_id, $searchterm = "", $a_first_letter = "", $a_def = "",
                $a_tax_node = 0, $a_add_amet_fields = false, array $a_amet_filter = null, $a_include_references = false)
        {
                global $ilDB;

                $join = $in = "";

                $terms = array();

                // get all term ids under taxonomy node (if given)
                if ($a_tax_node > 1)
                {
                        include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
                        $tax_ids = ilObjTaxonomy::getUsageOfObject($a_glo_id);
                        if (count($tax_ids) > 0)
                        {
                                $items = ilObjTaxonomy::getSubTreeItems("glo", $a_glo_id, "term", $tax_ids[0], $a_tax_node);
                                $sub_tree_ids = array();
                                foreach ($items as $i)
                                {
                                        $sub_tree_ids[] = $i["item_id"];
                                }
                                $in = " AND ".$ilDB->in("gt.id", $sub_tree_ids, false, "integer");
                        }
                }
                
                if ($a_def != "")
                {
                        // meta glossary?
                        if (is_array($a_glo_id))
                        {
                                $glo_where = $ilDB->in("page_object.parent_id", $a_glo_id, false, "integer");
                        }
                        else
                        {
                                $glo_where = " page_object.parent_id = ".$ilDB->quote($a_glo_id, "integer");
                        }

                        $join = " JOIN glossary_definition gd ON (gd.term_id = gt.id)".
                        " JOIN page_object ON (".
                        $glo_where.
                        " AND page_object.parent_type = ".$ilDB->quote("gdf", "text").
                        " AND page_object.page_id = gd.id".
                        " AND ".$ilDB->like("page_object.content", "text", "%".$a_def."%").
                        ")";
                }

                $searchterm = (!empty ($searchterm))
                        ? " AND ".$ilDB->like("term", "text", "%".$searchterm."%")." "
                        : "";
                        
                if ($a_first_letter != "")
                {
                        $searchterm.= " AND ".$ilDB->upper($ilDB->substr("term", 1, 1))." = ".$ilDB->upper($ilDB->quote($a_first_letter, "text"))." ";
                }

                // include references
                $where_glo_id_or = "";
                if ($a_include_references)
                {
                        $join.= " LEFT JOIN glo_term_reference tr ON (gt.id = tr.term_id) ";
                        if (is_array($a_glo_id))
                        {
                                $where_glo_id_or = " OR ".$ilDB->in("tr.glo_id", $a_glo_id, false, "integer");
                        }
                        else
                        {
                                $where_glo_id_or = " OR tr.glo_id = ".$ilDB->quote($a_glo_id, "integer");
                        }
                }

                // meta glossary
                if (is_array($a_glo_id))
                {
                        $where = "(".$ilDB->in("gt.glo_id", $a_glo_id, false, "integer").$where_glo_id_or.")";
                }
                else
                {
                        $where = "(gt.glo_id = ".$ilDB->quote($a_glo_id, "integer").$where_glo_id_or.")";
                }
                
                $where.= $in;


                $q = "SELECT DISTINCT(gt.term), gt.id, gt.glo_id, gt.language FROM glossary_term gt ".$join." WHERE ".$where.$searchterm." ORDER BY term";

                //echo $q; exit;

                $term_set = $ilDB->query($q);
                $glo_ids = array();
                while ($term_rec = $ilDB->fetchAssoc($term_set))
                {
                        $terms[] = array("term" => $term_rec["term"],
                                "language" => $term_rec["language"], "id" => $term_rec["id"], "glo_id" => $term_rec["glo_id"]);
                        $glo_ids[] = $term_rec["glo_id"];
                }

                // add advanced metadata
                if ($a_add_amet_fields || is_array($a_amet_filter))
                {                       
                        include_once("./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php");
                        $terms = ilAdvancedMDValues::queryForRecords($glo_ids, "term", $terms, "glo_id", "id", $a_amet_filter);
                }
                return $terms;
        }

        static function getFirstLetters($a_glo_id, $a_tax_node = 0)
        {
                global $ilDB;
                
                $terms = array();
                                
                // meta glossary
                if (is_array($a_glo_id))
                {
                        $where = $ilDB->in("glo_id", $a_glo_id, false, "integer");
                }
                else
                {
                        $where = " glo_id = ".$ilDB->quote($a_glo_id, "integer")." ";
                        
                        // get all term ids under taxonomy node (if given)
                        if ($a_tax_node > 1)
                        {
                                include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
                                $tax_ids = ilObjTaxonomy::getUsageOfObject($a_glo_id);
                                if (count($tax_ids) > 0)
                                {
                                        $items = ilObjTaxonomy::getSubTreeItems("glo", $a_glo_id, "term", $tax_ids[0], $a_tax_node);
                                        $sub_tree_ids = array();
                                        foreach ($items as $i)
                                        {
                                                $sub_tree_ids[] = $i["item_id"];
                                        }
                                        $in = " AND ".$ilDB->in("id", $sub_tree_ids, false, "integer");
                                }
                        }
                        
                        $where.= $in;
                }
                
                $q = "SELECT DISTINCT ".$ilDB->upper($ilDB->substr("term", 1, 1))." let FROM glossary_term WHERE ".$where." ORDER BY let";
                $let_set = $ilDB->query($q);
                
                $lets = array();
                while ($let_rec = $ilDB->fetchAssoc($let_set))
                {
                        $let[$let_rec["let"]] = $let_rec["let"];
                }
                return $let;
        }

        function exportXML(&$a_xml_writer, $a_inst)
        {

                $attrs = array();
                $attrs["Language"] = $this->getLanguage();
                $attrs["Id"] = "il_".IL_INST_ID."_git_".$this->getId();
                $a_xml_writer->xmlStartTag("GlossaryItem", $attrs);

                $attrs = array();
                $a_xml_writer->xmlElement("GlossaryTerm", $attrs, $this->getTerm());

                $defs = ilGlossaryDefinition::getDefinitionList($this->getId());

                foreach($defs as $def)
                {
                        $definition = new ilGlossaryDefinition($def["id"]);
                        $definition->exportXML($a_xml_writer, $a_inst);
                }

                $a_xml_writer->xmlEndTag("GlossaryItem");
        }

        static function getNumberOfUsages($a_term_id)
        {
                return count(ilGlossaryTerm::getUsages($a_term_id));
        }

        static function getUsages($a_term_id)
        {
                include_once("./Services/Link/classes/class.ilInternalLink.php");
                $usages = (ilInternalLink::_getSourcesOfTarget("git", $a_term_id, 0));

                include_once("./Modules/Glossary/classes/class.ilGlossaryTermReferences.php");
                foreach (ilGlossaryTermReferences::lookupReferencesOfTerm($a_term_id) as $glo_id)
                {
                        $usages["glo:termref:".$glo_id.":-"] = array(
                                "type" => "glo:termref",
                                "id" => $glo_id,
                                "lang" => "-"
                        );
                }

                return $usages;
        }       
        
        static function _copyTerm($a_term_id, $a_glossary_id)
        { 
                $old_term = new ilGlossaryTerm($a_term_id);

                // copy the term
                $new_term = new ilGlossaryTerm();
                $new_term->setTerm($old_term->getTerm());
                $new_term->setLanguage($old_term->getLanguage());
                $new_term->setGlossaryId($a_glossary_id);
                $new_term->create();

                // copy the definitions
                include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
                $def_list = ilGlossaryDefinition::getDefinitionList($a_term_id);
                foreach ($def_list as $def)
                {
                        $old_def = new ilGlossaryDefinition($def["id"]);
                        
                        $new_def = new ilGlossaryDefinition();
                        $new_def->setShortText($old_def->getShortText());
                        $new_def->setNr($old_def->getNr());
                        $new_def->setTermId($new_term->getId());
                        $new_def->create();
                        
                        // copy meta data
                        include_once("Services/MetaData/classes/class.ilMD.php");
                        $md = new ilMD($old_term->getGlossaryId(),
                                $old_def->getPageObject()->getId(),
                                $old_def->getPageObject()->getParentType());
                        $new_md = $md->cloneMD($a_glossary_id,
                                $new_def->getPageObject()->getId(),
                                $old_def->getPageObject()->getParentType());


                        $new_page = $new_def->getPageObject();
                        $old_def->getPageObject()->copy($new_page->getId(), $new_page->getParentType(), $new_page->getParentId(), true);

                        // page content
                        //$new_def->getPageObject()->setXMLContent($old_def->getPageObject()->copyXmlContent(true));
                        //$new_def->getPageObject()->buildDom();
                        //$new_def->getPageObject()->update();
                        
                }

                // adv metadata
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
                $old_recs = ilAdvancedMDRecord::_getSelectedRecordsByObject("glo", $old_term->getGlossaryId(), "term");
                $new_recs = ilAdvancedMDRecord::_getSelectedRecordsByObject("glo", $a_glossary_id, "term");
                foreach($old_recs as $old_record_obj)
                {
                        reset($new_recs);
                        foreach ($new_recs as $new_record_obj)
                        {
                                if ($old_record_obj->getRecordId() == $new_record_obj->getRecordId())
                                {
                                        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($old_record_obj->getRecordId()) as $def)
                                        {
                                                // now we need to copy $def->getFieldId() values from old term to new term
                                                // how?
                                                // clone values

                                                $source_primary = array("obj_id"=>array("integer", $old_term->getGlossaryId()));
                                                $source_primary["sub_type"] = array("text", "term");
                                                $source_primary["sub_id"] = array("integer", $old_term->getId());
                                                $source_primary["field_id"] = array("integer", $def->getFieldId());
                                                $target_primary = array("obj_id"=>array("integer", $new_term->getGlossaryId()));
                                                $target_primary["sub_type"] = array("text", "term");
                                                $target_primary["sub_id"] = array("integer", $new_term->getId());

                                                ilADTFactory::getInstance()->initActiveRecordByType();
                                                $has_cloned = ilADTActiveRecordByType::cloneByPrimary(
                                                        "adv_md_values",
                                                        array(
                                                                "obj_id" => "integer",
                                                                "sub_type" => "text",
                                                                "sub_id" => "integer",
                                                                "field_id" => "integer"
                                                        ),
                                                        $source_primary,
                                                        $target_primary,
                                                        array("disabled"=>"integer"));

                                        }
                                }
                        }
                }


                return $new_term->getId();
        }

        static function getTermsOfGlossary($a_glo_id)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT id FROM glossary_term WHERE ".
                        " glo_id = ".$ilDB->quote($a_glo_id, "integer")
                );
                $ids = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $ids[] = $rec["id"];
                }
                return $ids;
        }
}

?>