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 ()
	setActiveDownloads (bool $a_down)
	isActiveDownloads ()
	setShowTaxonomy (bool $a_val)
	getShowTaxonomy ()
	setAutoGlossaries (array $a_val)
	addAutoGlossary (int $glo_id)
	getAutoGlossaries ()
	removeAutoGlossary (int $a_glo_id)
	update ()
	updateAutoGlossaries ()
	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...
	createImportDirectory ()
	creates data directory for import files (data_dir/glo_data/glo_<id>/import, depending on data directory that is set in ILIAS setup/ini) More...
	getImportDirectory ()
	createExportDirectory (string $a_type="xml")
	getExportDirectory (string $a_type="xml")
	getExportFiles ()
	Get export files. More...
	setPublicExportFile (string $a_type, string $a_file)
	specify public export file for type More...
	getPublicExportFile (string $a_type)
	get public export file More...
	exportXML (ilXmlWriter $a_xml_writer, int $a_inst, string $a_target_dir, ilLog $expLog)
	exportXMLGlossaryItems (ilXmlWriter $a_xml_writer, int $a_inst, ilLog $expLog)
	exportXMLMetaData (ilXmlWriter $a_xml_writer)
	exportXMLMediaObjects (ilXmlWriter $a_xml_writer, int $a_inst, string $a_target_dir, ilLog $expLog)
	exportFileItems (string $a_target_dir, ilLog $expLog)
	modifyExportIdentifier (string $a_tag, string $a_param, string $a_value)
	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...
	getXMLZip ()
	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
	__construct (int $id=0, bool $reference=true)
	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 $desc)
	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)
	Get deletion dependencies. More...
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	_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)
static	getAdvMDSubItemTitle (int $a_obj_id, string $a_sub_type, int $a_sub_id)

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 Style Content DomainService	$content_style_domain
ilGlossaryDefPage	$page_object
array	$file_ids = []
array	$mob_ids = []
bool	$show_tax = false
int	$style_id = 0
bool	$downloads_active = false
bool	$glo_menu_active = false
bool	$online = false
int	$snippet_length = 0
string	$pres_mode = ""
bool	$virtual = false
string	$virtual_mode = ""
ilGlobalTemplateInterface	$tpl
ilObjUser	$user
array	$public_export_file = []
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
int	$id
bool	$referenced
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 = ""
bool	$offline = false
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	$id = 0,
		bool	$reference = true
	)

Parameters

int	$id	reference_id or object_id
bool	$reference	bool treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

      {
        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();
    }

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

Here is the call graph for this function:

Member Function Documentation

_lookupOnline()

static ilObjGlossary::_lookupOnline ( int  $a_id )

static

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

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

Referenced by ilRepositoryExplorer\isClickable(), and ilRepositoryExplorerGUI\isNodeClickable().

Here is the caller graph for this function:

addAutoGlossary()

ilObjGlossary::addAutoGlossary

(

int

$glo_id

)

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

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

References ilObject\_lookupType().

Here is the call graph for this function:

autoLinkGlossaryTerms()

ilObjGlossary::autoLinkGlossaryTerms

(

int

$a_glo_ref_id

)

Auto link glossary terms.

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

     : 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) {
            $source_defs = ilGlossaryDefinition::getDefinitionList($source_term["id"]);
 
            for ($j = 0, $jMax = count($source_defs); $j < $jMax; $j++) {
                $def = $source_defs[$j];
                $pg = new ilGlossaryDefPage($def["id"]);
 
                $c = $pg->getXMLContent();
                foreach ($terms as $t) {
                    if (is_int(stripos($c, $t["term"]))) {
                        $found_pages[$def["id"]]["terms"][] = $t;
                        if (!isset($found_pages[$def["id"]]["page"])) {
                            $found_pages[$def["id"]]["page"] = $pg;
                        }
                    }
                }
                reset($terms);
            }
        }
 
        // ilPCParagraph autoLinkGlossariesPage with page and terms
        foreach ($found_pages as $id => $fp) {
            ilPCParagraph::autoLinkGlossariesPage($fp["page"], $fp["terms"]);
        }
    }

cloneObject()

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

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

                                                                                          : ?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->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);
        }
 
 
        return $new_obj;
    }

References Vendor\Package\$a, $target_id, ilGlossaryTerm\_copyTerm(), ilCopyWizardOptions\_getInstance(), ILIAS\Survey\Mode\getId(), ilGlossaryTerm\getTermList(), and ilObjTaxonomy\saveUsage().

Here is the call graph for this function:

create()

ilObjGlossary::create

(

bool

$a_upload = false

)

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

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

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

Here is the call graph for this function:

createExportDirectory()

ilObjGlossary::createExportDirectory

(

string

$a_type = "xml"

)

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

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

References ilExport\_createExportDirectory(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

createImportDirectory()

ilObjGlossary::createImportDirectory

(

)

creates data directory for import files (data_dir/glo_data/glo_<id>/import, depending on data directory that is set in ILIAS setup/ini)

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

                                           : void
    {
        $glo_data_dir = ilFileUtils::getDataDir() . "/glo_data";
        ilFileUtils::makeDir($glo_data_dir);
        if (!is_writable($glo_data_dir)) {
            throw new ilGlossaryException("Glossary Data Directory (" . $glo_data_dir
                . ") not writeable.");
        }
 
        // create glossary directory (data_dir/glo_data/glo_<id>)
        $glo_dir = $glo_data_dir . "/glo_" . $this->getId();
        ilFileUtils::makeDir($glo_dir);
        if (!is_dir($glo_dir)) {
            throw new ilGlossaryException("Creation of Glossary Directory failed.");
        }
        // create Import subdirectory (data_dir/glo_data/glo_<id>/import)
        $import_dir = $glo_dir . "/import";
        ilFileUtils::makeDir($import_dir);
        if (!is_dir($import_dir)) {
            throw new ilGlossaryException("Creation of Export Directory failed.");
        }
    }

References ilFileUtils\getDataDir(), ILIAS\Survey\Mode\getId(), and ilFileUtils\makeDir().

Here is the call graph for this function:

delete()

ilObjGlossary::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!!

Returns

bool true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

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

                            : bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        // delete terms
        if (!$this->isVirtual()) {
            $terms = $this->getTermList();
            foreach ($terms as $term) {
                $term_obj = new ilGlossaryTerm($term["id"]);
                $term_obj->delete();
            }
        }
 
        // 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;
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

exportFileItems()

ilObjGlossary::exportFileItems	(	string	$a_target_dir,
		ilLog	$expLog
	)

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

     : void {
        foreach ($this->file_ids as $file_id) {
            $expLog->write(date("[y-m-d H:i:s] ") . "File Item " . $file_id);
            $file_obj = new ilObjFile($file_id, false);
            $file_obj->export($a_target_dir);
            unset($file_obj);
        }
    }

References ilLog\write().

Here is the call graph for this function:

exportXML()

ilObjGlossary::exportXML	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst,
		string	$a_target_dir,
		ilLog	$expLog
	)

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

     : void {
        // export glossary
        $attrs = array();
        $attrs["Type"] = "Glossary";
        $a_xml_writer->xmlStartTag("ContentObject", $attrs);
 
        // MetaData
        $this->exportXMLMetaData($a_xml_writer);
 
        // collect media objects
        $terms = $this->getTermList();
        $this->mob_ids = array();
        $this->file_ids = array();
        foreach ($terms as $term) {
            $defs = ilGlossaryDefinition::getDefinitionList($term["id"]);
 
            foreach ($defs as $def) {
                $this->page_object = new ilGlossaryDefPage($def["id"]);
                $this->page_object->buildDom();
                $this->page_object->insertInstIntoIDs(IL_INST_ID);
                $mob_ids = $this->page_object->collectMediaObjects(false);
                $file_ids = ilPCFileList::collectFileItems($this->page_object, $this->page_object->getDomDoc());
                foreach ($mob_ids as $mob_id) {
                    $this->mob_ids[$mob_id] = $mob_id;
                }
                foreach ($file_ids as $file_id) {
                    $this->file_ids[$file_id] = $file_id;
                }
            }
        }
 
        // export media objects
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Media Objects");
        $this->exportXMLMediaObjects($a_xml_writer, $a_inst, $a_target_dir, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Media Objects");
 
        // FileItems
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export File Items");
        $this->exportFileItems($a_target_dir, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export File Items");
 
        // Glossary
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Glossary Items");
        $this->exportXMLGlossaryItems($a_xml_writer, $a_inst, $expLog);
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Glossary Items");
 
        $a_xml_writer->xmlEndTag("ContentObject");
    }

exportXMLGlossaryItems()

ilObjGlossary::exportXMLGlossaryItems	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst,
		ilLog	$expLog
	)

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

     : void {
        $attrs = array();
        $a_xml_writer->xmlStartTag("Glossary", $attrs);
 
        // MetaData
        $this->exportXMLMetaData($a_xml_writer);
 
        $terms = $this->getTermList();
 
        // export glossary terms
        reset($terms);
        foreach ($terms as $term) {
            $expLog->write(date("[y-m-d H:i:s] ") . "Page Object " . $term["obj_id"]);
 
            // export xml to writer object
            $glo_term = new ilGlossaryTerm($term["id"]);
            $glo_term->exportXML($a_xml_writer, $a_inst);
 
            unset($glo_term);
        }
 
        $a_xml_writer->xmlEndTag("Glossary");
    }

exportXMLMediaObjects()

ilObjGlossary::exportXMLMediaObjects	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst,
		string	$a_target_dir,
		ilLog	$expLog
	)

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

     : void {
        foreach ($this->mob_ids as $mob_id) {
            $expLog->write(date("[y-m-d H:i:s] ") . "Media Object " . $mob_id);
            $media_obj = new ilObjMediaObject($mob_id);
            $media_obj->exportXML($a_xml_writer, $a_inst);
            $media_obj->exportFiles($a_target_dir);
            unset($media_obj);
        }
    }

References ilLog\write().

Here is the call graph for this function:

exportXMLMetaData()

ilObjGlossary::exportXMLMetaData

(

ilXmlWriter

$a_xml_writer

)

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

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

getAdvMDSubItemTitle()

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

static

Implements ilAdvancedMetaDataSubItems.

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

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

References $DIC, $lng, and ilGlossaryTerm\_lookGlossaryTerm().

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 395 of file class.ilObjGlossary.php.

     : array {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
 
        if ($this->isVirtual()) {
            $glo_ids = array();
 
            $virtual_mode = $this->getRefId() ? $this->getVirtualMode() : '';
            switch ($virtual_mode) {
                case "level":
                    $glo_arr = $tree->getChildsByType($tree->getParentId($this->getRefId()), "glo");
                    foreach ($glo_arr as $glo) {
                        {
                            if ($ids_are_ref_ids) {
                                $glo_ids[] = (int) $glo['child'];
                            } else {
                                $glo_ids[] = (int) $glo['obj_id'];
                            }
                        }
                    }
                    break;
 
                case "subtree":
                    $subtree_nodes = $tree->getSubTree($tree->getNodeData($tree->getParentId($this->getRefId())));
 
                    foreach ($subtree_nodes as $node) {
                        if ($node['type'] == 'glo') {
                            if ($ids_are_ref_ids) {
                                $glo_ids[] = (int) $node['child'];
                            } else {
                                $glo_ids[] = (int) $node['obj_id'];
                            }
                        }
                    }
                    break;
            }
            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;
    }

References ILIAS\Survey\Mode\getId(), and ILIAS\Repository\int().

Here is the call graph for this function:

getAutoGlossaries()

ilObjGlossary::getAutoGlossaries

(

)

Returns

int[]

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

                                       : array
    {
        return $this->auto_glossaries;
    }

Referenced by ilGlossaryAutoLinkTableGUI\__construct().

Here is the caller graph for this function:

getDeletionDependencies()

static ilObjGlossary::getDeletionDependencies ( int  $obj_id )

static

Get deletion dependencies.

Reimplemented from ilObject.

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

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

References $DIC, $lng, and ilObjSAHSLearningModule\getScormModulesForGlossary().

Here is the call graph for this function:

getExportDirectory()

ilObjGlossary::getExportDirectory

(

string

$a_type = "xml"

)

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

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

References ilExport\_getExportDirectory(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getExportFiles()

ilObjGlossary::getExportFiles

(

)

Get export files.

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

                                    : array
    {
        return ilExport::_getExportFiles($this->getId(), array("xml", "html"), $this->getType());
    }

References ilExport\_getExportFiles(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getFirstLetters()

ilObjGlossary::getFirstLetters

(

int

$a_tax_node = 0

)

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

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

getImportDirectory()

ilObjGlossary::getImportDirectory

(

)

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

                                        : string
    {
        $export_dir = ilFileUtils::getDataDir() . "/glo_data" . "/glo_" . $this->getId() . "/import";
 
        return $export_dir;
    }

References ilFileUtils\getDataDir(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getOnline()

ilObjGlossary::getOnline

(

)

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

                               : bool
    {
        return $this->online;
    }

References $online.

getPresentationMode()

ilObjGlossary::getPresentationMode

(

)

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

                                         : string
    {
        return $this->pres_mode;
    }

References $pres_mode.

getPublicExportFile()

ilObjGlossary::getPublicExportFile

(

string

$a_type

)

get public export file

Parameters

string

$a_type

type ("xml" / "html")

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

                                                       : string
    {
        return $this->public_export_file[$a_type] ?? "";
    }

getShowTaxonomy()

ilObjGlossary::getShowTaxonomy

(

)

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

                                     : bool
    {
        return $this->show_tax;
    }

getSnippetLength()

ilObjGlossary::getSnippetLength

(

)

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

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

getTaxonomyId()

ilObjGlossary::getTaxonomyId

(

)

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

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

References ILIAS\Survey\Mode\getId(), and ilObjTaxonomy\getUsageOfObject().

Here is the call 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 354 of file class.ilObjGlossary.php.

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

getVirtualMode()

ilObjGlossary::getVirtualMode

(

)

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

                                    : string
    {
        return $this->virtual_mode;
    }

References $virtual_mode.

Referenced by create().

Here is the caller graph for this function:

getXMLZip()

ilObjGlossary::getXMLZip

(

)

Reimplemented from ilObject.

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

                               : string
    {
        $glo_exp = new ilGlossaryExport($this);
        return $glo_exp->buildExportFile();
    }

isActiveDownloads()

ilObjGlossary::isActiveDownloads

(

)

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

                                       : bool
    {
        return $this->downloads_active;
    }

isActiveGlossaryMenu()

ilObjGlossary::isActiveGlossaryMenu

(

)

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

                                          : bool
    {
        return $this->glo_menu_active;
    }

isVirtual()

ilObjGlossary::isVirtual

(

)

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

                               : bool
    {
        return $this->virtual;
    }

References $virtual.

lookup()

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

staticprotected

Lookup glossary property.

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

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

lookupAutoGlossaries()

static ilObjGlossary::lookupAutoGlossaries ( int  $a_id )

static

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

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

Referenced by ilGlossaryDefPage\beforePageContentUpdate().

Here is the caller graph for this function:

lookupSnippetLength()

static ilObjGlossary::lookupSnippetLength ( int  $a_id )

static

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

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

Referenced by ilGlossaryDefinition\shortenShortText().

Here is the caller graph for this function:

modifyExportIdentifier()

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

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

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

References ILIAS\Survey\Mode\getId(), and IL_INST_ID.

Here is the call graph for this function:

read()

ilObjGlossary::read

(

)

Reimplemented from ilObject.

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

                          : void
    {
        parent::read();
        #               echo "Glossary<br>\n";
 
        $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"] ?? ""));
        if (isset($gl_rec["public_xml_file"]) && $gl_rec["public_xml_file"] != "") {
            $this->setPublicExportFile("xml", $gl_rec["public_xml_file"]);
        }
        if (isset($gl_rec["public_html_file"]) && $gl_rec["public_html_file"] != "") {
            $this->setPublicExportFile("html", $gl_rec["public_html_file"]);
        }
        $this->setActiveGlossaryMenu(ilUtil::yn2tf($gl_rec["glo_menu_active"]));
        $this->setActiveDownloads(ilUtil::yn2tf($gl_rec["downloads_active"]));
        $this->setPresentationMode((string) $gl_rec["pres_mode"]);
        $this->setSnippetLength((int) $gl_rec["snippet_length"]);
        $this->setShowTaxonomy((bool) $gl_rec["show_tax"]);
 
        // 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);
    }

References ilObject\getId(), setActiveDownloads(), setActiveGlossaryMenu(), setAutoGlossaries(), setOnline(), setPresentationMode(), setPublicExportFile(), setShowTaxonomy(), setSnippetLength(), setVirtualMode(), and ilUtil\yn2tf().

Here is the call graph for this function:

removeAutoGlossary()

ilObjGlossary::removeAutoGlossary

(

int

$a_glo_id

)

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

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

removeOfflineGlossaries()

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

Remove offline glossaries from obj id array.

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

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

References $id, and ilObject\_lookupObjectId().

Here is the call graph for this function:

setActiveDownloads()

ilObjGlossary::setActiveDownloads

(

bool

$a_down

)

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

                                                    : void
    {
        $this->downloads_active = $a_down;
    }

Referenced by read().

Here is the caller graph for this function:

setActiveGlossaryMenu()

ilObjGlossary::setActiveGlossaryMenu

(

bool

$a_act_glo_menu

)

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

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

Referenced by read().

Here is the caller graph for this function:

setAutoGlossaries()

ilObjGlossary::setAutoGlossaries

(

array

$a_val

)

Parameters

int[]

$a_val

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

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

Referenced by read().

Here is the caller graph for this function:

setOnline()

ilObjGlossary::setOnline

(

bool

$a_online

)

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

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

Referenced by read().

Here is the caller graph for this function:

setPresentationMode()

ilObjGlossary::setPresentationMode

(

string

$a_val

)

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

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

Referenced by create(), and read().

Here is the caller graph for this function:

setPublicExportFile()

ilObjGlossary::setPublicExportFile	(	string	$a_type,
		string	$a_file
	)

specify public export file for type

Parameters

string	$a_type	type ("xml" / "html")
string	$a_file	file name

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

     : void {
        $this->public_export_file[$a_type] = $a_file;
    }

Referenced by read().

Here is the caller graph for this function:

setShowTaxonomy()

ilObjGlossary::setShowTaxonomy

(

bool

$a_val

)

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

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

Referenced by read().

Here is the caller graph for this function:

setSnippetLength()

ilObjGlossary::setSnippetLength

(

int

$a_val

)

Set definition snippet length (in overview)

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

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

Referenced by create(), and read().

Here is the caller graph for this function:

setVirtualMode()

ilObjGlossary::setVirtualMode

(

string

$a_mode

)

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

                                                  : void
    {
        switch ($a_mode) {
            case "level":
            case "subtree":
            // case "fixed":
                $this->virtual_mode = $a_mode;
                $this->virtual = true;
                break;
 
            default:
                $this->virtual_mode = "none";
                $this->virtual = false;
                break;
        }
    }

Referenced by read().

Here is the caller graph for this function:

supportsLongTextQuery()

ilObjGlossary::supportsLongTextQuery

(

)

Is long text search supported.

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

                                           : bool
    {
        return true;
    }

update()

ilObjGlossary::update

(

)

Reimplemented from ilObject.

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

                            : bool
    {
        $this->updateMetaData();
 
        $this->db->update(
            'glossary',
            array(
                'is_online' => array('text', ilUtil::tf2yn($this->getOnline())),
                'virtual' => array('text', $this->getVirtualMode()),
                'public_xml_file' => array('text', $this->getPublicExportFile("xml")),
                'public_html_file' => array('text', $this->getPublicExportFile("html")),
                'glo_menu_active' => array('text', ilUtil::tf2yn($this->isActiveGlossaryMenu())),
                'downloads_active' => array('text', ilUtil::tf2yn($this->isActiveDownloads())),
                'pres_mode' => array('text', $this->getPresentationMode()),
                'show_tax' => array('integer', $this->getShowTaxonomy()),
                'snippet_length' => array('integer', $this->getSnippetLength())
            ),
            array(
                'id' => array('integer', $this->getId())
            )
        );
 
        $this->updateAutoGlossaries();
        return parent::update();
    }

References ILIAS\Survey\Mode\getId(), and ilUtil\tf2yn().

Here is the call graph for this function:

updateAutoGlossaries()

ilObjGlossary::updateAutoGlossaries

(

)

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

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

References ILIAS\Survey\Mode\getId().

Referenced by create().

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 38 of file class.ilObjGlossary.php.

$content_style_domain

ILIAS Style Content DomainService ilObjGlossary::$content_style_domain

protected

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

$downloads_active

bool ilObjGlossary::$downloads_active = false

protected

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

$file_ids

array ilObjGlossary::$file_ids = []

protected

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

$glo_menu_active

bool ilObjGlossary::$glo_menu_active = false

protected

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

$mob_ids

array ilObjGlossary::$mob_ids = []

protected

Definition at line 27 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 25 of file class.ilObjGlossary.php.

$pres_mode

string ilObjGlossary::$pres_mode = ""

protected

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

Referenced by getPresentationMode().

$public_export_file

array ilObjGlossary::$public_export_file = []

protected

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

$show_tax

bool ilObjGlossary::$show_tax = false

protected

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

$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 29 of file class.ilObjGlossary.php.

$tpl

ilGlobalTemplateInterface ilObjGlossary::$tpl

protected

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

$user

ilObjUser ilObjGlossary::$user

protected

Definition at line 39 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:

• Modules/Glossary/classes/class.ilObjGlossary.php