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

Public Member Functions
	__construct (int $a_id=0)
	read ()
	setId (int $a_id)
	getId ()
	getType ()
	setTermId (int $a_term_id)
	getTermId ()
	setShortText (string $a_text)
	getShortText ()
	setNr (int $a_nr)
	getNr ()
	assignPageObject (ilGlossaryDefPage $a_page_object)
	getPageObject ()
	getTitle ()
	setTitle (string $a_title)
	getDescription ()
	setDescription (string $a_description)
	setShortTextDirty (bool $a_val)
	getShortTextDirty ()
	create (bool $a_upload=false, bool $a_omit_page_creation=false)
	delete ()
	moveUp ()
	moveDown ()
	update ()
	shortenShortText (string $text)
	Shorten short text. More...
	updateShortText ()
	exportXML (ilXmlWriter $a_xml_writer, int $a_inst)
	exportXMLMetaData (ilXmlWriter $a_xml_writer)
	modifyExportIdentifier (string $a_tag, string $a_param, string $a_value)
	exportXMLDefinition (ilXmlWriter $a_xml_writer, int $a_inst=0)
	export page objects meta data to xml More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	MDUpdateListener (string $a_element)
	Meta data update listener. More...

Static Public Member Functions
static	getDefinitionList (int $a_term_id)
static	_lookupTermId (int $a_def_id)
	Looks up term id for a definition id. 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...

Data Fields
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
int	$id = 0
int	$term_id = 0
int	$glo_id = 0
ilGlossaryDefPage	$page_object
string	$short_text = ""
int	$nr = 0
bool	$short_text_dirty = false

Protected Attributes
array	$files_contained = []
array	$mobs_contained = []
string	$description = ""
string	$title = ""
ilDBInterface	$db
ilObjUser	$user

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

Author

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

Definition at line 22 of file class.ilGlossaryDefinition.php.

Constructor & Destructor Documentation

__construct()

ilGlossaryDefinition::__construct

(

int

$a_id = 0

)

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

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

      {
        global $DIC;

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

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

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

Here is the call graph for this function:

Member Function Documentation

_lookupTermId()

static ilGlossaryDefinition::_lookupTermId ( int  $a_def_id )

static

Looks up term id for a definition id.

Parameters

int

$a_def_id

definition id

Definition at line 549 of file class.ilGlossaryDefinition.php.

References $DIC, and $ilDB.

Referenced by ilObjMediaObjectAccess\checkAccessGlossaryTerm(), ilTermUsagesTableGUI\fillRow(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ilObjMediaObject\getParentObjectIdForUsage(), ilLMContentSearch\performSearch(), and ilGlossaryDefPageGUI\postOutputProcessing().

                                                       : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM glossary_definition WHERE id = " .
            $ilDB->quote($a_def_id, "integer");
        $def_set = $ilDB->query($q);
        $def_rec = $ilDB->fetchAssoc($def_set);

        return $def_rec["term_id"];
    }

Here is the caller graph for this function:

assignPageObject()

ilGlossaryDefinition::assignPageObject

(

ilGlossaryDefPage

$a_page_object

)

Definition at line 121 of file class.ilGlossaryDefinition.php.

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

create()

ilGlossaryDefinition::create	(	bool	$a_upload = false,
		bool	$a_omit_page_creation = false
	)

Definition at line 160 of file class.ilGlossaryDefinition.php.

References $db, $ilDB, createMetaData(), ilDBInterface\fetchAssoc(), getId(), getShortTextDirty(), getTermId(), ILIAS\Repository\int(), ilDBInterface\manipulate(), ilDBInterface\query(), ilDBInterface\quote(), setId(), and setNr().

Referenced by ilQuestionPageParser\buildTag().

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

        $term = new ilGlossaryTerm($this->getTermId());

        $this->setId($ilDB->nextId("glossary_definition"));

        $ilAtomQuery = $ilDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('glossary_definition');

        $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) {

            // get maximum definition number
            $q = "SELECT max(nr) AS max_nr FROM glossary_definition WHERE term_id = " .
                $ilDB->quote($this->getTermId(), "integer");
            $max_set = $ilDB->query($q);
            $max_rec = $ilDB->fetchAssoc($max_set);
            $max = (int) $max_rec["max_nr"];

            // insert new definition record
            $ilDB->manipulate("INSERT INTO glossary_definition (id, term_id, short_text, nr, short_text_dirty)" .
                " VALUES (" .
                $ilDB->quote($this->getId(), "integer") . "," .
                $ilDB->quote($this->getTermId(), "integer") . "," .
                $ilDB->quote($this->getShortText(), "text") . ", " .
                $ilDB->quote(($max + 1), "integer") . ", " .
                $ilDB->quote($this->getShortTextDirty(), "integer") .
                ")");
        });

        $ilAtomQuery->run();

        // get number
        $q = "SELECT nr FROM glossary_definition WHERE id = " .
            $ilDB->quote($this->id, "integer");
        $def_set = $ilDB->query($q);
        $def_rec = $ilDB->fetchAssoc($def_set);
        $this->setNr($def_rec["nr"]);

        // meta data will be created by
        // import parser
        if (!$a_upload) {
            $this->createMetaData();
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

createMetaData()

ilGlossaryDefinition::createMetaData

(

)

Definition at line 467 of file class.ilGlossaryDefinition.php.

References $lang, ilGlossaryTerm\_lookGlossaryID(), ilGlossaryTerm\_lookLanguage(), getDescription(), getId(), getTermId(), getTitle(), and getType().

Referenced by create().

                                    : void
    {
        $glo_id = ilGlossaryTerm::_lookGlossaryID($this->getTermId());
        $lang = ilGlossaryTerm::_lookLanguage($this->getTermId());
        $md_creator = new ilMDCreator($glo_id, $this->getId(), $this->getType());
        $md_creator->setTitle($this->getTitle());
        $md_creator->setTitleLanguage($lang);
        $md_creator->setDescription($this->getDescription());
        $md_creator->setDescriptionLanguage($lang);
        $md_creator->setKeywordLanguage($lang);
        $md_creator->setLanguage($lang);
        $md_creator->create();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilGlossaryDefinition::delete

(

)

Definition at line 216 of file class.ilGlossaryDefinition.php.

References $db, $ilDB, deleteMetaData(), ilDBInterface\fetchAssoc(), ilDBInterface\manipulate(), ilDBInterface\query(), ilDBInterface\quote(), and setNr().

Referenced by ilGlossaryTermGUI\deleteDefinition(), and ilObjGlossaryGUI\deleteDefinition().

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

        $ilAtomQuery = $ilDB->buildAtomQuery();
        $ilAtomQuery->addTableLock("glossary_definition");

        $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) {

            // be sure to get the right number
            $q = "SELECT * FROM glossary_definition WHERE id = " .
                $ilDB->quote($this->id, "integer");
            $def_set = $ilDB->query($q);
            $def_rec = $ilDB->fetchAssoc($def_set);
            $this->setNr($def_rec["nr"]);

            // update numbers of other definitions
            $ilDB->manipulate("UPDATE glossary_definition SET " .
                " nr = nr - 1 " .
                " WHERE term_id = " . $ilDB->quote($this->getTermId(), "integer") . " " .
                " AND nr > " . $ilDB->quote($this->getNr(), "integer"));

            // delete current definition
            $ilDB->manipulate("DELETE FROM glossary_definition " .
                " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
        });
        $ilAtomQuery->run();

        // delete page and meta data
        $this->page_object->delete();

        // delete meta data
        $this->deleteMetaData();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteMetaData()

ilGlossaryDefinition::deleteMetaData

(

)

Definition at line 498 of file class.ilGlossaryDefinition.php.

References ilGlossaryTerm\_lookGlossaryID(), getId(), getTermId(), and getType().

Referenced by delete().

                                    : void
    {
        // Delete meta data
        $glo_id = ilGlossaryTerm::_lookGlossaryID($this->getTermId());
        $md = new ilMD($glo_id, $this->getId(), $this->getType());
        $md->deleteAll();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportXML()

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

Definition at line 413 of file class.ilGlossaryDefinition.php.

References exportXMLDefinition(), exportXMLMetaData(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

     : void {
        $attrs = array();
        $a_xml_writer->xmlStartTag("Definition", $attrs);

        $this->exportXMLMetaData($a_xml_writer);
        $this->exportXMLDefinition($a_xml_writer, $a_inst);

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

Here is the call graph for this function:

exportXMLDefinition()

ilGlossaryDefinition::exportXMLDefinition	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst = 0
	)

export page objects meta data to xml

Definition at line 452 of file class.ilGlossaryDefinition.php.

References $xml, ilXmlWriter\appendXML(), and ilPCFileList\collectFileItems().

Referenced by exportXML().

     : void {
        $this->page_object->buildDom();
        $this->page_object->insertInstIntoIDs($a_inst);
        $this->mobs_contained = $this->page_object->collectMediaObjects(false);
        $this->files_contained = ilPCFileList::collectFileItems($this->page_object, $this->page_object->getDomDoc());
        $xml = $this->page_object->getXMLFromDom(false, false, false, "", true);
        $xml = str_replace("&", "&", $xml);
        $a_xml_writer->appendXML($xml);

        $this->page_object->freeDom();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportXMLMetaData()

ilGlossaryDefinition::exportXMLMetaData

(

ilXmlWriter

$a_xml_writer

)

Definition at line 427 of file class.ilGlossaryDefinition.php.

References ilGlossaryTerm\_lookGlossaryID(), ilXmlWriter\appendXML(), getId(), getTermId(), and getType().

Referenced by exportXML().

     : void {
        $glo_id = ilGlossaryTerm::_lookGlossaryID($this->getTermId());
        $md2xml = new ilMD2XML($glo_id, $this->getId(), $this->getType());
        $md2xml->setExportMode(true);
        $md2xml->startExport();
        $a_xml_writer->appendXML($md2xml->getXML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefinitionList()

static ilGlossaryDefinition::getDefinitionList ( int  $a_term_id )

static

Definition at line 392 of file class.ilGlossaryDefinition.php.

References $DIC, and $ilDB.

Referenced by ilGlossaryTerm\_copyTerm(), ilSoapGLOStructureReader\_parseStructure(), ilObjGlossary\autoLinkGlossaryTerms(), ilCOPageHTMLExport\collectPageElements(), ilGlossaryTerm\delete(), ILIAS\Glossary\Export\GlossaryHtmlExport\exportHTMLGlossaryTerms(), ilGlossaryTerm\exportXML(), ilObjGlossary\exportXML(), ilTermQuickListTableGUI\fillRow(), ilPresentationListTableGUI\fillRow(), ilTermListTableGUI\fillRow(), ilGlossaryTermGUI\getInternalLinks(), ilGlossaryExporter\getXmlExportTailDependencies(), ilGlossaryTermGUI\listDefinitions(), ilGlossaryPresentationGUI\listDefinitions(), ilGlossaryTermGUI\output(), and ilLMPresentationGUI\showPrintView().

                                                            : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $defs = array();
        $q = "SELECT * FROM glossary_definition WHERE term_id = " .
            $ilDB->quote($a_term_id, "integer") .
            " ORDER BY nr";
        $def_set = $ilDB->query($q);
        while ($def_rec = $ilDB->fetchAssoc($def_set)) {
            $defs[] = array("term_id" => $def_rec["term_id"],
                "page_id" => (int) ($def_rec["page_id"] ?? 0), "id" => $def_rec["id"],
                "short_text" => strip_tags($def_rec["short_text"], "<br>"),
                "nr" => $def_rec["nr"],
                "short_text_dirty" => $def_rec["short_text_dirty"]);
        }
        return $defs;
    }

Here is the caller graph for this function:

getDescription()

ilGlossaryDefinition::getDescription

(

)

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

References $description.

Referenced by createMetaData(), and updateMetaData().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getId()

ilGlossaryDefinition::getId

(

)

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

References $id.

Referenced by create(), createMetaData(), deleteMetaData(), exportXMLMetaData(), MDUpdateListener(), modifyExportIdentifier(), and updateMetaData().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getNr()

ilGlossaryDefinition::getNr

(

)

Definition at line 116 of file class.ilGlossaryDefinition.php.

References $nr.

Referenced by moveDown(), and moveUp().

                           : int
    {
        return $this->nr;
    }

Here is the caller graph for this function:

getPageObject()

ilGlossaryDefinition::getPageObject

(

)

Definition at line 126 of file class.ilGlossaryDefinition.php.

References $page_object.

                                   : ilGlossaryDefPage
    {
        return $this->page_object;
    }

getShortText()

ilGlossaryDefinition::getShortText

(

)

Definition at line 106 of file class.ilGlossaryDefinition.php.

References $short_text.

                                  : string
    {
        return $this->short_text;
    }

getShortTextDirty()

ilGlossaryDefinition::getShortTextDirty

(

)

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

References $short_text_dirty.

Referenced by create().

                                       : bool
    {
        return $this->short_text_dirty;
    }

Here is the caller graph for this function:

getTermId()

ilGlossaryDefinition::getTermId

(

)

Definition at line 96 of file class.ilGlossaryDefinition.php.

References $term_id.

Referenced by create(), createMetaData(), deleteMetaData(), exportXMLMetaData(), MDUpdateListener(), moveDown(), shortenShortText(), and updateMetaData().

                               : int
    {
        return $this->term_id;
    }

Here is the caller graph for this function:

getTitle()

ilGlossaryDefinition::getTitle

(

)

Definition at line 131 of file class.ilGlossaryDefinition.php.

References $title.

Referenced by createMetaData(), and updateMetaData().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilGlossaryDefinition::getType

(

)

Definition at line 86 of file class.ilGlossaryDefinition.php.

Referenced by createMetaData(), deleteMetaData(), exportXMLMetaData(), MDUpdateListener(), and updateMetaData().

                             : string
    {
        return "gdf";
    }

Here is the caller graph for this function:

MDUpdateListener()

ilGlossaryDefinition::MDUpdateListener

(

string

$a_element

)

Meta data update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Even if this is not stored to db, it should be stored to the object e.g. for during import parsing

Definition at line 518 of file class.ilGlossaryDefinition.php.

References $id, ilGlossaryTerm\_lookGlossaryID(), getId(), getTermId(), getType(), setDescription(), and setTitle().

                                                       : bool
    {
        switch ($a_element) {
            case 'General':

                // Update Title and description
                $glo_id = ilGlossaryTerm::_lookGlossaryID($this->getTermId());
                $md = new ilMD($glo_id, $this->getId(), $this->getType());
                $md_gen = $md->getGeneral();

                //ilObject::_writeTitle($this->getId(),$md_gen->getTitle());
                $this->setTitle($md_gen->getTitle());

                foreach ($md_gen->getDescriptionIds() as $id) {
                    $md_des = $md_gen->getDescription($id);
                    //ilObject::_writeDescription($this->getId(),$md_des->getDescription());
                    $this->setDescription($md_des->getDescription());
                    break;
                }

                break;

            default:
        }
        return true;
    }

Here is the call graph for this function:

modifyExportIdentifier()

ilGlossaryDefinition::modifyExportIdentifier	(	string	$a_tag,
		string	$a_param,
		string	$a_value
	)

Definition at line 437 of file class.ilGlossaryDefinition.php.

References getId(), and IL_INST_ID.

     : string {
        if ($a_tag == "Identifier" && $a_param == "Entry") {
            $a_value = "il_" . IL_INST_ID . "_gdf_" . $this->getId();
        }

        return $a_value;
    }

Here is the call graph for this function:

moveDown()

ilGlossaryDefinition::moveDown

(

)

Definition at line 287 of file class.ilGlossaryDefinition.php.

References $db, $ilDB, ilDBInterface\fetchAssoc(), getNr(), getTermId(), ilDBInterface\manipulate(), ilDBInterface\query(), ilDBInterface\quote(), and setNr().

Referenced by ilObjGlossaryGUI\moveDefinitionDown(), and ilGlossaryTermGUI\moveDown().

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

        $ilAtomQuery = $ilDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('glossary_definition');

        $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) {

            // be sure to get the right number
            $q = "SELECT * FROM glossary_definition WHERE id = " .
                $ilDB->quote($this->id, "integer");
            $def_set = $ilDB->query($q);
            $def_rec = $ilDB->fetchAssoc($def_set);
            $this->setNr($def_rec["nr"]);

            // get max number
            $q = "SELECT max(nr) as max_nr FROM glossary_definition WHERE term_id = " .
                $ilDB->quote($this->getTermId(), "integer");
            $max_set = $ilDB->query($q);
            $max_rec = $ilDB->fetchAssoc($max_set);

            if ($this->getNr() >= $max_rec["max_nr"]) {
                return;
            }

            // update numbers of other definitions
            $ilDB->manipulate("UPDATE glossary_definition SET " .
                " nr = nr - 1 " .
                " WHERE term_id = " . $ilDB->quote($this->getTermId(), "integer") . " " .
                " AND nr = " . $ilDB->quote(($this->getNr() + 1), "integer"));

            // delete current definition
            $ilDB->manipulate("UPDATE glossary_definition SET " .
                " nr = nr + 1 " .
                " WHERE term_id = " . $ilDB->quote($this->getTermId(), "integer") . " " .
                " AND id = " . $ilDB->quote($this->getId(), "integer"));
        });

        $ilAtomQuery->run();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveUp()

ilGlossaryDefinition::moveUp

(

)

Definition at line 252 of file class.ilGlossaryDefinition.php.

References $db, $ilDB, ilDBInterface\fetchAssoc(), getNr(), ilDBInterface\manipulate(), ilDBInterface\query(), ilDBInterface\quote(), and setNr().

Referenced by ilObjGlossaryGUI\moveDefinitionUp(), and ilGlossaryTermGUI\moveUp().

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

        $ilAtomQuery = $ilDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('glossary_definition');

        $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) {

            // be sure to get the right number
            $q = "SELECT * FROM glossary_definition WHERE id = " .
                $ilDB->quote($this->id, "integer");
            $def_set = $ilDB->query($q);
            $def_rec = $ilDB->fetchAssoc($def_set);
            $this->setNr($def_rec["nr"]);

            if ($this->getNr() < 2) {
                return;
            }

            // update numbers of other definitions
            $ilDB->manipulate("UPDATE glossary_definition SET " .
                " nr = nr + 1 " .
                " WHERE term_id = " . $ilDB->quote($this->getTermId(), "integer") . " " .
                " AND nr = " . $ilDB->quote(($this->getNr() - 1), "integer"));

            // delete current definition
            $ilDB->manipulate("UPDATE glossary_definition SET " .
                " nr = nr - 1 " .
                " WHERE term_id = " . $ilDB->quote($this->getTermId(), "integer") . " " .
                " AND id = " . $ilDB->quote($this->getId(), "integer"));
        });
        $ilAtomQuery->run();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilGlossaryDefinition::read

(

)

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

References $db, $ilDB, setNr(), setShortText(), setShortTextDirty(), and setTermId().

Referenced by __construct().

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

        $q = "SELECT * FROM glossary_definition WHERE id = " .
            $ilDB->quote($this->id, "integer");
        $def_set = $ilDB->query($q);
        $def_rec = $ilDB->fetchAssoc($def_set);

        $this->setTermId((int) $def_rec["term_id"]);
        $this->setShortText((string) $def_rec["short_text"]);
        $this->setNr((int) $def_rec["nr"]);
        $this->setShortTextDirty((bool) $def_rec["short_text_dirty"]);

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

Here is the call graph for this function:

Here is the caller graph for this function:

setDescription()

ilGlossaryDefinition::setDescription

(

string

$a_description

)

Definition at line 146 of file class.ilGlossaryDefinition.php.

Referenced by MDUpdateListener().

                                                         : void
    {
        $this->description = $a_description;
    }

Here is the caller graph for this function:

setId()

ilGlossaryDefinition::setId

(

int

$a_id

)

Definition at line 76 of file class.ilGlossaryDefinition.php.

Referenced by create().

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

Here is the caller graph for this function:

setNr()

ilGlossaryDefinition::setNr

(

int

$a_nr

)

Definition at line 111 of file class.ilGlossaryDefinition.php.

Referenced by create(), delete(), moveDown(), moveUp(), and read().

                                    : void
    {
        $this->nr = $a_nr;
    }

Here is the caller graph for this function:

setShortText()

ilGlossaryDefinition::setShortText

(

string

$a_text

)

Definition at line 101 of file class.ilGlossaryDefinition.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()

ilGlossaryDefinition::setShortTextDirty

(

bool

$a_val

)

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

Referenced by read(), and updateShortText().

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

Here is the caller graph for this function:

setShortTextsDirty()

static ilGlossaryDefinition::setShortTextsDirty ( int  $a_glo_id )

static

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

if length is changed in settings)

Definition at line 567 of file class.ilGlossaryDefinition.php.

References $DIC, $ilDB, and ilGlossaryTerm\getTermsOfGlossary().

Referenced by ilObjGlossaryGUI\saveProperties().

                                                            : void
    {
        global $DIC;

        $ilDB = $DIC->database();

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

setShortTextsDirtyGlobally()

static ilGlossaryDefinition::setShortTextsDirtyGlobally ( )

static

Set short texts dirty (for all glossaries)

Definition at line 587 of file class.ilGlossaryDefinition.php.

References $DIC, and $ilDB.

Referenced by ilObjAdvancedEditingGUI\initGeneralPageSettingsForm().

                                                       : void
    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

setTermId()

ilGlossaryDefinition::setTermId

(

int

$a_term_id

)

Definition at line 91 of file class.ilGlossaryDefinition.php.

Referenced by read().

                                             : void
    {
        $this->term_id = $a_term_id;
    }

Here is the caller graph for this function:

setTitle()

ilGlossaryDefinition::setTitle

(

string

$a_title

)

Definition at line 136 of file class.ilGlossaryDefinition.php.

Referenced by MDUpdateListener().

                                             : void
    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

shortenShortText()

ilGlossaryDefinition::shortenShortText

(

string

$text

)

Shorten short text.

Definition at line 346 of file class.ilGlossaryDefinition.php.

References ilGlossaryTerm\_lookGlossaryID(), getTermId(), ilObjGlossary\lookupSnippetLength(), and ilStr\shortenTextExtended().

Referenced by setShortText(), and updateShortText().

                                                  : string
    {
        $a_length = 196;

        if ($this->getTermId() > 0) {
            $glo_id = ilGlossaryTerm::_lookGlossaryID($this->getTermId());
            $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()

ilGlossaryDefinition::update

(

)

Definition at line 329 of file class.ilGlossaryDefinition.php.

References $db, $ilDB, and updateMetaData().

Referenced by updateShortText().

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

        $this->updateMetaData();

        $ilDB->manipulate("UPDATE glossary_definition SET " .
            " term_id = " . $ilDB->quote($this->getTermId(), "integer") . ", " .
            " nr = " . $ilDB->quote($this->getNr(), "integer") . ", " .
            " 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:

updateMetaData()

ilGlossaryDefinition::updateMetaData

(

)

Definition at line 481 of file class.ilGlossaryDefinition.php.

References ilGlossaryTerm\_lookGlossaryID(), getDescription(), getId(), getTermId(), getTitle(), and getType().

Referenced by update().

                                    : void
    {
        $glo_id = ilGlossaryTerm::_lookGlossaryID($this->getTermId());
        $md = new ilMD($glo_id, $this->getId(), $this->getType());
        $md_gen = $md->getGeneral();
        $md_gen->setTitle($this->getTitle());

        // sets first description (maybe not appropriate)
        $md_des_ids = $md_gen->getDescriptionIds();
        if (count($md_des_ids) > 0) {
            $md_des = $md_gen->getDescription($md_des_ids[0]);
            $md_des->setDescription($this->getDescription());
            $md_des->update();
        }
        $md_gen->update();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateShortText()

ilGlossaryDefinition::updateShortText

(

)

Definition at line 381 of file class.ilGlossaryDefinition.php.

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

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

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

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilGlossaryDefinition::$db

protected

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

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

$description

string ilGlossaryDefinition::$description = ""

protected

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

Referenced by getDescription().

$files_contained

array ilGlossaryDefinition::$files_contained = []

protected

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

$glo_id

int ilGlossaryDefinition::$glo_id = 0

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

$id

int ilGlossaryDefinition::$id = 0

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

Referenced by getId(), and MDUpdateListener().

$lng

ilLanguage ilGlossaryDefinition::$lng

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

Referenced by __construct().

$mobs_contained

array ilGlossaryDefinition::$mobs_contained = []

protected

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

$nr

int ilGlossaryDefinition::$nr = 0

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

Referenced by getNr().

$page_object

ilGlossaryDefPage ilGlossaryDefinition::$page_object

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

Referenced by getPageObject().

$short_text

string ilGlossaryDefinition::$short_text = ""

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

Referenced by getShortText().

$short_text_dirty

bool ilGlossaryDefinition::$short_text_dirty = false

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

Referenced by getShortTextDirty().

$term_id

int ilGlossaryDefinition::$term_id = 0

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

Referenced by getTermId().

$title

string ilGlossaryDefinition::$title = ""

protected

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

Referenced by getTitle().

$tpl

ilGlobalTemplateInterface ilGlossaryDefinition::$tpl

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

Referenced by __construct().

$user

ilObjUser ilGlossaryDefinition::$user

protected

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

---

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

• Modules/Glossary/Definition/class.ilGlossaryDefinition.php