ilGlossaryTerm Class Reference

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

Collaboration diagram for ilGlossaryTerm:

Public Member Functions
	__construct (int $a_id=0)
	read ()
	setId (int $a_id)
	set glossary term id (= glossary item id) More...
	getId ()
	setGlossary (ilObjGlossary $a_glossary)
	setGlossaryId (int $a_glo_id)
	getGlossaryId ()
	setTerm (string $a_term)
	getTerm ()
	setLanguage (string $a_language)
	getLanguage ()
	setImportId (string $a_import_id)
	getImportId ()
	setShortText (string $a_text)
	getShortText ()
	setShortTextDirty (int $a_val)
	getShortTextDirty ()
	assignPageObject (ilGlossaryDefPage $a_page_object)
	getPageObject ()
	create (bool $a_omit_page_creation=false)
	delete ()
	delete glossary term More...
	update ()
	shortenShortText (string $text)
	Shorten short text. More...
	updateShortText ()
	exportXML (ilXmlWriter $a_xml_writer, int $a_inst)

Static Public Member Functions
static	_getIdForImportId (string $a_import_id)
static	_exists (int $a_id)
	checks whether a glossary term with specified id exists or not More...
static	setShortTextsDirty (int $a_glo_id)
	Set all short texts of glossary dirty (e.g. More...
static	setShortTextsDirtyGlobally ()
	Set short texts dirty (for all glossaries) More...
static	_lookGlossaryID (int $term_id)
	get glossary id form term id More...
static	_lookGlossaryTerm (int $term_id)
	get glossary term More...
static	_lookLanguage (int $term_id)
	lookup term language More...
static	_lookShortText (int $term_id)
	get definition short text More...
static	_lookShortTextDirty (int $term_id)
	get definition short text dirty More...
static	getTermList (array $a_glo_ref_id, string $searchterm="", string $a_first_letter="", string $a_def="", int $a_tax_node=0, bool $a_add_amet_fields=false, array $a_amet_filter=null, bool $a_include_references=false)
	Get all terms for given set of glossary ids. More...
static	getFirstLetters (array $a_glo_id, int $a_tax_node=0)
static	getNumberOfUsages (int $a_term_id)
static	getUsages (int $a_term_id)
static	_copyTerm (int $a_term_id, int $a_glossary_id)
	Copy a term to a glossary. More...
static	getTermsOfGlossary (int $a_glo_id)

Data Fields
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
int	$id = 0
ilObjGlossary	$glossary
string	$term = ""
string	$language = ""
int	$glo_id = 0
string	$import_id = ""
string	$short_text = ""
int	$short_text_dirty = 0
ilGlossaryDefPage	$page_object

Protected Attributes
string	$type
ilDBInterface	$db
ilAppEventHandler	$event_handler

Detailed Description

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

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

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Glossary terms

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilGlossaryTerm.php.

Constructor & Destructor Documentation

__construct()

ilGlossaryTerm::__construct

(

int

$a_id = 0

)

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

References $DIC, $lng, $tpl, ILIAS\Repository\lng(), and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $lng = $DIC->language();
        $tpl = $DIC["tpl"];

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

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

Here is the call graph for this function:

Member Function Documentation

_copyTerm()

static ilGlossaryTerm::_copyTerm ( int  $a_term_id, int  $a_glossary_id  )

static

Copy a term to a glossary.

Returns

int new term id

Definition at line 641 of file class.ilGlossaryTerm.php.

References ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilADTActiveRecordByType\cloneByPrimary(), ilADTFactory\getInstance(), and ilAdvancedMDFieldDefinition\getInstancesByRecordId().

Referenced by ilObjGlossary\cloneObject(), ILIAS\Glossary\Term\TermManager\copyTermFromOtherGlossary(), and ilObjGlossaryGUI\pasteTerms().

     : int {
        $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->setShortText($old_term->getShortText());
        $new_term->setShortTextDirty($old_term->getShortTextDirty());
        $new_term->create();

        $new_page = $new_term->getPageObject();
        $old_term->getPageObject()->copy($new_page->getId(), $new_page->getParentType(), $new_page->getParentId(), true);

        // adv metadata
        $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_exists()

static ilGlossaryTerm::_exists ( int  $a_id )

static

checks whether a glossary term with specified id exists or not

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

References $DIC, $ilDB, $q, and ilInternalLink\_extractObjIdOfTarget().

Referenced by ilInternalLink\_exists(), ilCOPageHTMLExport\exportHTMLGlossaryTerms(), ilLinksTableGUI\fillRow(), and ilLMPresentationLinker\getLinkXML().

                                             : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        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;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIdForImportId()

static ilGlossaryTerm::_getIdForImportId ( string  $a_import_id )

static

Definition at line 78 of file class.ilGlossaryTerm.php.

References $DIC, $ilDB, $q, ilObject\_getAllReferences(), and ilObject\_hasUntrashedReference().

Referenced by ilInternalLink\_getIdForImportId().

     : int {
        global $DIC;

        $ilDB = $DIC->database();

        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 = self::_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 (int) $term_rec["id"];
            }
        }

        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookGlossaryID()

static ilGlossaryTerm::_lookGlossaryID ( int  $term_id )

static

get glossary id form term id

Definition at line 373 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

Referenced by ilTermDefinitionEditorGUI\__construct(), ilGlossaryTermGUI\__construct(), ilObjGlossaryGUI\__construct(), ilObjGlossaryAccess\_checkGoto(), ilGlossaryTermGUI\_goto(), ILIAS\Glossary\Term\TermManager\copyTermFromOtherGlossary(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ILIAS\components\ILIAS\Glossary\Table\TermUsagesTable\getComponent(), ILIAS\components\ILIAS\Glossary\Table\TermUsagesTable\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\getDataRetrieval(), ilGlossaryTermPermission\getGlossaryIdForTerm(), ilObjMediaObject\getParentObjectIdForUsage(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\handleTermForModal(), ilGlossaryPresentationGUI\initByRequest(), and ILIAS\Glossary\Term\TermManager\referenceTermsFromOtherGlossary().

                                                        : int
    {
        global $DIC;

        $ilDB = $DIC->database();

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

        return (int) ($obj_rec["glo_id"] ?? 0);
    }

Here is the caller graph for this function:

_lookGlossaryTerm()

static ilGlossaryTerm::_lookGlossaryTerm ( int  $term_id )

static

get glossary term

Definition at line 390 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

Referenced by ilLinksTableGUI\fillRow(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ilObjGlossary\getAdvMDSubItemTitle(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\getComponent(), ILIAS\components\ILIAS\Glossary\Table\TermUsagesTable\getDataRetrieval(), ilObjGlossarySubItemListGUI\getHTML(), ilObjGlossaryGUI\getTemplate(), ilGlossaryFlashcardBoxGUI\getTermText(), ilLinkInputGUI\getTranslatedValue(), ilObjGlossaryGUI\putTermsIntoClipBoard(), and ilLMPresentationGUI\showPrintView().

                                                          : string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $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"] ?? "";
    }

Here is the caller graph for this function:

_lookLanguage()

static ilGlossaryTerm::_lookLanguage ( int  $term_id )

static

lookup term language

Definition at line 407 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

                                                      : string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $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"];
    }

_lookShortText()

static ilGlossaryTerm::_lookShortText ( int  $term_id )

static

get definition short text

Definition at line 424 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

Referenced by ILIAS\components\ILIAS\Glossary\Table\TermListTable\getDataRetrieval(), and ilPresentationTableGUI\getShortTextForTerm().

                                                       : string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $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["short_text"] ?? "";
    }

Here is the caller graph for this function:

_lookShortTextDirty()

static ilGlossaryTerm::_lookShortTextDirty ( int  $term_id )

static

get definition short text dirty

Definition at line 441 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

Referenced by ILIAS\components\ILIAS\Glossary\Table\TermListTable\getDataRetrieval(), and ilPresentationTableGUI\getShortTextForTerm().

                                                            : int
    {
        global $DIC;

        $ilDB = $DIC->database();

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

        return (int) ($obj_rec["short_text_dirty"] ?? 0);
    }

Here is the caller graph for this function:

assignPageObject()

ilGlossaryTerm::assignPageObject

(

ilGlossaryDefPage

$a_page_object

)

Definition at line 212 of file class.ilGlossaryTerm.php.

                                                                      : void
    {
        $this->page_object = $a_page_object;
    }

create()

ilGlossaryTerm::create

(

bool

$a_omit_page_creation = false

)

Definition at line 222 of file class.ilGlossaryTerm.php.

References $db, $ilDB, getGlossaryId(), getId(), getShortText(), getShortTextDirty(), and setId().

Referenced by ilObjGlossaryGUI\addTerm().

                                                              : void
    {
        $ilDB = $this->db;

        $this->setId($ilDB->nextId("glossary_term"));
        $ilDB->manipulate("INSERT INTO glossary_term" .
            " (id, glo_id, term, language, import_id, create_date, last_update, short_text, short_text_dirty)" .
            " VALUES (" .
            $ilDB->quote($this->getId(), "integer") . ", " .
            $ilDB->quote($this->getGlossaryId(), "integer") . ", " .
            $ilDB->quote($this->getTerm(), "text") . ", " .
            $ilDB->quote($this->getLanguage(), "text") . ", " .
            $ilDB->quote($this->getImportId(), "text") . ", " .
            $ilDB->now() . ", " .
            $ilDB->now() . ", " .
            $ilDB->quote($this->getShortText(), "text") . ", " .
            $ilDB->quote($this->getShortTextDirty(), "integer") . ")");

        if (!$a_omit_page_creation) {
            $this->page_object = new ilGlossaryDefPage();
            $this->page_object->setId($this->getId());
            $this->page_object->setParentId($this->getGlossaryId());
            $this->page_object->create(false);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilGlossaryTerm::delete

(

)

delete glossary term

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

References $db, $ilDB, ilGlossaryTermReferences\deleteReferencesOfTerm(), and getId().

                            : void
    {
        $ilDB = $this->db;

        // delete term references
        ilGlossaryTermReferences::deleteReferencesOfTerm($this->getId());

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

        $this->page_object->delete();

        // delete flashcard entries
        $this->event_handler->raise("components/ILIAS/Glossary", "deleteTerm", ["term_id" => $this->getId()]);
    }

Here is the call graph for this function:

exportXML()

ilGlossaryTerm::exportXML	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst
	)

Definition at line 602 of file class.ilGlossaryTerm.php.

References getId(), getLanguage(), getTerm(), IL_INST_ID, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

     : void {
        $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());

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

Here is the call graph for this function:

getFirstLetters()

static ilGlossaryTerm::getFirstLetters ( array  $a_glo_id, int  $a_tax_node = 0  )

static

Definition at line 561 of file class.ilGlossaryTerm.php.

References $DIC, $ilDB, $q, ilObjTaxonomy\getSubTreeItems(), and ilObjTaxonomy\getUsageOfObject().

Referenced by ilObjGlossary\getFirstLetters().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        // meta glossary
        if (count($a_glo_id) > 1) {
            $where = $ilDB->in("glo_id", $a_glo_id, false, "integer");
        } else {
            $a_glo_id = current($a_glo_id);
            $where = " glo_id = " . $ilDB->quote($a_glo_id, "integer") . " ";
            $in = "";
            // get all term ids under taxonomy node (if given)
            if ($a_tax_node > 1) {
                $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);

        $let = array();
        while ($let_rec = $ilDB->fetchAssoc($let_set)) {
            $let[$let_rec["let"]] = $let_rec["let"];
        }
        return $let;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGlossaryId()

ilGlossaryTerm::getGlossaryId

(

)

Definition at line 156 of file class.ilGlossaryTerm.php.

References $glo_id.

Referenced by create().

                                   : int
    {
        return $this->glo_id;
    }

Here is the caller graph for this function:

getId()

ilGlossaryTerm::getId

(

)

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

References $id.

Referenced by ilObjGlossaryGUI\addTerm(), create(), delete(), exportXML(), read(), shortenShortText(), and update().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getImportId()

ilGlossaryTerm::getImportId

(

)

Definition at line 187 of file class.ilGlossaryTerm.php.

References $import_id.

                                 : string
    {
        return $this->import_id;
    }

getLanguage()

ilGlossaryTerm::getLanguage

(

)

Definition at line 177 of file class.ilGlossaryTerm.php.

References $language.

Referenced by exportXML().

                                 : string
    {
        return $this->language;
    }

Here is the caller graph for this function:

getNumberOfUsages()

static ilGlossaryTerm::getNumberOfUsages ( int  $a_term_id )

static

Definition at line 617 of file class.ilGlossaryTerm.php.

Referenced by ilTermDefinitionEditorGUI\__construct(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\getDataRetrieval(), ilGlossaryTermGUI\getTabs(), and ILIAS\components\ILIAS\Glossary\Table\TermListTable\handleTermForModal().

                                                            : int
    {
        return count(self::getUsages($a_term_id));
    }

Here is the caller graph for this function:

getPageObject()

ilGlossaryTerm::getPageObject

(

)

Definition at line 217 of file class.ilGlossaryTerm.php.

References $page_object.

                                   : ilGlossaryDefPage
    {
        return $this->page_object;
    }

getShortText()

ilGlossaryTerm::getShortText

(

)

Definition at line 197 of file class.ilGlossaryTerm.php.

References $short_text.

Referenced by create(), and update().

                                  : string
    {
        return $this->short_text;
    }

Here is the caller graph for this function:

getShortTextDirty()

ilGlossaryTerm::getShortTextDirty

(

)

Definition at line 207 of file class.ilGlossaryTerm.php.

References $short_text_dirty.

Referenced by create(), and update().

                                       : int
    {
        return $this->short_text_dirty;
    }

Here is the caller graph for this function:

getTerm()

ilGlossaryTerm::getTerm

(

)

Definition at line 166 of file class.ilGlossaryTerm.php.

References $term.

Referenced by exportXML().

                             : string
    {
        return $this->term;
    }

Here is the caller graph for this function:

getTermList()

static ilGlossaryTerm::getTermList ( array  $a_glo_ref_id, string  $searchterm = "", string  $a_first_letter = "", string  $a_def = "", int  $a_tax_node = 0, bool  $a_add_amet_fields = false, array  $a_amet_filter = null, bool  $a_include_references = false  )

static

Get all terms for given set of glossary ids.

Definition at line 458 of file class.ilGlossaryTerm.php.

References $DIC, $ilDB, $q, ilObject\_lookupObjectId(), ilObjTaxonomy\getSubTreeItems(), ilObjTaxonomy\getUsageOfObject(), and ilAdvancedMDValues\queryForRecords().

Referenced by ilPCParagraph\autoLinkGlossaries(), ilObjGlossary\autoLinkGlossaryTerms(), ilObjContentObject\autoLinkGlossaryTerms(), ilObjGlossary\cloneObject(), ilObjGlossary\getTermList(), and ilGlossaryExporter\getXmlExportTailDependencies().

     : array {
        global $DIC;

        if (count($a_glo_ref_id) > 1) {
            $a_glo_id = array_map(static function ($id): int {
                return ilObject::_lookupObjectId($id);
            }, $a_glo_ref_id);
        } else {
            $a_glo_id = ilObject::_lookupObjectId(current($a_glo_ref_id));
        }
        $ilDB = $DIC->database();

        $join = $in = "";

        $terms = array();

        // get all term ids under taxonomy node (if given)
        if ($a_tax_node > 1) {
            $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 page_object ON (" .
            $glo_where .
            " AND page_object.parent_type = " . $ilDB->quote("term", "text") .
            " AND page_object.page_id = gt.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, gt.short_text, gt.short_text_dirty FROM glossary_term gt " .
            $join . " WHERE " . $where . $searchterm . " ORDER BY gt.term, gt.id";

        $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"],
                "short_text" => strip_tags((string) $term_rec["short_text"], "<br>"),
                "short_text_dirty" => $term_rec["short_text_dirty"]);
            $glo_ids[] = $term_rec["glo_id"];
        }

        // add advanced metadata
        if (($a_add_amet_fields || is_array($a_amet_filter)) && count($a_glo_ref_id) == 1) {
            $terms = ilAdvancedMDValues::queryForRecords(current($a_glo_ref_id), "glo", "term", $glo_ids, "term", $terms, "glo_id", "id", $a_amet_filter);
        }
        return $terms;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTermsOfGlossary()

static ilGlossaryTerm::getTermsOfGlossary ( int  $a_glo_id )

static

Returns

int[] term ids

Definition at line 703 of file class.ilGlossaryTerm.php.

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

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\edit().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $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[] = (int) $rec["id"];
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUsages()

static ilGlossaryTerm::getUsages ( int  $a_term_id )

static

Definition at line 622 of file class.ilGlossaryTerm.php.

References $glo_id, ilInternalLink\_getSourcesOfTarget(), and ilGlossaryTermReferences\lookupReferencesOfTerm().

Referenced by ILIAS\components\ILIAS\Glossary\Table\TermUsagesTable\getDataRetrieval().

                                                    : array
    {
        $usages = (ilInternalLink::_getSourcesOfTarget("git", $a_term_id, 0));

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

        return $usages;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilGlossaryTerm::read

(

)

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

References $db, $ilDB, $q, getId(), setGlossaryId(), setImportId(), setLanguage(), setShortText(), setShortTextDirty(), and setTerm().

Referenced by __construct().

                          : void
    {
        $ilDB = $this->db;

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

        $this->setTerm((string) $term_rec["term"]);
        $this->setImportId((string) $term_rec["import_id"]);
        $this->setLanguage((string) $term_rec["language"]);
        $this->setGlossaryId((int) $term_rec["glo_id"]);
        $this->setShortText((string) $term_rec["short_text"]);
        $this->setShortTextDirty((int) $term_rec["short_text_dirty"]);

        $this->page_object = new ilGlossaryDefPage($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setGlossary()

ilGlossaryTerm::setGlossary

(

ilObjGlossary

$a_glossary

)

Definition at line 143 of file class.ilGlossaryTerm.php.

References ilObject\getId(), and setGlossaryId().

Referenced by ilObjGlossaryGUI\addTerm().

     : void {
        $this->glossary = $a_glossary;
        $this->setGlossaryId($a_glossary->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setGlossaryId()

ilGlossaryTerm::setGlossaryId

(

int

$a_glo_id

)

Definition at line 150 of file class.ilGlossaryTerm.php.

Referenced by read(), and setGlossary().

     : void {
        $this->glo_id = $a_glo_id;
    }

Here is the caller graph for this function:

setId()

ilGlossaryTerm::setId

(

int

$a_id

)

set glossary term id (= glossary item id)

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

Referenced by create().

                                    : void
    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setImportId()

ilGlossaryTerm::setImportId

(

string

$a_import_id

)

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

Referenced by read().

                                                    : void
    {
        $this->import_id = $a_import_id;
    }

Here is the caller graph for this function:

setLanguage()

ilGlossaryTerm::setLanguage

(

string

$a_language

)

Definition at line 171 of file class.ilGlossaryTerm.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by ilObjGlossaryGUI\addTerm(), and read().

     : void {
        $this->language = $a_language;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setShortText()

ilGlossaryTerm::setShortText

(

string

$a_text

)

Definition at line 192 of file class.ilGlossaryTerm.php.

References shortenShortText().

Referenced by read(), and updateShortText().

                                                : void
    {
        $this->short_text = $this->shortenShortText($a_text);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setShortTextDirty()

ilGlossaryTerm::setShortTextDirty

(

int

$a_val

)

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

Referenced by read(), and updateShortText().

                                                 : void
    {
        $this->short_text_dirty = $a_val;
    }

Here is the caller graph for this function:

setShortTextsDirty()

static ilGlossaryTerm::setShortTextsDirty ( int  $a_glo_id )

static

Set all short texts of glossary dirty (e.g.

if length is changed in settings)

TODO: the new SettingsGUI doesn't use this, remove?

Definition at line 338 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

                                                            : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $term_ids = self::getTermsOfGlossary($a_glo_id);

        foreach ($term_ids as $term_id) {
            $ilDB->manipulate(
                "UPDATE glossary_term SET " .
                " short_text_dirty = " . $ilDB->quote(1, "integer") .
                " WHERE id = " . $ilDB->quote($term_id, "integer")
            );
        }
    }

setShortTextsDirtyGlobally()

static ilGlossaryTerm::setShortTextsDirtyGlobally ( )

static

Set short texts dirty (for all glossaries)

Definition at line 358 of file class.ilGlossaryTerm.php.

References $DIC, and $ilDB.

Referenced by ilObjAdvancedEditingGUI\initGeneralPageSettingsForm().

                                                       : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulate(
            "UPDATE glossary_term SET " .
            " short_text_dirty = " . $ilDB->quote(1, "integer")
        );
    }

Here is the caller graph for this function:

setTerm()

ilGlossaryTerm::setTerm

(

string

$a_term

)

Definition at line 161 of file class.ilGlossaryTerm.php.

Referenced by ilObjGlossaryGUI\addTerm(), and read().

                                           : void
    {
        $this->term = $a_term;
    }

Here is the caller graph for this function:

shortenShortText()

ilGlossaryTerm::shortenShortText

(

string

$text

)

Shorten short text.

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

References getId(), ilObjGlossary\lookupSnippetLength(), and ilStr\shortenTextExtended().

Referenced by setShortText(), and updateShortText().

                                                  : string
    {
        $a_length = 196;

        if ($this->getId() > 0) {
            $glo_id = self::_lookGlossaryID($this->getId());
            $snippet_length = ilObjGlossary::lookupSnippetLength($glo_id);
            if ($snippet_length > 0) {
                $a_length = $snippet_length;
            }
        }

        $text = str_replace("<br/>", "<br>", $text);
        $text = strip_tags($text, "<br>");
        $offset = 0;
        if (is_int(strpos(substr($text, $a_length - 16 - 5, 10), "[tex]"))) {
            $offset = 5;
        }
        $short = ilStr::shortenTextExtended($text, $a_length - 16 + $offset, true);

        // make short text longer, if tex end tag is missing
        $ltexs = strrpos($short, "[tex]");
        $ltexe = strrpos($short, "[/tex]");
        if ($ltexs > $ltexe) {
            $ltexe = strpos($text, "[/tex]", $ltexs);
            if ($ltexe > 0) {
                $text = ilStr::shortenTextExtended($text, $ltexe + 6, true);
            }
        }

        $short = ilStr::shortenTextExtended($text, $a_length, true);

        return $short;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilGlossaryTerm::update

(

)

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

References $db, $ilDB, getId(), getShortText(), and getShortTextDirty().

Referenced by updateShortText().

                            : void
    {
        $ilDB = $this->db;

        $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() . ", " .
            " short_text = " . $ilDB->quote($this->getShortText(), "text") . ", " .
            " short_text_dirty = " . $ilDB->quote($this->getShortTextDirty(), "integer") . " " .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateShortText()

ilGlossaryTerm::updateShortText

(

)

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

References $text, setShortText(), setShortTextDirty(), shortenShortText(), and update().

                                     : void
    {
        $this->page_object->buildDom();
        $text = $this->page_object->getFirstParagraphText();
        $short = $this->shortenShortText($text);

        $this->setShortText($short);
        $this->setShortTextDirty(0);
        $this->update();
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilGlossaryTerm::$db

protected

Definition at line 26 of file class.ilGlossaryTerm.php.

Referenced by create(), delete(), read(), and update().

$event_handler

ilAppEventHandler ilGlossaryTerm::$event_handler

protected

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

$glo_id

int ilGlossaryTerm::$glo_id = 0

Definition at line 33 of file class.ilGlossaryTerm.php.

Referenced by getGlossaryId(), and getUsages().

$glossary

ilObjGlossary ilGlossaryTerm::$glossary

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

$id

int ilGlossaryTerm::$id = 0

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

Referenced by getId().

$import_id

string ilGlossaryTerm::$import_id = ""

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

Referenced by getImportId().

$language

string ilGlossaryTerm::$language = ""

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

Referenced by getLanguage().

$lng

ilLanguage ilGlossaryTerm::$lng

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

Referenced by __construct().

$page_object

ilGlossaryDefPage ilGlossaryTerm::$page_object

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

Referenced by getPageObject().

$short_text

string ilGlossaryTerm::$short_text = ""

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

Referenced by getShortText().

$short_text_dirty

int ilGlossaryTerm::$short_text_dirty = 0

Definition at line 36 of file class.ilGlossaryTerm.php.

Referenced by getShortTextDirty().

$term

string ilGlossaryTerm::$term = ""

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

Referenced by getTerm().

$tpl

ilGlobalTemplateInterface ilGlossaryTerm::$tpl

Definition at line 28 of file class.ilGlossaryTerm.php.

Referenced by __construct().

$type

string ilGlossaryTerm::$type

protected

Definition at line 25 of file class.ilGlossaryTerm.php.

---

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

• components/ILIAS/Glossary/Term/class.ilGlossaryTerm.php