ilObjGlossary Class Reference

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

Inheritance diagram for ilObjGlossary:

Collaboration diagram for ilObjGlossary:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	create (bool $a_upload=false)
	read ()
	setVirtualMode (string $a_mode)
	getVirtualMode ()
	isVirtual ()
	setPresentationMode (string $a_val)
	getPresentationMode ()
	setSnippetLength (int $a_val)
	Set definition snippet length (in overview) More...
	getSnippetLength ()
	setOnline (bool $a_online)
	getOnline ()
	setActiveGlossaryMenu (bool $a_act_glo_menu)
	isActiveGlossaryMenu ()
	setShowTaxonomy (bool $a_val)
	getShowTaxonomy ()
	setActiveFlashcards (bool $a_flash)
	isActiveFlashcards ()
	setFlashcardsMode (string $a_flash)
	getFlashcardsMode ()
	setAutoGlossaries (array $a_val)
	addAutoGlossary (int $glo_id)
	getAutoGlossaries ()
	removeAutoGlossary (int $a_glo_id)
	update ()
	updateAutoGlossaries ()
	getGlossariesForCollection ()
	addGlossaryForCollection (int $glo_id)
	removeGlossaryFromCollection (int $glo_id)
	getTermList (string $searchterm="", string $a_letter="", string $a_def="", int $a_tax_node=0, bool $a_include_offline_childs=false, bool $a_add_amet_fields=false, array $a_amet_filter=null, bool $a_omit_virtual=false, bool $a_include_references=false)
	getFirstLetters (int $a_tax_node=0)
	getAllGlossaryIds (bool $a_include_offline_childs=false, bool $ids_are_ref_ids=false)
	Get all glossary ids. More...
	createExportDirectory (string $a_type="xml")
	getExportDirectory (string $a_type="xml")
	delete ()
	getTaxonomyId ()
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
	removeOfflineGlossaries (array $a_glo_ids, bool $ids_are_ref_ids=false)
	Remove offline glossaries from obj id array. More...
	autoLinkGlossaryTerms (int $a_glo_ref_id)
	Auto link glossary terms. More...
	supportsLongTextQuery ()
	Is long text search supported. More...
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_lookupOnline (int $a_id)
static	lookupSnippetLength (int $a_id)
static	lookupAutoGlossaries (int $a_id)
static	getDeletionDependencies (int $obj_id)
static	getAdvMDSubItemTitle (int $a_obj_id, string $a_sub_type, int $a_sub_id)
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields
array	$auto_glossaries = array()
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Static Protected Member Functions
static	lookup (int $a_id, string $a_property)
	Lookup glossary property. More...

Protected Attributes
ILIAS Glossary Term TermManager	$term_manager
ILIAS Style Content DomainService	$content_style_domain
ilGlossaryDefPage	$page_object
array	$file_ids = []
array	$mob_ids = []
bool	$show_tax = false
int	$style_id = 0
bool	$glo_menu_active = false
bool	$online = false
int	$snippet_length = 0
string	$pres_mode = ""
bool	$virtual = false
string	$virtual_mode = ""
bool	$flashcards_active = false
string	$flashcards_mode = ""
ilGlobalTemplateInterface	$tpl
ilObjUser	$user
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Additional Inherited Members
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

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.ilObjGlossary.php.

Constructor & Destructor Documentation

__construct()

ilObjGlossary::__construct	(	int	$a_id = 0,
		bool	$a_call_by_reference = true
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

      {
        global $DIC;
        $this->tpl = $DIC["tpl"];

        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->type = "glo";
        parent::__construct($a_id, $a_call_by_reference);
        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain();
        $this->term_manager = $DIC->glossary()->internal()->domain()->term($this);
    }

Here is the call graph for this function:

Member Function Documentation

_lookupOnline()

static ilObjGlossary::_lookupOnline ( int  $a_id )

static

Definition at line 176 of file class.ilObjGlossary.php.

References ilObject\$db, $DIC, $lm_set, $q, ilDBInterface\fetchAssoc(), ilDBInterface\query(), ilDBInterface\quote(), and ilUtil\yn2tf().

Referenced by ilRepositoryExplorer\isClickable().

     : bool {
        global $DIC;

        $db = $DIC->database();

        $q = "SELECT is_online FROM glossary WHERE id = " .
            $db->quote($a_id, "integer");
        $lm_set = $db->query($q);
        $lm_rec = $db->fetchAssoc($lm_set);

        return ilUtil::yn2tf($lm_rec["is_online"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addAutoGlossary()

ilObjGlossary::addAutoGlossary

(

int

$glo_id

)

Definition at line 267 of file class.ilObjGlossary.php.

References ilObject\_lookupType().

Referenced by setAutoGlossaries().

                                                : void
    {
        if ($glo_id > 0 && ilObject::_lookupType($glo_id) == "glo" &&
            !in_array($glo_id, $this->auto_glossaries)) {
            $this->auto_glossaries[] = $glo_id;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addGlossaryForCollection()

ilObjGlossary::addGlossaryForCollection

(

int

$glo_id

)

Definition at line 374 of file class.ilObjGlossary.php.

References ilObject\getId().

Referenced by ilObjGlossaryGUI\saveGlossaryForCollection().

                                                         : void
    {
        $this->db->replace(
            "glossary_collection",
            [
                "id" => ["integer", $this->getId()],
                "glo_id" => ["integer", $glo_id]
            ],
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

autoLinkGlossaryTerms()

ilObjGlossary::autoLinkGlossaryTerms

(

int

$a_glo_ref_id

)

Auto link glossary terms.

Definition at line 670 of file class.ilObjGlossary.php.

References $c, $id, ilPCParagraph\autoLinkGlossariesPage(), ilObject\getRefId(), and ilGlossaryTerm\getTermList().

     : void {
        // get terms of target glossary
        $terms = ilGlossaryTerm::getTermList([$a_glo_ref_id]);

        // for each get page: get content
        $source_terms = ilGlossaryTerm::getTermList([$this->getRefId()]);
        $found_pages = array();
        foreach ($source_terms as $source_term) {
            $pg = new ilGlossaryDefPage($source_term["id"]);
            $c = $pg->getXMLContent();
            foreach ($terms as $t) {
                if (is_int(stripos($c, $t["term"]))) {
                    $found_pages[$source_term["id"]]["terms"][] = $t;
                    if (!isset($found_pages[$source_term["id"]]["page"])) {
                        $found_pages[$source_term["id"]]["page"] = $pg;
                    }
                }
            }
            reset($terms);
        }

        // ilPCParagraph autoLinkGlossariesPage with page and terms
        foreach ($found_pages as $id => $fp) {
            ilPCParagraph::autoLinkGlossariesPage($fp["page"], $fp["terms"]);
        }
    }

Here is the call graph for this function:

cloneObject()

ilObjGlossary::cloneObject	(	int	$target_id,
		int	$copy_id = 0,
		bool	$omit_tree = false
	)

Definition at line 544 of file class.ilObjGlossary.php.

References Vendor\Package\$a, ilGlossaryTerm\_copyTerm(), ilCopyWizardOptions\_getInstance(), ilObject\cloneMetaData(), ilTaxNodeAssignment\getAssignmentsOfItem(), getAutoGlossaries(), ilObject\getDescription(), getFlashcardsMode(), getGlossariesForCollection(), ilObject\getId(), getOnline(), getPresentationMode(), ilObject\getRefId(), getSnippetLength(), getTaxonomyId(), ilGlossaryTerm\getTermList(), getVirtualMode(), isActiveFlashcards(), and ilObjTaxonomy\saveUsage().

                                                                                          : ?ilObject
    {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
        $this->cloneMetaData($new_obj);

        $tax_ass = null;
        $new_tax_ass = null;
        $map = [];

        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($copy_id);

        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOnline($this->getOnline());
        }

        //              $new_obj->setTitle($this->getTitle());
        $new_obj->setDescription($this->getDescription());
        $new_obj->setVirtualMode($this->getVirtualMode());
        $new_obj->setPresentationMode($this->getPresentationMode());
        $new_obj->setSnippetLength($this->getSnippetLength());
        $new_obj->setAutoGlossaries($this->getAutoGlossaries());
        $new_obj->setActiveFlashcards($this->isActiveFlashcards());
        $new_obj->setFlashcardsMode($this->getFlashcardsMode());
        $new_obj->update();

        // set/copy stylesheet
        $this->content_style_domain->styleForRefId($this->getRefId())->cloneTo($new_obj->getId());

        // copy taxonomy
        if (($tax_id = $this->getTaxonomyId()) > 0) {
            // clone it
            $tax = new ilObjTaxonomy($tax_id);
            $new_tax = $tax->cloneObject(0, 0, true);
            $map = $tax->getNodeMapping();

            // assign new taxonomy to new glossary
            ilObjTaxonomy::saveUsage($new_tax->getId(), $new_obj->getId());

            $tax_ass = new ilTaxNodeAssignment("glo", $this->getId(), "term", $tax_id);
            $new_tax_ass = new ilTaxNodeAssignment("glo", $new_obj->getId(), "term", $new_tax->getId());
        }

        // copy terms
        $term_mappings = array();
        foreach (ilGlossaryTerm::getTermList([$this->getRefId()]) as $term) {
            $new_term_id = ilGlossaryTerm::_copyTerm($term["id"], $new_obj->getId());
            $term_mappings[$term["id"]] = $new_term_id;

            // copy tax node assignments
            if ($tax_id > 0) {
                $assignmts = $tax_ass->getAssignmentsOfItem($term["id"]);
                foreach ($assignmts as $a) {
                    if ($map[$a["node_id"]] > 0) {
                        $new_tax_ass->addAssignment($map[$a["node_id"]], $new_term_id);
                    }
                }
            }
        }

        // add mapping of term_ids to copy wizard options
        if (!empty($term_mappings)) {
            $cp_options->appendMapping($this->getRefId() . '_glo_terms', $term_mappings);
        }

        // copy collection glossaries
        foreach ($this->getGlossariesForCollection() as $glo_id) {
            $new_obj->addGlossaryForCollection($glo_id);
        }

        return $new_obj;
    }

Here is the call graph for this function:

create()

ilObjGlossary::create

(

bool

$a_upload = false

)

Definition at line 61 of file class.ilObjGlossary.php.

References $id, ilObject\createMetaData(), ilObject\getId(), getVirtualMode(), setPresentationMode(), setSnippetLength(), and updateAutoGlossaries().

                                                  : int
    {
        $id = parent::create();

        // meta data will be created by
        // import parser
        if (!$a_upload) {
            $this->createMetaData();
        }
        $this->db->insert(
            'glossary',
            array(
                'id' => array('integer', $this->getId()),
                'is_online' => array('text', 'n'),
                'virtual' => array('text', $this->getVirtualMode()),
                'pres_mode' => array('text', 'table'),
                'snippet_length' => array('integer', 200)
            )
        );

        $this->setPresentationMode("table");
        $this->setSnippetLength(200);

        $this->updateAutoGlossaries();

        return $id;
    }

Here is the call graph for this function:

createExportDirectory()

ilObjGlossary::createExportDirectory

(

string

$a_type = "xml"

)

Definition at line 479 of file class.ilObjGlossary.php.

References ilExport\_createExportDirectory(), ilObject\getId(), and ilObject\getType().

                                                                 : string
    {
        return ilExport::_createExportDirectory($this->getId(), $a_type, $this->getType());
    }

Here is the call graph for this function:

delete()

ilObjGlossary::delete

(

)

Definition at line 489 of file class.ilObjGlossary.php.

References $q, ilObject\deleteMetaData(), ilObject\getId(), getTermList(), and isVirtual().

                            : bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // delete terms
        if (!$this->isVirtual()) {
            $terms = $this->getTermList();
            foreach ($terms as $term) {
                $this->term_manager->deleteTerm((int) $term["id"]);
            }
        }

        // delete term references
        $refs = new ilGlossaryTermReferences($this->getId());
        $refs->delete();

        // delete glossary data entry
        $q = "DELETE FROM glossary WHERE id = " . $this->db->quote($this->getId());
        $this->db->query($q);

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

        return true;
    }

Here is the call graph for this function:

getAdvMDSubItemTitle()

static ilObjGlossary::getAdvMDSubItemTitle ( int  $a_obj_id, string  $a_sub_type, int  $a_sub_id  )

static

Implements ilAdvancedMetaDataSubItems.

Definition at line 653 of file class.ilObjGlossary.php.

References $DIC, ilObject\$lng, ilGlossaryTerm\_lookGlossaryTerm(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                                                                                 : string
    {
        global $DIC;

        $lng = $DIC->language();

        if ($a_sub_type == "term") {
            $lng->loadLanguageModule("glo");

            return $lng->txt("glo_term") . ' "' . ilGlossaryTerm::_lookGlossaryTerm($a_sub_id) . '"';
        }
        return "";
    }

Here is the call graph for this function:

getAllGlossaryIds()

ilObjGlossary::getAllGlossaryIds	(	bool	$a_include_offline_childs = false,
		bool	$ids_are_ref_ids = false
	)

Get all glossary ids.

Returns

int[]

Definition at line 436 of file class.ilObjGlossary.php.

References $DIC, ilObject\$tree, ilObject\_getAllReferences(), getGlossariesForCollection(), ilObject\getId(), ilObject\getRefId(), getVirtualMode(), isVirtual(), and removeOfflineGlossaries().

Referenced by getFirstLetters(), and getTermList().

     : array {
        global $DIC;

        $tree = $DIC->repositoryTree();

        if ($this->isVirtual()) {
            $glo_ids = array();

            $virtual_mode = $this->getRefId() ? $this->getVirtualMode() : '';
            if ($virtual_mode === "coll") {
                $glo_ids = $this->getGlossariesForCollection();
                if ($ids_are_ref_ids) {
                    $glo_ref_ids = [];
                    foreach ($glo_ids as $obj_id) {
                        $glo_ref_ids[] = current(ilObject::_getAllReferences($obj_id));
                    }
                    $glo_ids = $glo_ref_ids;
                }
            }
            if (!$a_include_offline_childs) {
                $glo_ids = $this->removeOfflineGlossaries($glo_ids, $ids_are_ref_ids);
            }
            // always show entries of current glossary (if no permission is given, user will not come to the presentation screen)
            // see bug #14477
            if ($ids_are_ref_ids) {
                if (!in_array($this->getRefId(), $glo_ids)) {
                    $glo_ids[] = $this->getRefId();
                }
            } elseif (!in_array($this->getId(), $glo_ids)) {
                $glo_ids[] = $this->getId();
            }
        } elseif ($ids_are_ref_ids) {
            $glo_ids = [$this->getRefId()];
        } else {
            $glo_ids = [$this->getId()];
        }

        return $glo_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAutoGlossaries()

ilObjGlossary::getAutoGlossaries

(

)

Returns

int[]

Definition at line 278 of file class.ilObjGlossary.php.

References $auto_glossaries.

Referenced by cloneObject(), removeAutoGlossary(), and updateAutoGlossaries().

                                       : array
    {
        return $this->auto_glossaries;
    }

Here is the caller graph for this function:

getDeletionDependencies()

static ilObjGlossary::getDeletionDependencies ( int  $obj_id )

static

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

References $DIC, ilObject\$lng, ilObjSAHSLearningModule\getScormModulesForGlossary(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                                               : array
    {
        global $DIC;

        $lng = $DIC->language();

        $dep = array();
        $sms = ilObjSAHSLearningModule::getScormModulesForGlossary($obj_id);
        foreach ($sms as $sm) {
            $lng->loadLanguageModule("content");
            $dep[$sm] = $lng->txt("glo_used_in_scorm");
        }
        return $dep;
    }

Here is the call graph for this function:

getExportDirectory()

ilObjGlossary::getExportDirectory

(

string

$a_type = "xml"

)

Definition at line 484 of file class.ilObjGlossary.php.

References ilExport\_getExportDirectory(), ilObject\getId(), and ilObject\getType().

                                                              : string
    {
        return ilExport::_getExportDirectory($this->getId(), $a_type, $this->getType());
    }

Here is the call graph for this function:

getFirstLetters()

ilObjGlossary::getFirstLetters

(

int

$a_tax_node = 0

)

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

References getAllGlossaryIds(), and ilGlossaryTerm\getFirstLetters().

     : array {
        $glo_ids = $this->getAllGlossaryIds();
        $first_letters = ilGlossaryTerm::getFirstLetters($glo_ids, $a_tax_node);
        return $first_letters;
    }

Here is the call graph for this function:

getFlashcardsMode()

ilObjGlossary::getFlashcardsMode

(

)

Definition at line 250 of file class.ilObjGlossary.php.

References $flashcards_mode.

Referenced by cloneObject(), and update().

                                       : string
    {
        return $this->flashcards_mode;
    }

Here is the caller graph for this function:

getGlossariesForCollection()

ilObjGlossary::getGlossariesForCollection

(

)

Returns

int[]

Definition at line 360 of file class.ilObjGlossary.php.

References ILIAS\Repository\int().

Referenced by cloneObject(), and getAllGlossaryIds().

                                                : array
    {
        $set = $this->db->query(
            "SELECT * FROM glossary_collection " .
            " WHERE id = " . $this->db->quote($this->getId(), "integer")
        );
        $glos = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $glos[] = (int) $rec["glo_id"];
        }

        return $glos;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOnline()

ilObjGlossary::getOnline

(

)

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

References $online.

Referenced by cloneObject(), and update().

                               : bool
    {
        return $this->online;
    }

Here is the caller graph for this function:

getPresentationMode()

ilObjGlossary::getPresentationMode

(

)

Definition at line 148 of file class.ilObjGlossary.php.

References $pres_mode.

Referenced by cloneObject(), and update().

                                         : string
    {
        return $this->pres_mode;
    }

Here is the caller graph for this function:

getShowTaxonomy()

ilObjGlossary::getShowTaxonomy

(

)

Definition at line 230 of file class.ilObjGlossary.php.

References $show_tax.

Referenced by update().

                                     : bool
    {
        return $this->show_tax;
    }

Here is the caller graph for this function:

getSnippetLength()

ilObjGlossary::getSnippetLength

(

)

Definition at line 159 of file class.ilObjGlossary.php.

Referenced by cloneObject(), and update().

                                      : int
    {
        return ($this->snippet_length > 0)
            ? $this->snippet_length
            : 200;
    }

Here is the caller graph for this function:

getTaxonomyId()

ilObjGlossary::getTaxonomyId

(

)

Definition at line 533 of file class.ilObjGlossary.php.

References ilObject\getId(), and ilObjTaxonomy\getUsageOfObject().

Referenced by cloneObject().

                                   : int
    {
        $tax_ids = ilObjTaxonomy::getUsageOfObject($this->getId());
        if (count($tax_ids) > 0) {
            // glossaries handle max. one taxonomy
            return (int) $tax_ids[0];
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTermList()

ilObjGlossary::getTermList	(	string	$searchterm = "",
		string	$a_letter = "",
		string	$a_def = "",
		int	$a_tax_node = 0,
		bool	$a_include_offline_childs = false,
		bool	$a_add_amet_fields = false,
		array	$a_amet_filter = null,
		bool	$a_omit_virtual = false,
		bool	$a_include_references = false
	)

Definition at line 395 of file class.ilObjGlossary.php.

References getAllGlossaryIds(), ilObject\getRefId(), and ilGlossaryTerm\getTermList().

Referenced by delete(), and assQuestionGUI\outGlossarySelector().

     : array {
        if ($a_omit_virtual) {
            $glo_ref_ids[] = $this->getRefId();
        } else {
            $glo_ref_ids = $this->getAllGlossaryIds($a_include_offline_childs, true);
        }
        $list = ilGlossaryTerm::getTermList(
            $glo_ref_ids,
            $searchterm,
            $a_letter,
            $a_def,
            $a_tax_node,
            $a_add_amet_fields,
            $a_amet_filter,
            $a_include_references
        );
        return $list;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getVirtualMode()

ilObjGlossary::getVirtualMode

(

)

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

References $virtual_mode.

Referenced by cloneObject(), create(), getAllGlossaryIds(), and update().

                                    : string
    {
        return $this->virtual_mode;
    }

Here is the caller graph for this function:

isActiveFlashcards()

ilObjGlossary::isActiveFlashcards

(

)

Definition at line 240 of file class.ilObjGlossary.php.

References $flashcards_active.

Referenced by cloneObject(), and update().

                                        : bool
    {
        return $this->flashcards_active;
    }

Here is the caller graph for this function:

isActiveGlossaryMenu()

ilObjGlossary::isActiveGlossaryMenu

(

)

Definition at line 220 of file class.ilObjGlossary.php.

References $glo_menu_active.

Referenced by update().

                                          : bool
    {
        return $this->glo_menu_active;
    }

Here is the caller graph for this function:

isVirtual()

ilObjGlossary::isVirtual

(

)

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

References $virtual.

Referenced by delete(), and getAllGlossaryIds().

                               : bool
    {
        return $this->virtual;
    }

Here is the caller graph for this function:

lookup()

static ilObjGlossary::lookup ( int  $a_id, string  $a_property  )

staticprotected

Lookup glossary property.

Definition at line 194 of file class.ilObjGlossary.php.

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

     : string {
        global $DIC;

        $db = $DIC->database();

        $set = $db->query("SELECT $a_property FROM glossary WHERE id = " .
            $db->quote($a_id, "integer"));
        $rec = $db->fetchAssoc($set);

        return $rec[$a_property];
    }

Here is the call graph for this function:

lookupAutoGlossaries()

static ilObjGlossary::lookupAutoGlossaries ( int  $a_id )

static

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

References ilObject\$db, $DIC, ilDBInterface\fetchAssoc(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilGlossaryDefPage\beforePageContentUpdate().

     : array {
        global $DIC;

        $db = $DIC->database();

        // read auto glossaries
        $set = $db->query(
            "SELECT * FROM glo_glossaries " .
            " WHERE id = " . $db->quote($a_id, "integer")
        );
        $glos = array();
        while ($rec = $db->fetchAssoc($set)) {
            $glos[] = (int) $rec["glo_id"];
        }
        return $glos;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupSnippetLength()

static ilObjGlossary::lookupSnippetLength ( int  $a_id )

static

Definition at line 209 of file class.ilObjGlossary.php.

Referenced by ilGlossaryTerm\shortenShortText().

                                                         : int
    {
        return (int) self::lookup($a_id, "snippet_length");
    }

Here is the caller graph for this function:

read()

ilObjGlossary::read

(

)

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

References $q, ilObject\getId(), setActiveFlashcards(), setActiveGlossaryMenu(), setAutoGlossaries(), setFlashcardsMode(), setOnline(), setPresentationMode(), setShowTaxonomy(), setSnippetLength(), setVirtualMode(), and ilUtil\yn2tf().

                          : void
    {
        parent::read();

        $q = "SELECT * FROM glossary WHERE id = " .
            $this->db->quote($this->getId(), "integer");
        $gl_set = $this->db->query($q);
        $gl_rec = $this->db->fetchAssoc($gl_set);
        $this->setOnline(ilUtil::yn2tf($gl_rec["is_online"]));
        $this->setVirtualMode((string) ($gl_rec["virtual"] ?? ""));
        $this->setActiveGlossaryMenu(ilUtil::yn2tf($gl_rec["glo_menu_active"]));
        $this->setPresentationMode((string) $gl_rec["pres_mode"]);
        $this->setSnippetLength((int) $gl_rec["snippet_length"]);
        $this->setShowTaxonomy((bool) $gl_rec["show_tax"]);
        $this->setActiveFlashcards(ilUtil::yn2tf($gl_rec["flash_active"]));
        $this->setFlashcardsMode($gl_rec["flash_mode"]);

        // read auto glossaries
        $set = $this->db->query(
            "SELECT * FROM glo_glossaries " .
            " WHERE id = " . $this->db->quote($this->getId(), "integer")
        );
        $glos = array();
        while ($rec = $this->db->fetchAssoc($set)) {
            $glos[] = $rec["glo_id"];
        }
        $this->setAutoGlossaries($glos);
    }

Here is the call graph for this function:

removeAutoGlossary()

ilObjGlossary::removeAutoGlossary

(

int

$a_glo_id

)

Definition at line 283 of file class.ilObjGlossary.php.

References getAutoGlossaries(), and setAutoGlossaries().

     : void {
        $glo_ids = array();
        foreach ($this->getAutoGlossaries() as $g) {
            if ($g != $a_glo_id) {
                $glo_ids[] = $g;
            }
        }
        $this->setAutoGlossaries($glo_ids);
    }

Here is the call graph for this function:

removeGlossaryFromCollection()

ilObjGlossary::removeGlossaryFromCollection

(

int

$glo_id

)

Definition at line 386 of file class.ilObjGlossary.php.

                                                             : void
    {
        $this->db->manipulate(
            "DELETE FROM glossary_collection WHERE " .
            " id = " . $this->db->quote($this->getId(), "integer") .
            " AND glo_id = " . $this->db->quote($glo_id, "integer")
        );
    }

removeOfflineGlossaries()

ilObjGlossary::removeOfflineGlossaries	(	array	$a_glo_ids,
		bool	$ids_are_ref_ids = false
	)

Remove offline glossaries from obj id array.

Definition at line 620 of file class.ilObjGlossary.php.

References $id, ilObject\$ref_id, and ilObject\_lookupObjectId().

Referenced by getAllGlossaryIds().

     : array {
        $glo_ids = $a_glo_ids;
        if ($ids_are_ref_ids) {
            $glo_ids = array_map(static function ($id): int {
                return ilObject::_lookupObjectId($id);
            }, $a_glo_ids);
        }

        $set = $this->db->query(
            "SELECT id FROM glossary " .
            " WHERE " . $this->db->in("id", $glo_ids, false, "integer") .
            " AND is_online = " . $this->db->quote("y", "text")
        );
        $online_glo_ids = array();
        while ($rec = $this->db->fetchAssoc($set)) {
            $online_glo_ids[] = $rec["id"];
        }

        if (!$ids_are_ref_ids) {
            return $online_glo_ids;
        }

        $online_ref_ids = array_filter($a_glo_ids, static function ($ref_id) use ($online_glo_ids): bool {
            return in_array(ilObject::_lookupObjectId($ref_id), $online_glo_ids);
        });


        return $online_ref_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setActiveFlashcards()

ilObjGlossary::setActiveFlashcards

(

bool

$a_flash

)

Definition at line 235 of file class.ilObjGlossary.php.

Referenced by read().

                                                      : void
    {
        $this->flashcards_active = $a_flash;
    }

Here is the caller graph for this function:

setActiveGlossaryMenu()

ilObjGlossary::setActiveGlossaryMenu

(

bool

$a_act_glo_menu

)

Definition at line 215 of file class.ilObjGlossary.php.

Referenced by read().

                                                               : void
    {
        $this->glo_menu_active = $a_act_glo_menu;
    }

Here is the caller graph for this function:

setAutoGlossaries()

ilObjGlossary::setAutoGlossaries

(

array

$a_val

)

Parameters

int[]

$a_val

Definition at line 258 of file class.ilObjGlossary.php.

References addAutoGlossary().

Referenced by read(), and removeAutoGlossary().

     : void {
        $this->auto_glossaries = array();
        foreach ($a_val as $v) {
            $this->addAutoGlossary($v);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFlashcardsMode()

ilObjGlossary::setFlashcardsMode

(

string

$a_flash

)

Definition at line 245 of file class.ilObjGlossary.php.

Referenced by read().

                                                      : void
    {
        $this->flashcards_mode = $a_flash;
    }

Here is the caller graph for this function:

setOnline()

ilObjGlossary::setOnline

(

bool

$a_online

)

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

Referenced by read().

                                             : void
    {
        $this->online = $a_online;
    }

Here is the caller graph for this function:

setPresentationMode()

ilObjGlossary::setPresentationMode

(

string

$a_val

)

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

Referenced by create(), and read().

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

Here is the caller graph for this function:

setShowTaxonomy()

ilObjGlossary::setShowTaxonomy

(

bool

$a_val

)

Definition at line 225 of file class.ilObjGlossary.php.

Referenced by read().

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

Here is the caller graph for this function:

setSnippetLength()

ilObjGlossary::setSnippetLength

(

int

$a_val

)

Set definition snippet length (in overview)

Definition at line 154 of file class.ilObjGlossary.php.

Referenced by create(), and read().

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

Here is the caller graph for this function:

setVirtualMode()

ilObjGlossary::setVirtualMode

(

string

$a_mode

)

Definition at line 118 of file class.ilObjGlossary.php.

Referenced by read().

                                                  : void
    {
        switch ($a_mode) {
            case "coll":
                $this->virtual_mode = $a_mode;
                $this->virtual = true;
                break;

            default:
                $this->virtual_mode = "none";
                $this->virtual = false;
                break;
        }
    }

Here is the caller graph for this function:

supportsLongTextQuery()

ilObjGlossary::supportsLongTextQuery

(

)

Is long text search supported.

Definition at line 702 of file class.ilObjGlossary.php.

                                           : bool
    {
        return true;
    }

update()

ilObjGlossary::update

(

)

Definition at line 295 of file class.ilObjGlossary.php.

References getFlashcardsMode(), ilObject\getId(), getOnline(), getPresentationMode(), getShowTaxonomy(), getSnippetLength(), getVirtualMode(), isActiveFlashcards(), isActiveGlossaryMenu(), ilUtil\tf2yn(), updateAutoGlossaries(), and ilObject\updateMetaData().

                            : bool
    {
        $this->updateMetaData();

        $this->db->update(
            'glossary',
            array(
                'is_online' => array('text', ilUtil::tf2yn($this->getOnline())),
                'virtual' => array('text', $this->getVirtualMode()),
                'glo_menu_active' => array('text', ilUtil::tf2yn($this->isActiveGlossaryMenu())),
                'pres_mode' => array('text', $this->getPresentationMode()),
                'show_tax' => array('integer', $this->getShowTaxonomy()),
                'snippet_length' => array('integer', $this->getSnippetLength()),
                'flash_active' => array('text', ilUtil::tf2yn($this->isActiveFlashcards())),
                'flash_mode' => array('text', $this->getFlashcardsMode())
            ),
            array(
                'id' => array('integer', $this->getId())
            )
        );

        $this->updateAutoGlossaries();
        return parent::update();
    }

Here is the call graph for this function:

updateAutoGlossaries()

ilObjGlossary::updateAutoGlossaries

(

)

Definition at line 320 of file class.ilObjGlossary.php.

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

Referenced by create(), and update().

                                          : void
    {
        // update auto glossaries
        $this->db->manipulate(
            "DELETE FROM glo_glossaries WHERE " .
            " id = " . $this->db->quote($this->getId(), "integer")
        );
        foreach ($this->getAutoGlossaries() as $glo_id) {
            $this->db->insert(
                'glo_glossaries',
                array(
                    'id' => array('integer', $this->getId()),
                    'glo_id' => array('integer', $glo_id)
                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$auto_glossaries

array ilObjGlossary::$auto_glossaries = array()

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

Referenced by getAutoGlossaries().

$content_style_domain

ILIAS Style Content DomainService ilObjGlossary::$content_style_domain

protected

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

$file_ids

array ilObjGlossary::$file_ids = []

protected

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

$flashcards_active

bool ilObjGlossary::$flashcards_active = false

protected

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

Referenced by isActiveFlashcards().

$flashcards_mode

string ilObjGlossary::$flashcards_mode = ""

protected

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

Referenced by getFlashcardsMode().

$glo_menu_active

bool ilObjGlossary::$glo_menu_active = false

protected

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

Referenced by isActiveGlossaryMenu().

$mob_ids

array ilObjGlossary::$mob_ids = []

protected

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

$online

bool ilObjGlossary::$online = false

protected

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

Referenced by getOnline().

$page_object

ilGlossaryDefPage ilObjGlossary::$page_object

protected

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

$pres_mode

string ilObjGlossary::$pres_mode = ""

protected

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

Referenced by getPresentationMode().

$show_tax

bool ilObjGlossary::$show_tax = false

protected

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

Referenced by getShowTaxonomy().

$snippet_length

int ilObjGlossary::$snippet_length = 0

protected

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

$style_id

int ilObjGlossary::$style_id = 0

protected

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

$term_manager

ILIAS Glossary Term TermManager ilObjGlossary::$term_manager

protected

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

$tpl

ilGlobalTemplateInterface ilObjGlossary::$tpl

protected

Definition at line 39 of file class.ilObjGlossary.php.

$user

ilObjUser ilObjGlossary::$user

protected

Definition at line 41 of file class.ilObjGlossary.php.

$virtual

bool ilObjGlossary::$virtual = false

protected

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

Referenced by isVirtual().

$virtual_mode

string ilObjGlossary::$virtual_mode = ""

protected

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

Referenced by getVirtualMode().

---

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

• components/ILIAS/Glossary/classes/class.ilObjGlossary.php