ilObjGlossary Class Reference
Class ilObjGlossary. More...
Inheritance diagram for ilObjGlossary:
Collaboration diagram for ilObjGlossary:
Public Member Functions | |
| ilObjGlossary ($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 () | |
| _lookupOnline ($a_id) | |
| check wether content object is online More... | |
| 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... | |
| update () | |
| Update object. 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) | |
| Get term list. More... | |
| getFirstLetters ($a_tax_node=0) | |
| Get term list. More... | |
| getAllGlossaryIds ($a_include_offline_childs=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... | |
| notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
| notifys an object about an event occured Based on the event happend, each object may decide how it reacts. More... | |
| getXMLZip () | |
| Get zipped xml file for glossary. More... | |
| getTaxonomyId () | |
| Get taxonomy. More... | |
| cloneObject ($a_target_id, $a_copy_id=0) | |
| Clone glossary. More... | |
| removeOfflineGlossaries ($a_glo_ids) | |
| Remove offline glossaries from obj id array. More... | |
| Public Member Functions inherited from ilObject | |
| ilObject ($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 ($a_force_db=false) | |
| 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... | |
| getOwner () | |
| get object owner More... | |
| getOwnerName () | |
| _lookupOwnerName ($a_owner_id) | |
| lookup owner name for owner id More... | |
| setOwner ($a_owner) | |
| set object owner More... | |
| getCreateDate () | |
| get create date @access public More... | |
| getLastUpdateDate () | |
| get last update date @access public More... | |
| getDiskUsage () | |
| setObjDataRecord ($a_record) | |
| set object_data record (note: this method should only be called from the ilObjectFactory class) 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... | |
| _getIdForImportId ($a_import_id) | |
| get current object id for import id (static) More... | |
| _lookupOwner ($a_id) | |
| lookup object owner More... | |
| _lookupLastUpdate ($a_id, $a_as_string=false) | |
| lookup last update More... | |
| _getLastUpdateOfObjects ($a_objs) | |
| Get last update for a set of media objects. More... | |
| _setDeletedDate ($a_ref_id) | |
| only called in ilTree::saveSubTree More... | |
| _resetDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes More... | |
| _lookupDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes More... | |
| _writeTitle ($a_obj_id, $a_title) | |
| write title to db (static) More... | |
| _writeDescription ($a_obj_id, $a_desc) | |
| write description to db (static) More... | |
| _writeImportId ($a_obj_id, $a_import_id) | |
| write import id to db (static) More... | |
| _isInTrash ($a_ref_id) | |
| checks wether object is in trash More... | |
| _hasUntrashedReference ($a_obj_id) | |
| checks wether an object has at least one reference that is not in trash More... | |
| _getObjectsDataForType ($a_type, $a_omit_trash=false) | |
| get all objects of a certain type 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... | |
| 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 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... | |
| notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
| notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More... | |
| setRegisterMode ($a_bool) | |
| isUserRegistered ($a_user_id=0) | |
| requireRegistration () | |
| getXMLZip () | |
| getHTMLDirectory () | |
| cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
| Clone object permissions, put in tree ... More... | |
| 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... | |
| _lookupCreationDate ($a_id) | |
| Lookup creation date. More... | |
Static Public Member Functions | |
| static | lookupSnippetLength ($a_id) |
| Lookup snippet length. 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 | _getAllReferences ($a_id) |
| get all reference ids of object More... | |
| static | _lookupTitle ($a_id) |
| lookup object title More... | |
| static | _getIdsForTitle ($title, $type='', $partialmatch=false) |
| static | _lookupDescription ($a_id) |
| lookup object description More... | |
| static | _lookupObjId ($a_id) |
| static | setDeletedDates ($a_ref_ids) |
| Set deleted date @global type $ilDB. More... | |
| static | _lookupType ($a_id, $a_reference=false) |
| lookup object type More... | |
| static | _lookupObjectId ($a_ref_id) |
| lookup object id 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 | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
| Get icon for repository item. 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 | 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) |
Static Protected Member Functions | |
| static | lookup ($a_id, $a_property) |
| Lookup glossary property. More... | |
Additional Inherited Members | |
| Data Fields inherited from ilObject | |
| const | TITLE_LENGTH = 255 |
| max length of object title More... | |
| const | DESC_LENGTH = 128 |
| $ilias | |
| $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 | |
| $obj_data_record | |
| object_data record More... | |
Detailed Description
Member Function Documentation
◆ _lookupOnline()
| ilObjGlossary::_lookupOnline | ( | $a_id | ) |
check wether content object is online
Definition at line 226 of file class.ilObjGlossary.php.
References $ilDB, $lm_set, and ilUtil\yn2tf().
Referenced by ilShopRepositoryExplorer\isClickable(), ilRepositoryExplorer\isClickable(), and ilRepositoryExplorerGUI\isNodeClickable().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ cloneObject()
| ilObjGlossary::cloneObject | ( | $a_target_id, | |
$a_copy_id = 0 |
|||
| ) |
Clone glossary.
- Parameters
-
int target ref_id int copy id
Definition at line 1158 of file class.ilObjGlossary.php.
1159 {
1161
1162 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
1163 $this->cloneMetaData($new_obj);
1164
1165 //copy online status if object is not the root copy object
1166 $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
1167
1168 if(!$cp_options->isRootNode($this->getRefId()))
1169 {
1170 $new_obj->setOnline($this->getOnline());
1171 }
1172
1173// $new_obj->setTitle($this->getTitle());
1174 $new_obj->setDescription($this->getDescription());
1175 $new_obj->setVirtualMode($this->getVirtualMode());
1176 $new_obj->setPresentationMode($this->getPresentationMode());
1177 $new_obj->setSnippetLength($this->getSnippetLength());
1178 $new_obj->update();
1179
1180 // set/copy stylesheet
1181 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
1182 $style_id = $this->getStyleSheetId();
1184 {
1185 $style_obj = $ilias->obj_factory->getInstanceByObjId($style_id);
1186 $new_id = $style_obj->ilClone();
1187 $new_obj->setStyleSheetId($new_id);
1188 $new_obj->update();
1189 }
1190
1191 // copy taxonomy
1193 {
1194 // clone it
1195 include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
1197 $new_tax = $tax->cloneObject(0,0,true);
1198 $map = $tax->getNodeMapping();
1199
1200 // assign new taxonomy to new glossary
1201 ilObjTaxonomy::saveUsage($new_tax->getId(), $new_obj->getId());
1202 }
1203
1204 // assign new tax/new glossary
1205 // handle mapping
1206
1207 // prepare tax node assignments objects
1208 include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
1209 if ($tax_id > 0)
1210 {
1213 }
1214
1215 // copy terms
1217 {
1219
1220 // copy tax node assignments
1221 if ($tax_id > 0)
1222 {
1223 $assignmts = $tax_ass->getAssignmentsOfItem($term["id"]);
1224 foreach ($assignmts as $a)
1225 {
1226 if ($map[$a["node_id"]] > 0)
1227 {
1228 $new_tax_ass->addAssignment($map[$a["node_id"]] ,$new_term_id);
1229 }
1230 }
1231 }
1232 }
1233
1234 return $new_obj;
1235 }
static _getInstance($a_copy_id)
Get instance of copy wizard options.
Definition: class.ilCopyWizardOptions.php:78
_copyTerm($a_term_id, $a_glossary_id)
Copy a term to a glossary.
Definition: class.ilGlossaryTerm.php:545
static getTermList($a_glo_id, $searchterm="", $a_first_letter="", $a_def="", $a_tax_node=0, $a_add_amet_fields=false, array $a_amet_filter=null)
Get all terms for given set of glossary ids.
Definition: class.ilGlossaryTerm.php:353
References $ilDB, ilObject\$ilias, $ilUser, ilGlossaryTerm\_copyTerm(), ilCopyWizardOptions\_getInstance(), ilObjStyleSheet\_lookupStandard(), ilObject\cloneMetaData(), getDescription(), ilObject\getId(), getOnline(), getPresentationMode(), 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 36 of file class.ilObjGlossary.php.
37 {
38 global $ilDB;
39
40 parent::create();
41
42 // meta data will be created by
43 // import parser
44 if (!$a_upload)
45 {
46 $this->createMetaData();
47 }
48
49 $ilDB->manipulate("INSERT INTO glossary (id, is_online, virtual, pres_mode, snippet_length) VALUES (".
55 ")");
57 $this->setSnippetLength(200);
58
60 {
61 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
63 }
64
65 }
static writeStyleUsage($a_obj_id, $a_style_id)
Write style usage.
Definition: class.ilObjStyleSheet.php:3665
References $ilDB, ilObject\createMetaData(), ilObject\getId(), getStyleSheetId(), setPresentationMode(), setSnippetLength(), and ilObjStyleSheet\writeStyleUsage().
Here is the call graph for this function:
◆ createExportDirectory()
| ilObjGlossary::createExportDirectory | ( | $a_type = "xml" | ) |
Creates export directory.
Definition at line 499 of file class.ilObjGlossary.php.
500 {
501 include_once("./Services/Export/classes/class.ilExport.php");
503 }
_createExportDirectory($a_obj_id, $a_export_type="xml", $a_obj_type="")
Create export directory.
Definition: class.ilExport.php:199
References 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 460 of file class.ilObjGlossary.php.
461 {
463 ilUtil::makeDir($glo_data_dir);
464 if(!is_writable($glo_data_dir))
465 {
468 }
469
470 // create glossary directory (data_dir/glo_data/glo_<id>)
472 ilUtil::makeDir($glo_dir);
473 if(!@is_dir($glo_dir))
474 {
475 $this->ilias->raiseError("Creation of Glossary Directory failed.",$this->ilias->error_obj->FATAL);
476 }
477 // create Import subdirectory (data_dir/glo_data/glo_<id>/import)
478 $import_dir = $glo_dir."/import";
479 ilUtil::makeDir($import_dir);
480 if(!@is_dir($import_dir))
481 {
482 $this->ilias->raiseError("Creation of Export Directory failed.",$this->ilias->error_obj->FATAL);
483 }
484 }
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2428
redirection script todo: (a better solution should control the processing via a xml file)
References 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
Reimplemented from ilObject.
Definition at line 1003 of file class.ilObjGlossary.php.
1004 {
1005 global $ilDB;
1006
1007 // always call parent delete function first!!
1008 if (!parent::delete())
1009 {
1010 return false;
1011 }
1012
1013 // delete terms
1015 {
1016 $terms = $this->getTermList();
1017 foreach ($terms as $term)
1018 {
1020 $term_obj->delete();
1021 }
1022 }
1023
1024 // delete glossary data entry
1026 $ilDB->query($q);
1027
1028 // delete meta data
1029 $this->deleteMetaData();
1030/*
1031 $nested = new ilNestedSetXML();
1032 $nested->init($this->getId(), $this->getType());
1033 $nested->deleteAllDBData();
1034*/
1035
1036 return true;
1037 }
isVirtual()
returns true if glossary type is virtual (any mode)
Definition: class.ilObjGlossary.php:147
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)
Get term list.
Definition: class.ilObjGlossary.php:355
References $ilDB, 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 962 of file class.ilObjGlossary.php.
963 {
964 include_once("./Modules/File/classes/class.ilObjFile.php");
965
966 foreach ($this->file_ids as $file_id)
967 {
968 $expLog->write(date("[y-m-d H:i:s] ")."File Item ".$file_id);
970 $file_obj->export($a_target_dir);
971 unset($file_obj);
972 }
973 }
Referenced by exportXML().
Here is the caller graph for this function:
◆ exportHTML()
| ilObjGlossary::exportHTML | ( | $a_target_dir, | |
| $log | |||
| ) |
export html package
Definition at line 549 of file class.ilObjGlossary.php.
550 {
552
553 // initialize temporary target directory
554 ilUtil::delDir($a_target_dir);
555 ilUtil::makeDir($a_target_dir);
556
557 include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
559 $this->co_page_html_export->createDirectories();
560
561 // export system style sheet
564 copy($location_stylesheet, $a_target_dir."/".$style_name);
565 $location_stylesheet = ilUtil::getStyleSheetLocation();
566
568 {
569 $cont_stylesheet = "Services/COPage/css/content.css";
570 copy($cont_stylesheet, $a_target_dir."/content.css");
571 }
572 else
573 {
574 $content_style_img_dir = $a_target_dir."/images";
575 ilUtil::makeDir($content_style_img_dir);
577 $style->writeCSSFile($a_target_dir."/content.css", "images");
578 $style->copyImagesToDir($content_style_img_dir);
579 }
580
581 // export syntax highlighting style
582 $syn_stylesheet = ilObjStyleSheet::getSyntaxStylePath();
583 copy($syn_stylesheet, $a_target_dir."/syntaxhighlight.css");
584
585 // get glossary presentation gui class
586 include_once("./Modules/Glossary/classes/class.ilGlossaryPresentationGUI.php");
589 $glo_gui->setOfflineMode(true);
590 $glo_gui->setOfflineDirectory($a_target_dir);
591
592 // could be implemented in the future if other export
593 // formats are supported (e.g. scorm)
594 //$glo_gui->setExportFormat($a_export_format);
595
596 // export terms
597 $this->exportHTMLGlossaryTerms($glo_gui, $a_target_dir);
598
599 // export all media objects
600 foreach ($this->offline_mobs as $mob)
601 {
603 }
607
608 // export all file objects
610 {
612 }
613
614 // export images
615 $image_dir = $a_target_dir."/images";
616 ilUtil::makeDir($image_dir);
619 $image_dir."/enlarge.svg");
621 $image_dir."/browser/plus.png");
623 $image_dir."/browser/minus.png");
625 $image_dir."/browser/blank.png");
627 $image_dir."/icon_st.svg");
629 $image_dir."/icon_pg.svg");
631 $image_dir."/nav_arr_L.png");
633 $image_dir."/nav_arr_R.png");
634
635 // template workaround: reset of template
639
640 // zip everything
641 if (true)
642 {
643 // zip it all
644 $date = time();
647//echo "zip-".$a_target_dir."-to-".$zip_file;
648 ilUtil::zip($a_target_dir, $zip_file);
649 ilUtil::delDir($a_target_dir);
650 }
651 }
Class ilGlossaryPresentationGUI.
Definition: class.ilGlossaryPresentationGUI.php:25
exportHTMLMOB($a_target_dir, &$a_glo_gui, $a_mob_id)
export media object to html
Definition: class.ilObjGlossary.php:738
exportHTMLGlossaryTerms(&$a_glo_gui, $a_target_dir)
export glossary terms
Definition: class.ilObjGlossary.php:657
getExportDirectory($a_type="xml")
Get export directory of glossary.
Definition: class.ilObjGlossary.php:508
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:12
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
Definition: class.ilUtil.php:2535
static getStyleSheetLocation($mode="output", $a_css_name="", $a_css_location="")
get full style sheet file name (path inclusive) of current user
Definition: class.ilUtil.php:176
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:71
References $_GET, $file, ilObject\$ilias, $tpl, ilUtil\delDir(), exportHTMLFile(), exportHTMLGlossaryTerms(), exportHTMLMOB(), getExportDirectory(), ilObject\getId(), ilUtil\getImagePath(), getStyleSheetId(), ilUtil\getStyleSheetLocation(), ilObjStyleSheet\getSyntaxStylePath(), ilObject\getType(), ilUtil\makeDir(), 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 796 of file class.ilObjGlossary.php.
797 {
798 $file_dir = $a_target_dir."/files/file_".$a_file_id;
799 ilUtil::makeDir($file_dir);
800 include_once("./Modules/File/classes/class.ilObjFile.php");
802 $source_file = $file_obj->getDirectory($file_obj->getVersion())."/".$file_obj->getFileName();
803 if (!is_file($source_file))
804 {
805 $source_file = $file_obj->getDirectory()."/".$file_obj->getFileName();
806 }
807 copy($source_file, $file_dir."/".$file_obj->getFileName());
808 }
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 657 of file class.ilObjGlossary.php.
658 {
659 global $ilUser;
660
661 include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
663 $copage_export->exportSupportScripts();
664
665 // index.html file
668 $a_glo_gui->tpl->setVariable("LOCATION_STYLESHEET","./".$style_name);
669 $a_glo_gui->tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
670 $a_glo_gui->tpl->setTitle($this->getTitle());
671
672 $content = $a_glo_gui->listTerms();
674
675 // open file
677 {
679 " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
680 }
681 chmod($file, 0770);
682 fwrite($fp, $content);
683 fclose($fp);
684
685 $terms = $this->getTermList();
686
687 $this->offline_mobs = array();
688 $this->offline_files = array();
689
690 foreach($terms as $term)
691 {
693 $a_glo_gui->tpl = $copage_export->getPreparedMainTemplate();
694 //$tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
695
696 // set style
698 $a_glo_gui->tpl->setVariable("LOCATION_STYLESHEET","./".$style_name);
699
704
705 // open file
707 {
709 " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
710 }
711 chmod($file, 0770);
712 fwrite($fp, $content);
713 fclose($fp);
714
715 // store linked/embedded media objects of glosssary term
716 include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
718 foreach($defs as $def)
719 {
721 foreach($def_mobs as $def_mob)
722 {
723 $this->offline_mobs[$def_mob] = $def_mob;
724 }
725
726 // get all files of page
727 include_once("./Modules/File/classes/class.ilObjFile.php");
729 $this->offline_files = array_merge($this->offline_files, $def_files);
730
731 }
732 }
733 }
_getFilesOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_usage_lang="-")
get all files of an object
Definition: class.ilObjFile.php:962
_getMobsOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
get mobs of object
Definition: class.ilObjMediaObject.php:1038
References $_GET, $file, $ilUser, ilObjFile\_getFilesOfObject(), ilObjMediaObject\_getMobsOfObject(), ilGlossaryDefinition\getDefinitionList(), getTermList(), and getTitle().
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 738 of file class.ilObjGlossary.php.
739 {
740 global $tpl;
741
742 $mob_dir = $a_target_dir."/mobs";
743
745 if (@is_dir($source_dir))
746 {
749 }
750
756 $content =& $a_glo_gui->media();
758
759 // open file
761 {
763 " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
764 }
765 chmod($file, 0770);
766 fwrite($fp, $content);
767 fclose($fp);
768
769 // fullscreen
770 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
772 if ($mob_obj->hasFullscreenItem())
773 {
778 $content = $a_glo_gui->fullscreen();
780
781 // open file
783 {
785 " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
786 }
787 chmod($file, 0770);
788 fwrite($fp, $content);
789 fclose($fp);
790 }
791 }
static rCopy($a_sdir, $a_tdir, $preserveTimeAttributes=false)
Copies content of a directory $a_sdir recursively to a directory $a_tdir.
Definition: class.ilUtil.php:1570
References $_GET, $file, $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 817 of file class.ilObjGlossary.php.
818 {
819 global $ilBench;
820
821 // export glossary
822 $attrs = array();
823 $attrs["Type"] = "Glossary";
824 $a_xml_writer->xmlStartTag("ContentObject", $attrs);
825
826 // MetaData
827 $this->exportXMLMetaData($a_xml_writer);
828
829 // collect media objects
830 $terms = $this->getTermList();
831 $this->mob_ids = array();
832 $this->file_ids = array();
833 foreach ($terms as $term)
834 {
835 include_once "./Modules/Glossary/classes/class.ilGlossaryDefinition.php";
836
838
839 foreach($defs as $def)
840 {
842 $this->page_object->buildDom();
843 $this->page_object->insertInstIntoIDs(IL_INST_ID);
844 $mob_ids = $this->page_object->collectMediaObjects(false);
845 include_once("./Services/COPage/classes/class.ilPCFileList.php");
846 $file_ids = ilPCFileList::collectFileItems($this->page_object, $this->page_object->getDomDoc());
847 foreach($mob_ids as $mob_id)
848 {
849 $this->mob_ids[$mob_id] = $mob_id;
850 }
851 foreach($file_ids as $file_id)
852 {
853 $this->file_ids[$file_id] = $file_id;
854 }
855 }
856 }
857
858 // export media objects
859 $expLog->write(date("[y-m-d H:i:s] ")."Start Export Media Objects");
861 $this->exportXMLMediaObjects($a_xml_writer, $a_inst, $a_target_dir, $expLog);
863 $expLog->write(date("[y-m-d H:i:s] ")."Finished Export Media Objects");
864
865 // FileItems
866 $expLog->write(date("[y-m-d H:i:s] ")."Start Export File Items");
868 $this->exportFileItems($a_target_dir, $expLog);
870 $expLog->write(date("[y-m-d H:i:s] ")."Finished Export File Items");
871
872 // Glossary
873 $expLog->write(date("[y-m-d H:i:s] ")."Start Export Glossary Items");
875 $this->exportXMLGlossaryItems($a_xml_writer, $a_inst, $expLog);
877 $expLog->write(date("[y-m-d H:i:s] ")."Finished Export Glossary Items");
878
879 $a_xml_writer->xmlEndTag("ContentObject");
880 }
exportFileItems($a_target_dir, &$expLog)
export files of file itmes
Definition: class.ilObjGlossary.php:962
exportXMLGlossaryItems(&$a_xml_writer, $a_inst, &$expLog)
export page objects to xml (see ilias_co.dtd)
Definition: class.ilObjGlossary.php:888
exportXMLMediaObjects(&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)
export media objects to xml (see ilias_co.dtd)
Definition: class.ilObjGlossary.php:944
exportXMLMetaData(&$a_xml_writer)
export content objects meta data to xml (see ilias_co.dtd)
Definition: class.ilObjGlossary.php:929
static collectFileItems($a_page, $a_domdoc)
Get all file items that are used within the page.
Definition: class.ilPCFileList.php:347
References $ilBench, 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 888 of file class.ilObjGlossary.php.
889 {
890 global $ilBench;
891
892 $attrs = array();
893 $a_xml_writer->xmlStartTag("Glossary", $attrs);
894
895 // MetaData
896 $this->exportXMLMetaData($a_xml_writer);
897
898 $terms = $this->getTermList();
899
900 // export glossary terms
901 reset($terms);
902 foreach ($terms as $term)
903 {
905 $expLog->write(date("[y-m-d H:i:s] ")."Page Object ".$page["obj_id"]);
906
907 // export xml to writer object
912 $glo_term->exportXML($a_xml_writer, $a_inst);
914
915 unset($glo_term);
916
918 }
919
920 $a_xml_writer->xmlEndTag("Glossary");
921 }
References $ilBench, 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 944 of file class.ilObjGlossary.php.
945 {
946 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
947
948 foreach ($this->mob_ids as $mob_id)
949 {
950 $expLog->write(date("[y-m-d H:i:s] ")."Media Object ".$mob_id);
952 $media_obj->exportXML($a_xml_writer, $a_inst);
953 $media_obj->exportFiles($a_target_dir);
954 unset($media_obj);
955 }
956 }
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 929 of file class.ilObjGlossary.php.
930 {
931 include_once("Services/MetaData/classes/class.ilMD2XML.php");
933 $md2xml->setExportMode(true);
934 $md2xml->startExport();
935 $a_xml_writer->appendXML($md2xml->getXML());
936 }
Definition: class.ilMD2XML.php:35
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 |
Implements ilAdvancedMetaDataSubItems.
Definition at line 1259 of file class.ilObjGlossary.php.
1260 {
1261 global $lng;
1262
1263 if($a_sub_type == "term")
1264 {
1266
1267 include_once "Modules/Glossary/classes/class.ilGlossaryTerm.php";
1269 }
1270 }
References ilObject\$lng, and ilGlossaryTerm\_lookGlossaryTerm().
Here is the call graph for this function:
◆ getAllGlossaryIds()
| ilObjGlossary::getAllGlossaryIds | ( | $a_include_offline_childs = false | ) |
Get all glossary ids.
- Parameters
-
return
Definition at line 387 of file class.ilObjGlossary.php.
388 {
389 global $tree;
390
392 {
393 $glo_ids = array();
394
396 switch ($virtual_mode)
397 {
398 case "level":
399 $glo_arr = $tree->getChildsByType($tree->getParentId($this->getRefId()),"glo");
400 $glo_ids[] = $this->getId();
401 foreach ($glo_arr as $glo)
402 {
403 {
404 $glo_ids[] = $glo['obj_id'];
405 }
406 }
407 if (!$a_include_offline_childs)
408 {
409 $glo_ids = ilObjGlossary::removeOfflineGlossaries($glo_ids);
410 }
411 // always show entries of current glossary (if no permission is given, user will not come to the presentation screen)
412 // see bug #14477
414 {
415 $glo_ids[] = $this->getId();
416 }
417 break;
418
419 case "subtree":
420 $subtree_nodes = $tree->getSubTree($tree->getNodeData($tree->getParentId($this->getRefId())));
421
422 foreach ($subtree_nodes as $node)
423 {
424 if ($node['type'] == 'glo')
425 {
426 $glo_ids[] = $node['obj_id'];
427 }
428 }
429 if (!$a_include_offline_childs)
430 {
431 $glo_ids = ilObjGlossary::removeOfflineGlossaries($glo_ids);
432 }
433 // always show entries of current glossary (if no permission is given, user will not come to the presentation screen)
434 // see bug #14477
436 {
437 $glo_ids[] = $this->getId();
438 }
439 break;
440
441 // fallback to none virtual mode in case of error
442 default:
443 $glo_ids[] = $this->getId();
444 break;
445 }
446 }
447 else
448 {
449 $glo_ids = $this->getId();
450 }
451
452 return $glo_ids;
453 }
removeOfflineGlossaries($a_glo_ids)
Remove offline glossaries from obj id array.
Definition: class.ilObjGlossary.php:1243
References 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:
◆ getDeletionDependencies()
|
static |
Get deletion dependencies.
Reimplemented from ilObject.
Definition at line 1117 of file class.ilObjGlossary.php.
1118 {
1119 global $lng;
1120
1121 $dep = array();
1122 include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php");
1123 $sms = ilObjSAHSLearningModule::getScormModulesForGlossary($a_obj_id);
1124 foreach ($sms as $sm)
1125 {
1128 }
1129//echo "-".$a_obj_id."-";
1130//var_dump($dep);
1131 return $dep;
1132 }
static getScormModulesForGlossary($a_glo_id)
Get SCORM modules that assign a certain glossary.
Definition: class.ilObjSAHSLearningModule.php:948
References 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 101 of file class.ilObjGlossary.php.
102 {
103 return parent::getDescription();
104 }
Referenced by cloneObject().
Here is the caller graph for this function:
◆ getExportDirectory()
| ilObjGlossary::getExportDirectory | ( | $a_type = "xml" | ) |
Get export directory of glossary.
Definition at line 508 of file class.ilObjGlossary.php.
509 {
510 include_once("./Services/Export/classes/class.ilExport.php");
512 }
static _getExportDirectory($a_obj_id, $a_type="xml", $a_obj_type="", $a_entity="")
Get export directory for an repository object.
Definition: class.ilExport.php:99
References 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 517 of file class.ilObjGlossary.php.
518 {
519 include_once("./Services/Export/classes/class.ilExport.php");
521 }
_getExportFiles($a_obj_id, $a_export_types="", $a_obj_type="")
Get Export Files for a repository object.
Definition: class.ilExport.php:134
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 374 of file class.ilObjGlossary.php.
375 {
376 $glo_ids = $this->getAllGlossaryIds();
377 $first_letters = ilGlossaryTerm::getFirstLetters($glo_ids, $a_tax_node);
378 return $first_letters;
379 }
static getFirstLetters($a_glo_id, $a_tax_node=0)
Get all terms for given set of glossary ids.
Definition: class.ilGlossaryTerm.php:445
getAllGlossaryIds($a_include_offline_childs=false)
Get all glossary ids.
Definition: class.ilObjGlossary.php:387
References getAllGlossaryIds(), and ilGlossaryTerm\getFirstLetters().
Here is the call graph for this function:
◆ getImportDirectory()
| ilObjGlossary::getImportDirectory | ( | ) |
get import directory of glossary
Definition at line 489 of file class.ilObjGlossary.php.
490 {
492
493 return $export_dir;
494 }
References ilUtil\getDataDir().
Here is the call graph for this function:
◆ getOnline()
| ilObjGlossary::getOnline | ( | ) |
Definition at line 218 of file class.ilObjGlossary.php.
219 {
220 return $this->online;
221 }
Referenced by cloneObject().
Here is the caller graph for this function:
◆ getPresentationMode()
| ilObjGlossary::getPresentationMode | ( | ) |
Get presentation mode.
- Returns
- string presentation mode
Definition at line 186 of file class.ilObjGlossary.php.
187 {
188 return $this->pres_mode;
189 }
Referenced by cloneObject().
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 541 of file class.ilObjGlossary.php.
542 {
543 return $this->public_export_file[$a_type];
544 }
◆ getShowTaxonomy()
| ilObjGlossary::getShowTaxonomy | ( | ) |
Get show taxonomy.
- Returns
- bool show taxonomy
Definition at line 319 of file class.ilObjGlossary.php.
320 {
321 return $this->show_tax;
322 }
◆ getSnippetLength()
| ilObjGlossary::getSnippetLength | ( | ) |
Get snippet length.
- Returns
- int snippet length
Definition at line 206 of file class.ilObjGlossary.php.
207 {
208 return ($this->snippet_length > 0)
209 ? $this->snippet_length
210 : null;
211 }
Referenced by cloneObject().
Here is the caller graph for this function:
◆ getStyleSheetId()
| ilObjGlossary::getStyleSheetId | ( | ) |
Get ID of assigned style sheet object.
Definition at line 290 of file class.ilObjGlossary.php.
291 {
292 return $this->style_id;
293 }
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 1139 of file class.ilObjGlossary.php.
1140 {
1141 include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
1143 if (count($tax_ids) > 0)
1144 {
1145 // glossaries handle max. one taxonomy
1146 return $tax_ids[0];
1147 }
1148 return 0;
1149 }
static getUsageOfObject($a_obj_id, $a_include_titles=false)
Get usage of object.
Definition: class.ilObjTaxonomy.php:302
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 |
|||
| ) |
Get term list.
Definition at line 355 of file class.ilObjGlossary.php.
357 {
358 if ($a_omit_virtual)
359 {
360 $glo_ids[] = $this->getId();
361 }
362 else
363 {
364 $glo_ids = $this->getAllGlossaryIds($a_include_offline_childs);
365 }
366 $list = ilGlossaryTerm::getTermList($glo_ids, $searchterm, $a_letter, $a_def, $a_tax_node,
367 $a_add_amet_fields, $a_amet_filter);
368 return $list;
369 }
References getAllGlossaryIds(), ilObject\getId(), 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 157 of file class.ilObjGlossary.php.
158 {
159 return parent::getTitle();
160 }
Referenced by exportHTMLGlossaryTerms().
Here is the caller graph for this function:
◆ getVirtualMode()
| ilObjGlossary::getVirtualMode | ( | ) |
get glossary type (normal or virtual)
Definition at line 139 of file class.ilObjGlossary.php.
140 {
141 return $this->virtual_mode;
142 }
Referenced by cloneObject(), and getAllGlossaryIds().
Here is the caller graph for this function:
◆ getXMLZip()
| ilObjGlossary::getXMLZip | ( | ) |
Get zipped xml file for glossary.
Reimplemented from ilObject.
Definition at line 1106 of file class.ilObjGlossary.php.
1107 {
1108 include_once("./Modules/Glossary/classes/class.ilGlossaryExport.php");
1110 return $glo_exp->buildExportFile();
1111 }
◆ ilObjGlossary()
| ilObjGlossary::ilObjGlossary | ( | $a_id = 0, |
|
$a_call_by_reference = true |
|||
| ) |
Constructor @access public.
Definition at line 27 of file class.ilObjGlossary.php.
28 {
29 $this->type = "glo";
30 $this->ilObject($a_id,$a_call_by_reference);
31 }
References ilObject\ilObject().
Here is the call graph for this function:
◆ isActiveDownloads()
| ilObjGlossary::isActiveDownloads | ( | ) |
Definition at line 282 of file class.ilObjGlossary.php.
283 {
284 return $this->downloads_active;
285 }
◆ isActiveGlossaryMenu()
| ilObjGlossary::isActiveGlossaryMenu | ( | ) |
Definition at line 272 of file class.ilObjGlossary.php.
273 {
274 return $this->glo_menu_active;
275 }
◆ isVirtual()
| ilObjGlossary::isVirtual | ( | ) |
returns true if glossary type is virtual (any mode)
Definition at line 147 of file class.ilObjGlossary.php.
148 {
149 return $this->virtual;
150 }
Referenced by delete(), and getAllGlossaryIds().
Here is the caller graph for this function:
◆ lookup()
|
staticprotected |
Lookup glossary property.
- Parameters
-
int glossary id string property
Definition at line 244 of file class.ilObjGlossary.php.
245 {
246 global $ilDB;
247
250 $rec = $ilDB->fetchAssoc($set);
251
252 return $rec[$a_property];
253 }
References $ilDB.
Referenced by lookupSnippetLength().
Here is the caller graph for this function:
◆ lookupSnippetLength()
|
static |
Lookup snippet length.
- Parameters
-
int glossary id
- Returns
- int snippet length
Definition at line 261 of file class.ilObjGlossary.php.
262 {
264 }
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 980 of file class.ilObjGlossary.php.
981 {
982 if ($a_tag == "Identifier" && $a_param == "Entry")
983 {
985 }
986
987 return $a_value;
988 }
References ilObject\getId().
Here is the call graph for this function:
◆ notify()
| ilObjGlossary::notify | ( | $a_event, | |
| $a_ref_id, | |||
| $a_parent_non_rbac_id, | |||
| $a_node_id, | |||
$a_params = 0 |
|||
| ) |
notifys an object about an event occured Based on the event happend, each object may decide how it reacts.
@access public
- Parameters
-
string event integer reference id of object where the event occured array passes optional paramters if required
- Returns
- boolean
Reimplemented from ilObject.
Definition at line 1049 of file class.ilObjGlossary.php.
1050 {
1051 global $tree;
1052
1053 switch ($a_event)
1054 {
1055 case "link":
1056
1057 //var_dump("<pre>",$a_params,"</pre>");
1058 //echo "Glossary ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
1059 //exit;
1060 break;
1061
1062 case "cut":
1063
1064 //echo "Glossary ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
1065 //exit;
1066 break;
1067
1068 case "copy":
1069
1070 //var_dump("<pre>",$a_params,"</pre>");
1071 //echo "Glossary ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
1072 //exit;
1073 break;
1074
1075 case "paste":
1076
1077 //echo "Glossary ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
1078 //exit;
1079 break;
1080
1081 case "new":
1082
1083 //echo "Glossary ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
1084 //exit;
1085 break;
1086 }
1087
1088 // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
1090 {
1091 $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
1092 $parent_type = $parent_obj->getType();
1094 {
1095 $a_node_id = (int) $tree->getParentId($a_node_id);
1096 }
1097 }
1098
1099 parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
1100 }
References $_GET, and ilObject\getType().
Here is the call graph for this function:
◆ read()
| ilObjGlossary::read | ( | ) |
read data of content object
Definition at line 70 of file class.ilObjGlossary.php.
71 {
72 global $ilDB;
73
74 parent::read();
75# echo "Glossary<br>\n";
76
77 $q = "SELECT * FROM glossary WHERE id = ".
79 $gl_set = $ilDB->query($q);
80 $gl_rec = $ilDB->fetchAssoc($gl_set);
90
91 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
93
94 }
setVirtualMode($a_mode)
set glossary type (virtual: fixed/level/subtree, normal:none)
Definition: class.ilObjGlossary.php:118
setPublicExportFile($a_type, $a_file)
specify public export file for type
Definition: class.ilObjGlossary.php:529
setStyleSheetId($a_style_id)
Set ID of assigned style sheet object.
Definition: class.ilObjGlossary.php:298
setActiveGlossaryMenu($a_act_glo_menu)
Definition: class.ilObjGlossary.php:267
References $ilDB, ilObject\getId(), ilObjStyleSheet\lookupObjectStyle(), setActiveDownloads(), setActiveGlossaryMenu(), setOnline(), setPresentationMode(), setPublicExportFile(), setShowTaxonomy(), setSnippetLength(), setStyleSheetId(), setVirtualMode(), and ilUtil\yn2tf().
Here is the call graph for this function:
◆ removeOfflineGlossaries()
| ilObjGlossary::removeOfflineGlossaries | ( | $a_glo_ids | ) |
Remove offline glossaries from obj id array.
- Parameters
-
return
Definition at line 1243 of file class.ilObjGlossary.php.
1244 {
1245 global $ilDB;
1246
1249 " AND is_online = ".$ilDB->quote("y", "text")
1250 );
1251 $glo_ids = array();
1253 {
1254 $glo_ids[] = $rec["id"];
1255 }
1256 return $glo_ids;
1257 }
References $ilDB.
Referenced by getAllGlossaryIds().
Here is the caller graph for this function:
◆ setActiveDownloads()
| ilObjGlossary::setActiveDownloads | ( | $a_down | ) |
Definition at line 277 of file class.ilObjGlossary.php.
278 {
279 $this->downloads_active = $a_down;
280 }
Referenced by read().
Here is the caller graph for this function:
◆ setActiveGlossaryMenu()
| ilObjGlossary::setActiveGlossaryMenu | ( | $a_act_glo_menu | ) |
Definition at line 267 of file class.ilObjGlossary.php.
268 {
269 $this->glo_menu_active = $a_act_glo_menu;
270 }
Referenced by read().
Here is the caller graph for this function:
◆ setDescription()
| ilObjGlossary::setDescription | ( | $a_description | ) |
set description of glossary object
Reimplemented from ilObject.
Definition at line 109 of file class.ilObjGlossary.php.
110 {
111 parent::setDescription($a_description);
112 }
◆ setOnline()
| ilObjGlossary::setOnline | ( | $a_online | ) |
Definition at line 213 of file class.ilObjGlossary.php.
214 {
215 $this->online = $a_online;
216 }
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 176 of file class.ilObjGlossary.php.
177 {
178 $this->pres_mode = $a_val;
179 }
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 529 of file class.ilObjGlossary.php.
530 {
531 $this->public_export_file[$a_type] = $a_file;
532 }
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 309 of file class.ilObjGlossary.php.
310 {
311 $this->show_tax = $a_val;
312 }
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 196 of file class.ilObjGlossary.php.
197 {
198 $this->snippet_length = $a_val;
199 }
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 298 of file class.ilObjGlossary.php.
299 {
300 $this->style_id = $a_style_id;
301 }
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 165 of file class.ilObjGlossary.php.
166 {
167 parent::setTitle($a_title);
168// $this->meta_data->setTitle($a_title);
169 }
◆ setVirtualMode()
| ilObjGlossary::setVirtualMode | ( | $a_mode | ) |
set glossary type (virtual: fixed/level/subtree, normal:none)
Definition at line 118 of file class.ilObjGlossary.php.
119 {
120 switch ($a_mode)
121 {
122 case "level":
123 case "subtree":
124 // case "fixed":
125 $this->virtual_mode = $a_mode;
126 $this->virtual = true;
127 break;
128
129 default:
130 $this->virtual_mode = "none";
131 $this->virtual = false;
132 break;
133 }
134 }
Referenced by read().
Here is the caller graph for this function:
◆ update()
| ilObjGlossary::update | ( | ) |
Update object.
Reimplemented from ilObject.
Definition at line 327 of file class.ilObjGlossary.php.
328 {
329 global $ilDB;
330
331 $this->updateMetaData();
332
333 $ilDB->manipulate("UPDATE glossary SET ".
335 " virtual = ".$ilDB->quote($this->getVirtualMode(), "text").",".
336 " public_xml_file = ".$ilDB->quote($this->getPublicExportFile("xml"), "text").",".
337 " public_html_file = ".$ilDB->quote($this->getPublicExportFile("html"), "text").",".
340 " pres_mode = ".$ilDB->quote($this->getPresentationMode(), "text").", ".
341 " show_tax = ".$ilDB->quote((int) $this->getShowTaxonomy(), "integer").", ".
342 " snippet_length = ".$ilDB->quote((int)$this->getSnippetLength(), "integer")." ".
343 " WHERE id = ".$ilDB->quote($this->getId(), "integer"));
344
345 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
347
348 parent::update();
349 }
References $ilDB, ilObject\getId(), getStyleSheetId(), ilUtil\tf2yn(), ilObject\updateMetaData(), and ilObjStyleSheet\writeStyleUsage().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Modules/Glossary/classes/class.ilObjGlossary.php
