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

Public Member Functions
	__construct (int $a_glo_id=0)
	setGlossaryId (int $a_val)
	getGlossaryId ()
	setTerms (array $a_val)
	getTerms ()
	addTerm (int $a_term_id)
	deleteTerm (int $a_term_id)
	read ()
	update ()
	delete ()
	Delete references (of glossary) More...

Static Public Member Functions
static	deleteReferencesOfTerm (int $a_term_id)
	Delete all references of a term. More...
static	hasReferences (int $a_glossary_id)
	Check if a glossary uses references. More...
static	isReferenced (array $a_glo_id, int $a_term_id)
	Is a term referenced by a set of glossaries. More...
static	lookupReferencesOfTerm (int $a_term_id)

Protected Attributes
int	$glo_id
array	$terms = array()
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 term reference

Author

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

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

Constructor & Destructor Documentation

__construct()

ilGlossaryTermReferences::__construct

(

int

$a_glo_id = 0

)

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

References $DIC, read(), and setGlossaryId().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->event_handler = $DIC->event();

        $this->setGlossaryId($a_glo_id);
        if ($a_glo_id > 0) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

addTerm()

ilGlossaryTermReferences::addTerm

(

int

$a_term_id

)

Definition at line 70 of file class.ilGlossaryTermReferences.php.

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

                                           : void
    {
        if (!in_array($a_term_id, $this->terms)) {
            $this->terms[] = $a_term_id;
        }
    }

Here is the caller graph for this function:

delete()

ilGlossaryTermReferences::delete

(

)

Delete references (of glossary)

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

                            : void
    {
        $this->db->manipulate(
            "DELETE FROM glo_term_reference WHERE " .
            " glo_id = " . $this->db->quote($this->getGlossaryId(), "integer")
        );
    }

deleteReferencesOfTerm()

static ilGlossaryTermReferences::deleteReferencesOfTerm ( int  $a_term_id )

static

Delete all references of a term.

Definition at line 127 of file class.ilGlossaryTermReferences.php.

References $DIC, ilDBInterface\manipulate(), and ilDBInterface\quote().

Referenced by ilGlossaryTerm\delete(), and ILIAS\Glossary\Term\TermManager\deleteTerm().

                                                                 : void
    {
        global $DIC;

        $db = $DIC->database();
        $db->manipulate(
            "DELETE FROM glo_term_reference WHERE " .
            " term_id = " . $db->quote($a_term_id, "integer")
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteTerm()

ilGlossaryTermReferences::deleteTerm

(

int

$a_term_id

)

Definition at line 77 of file class.ilGlossaryTermReferences.php.

Referenced by ilObjGlossaryGUI\deleteTerms().

                                              : void
    {
        foreach ($this->terms as $k => $v) {
            if ($v == $a_term_id) {
                unset($this->terms[$k]);
            }
        }

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

Here is the caller graph for this function:

getGlossaryId()

ilGlossaryTermReferences::getGlossaryId

(

)

Definition at line 49 of file class.ilGlossaryTermReferences.php.

References $glo_id.

Referenced by update().

                                   : int
    {
        return $this->glo_id;
    }

Here is the caller graph for this function:

getTerms()

ilGlossaryTermReferences::getTerms

(

)

Returns

int[] term ids

Definition at line 65 of file class.ilGlossaryTermReferences.php.

References $terms.

Referenced by update().

                              : array
    {
        return $this->terms;
    }

Here is the caller graph for this function:

hasReferences()

static ilGlossaryTermReferences::hasReferences ( int  $a_glossary_id )

static

Check if a glossary uses references.

Definition at line 142 of file class.ilGlossaryTermReferences.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

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

                                                            : bool
    {
        global $DIC;

        $db = $DIC->database();
        $set = $db->query(
            "SELECT * FROM glo_term_reference  " .
            " WHERE glo_id = " . $db->quote($a_glossary_id, "integer")
        );
        if ($rec = $db->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isReferenced()

static ilGlossaryTermReferences::isReferenced ( array  $a_glo_id, int  $a_term_id  )

static

Is a term referenced by a set of glossaries.

Parameters

	int[]	$a_glo_id glossary ids
int	$a_term_id

Returns

bool

Definition at line 163 of file class.ilGlossaryTermReferences.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\in(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjGlossaryGUI\__construct(), ilObjGlossaryGUI\deleteTerms(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\handleTermForModal(), and ilGlossaryPresentationGUI\initByRequest().

     : bool {
        global $DIC;

        $db = $DIC->database();
        $set = $db->query(
            "SELECT * FROM glo_term_reference " .
            " WHERE " . $db->in("glo_id", $a_glo_id, false, "integer") .
            " AND term_id = " . $db->quote($a_term_id, "integer")
        );
        if ($db->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupReferencesOfTerm()

static ilGlossaryTermReferences::lookupReferencesOfTerm ( int  $a_term_id )

static

Parameters

int

$a_term_id

term id

Returns

int[] glossary ids

Definition at line 185 of file class.ilGlossaryTermReferences.php.

References $DIC, $q, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilGlossaryTerm\getUsages().

     : array {
        global $DIC;

        $db = $DIC->database();
        $set = $db->query(
            $q = "SELECT DISTINCT glo_id FROM glo_term_reference " .
            " WHERE term_id = " . $db->quote($a_term_id, "integer")
        );
        $glos = array();
        while ($rec = $db->fetchAssoc($set)) {
            $glos[] = $rec["glo_id"];
        }
        return $glos;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilGlossaryTermReferences::read

(

)

Definition at line 89 of file class.ilGlossaryTermReferences.php.

References addTerm().

Referenced by __construct().

                          : void
    {
        $set = $this->db->query("SELECT term_id FROM glo_term_reference " .
            " WHERE glo_id = " . $this->db->quote($this->getGlossaryId(), "integer"));
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->addTerm($rec["term_id"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setGlossaryId()

ilGlossaryTermReferences::setGlossaryId

(

int

$a_val

)

Definition at line 44 of file class.ilGlossaryTermReferences.php.

Referenced by __construct().

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

Here is the caller graph for this function:

setTerms()

ilGlossaryTermReferences::setTerms

(

array

$a_val

)

Parameters

int[]

$a_val term ids

Definition at line 57 of file class.ilGlossaryTermReferences.php.

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

update()

ilGlossaryTermReferences::update

(

)

Definition at line 98 of file class.ilGlossaryTermReferences.php.

References getGlossaryId(), and getTerms().

                            : void
    {
        $this->delete();
        foreach ($this->getTerms() as $t) {
            $this->db->replace(
                "glo_term_reference",
                array(
                    "glo_id" => array("integer", $this->getGlossaryId()),
                    "term_id" => array("integer", $t),
                ),
                array()
            );
        }
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilGlossaryTermReferences::$db

protected

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

$event_handler

ilAppEventHandler ilGlossaryTermReferences::$event_handler

protected

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

$glo_id

int ilGlossaryTermReferences::$glo_id

protected

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

Referenced by getGlossaryId().

$terms

array ilGlossaryTermReferences::$terms = array()

protected

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

Referenced by getTerms().

---

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

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