Inheritance diagram for ilObjGlossary:

Collaboration diagram for ilObjGlossary:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor @access public. More...

	create ($a_upload=false)
	create glossary object More...

	read ()
	read data of content object More...

	getDescription ()
	get description of glossary object More...

	setDescription ($a_description)
	set description of glossary object More...

	setVirtualMode ($a_mode)
	set glossary type (virtual: fixed/level/subtree, normal:none) More...

	getVirtualMode ()
	get glossary type (normal or virtual) More...

	isVirtual ()
	returns true if glossary type is virtual (any mode) More...

	getTitle ()
	get title of glossary object More...

	setTitle ($a_title)
	set title of glossary object More...

	setPresentationMode ($a_val)
	Set presentation mode. More...

	getPresentationMode ()
	Get presentation mode. More...

	setSnippetLength ($a_val)
	Set snippet length. More...

	getSnippetLength ()
	Get snippet length. More...

	setOnline ($a_online)

	getOnline ()

	setActiveGlossaryMenu ($a_act_glo_menu)

	isActiveGlossaryMenu ()

	setActiveDownloads ($a_down)

	isActiveDownloads ()

	getStyleSheetId ()
	Get ID of assigned style sheet object. More...

	setStyleSheetId ($a_style_id)
	Set ID of assigned style sheet object. More...

	setShowTaxonomy ($a_val)
	Set show taxonomy. More...

	getShowTaxonomy ()
	Get show taxonomy. More...

	setAutoGlossaries ($a_val)
	Set auto glossaries. More...

	addAutoGlossary ($glo_id)
	Add auto glossary. More...

	getAutoGlossaries ()
	Get auto glossaries. More...

	removeAutoGlossary ($a_glo_id)
	Remove auto glossary. More...

	update ()
	Update object. More...

	updateAutoGlossaries ()
	Update auto glossaries. More...

	getTermList ( $searchterm="", $a_letter="", $a_def="", $a_tax_node=0, $a_include_offline_childs=false, $a_add_amet_fields=false, array $a_amet_filter=null, $a_omit_virtual=false, $a_include_references=false)
	Get term list. More...

	getFirstLetters ($a_tax_node=0)
	Get term list. More...

	getAllGlossaryIds ($a_include_offline_childs=false, $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 ()
	get import directory of glossary More...

	createExportDirectory ($a_type="xml")
	Creates export directory. More...

	getExportDirectory ($a_type="xml")
	Get export directory of glossary. More...

	getExportFiles ()
	Get export files. More...

	setPublicExportFile ($a_type, $a_file)
	specify public export file for type More...

	getPublicExportFile ($a_type)
	get public export file More...

	exportHTML ($a_target_dir, $log)
	export html package More...

	exportHTMLGlossaryTerms (&$a_glo_gui, $a_target_dir)
	export glossary terms More...

	exportHTMLMOB ($a_target_dir, &$a_glo_gui, $a_mob_id)
	export media object to html More...

	exportHTMLFile ($a_target_dir, $a_file_id)
	export file object More...

	exportXML (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)
	export object to xml (see ilias_co.dtd) More...

	exportXMLGlossaryItems (&$a_xml_writer, $a_inst, &$expLog)
	export page objects to xml (see ilias_co.dtd) More...

	exportXMLMetaData (&$a_xml_writer)
	export content objects meta data to xml (see ilias_co.dtd) More...

	exportXMLMediaObjects (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)
	export media objects to xml (see ilias_co.dtd) More...

	exportFileItems ($a_target_dir, &$expLog)
	export files of file itmes More...

	modifyExportIdentifier ($a_tag, $a_param, $a_value)

	delete ()
	delete glossary and all related data More...

	getXMLZip ()
	Get zipped xml file for glossary. More...

	getTaxonomyId ()
	Get taxonomy. More...

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone glossary. More...

	removeOfflineGlossaries ($a_glo_ids, $ids_are_ref_ids=false)
	Remove offline glossaries from obj id array. More...

	autoLinkGlossaryTerms ($a_glo_ref_id)
	Auto link glossary terms. More...

	supportsLongTextQuery ()
	Is long text search supported. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_lookupOnline ($a_id)
	check wether content object is online More...

static	lookupSnippetLength ($a_id)
	Lookup snippet length. More...

static	lookupAutoGlossaries ($a_id)
	Lookup auto glossaries. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getAdvMDSubItemTitle ($a_obj_id, $a_sub_type, $a_sub_id)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

static	getAdvMDSubItemTitle ($a_obj_id, $a_sub_type, $a_sub_id)

Data Fields
	$auto_glossaries = array()

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

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

Protected Attributes
	$tpl

	$db

	$user

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjGlossary.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor @access public.

Reimplemented from ilObject.

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

    {
        global $DIC;
        $this->error = $DIC["ilErr"];
        $this->tpl = $DIC["tpl"];
 
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->type = "glo";
        parent::__construct($a_id, $a_call_by_reference);
    }

References $DIC, error(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ _lookupOnline()

static ilObjGlossary::_lookupOnline ( $a_id )

static

check wether content object is online

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

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

References $db, $DIC, $lm_set, and ilUtil\yn2tf().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAutoGlossary()

ilObjGlossary::addAutoGlossary ( $glo_id )

Add auto glossary.

Parameters

int $glo_id

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

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

References ilObject\_lookupType().

Referenced by setAutoGlossaries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ autoLinkGlossaryTerms()

ilObjGlossary::autoLinkGlossaryTerms ( $a_glo_ref_id )

Auto link glossary terms.

Parameters

return

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

    {
        // get terms of target glossary
        include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
        $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; $j < count($source_defs); $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 (!is_object($found_pages[$def["id"]]["page"])) {
                            $found_pages[$def["id"]]["page"] = $pg;
                        }
                    }
                }
                reset($terms);
            }
        }
 
        // ilPCParagraph autoLinkGlossariesPage with page and terms
        include_once("./Services/COPage/classes/class.ilPCParagraph.php");
        foreach ($found_pages as $id => $fp) {
            ilPCParagraph::autoLinkGlossariesPage($fp["page"], $fp["terms"]);
        }
    }

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

Here is the call graph for this function:

◆ cloneObject()

ilObjGlossary::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone glossary.

Parameters

int	target ref_id
int	copy id

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

    {
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
        $this->cloneMetaData($new_obj);
 
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_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
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $style_id = $this->getStyleSheetId();
        if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id)) {
            include_once("./Services/Object/classes/class.ilObjectFactory.php");
            $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
            $new_id = $style_obj->ilClone();
            $new_obj->setStyleSheetId($new_id);
            $new_obj->update();
        }
        
        // copy taxonomy
        if (($tax_id = $this->getTaxonomyId()) > 0) {
            // clone it
            include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
            $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());
        }
        
        // assign new tax/new glossary
        // handle mapping
        
        // prepare tax node assignments objects
        include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
        if ($tax_id > 0) {
            $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', (array) $term_mappings);
        }
 
 
        return $new_obj;
    }

References $map, ilGlossaryTerm\_copyTerm(), ilCopyWizardOptions\_getInstance(), ilObjStyleSheet\_lookupStandard(), ilObject\cloneMetaData(), getAutoGlossaries(), getDescription(), ilObject\getId(), ilObjectFactory\getInstanceByObjId(), getOnline(), getPresentationMode(), ilObject\getRefId(), getSnippetLength(), getStyleSheetId(), getTaxonomyId(), ilGlossaryTerm\getTermList(), getVirtualMode(), and ilObjTaxonomy\saveUsage().

Here is the call graph for this function:

◆ create()

ilObjGlossary::create ( $a_upload = false )

create glossary object

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

    {
        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();
 
        if (((int) $this->getStyleSheetId()) > 0) {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
        }
    }

References ilObject\createMetaData(), ilObject\getId(), getStyleSheetId(), getVirtualMode(), setPresentationMode(), setSnippetLength(), updateAutoGlossaries(), and ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

◆ createExportDirectory()

ilObjGlossary::createExportDirectory ( $a_type = "xml" )

Creates export directory.

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

    {
        include_once("./Services/Export/classes/class.ilExport.php");
        return ilExport::_createExportDirectory($this->getId(), $a_type, $this->getType());
    }

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

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

    {
        $ilErr = $this->error;
 
        $glo_data_dir = ilUtil::getDataDir() . "/glo_data";
        ilUtil::makeDir($glo_data_dir);
        if (!is_writable($glo_data_dir)) {
            $ilErr->raiseError("Glossary Data Directory (" . $glo_data_dir
                . ") not writeable.", $ilErr->error_obj->FATAL);
        }
 
        // create glossary directory (data_dir/glo_data/glo_<id>)
        $glo_dir = $glo_data_dir . "/glo_" . $this->getId();
        ilUtil::makeDir($glo_dir);
        if (!@is_dir($glo_dir)) {
            $ilErr->raiseError("Creation of Glossary Directory failed.", $ilErr->FATAL);
        }
        // create Import subdirectory (data_dir/glo_data/glo_<id>/import)
        $import_dir = $glo_dir . "/import";
        ilUtil::makeDir($import_dir);
        if (!@is_dir($import_dir)) {
            $ilErr->raiseError("Creation of Export Directory failed.", $ilErr->FATAL);
        }
    }

References ilObject\$error, $ilErr, ilUtil\getDataDir(), ilObject\getId(), and ilUtil\makeDir().

Here is the call graph for this function:

◆ delete()

ilObjGlossary::delete ( )

delete glossary and all related data

this method has been tested on may 9th 2004 meta data, terms, definitions, definition meta data and definition pages have been deleted correctly as desired

@access public

Returns: boolean true if all object data were removed; false if only a references were removed

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

    {
        // 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
        include_once("./Modules/Glossary/classes/class.ilGlossaryTermReferences.php");
        $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 ilObject\deleteMetaData(), ilObject\getId(), getTermList(), and isVirtual().

Here is the call graph for this function:

◆ exportFileItems()

ilObjGlossary::exportFileItems	(		$a_target_dir,
		&	$expLog
	)

export files of file itmes

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

    {
        include_once("./Modules/File/classes/class.ilObjFile.php");
 
        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);
        }
    }

Referenced by exportXML().

Here is the caller graph for this function:

◆ exportHTML()

ilObjGlossary::exportHTML	(	$a_target_dir,
		$log
	)

export html package

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

    {
        $tpl = $this->tpl;
 
        // initialize temporary target directory
        ilUtil::delDir($a_target_dir);
        ilUtil::makeDir($a_target_dir);
        
        // init mathjax rendering for export
        include_once './Services/MathJax/classes/class.ilMathJax.php';
        ilMathJax::getInstance()->init(ilMathJax::PURPOSE_EXPORT);
 
        include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
        $this->co_page_html_export = new ilCOPageHTMLExport($a_target_dir);
        $this->co_page_html_export->createDirectories();
 
        // export system style sheet
        $location_stylesheet = ilUtil::getStyleSheetLocation("filesystem");
        $style_name = $this->user->prefs["style"] . ".css";
        copy($location_stylesheet, $a_target_dir . "/" . $style_name);
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        
        if ($this->getStyleSheetId() < 1) {
            $cont_stylesheet = "Services/COPage/css/content.css";
            copy($cont_stylesheet, $a_target_dir . "/content.css");
        } else {
            $content_style_img_dir = $a_target_dir . "/images";
            ilUtil::makeDir($content_style_img_dir);
            $style = new ilObjStyleSheet($this->getStyleSheetId());
            $style->writeCSSFile($a_target_dir . "/content.css", "images");
            $style->copyImagesToDir($content_style_img_dir);
        }
        
        // export syntax highlighting style
        $syn_stylesheet = ilObjStyleSheet::getSyntaxStylePath();
        copy($syn_stylesheet, $a_target_dir . "/syntaxhighlight.css");
 
        // get glossary presentation gui class
        include_once("./Modules/Glossary/classes/class.ilGlossaryPresentationGUI.php");
        $_GET["cmd"] = "nop";
        $glo_gui = new ilGlossaryPresentationGUI();
        $glo_gui->setOfflineMode(true);
        $glo_gui->setOfflineDirectory($a_target_dir);
        
        // could be implemented in the future if other export
        // formats are supported (e.g. scorm)
        //$glo_gui->setExportFormat($a_export_format);
 
        // export terms
        $this->exportHTMLGlossaryTerms($glo_gui, $a_target_dir);
                
        // export all media objects
        foreach ($this->offline_mobs as $mob) {
            $this->exportHTMLMOB($a_target_dir, $glo_gui, $mob, "_blank");
        }
        $_GET["obj_type"] = "MediaObject";
        $_GET["obj_id"] = $a_mob_id;
        $_GET["cmd"] = "";
        
        // export all file objects
        foreach ($this->offline_files as $file) {
            $this->exportHTMLFile($a_target_dir, $file);
        }
        
        // export images
        $image_dir = $a_target_dir . "/images";
        ilUtil::makeDir($image_dir);
        ilUtil::makeDir($image_dir . "/browser");
        copy(
            ilUtil::getImagePath("enlarge.svg", false, "filesystem"),
            $image_dir . "/enlarge.svg"
        );
        copy(
            ilUtil::getImagePath("browser/blank.png", false, "filesystem"),
            $image_dir . "/browser/plus.png"
        );
        copy(
            ilUtil::getImagePath("browser/blank.png", false, "filesystem"),
            $image_dir . "/browser/minus.png"
        );
        copy(
            ilUtil::getImagePath("browser/blank.png", false, "filesystem"),
            $image_dir . "/browser/blank.png"
        );
        copy(
            ilUtil::getImagePath("icon_st.svg", false, "filesystem"),
            $image_dir . "/icon_st.svg"
        );
        copy(
            ilUtil::getImagePath("icon_pg.svg", false, "filesystem"),
            $image_dir . "/icon_pg.svg"
        );
        copy(
            ilUtil::getImagePath("nav_arr_L.png", false, "filesystem"),
            $image_dir . "/nav_arr_L.png"
        );
        copy(
            ilUtil::getImagePath("nav_arr_R.png", false, "filesystem"),
            $image_dir . "/nav_arr_R.png"
        );
            
        // template workaround: reset of template
        $tpl = new ilTemplate("tpl.main.html", true, true);
        $tpl->setVariable("LOCATION_STYLESHEET", $location_stylesheet);
        $tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
        
        // zip everything
        if (true) {
            // zip it all
            $date = time();
            $zip_file = $this->getExportDirectory("html") . "/" . $date . "__" . IL_INST_ID . "__" .
                $this->getType() . "_" . $this->getId() . ".zip";
            //echo "zip-".$a_target_dir."-to-".$zip_file;
            ilUtil::zip($a_target_dir, $zip_file);
            ilUtil::delDir($a_target_dir);
        }
    }

References $_GET, $style, $tpl, ilUtil\delDir(), exportHTMLFile(), exportHTMLGlossaryTerms(), exportHTMLMOB(), getExportDirectory(), ilObject\getId(), ilUtil\getImagePath(), ilMathJax\getInstance(), getStyleSheetId(), ilUtil\getStyleSheetLocation(), ilObjStyleSheet\getSyntaxStylePath(), ilObject\getType(), ilUtil\makeDir(), ilMathJax\PURPOSE_EXPORT, user(), and ilUtil\zip().

Here is the call graph for this function:

◆ exportHTMLFile()

ilObjGlossary::exportHTMLFile	(	$a_target_dir,
		$a_file_id
	)

export file object

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

    {
        $file_dir = $a_target_dir . "/files/file_" . $a_file_id;
        ilUtil::makeDir($file_dir);
        include_once("./Modules/File/classes/class.ilObjFile.php");
        $file_obj = new ilObjFile($a_file_id, false);
        $source_file = $file_obj->getDirectory($file_obj->getVersion()) . "/" . $file_obj->getFileName();
        if (!is_file($source_file)) {
            $source_file = $file_obj->getDirectory() . "/" . $file_obj->getFileName();
        }
        copy($source_file, $file_dir . "/" . $file_obj->getFileName());
    }

References ilUtil\makeDir().

Referenced by exportHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportHTMLGlossaryTerms()

ilObjGlossary::exportHTMLGlossaryTerms	(	&	$a_glo_gui,
			$a_target_dir
	)

export glossary terms

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

    {
        include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
        $copage_export = new ilCOPageHTMLExport($a_target_dir);
        $copage_export->exportSupportScripts();
        
        // index.html file
        $a_glo_gui->tpl = new ilTemplate("tpl.main.html", true, true);
        $style_name = $this->user->prefs["style"] . ".css";
        ;
        $a_glo_gui->tpl->setVariable("LOCATION_STYLESHEET", "./" . $style_name);
        $a_glo_gui->tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
        $a_glo_gui->tpl->setTitle($this->getTitle());
 
        $content = $a_glo_gui->listTerms();
        $file = $a_target_dir . "/index.html";
                        
        // open file
        if (!($fp = @fopen($file, "w+"))) {
            die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
        }
        chmod($file, 0770);
        fwrite($fp, $content);
        fclose($fp);
        
        $terms = $this->getTermList();
        
        $this->offline_mobs = array();
        $this->offline_files = array();
        
        foreach ($terms as $term) {
            $a_glo_gui->tpl = new ilTemplate("tpl.main.html", true, true);
            $a_glo_gui->tpl = $copage_export->getPreparedMainTemplate();
            //$tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
            
            // set style
            $style_name = $this->user->prefs["style"] . ".css";
            ;
            $a_glo_gui->tpl->setVariable("LOCATION_STYLESHEET", "./" . $style_name);
 
            $_GET["term_id"] = $term["id"];
            $_GET["frame"] = "_blank";
            $content = $a_glo_gui->listDefinitions($_GET["ref_id"], $term["id"], false);
            $file = $a_target_dir . "/term_" . $term["id"] . ".html";
                            
            // open file
            if (!($fp = @fopen($file, "w+"))) {
                die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                    " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
            }
            chmod($file, 0770);
            fwrite($fp, $content);
            fclose($fp);
 
            // store linked/embedded media objects of glosssary term
            include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
            $defs = ilGlossaryDefinition::getDefinitionList($term["id"]);
            foreach ($defs as $def) {
                $def_mobs = ilObjMediaObject::_getMobsOfObject("gdf:pg", $def["id"]);
                foreach ($def_mobs as $def_mob) {
                    $this->offline_mobs[$def_mob] = $def_mob;
                }
                
                // get all files of page
                include_once("./Modules/File/classes/class.ilObjFile.php");
                $def_files = ilObjFile::_getFilesOfObject("gdf:pg", $def["id"]);
                $this->offline_files = array_merge($this->offline_files, $def_files);
            }
        }
    }

References $_GET, $def, ilObjFile\_getFilesOfObject(), ilObjMediaObject\_getMobsOfObject(), ilGlossaryDefinition\getDefinitionList(), getTermList(), getTitle(), and user().

Referenced by exportHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportHTMLMOB()

ilObjGlossary::exportHTMLMOB	(		$a_target_dir,
		&	$a_glo_gui,
			$a_mob_id
	)

export media object to html

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

    {
        $tpl = $this->tpl;
 
        $mob_dir = $a_target_dir . "/mobs";
 
        $source_dir = ilUtil::getWebspaceDir() . "/mobs/mm_" . $a_mob_id;
        if (@is_dir($source_dir)) {
            ilUtil::makeDir($mob_dir . "/mm_" . $a_mob_id);
            ilUtil::rCopy($source_dir, $mob_dir . "/mm_" . $a_mob_id);
        }
        
        $tpl = new ilTemplate("tpl.main.html", true, true);
        $tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
        $_GET["obj_type"] = "MediaObject";
        $_GET["mob_id"] = $a_mob_id;
        $_GET["cmd"] = "";
        $content = $a_glo_gui->media();
        $file = $a_target_dir . "/media_" . $a_mob_id . ".html";
 
        // open file
        if (!($fp = @fopen($file, "w+"))) {
            die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
        }
        chmod($file, 0770);
        fwrite($fp, $content);
        fclose($fp);
        
        // fullscreen
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
        $mob_obj = new ilObjMediaObject($a_mob_id);
        if ($mob_obj->hasFullscreenItem()) {
            $tpl = new ilTemplate("tpl.main.html", true, true);
            $tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
            $_GET["mob_id"] = $a_mob_id;
            $_GET["cmd"] = "fullscreen";
            $content = $a_glo_gui->fullscreen();
            $file = $a_target_dir . "/fullscreen_" . $a_mob_id . ".html";
    
            // open file
            if (!($fp = @fopen($file, "w+"))) {
                die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                    " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
            }
            chmod($file, 0770);
            fwrite($fp, $content);
            fclose($fp);
        }
    }

References $_GET, $tpl, ilUtil\getWebspaceDir(), ilUtil\makeDir(), and ilUtil\rCopy().

Referenced by exportHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXML()

ilObjGlossary::exportXML	(	&	$a_xml_writer,
			$a_inst,
			$a_target_dir,
		&	$expLog
	)

export object to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

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

    {
        // 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) {
            include_once "./Modules/Glossary/classes/class.ilGlossaryDefinition.php";
            
            $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);
                include_once("./Services/COPage/classes/class.ilPCFileList.php");
                $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");
    }

References $def, ilPCFileList\collectFileItems(), exportFileItems(), exportXMLGlossaryItems(), exportXMLMediaObjects(), exportXMLMetaData(), ilGlossaryDefinition\getDefinitionList(), and getTermList().

Here is the call graph for this function:

◆ exportXMLGlossaryItems()

ilObjGlossary::exportXMLGlossaryItems	(	&	$a_xml_writer,
			$a_inst,
		&	$expLog
	)

export page objects to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

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

    {
        $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 " . $page["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");
    }

References exportXMLMetaData(), and getTermList().

Referenced by exportXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXMLMediaObjects()

ilObjGlossary::exportXMLMediaObjects	(	&	$a_xml_writer,
			$a_inst,
			$a_target_dir,
		&	$expLog
	)

export media objects to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

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

    {
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
 
        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);
        }
    }

Referenced by exportXML().

Here is the caller graph for this function:

◆ exportXMLMetaData()

ilObjGlossary::exportXMLMetaData ( & $a_xml_writer )

export content objects meta data to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

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

    {
        include_once("Services/MetaData/classes/class.ilMD2XML.php");
        $md2xml = new ilMD2XML($this->getId(), 0, $this->getType());
        $md2xml->setExportMode(true);
        $md2xml->startExport();
        $a_xml_writer->appendXML($md2xml->getXML());
    }

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

Referenced by exportXML(), and exportXMLGlossaryItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdvMDSubItemTitle()

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

static

Implements ilAdvancedMetaDataSubItems.

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

    {
        global $DIC;
 
        $lng = $DIC->language();
        
        if ($a_sub_type == "term") {
            $lng->loadLanguageModule("glo");
            
            include_once "Modules/Glossary/classes/class.ilGlossaryTerm.php";
            return $lng->txt("glo_term") . ' "' . ilGlossaryTerm::_lookGlossaryTerm($a_sub_id) . '"';
        }
    }

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

Here is the call graph for this function:

◆ getAllGlossaryIds()

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

Get all glossary ids.

Parameters

return

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

    {
        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[] = $glo['child'];
                            } else {
                                $glo_ids[] = $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[] = $node['child'];
                            } else {
                                $glo_ids[] = $node['obj_id'];
                            }
                        }
                    }
                    break;
            }
            if (!$a_include_offline_childs) {
                $glo_ids = ilObjGlossary::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();
                }
            } else {
                if (!in_array($this->getId(), $glo_ids)) {
                    $glo_ids[] = $this->getId();
                }
            }
        } else {
            if ($ids_are_ref_ids) {
                $glo_ids = $this->getRefId();
            } else {
                $glo_ids = $this->getId();
            }
        }
        
        return $glo_ids;
    }

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

Referenced by getFirstLetters(), and getTermList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAutoGlossaries()

ilObjGlossary::getAutoGlossaries ( )

Get auto glossaries.

Returns: array int

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

    {
        return $this->auto_glossaries;
    }

References $auto_glossaries.

Referenced by ilGlossaryAutoLinkTableGUI\__construct(), cloneObject(), removeAutoGlossary(), and updateAutoGlossaries().

Here is the caller graph for this function:

◆ getDeletionDependencies()

static ilObjGlossary::getDeletionDependencies ( $a_obj_id )

static

Get deletion dependencies.

Reimplemented from ilObject.

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

    {
        global $DIC;
 
        $lng = $DIC->language();
        
        $dep = array();
        include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php");
        $sms = ilObjSAHSLearningModule::getScormModulesForGlossary($a_obj_id);
        foreach ($sms as $sm) {
            $lng->loadLanguageModule("content");
            $dep[$sm] = $lng->txt("glo_used_in_scorm");
        }
        //echo "-".$a_obj_id."-";
        //var_dump($dep);
        return $dep;
    }

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

Here is the call graph for this function:

◆ getDescription()

ilObjGlossary::getDescription ( )

get description of glossary object

Returns: string description

Reimplemented from ilObject.

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

    {
        return parent::getDescription();
    }

References Gettext\Languages\Exporter\getDescription().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportDirectory()

ilObjGlossary::getExportDirectory ( $a_type = "xml" )

Get export directory of glossary.

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

    {
        include_once("./Services/Export/classes/class.ilExport.php");
        return ilExport::_getExportDirectory($this->getId(), $a_type, $this->getType());
    }

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

Referenced by exportHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportFiles()

ilObjGlossary::getExportFiles ( )

Get export files.

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

    {
        include_once("./Services/Export/classes/class.ilExport.php");
        return ilExport::_getExportFiles($this->getId(), array("xml", "html"), $this->getType());
    }

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

Here is the call graph for this function:

◆ getFirstLetters()

ilObjGlossary::getFirstLetters ( $a_tax_node = 0 )

Get term list.

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

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

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

Here is the call graph for this function:

◆ getImportDirectory()

ilObjGlossary::getImportDirectory ( )

get import directory of glossary

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

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

References ilUtil\getDataDir(), and ilObject\getId().

Here is the call graph for this function:

◆ getOnline()

ilObjGlossary::getOnline ( )

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

    {
        return $this->online;
    }

Referenced by cloneObject(), and update().

Here is the caller graph for this function:

◆ getPresentationMode()

ilObjGlossary::getPresentationMode ( )

Get presentation mode.

Returns: string presentation mode

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

    {
        return $this->pres_mode;
    }

Referenced by cloneObject(), and update().

Here is the caller graph for this function:

◆ getPublicExportFile()

ilObjGlossary::getPublicExportFile ( $a_type )

get public export file

Parameters

string $a_type type ("xml" / "html")

Returns: string $a_file file name

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

    {
        return $this->public_export_file[$a_type];
    }

References $a_type.

Referenced by update().

Here is the caller graph for this function:

◆ getShowTaxonomy()

ilObjGlossary::getShowTaxonomy ( )

Get show taxonomy.

Returns: bool show taxonomy

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

    {
        return $this->show_tax;
    }

Referenced by update().

Here is the caller graph for this function:

◆ getSnippetLength()

ilObjGlossary::getSnippetLength ( )

Get snippet length.

Returns: int snippet length

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

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

Referenced by cloneObject(), and update().

Here is the caller graph for this function:

◆ getStyleSheetId()

ilObjGlossary::getStyleSheetId ( )

Get ID of assigned style sheet object.

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

    {
        return $this->style_id;
    }

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

Here is the caller graph for this function:

◆ getTaxonomyId()

ilObjGlossary::getTaxonomyId ( )

Get taxonomy.

Returns: int taxononmy ID

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

    {
        include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
        $tax_ids = ilObjTaxonomy::getUsageOfObject($this->getId());
        if (count($tax_ids) > 0) {
            // glossaries handle max. one taxonomy
            return $tax_ids[0];
        }
        return 0;
    }

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

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTermList()

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

Get term list.

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

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

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

Referenced by delete(), exportHTMLGlossaryTerms(), exportXML(), and exportXMLGlossaryItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilObjGlossary::getTitle ( )

get title of glossary object

Returns: string title

Reimplemented from ilObject.

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

    {
        return parent::getTitle();
    }

Referenced by exportHTMLGlossaryTerms().

Here is the caller graph for this function:

◆ getVirtualMode()

ilObjGlossary::getVirtualMode ( )

get glossary type (normal or virtual)

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

    {
        return $this->virtual_mode;
    }

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

Here is the caller graph for this function:

◆ getXMLZip()

ilObjGlossary::getXMLZip ( )

Get zipped xml file for glossary.

Reimplemented from ilObject.

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

    {
        include_once("./Modules/Glossary/classes/class.ilGlossaryExport.php");
        $glo_exp = new ilGlossaryExport($this);
        return $glo_exp->buildExportFile();
    }

◆ isActiveDownloads()

ilObjGlossary::isActiveDownloads ( )

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

    {
        return $this->downloads_active;
    }

Referenced by update().

Here is the caller graph for this function:

◆ isActiveGlossaryMenu()

ilObjGlossary::isActiveGlossaryMenu ( )

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

    {
        return $this->glo_menu_active;
    }

Referenced by update().

Here is the caller graph for this function:

◆ isVirtual()

ilObjGlossary::isVirtual ( )

returns true if glossary type is virtual (any mode)

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

    {
        return $this->virtual;
    }

Referenced by delete(), and getAllGlossaryIds().

Here is the caller graph for this function:

◆ lookup()

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

staticprotected

Lookup glossary property.

Parameters

int	glossary id
string	property

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

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

References $db, and $DIC.

Referenced by lookupSnippetLength().

Here is the caller graph for this function:

◆ lookupAutoGlossaries()

static ilObjGlossary::lookupAutoGlossaries ( $a_id )

static

Lookup auto glossaries.

Parameters

return

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

    {
        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[] = $rec["glo_id"];
        }
        return $glos;
    }

References $db, and $DIC.

Referenced by ilGlossaryDefPage\beforePageContentUpdate().

Here is the caller graph for this function:

◆ lookupSnippetLength()

static ilObjGlossary::lookupSnippetLength ( $a_id )

static

Lookup snippet length.

Parameters

int	glossary id

Returns: int snippet length

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

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

References lookup().

Referenced by ilGlossaryDefinition\shortenShortText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyExportIdentifier()

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

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ read()

ilObjGlossary::read ( )

read data of content object

Reimplemented from ilObject.

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

    {
        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($gl_rec["virtual"]);
        $this->setPublicExportFile("xml", $gl_rec["public_xml_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($gl_rec["pres_mode"]);
        $this->setSnippetLength($gl_rec["snippet_length"]);
        $this->setShowTaxonomy($gl_rec["show_tax"]);
        
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));
 
        // 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(), ilObjStyleSheet\lookupObjectStyle(), setActiveDownloads(), setActiveGlossaryMenu(), setAutoGlossaries(), setOnline(), setPresentationMode(), setPublicExportFile(), setShowTaxonomy(), setSnippetLength(), setStyleSheetId(), setVirtualMode(), and ilUtil\yn2tf().

Here is the call graph for this function:

◆ removeAutoGlossary()

ilObjGlossary::removeAutoGlossary ( $a_glo_id )

Remove auto glossary.

Parameters

return

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

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

References getAutoGlossaries(), and setAutoGlossaries().

Here is the call graph for this function:

◆ removeOfflineGlossaries()

ilObjGlossary::removeOfflineGlossaries	(	$a_glo_ids,
		$ids_are_ref_ids = `false`
	)

Remove offline glossaries from obj id array.

Parameters

return

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

    {
        $glo_ids = $a_glo_ids;
        if ($ids_are_ref_ids) {
            $glo_ids = array_map(function ($id) {
                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, function ($ref_id) use ($online_glo_ids) {
            return in_array(ilObject::_lookupObjectId($ref_id), $online_glo_ids);
        });
 
 
        return $online_ref_ids;
    }

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

Referenced by getAllGlossaryIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActiveDownloads()

ilObjGlossary::setActiveDownloads ( $a_down )

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

    {
        $this->downloads_active = $a_down;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setActiveGlossaryMenu()

ilObjGlossary::setActiveGlossaryMenu ( $a_act_glo_menu )

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

    {
        $this->glo_menu_active = $a_act_glo_menu;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setAutoGlossaries()

ilObjGlossary::setAutoGlossaries ( $a_val )

Set auto glossaries.

Parameters

array $a_val int

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

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

References addAutoGlossary().

Referenced by read(), and removeAutoGlossary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDescription()

ilObjGlossary::setDescription ( $a_description )

set description of glossary object

Reimplemented from ilObject.

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

    {
        parent::setDescription($a_description);
    }

◆ setOnline()

ilObjGlossary::setOnline ( $a_online )

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

    {
        $this->online = $a_online;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setPresentationMode()

ilObjGlossary::setPresentationMode ( $a_val )

Set presentation mode.

Parameters

string presentation mode

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

    {
        $this->pres_mode = $a_val;
    }

Referenced by create(), and read().

Here is the caller graph for this function:

◆ setPublicExportFile()

ilObjGlossary::setPublicExportFile	(	$a_type,
		$a_file
	)

specify public export file for type

Parameters

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

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

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

References $a_type.

Referenced by read().

Here is the caller graph for this function:

◆ setShowTaxonomy()

ilObjGlossary::setShowTaxonomy ( $a_val )

Set show taxonomy.

Parameters

bool $a_val show taxonomy

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

    {
        $this->show_tax = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setSnippetLength()

ilObjGlossary::setSnippetLength ( $a_val )

Set snippet length.

Parameters

int	snippet length

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

    {
        $this->snippet_length = $a_val;
    }

Referenced by create(), and read().

Here is the caller graph for this function:

◆ setStyleSheetId()

ilObjGlossary::setStyleSheetId ( $a_style_id )

Set ID of assigned style sheet object.

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

    {
        $this->style_id = $a_style_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTitle()

ilObjGlossary::setTitle ( $a_title )

set title of glossary object

Reimplemented from ilObject.

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

    {
        parent::setTitle($a_title);
        //              $this->meta_data->setTitle($a_title);
    }

◆ setVirtualMode()

ilObjGlossary::setVirtualMode ( $a_mode )

set glossary type (virtual: fixed/level/subtree, normal:none)

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

    {
        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.

Returns: bool

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

    {
        return true;
    }

◆ update()

ilObjGlossary::update ( )

Update object.

Reimplemented from ilObject.

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

    {
        $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())
            )
        );
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
 
        $this->updateAutoGlossaries();
        parent::update();
    }

References ilObject\getId(), getOnline(), getPresentationMode(), getPublicExportFile(), getShowTaxonomy(), getSnippetLength(), getStyleSheetId(), getVirtualMode(), isActiveDownloads(), isActiveGlossaryMenu(), ilUtil\tf2yn(), League\Flysystem\Adapter\Polyfill\update(), updateAutoGlossaries(), ilObject\updateMetaData(), and ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

◆ updateAutoGlossaries()

ilObjGlossary::updateAutoGlossaries ( )

Update auto glossaries.

Parameters

return

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

    {
        // 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 getAutoGlossaries(), and ilObject\getId().

Referenced by create(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $auto_glossaries

ilObjGlossary::$auto_glossaries = array()

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

Referenced by getAutoGlossaries().

◆ $db

ilObjGlossary::$db

protected

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

Referenced by _lookupOnline(), lookup(), and lookupAutoGlossaries().

◆ $tpl

ilObjGlossary::$tpl

protected

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

Referenced by exportHTML(), and exportHTMLMOB().

◆ $user

ilObjGlossary::$user

protected

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

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

Modules/Glossary/classes/class.ilObjGlossary.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookupOnline()

◆ addAutoGlossary()

◆ autoLinkGlossaryTerms()

◆ cloneObject()

◆ create()

◆ createExportDirectory()

◆ createImportDirectory()

◆ delete()

◆ exportFileItems()

◆ exportHTML()

◆ exportHTMLFile()

◆ exportHTMLGlossaryTerms()

◆ exportHTMLMOB()

◆ exportXML()

◆ exportXMLGlossaryItems()

◆ exportXMLMediaObjects()

◆ exportXMLMetaData()

◆ getAdvMDSubItemTitle()

◆ getAllGlossaryIds()

◆ getAutoGlossaries()

◆ getDeletionDependencies()

◆ getDescription()

◆ getExportDirectory()

◆ getExportFiles()

◆ getFirstLetters()

◆ getImportDirectory()

◆ getOnline()

◆ getPresentationMode()

◆ getPublicExportFile()

◆ getShowTaxonomy()

◆ getSnippetLength()

◆ getStyleSheetId()

◆ getTaxonomyId()

◆ getTermList()

◆ getTitle()

◆ getVirtualMode()

◆ getXMLZip()

◆ isActiveDownloads()

◆ isActiveGlossaryMenu()

◆ isVirtual()

◆ lookup()

◆ lookupAutoGlossaries()

◆ lookupSnippetLength()

◆ modifyExportIdentifier()

◆ read()

◆ removeAutoGlossary()

◆ removeOfflineGlossaries()

◆ setActiveDownloads()

◆ setActiveGlossaryMenu()

◆ setAutoGlossaries()

◆ setDescription()

◆ setOnline()

◆ setPresentationMode()

◆ setPublicExportFile()

◆ setShowTaxonomy()

◆ setSnippetLength()

◆ setStyleSheetId()

◆ setTitle()

◆ setVirtualMode()

◆ supportsLongTextQuery()

◆ update()

◆ updateAutoGlossaries()

Field Documentation

◆ $auto_glossaries

◆ $db

◆ $tpl

◆ $user