ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilObjHelpSettings Class Reference

Help settings application class. More...

+ Inheritance diagram for ilObjHelpSettings:
+ Collaboration diagram for ilObjHelpSettings:

Public Member Functions

 initType ()
 Init type. More...
 
 uploadHelpModule ($a_file)
 Upload help file. More...
 
 getHelpModules ()
 Get help modules. More...
 
 deleteModule ($a_id)
 Delete module. More...
 
- Public Member Functions inherited from ilObject2
 __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 data from db. 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 ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 create ($a_clone_mode=false)
 
 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...
 
 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...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. 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...
 
 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 ()
 
 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...
 
 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...
 
 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...
 
 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 createHelpModule ()
 Create help module. More...
 
static writeHelpModuleLmId ($a_id, $a_lm_id)
 Write help module lm id. More...
 
static lookupModuleTitle ($a_id)
 lookup module title More...
 
static lookupModuleLmId ($a_id)
 lookup module lm id More...
 
static isHelpLM ($a_lm_id)
 Check if LM is a help LM. More...
 
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_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 _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 _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, $a_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 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 _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 @global type $ilDB. 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 _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 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...
 

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
 
- Protected Member Functions inherited from ilObject2
 initType ()
 
 doRead ()
 
 doCreate ()
 
 beforeCreate ()
 
 doUpdate ()
 
 beforeUpdate ()
 
 doMDUpdateListener ($a_element)
 
 beforeMDUpdateListener ($a_element)
 
 doCreateMetaData ()
 
 beforeCreateMetaData ()
 
 doUpdateMetaData ()
 
 beforeUpdateMetaData ()
 
 doDelete ()
 
 beforeDelete ()
 
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 
 beforeCloneObject ()
 

Detailed Description

Help settings application class.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 15 of file class.ilObjHelpSettings.php.

Member Function Documentation

◆ createHelpModule()

static ilObjHelpSettings::createHelpModule ( )
static

Create help module.

Parameters

return

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

32 {
33 global $ilDB;
34
35 $id = $ilDB->nextId("help_module");
36
37 $ilDB->manipulate("INSERT INTO help_module ".
38 "(id) VALUES (".
39 $ilDB->quote($id, "integer").
40 ")");
41
42 return $id;
43 }
global $ilDB

References ilObject\$id, and $ilDB.

Referenced by uploadHelpModule().

+ Here is the caller graph for this function:

◆ deleteModule()

ilObjHelpSettings::deleteModule (   $a_id)

Delete module.

Parameters

return

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

220 {
221 global $ilDB, $ilSetting;
222
223 // if this is the currently activated one, deactivate it first
224 if ($a_id == (int) $ilSetting->get("help_module"))
225 {
226 $ilSetting->set("help_module", "");
227 }
228
229 $set = $ilDB->query("SELECT * FROM help_module ".
230 " WHERE id = ".$ilDB->quote($a_id, "integer")
231 );
232 $rec = $ilDB->fetchAssoc($set);
233
234 // delete learning module
235 if (ilObject::_lookupType($rec["lm_id"]) == "lm")
236 {
237 include_once("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
238 $lm = new ilObjLearningModule($rec["lm_id"], false);
239 $lm->delete();
240 }
241
242 // delete mappings
243 include_once("./Services/Help/classes/class.ilHelpMapping.php");
245
246 // delete tooltips
247 include_once("./Services/Help/classes/class.ilHelp.php");
249
250 // delete help module record
251 $ilDB->manipulate("DELETE FROM help_module WHERE ".
252 " id = ".$ilDB->quote($a_id, "integer"));
253
254 }
static deleteEntriesOfModule($a_id)
Delete entries of module.
static deleteTooltipsOfModule($a_id)
Delete tooltips of module.
Class ilObjLearningModule.
static _lookupType($a_id, $a_reference=false)
lookup object type
global $ilSetting
Definition: privfeed.php:17

References $ilDB, $ilSetting, ilObject\_lookupType(), ilHelpMapping\deleteEntriesOfModule(), and ilHelp\deleteTooltipsOfModule().

+ Here is the call graph for this function:

◆ getHelpModules()

ilObjHelpSettings::getHelpModules ( )

Get help modules.

Parameters

return

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

155 {
156 global $ilDB;
157
158 $set = $ilDB->query("SELECT * FROM help_module");
159
160 $mods = array();
161 while ($rec = $ilDB->fetchAssoc($set))
162 {
163 if (ilObject::_lookupType($rec["lm_id"]) == "lm")
164 {
165 $rec["title"] = ilObject::_lookupTitle($rec["lm_id"]);
166 $rec["create_date"] = ilObject::_lookupCreationDate($rec["lm_id"]);
167 }
168
169 $mods[] = $rec;
170 }
171
172 return $mods;
173 }
static _lookupTitle($a_id)
lookup object title
static _lookupCreationDate($a_id)
Lookup creation date.

References $ilDB, ilObject\_lookupCreationDate(), ilObject\_lookupTitle(), and ilObject\_lookupType().

+ Here is the call graph for this function:

◆ initType()

ilObjHelpSettings::initType ( )

Init type.

Reimplemented from ilObject2.

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

21 {
22 $this->type = "hlps";
23 }

◆ isHelpLM()

static ilObjHelpSettings::isHelpLM (   $a_lm_id)
static

Check if LM is a help LM.

Parameters
integer$a_lm_idlm id
Returns
bool true/false

Definition at line 262 of file class.ilObjHelpSettings.php.

263 {
264 global $ilDB;
265
266 $set = $ilDB->query("SELECT id FROM help_module ".
267 " WHERE lm_id = ".$ilDB->quote($a_lm_id, "integer")
268 );
269 if ($rec = $ilDB->fetchAssoc($set))
270 {
271 return true;
272 }
273 return false;
274 }

References $ilDB.

Referenced by ilLMObject\_getIdForImportId().

+ Here is the caller graph for this function:

◆ lookupModuleLmId()

static ilObjHelpSettings::lookupModuleLmId (   $a_id)
static

lookup module lm id

Parameters

return

Definition at line 202 of file class.ilObjHelpSettings.php.

203 {
204 global $ilDB;
205
206 $set = $ilDB->query("SELECT lm_id FROM help_module ".
207 " WHERE id = ".$ilDB->quote($a_id, "integer")
208 );
209 $rec = $ilDB->fetchAssoc($set);
210 return $rec["lm_id"];
211 }

References $ilDB.

Referenced by ilHelp\getHelpLMId().

+ Here is the caller graph for this function:

◆ lookupModuleTitle()

static ilObjHelpSettings::lookupModuleTitle (   $a_id)
static

lookup module title

Parameters

return

Definition at line 181 of file class.ilObjHelpSettings.php.

182 {
183 global $ilDB;
184
185 $set = $ilDB->query("SELECT * FROM help_module ".
186 " WHERE id = ".$ilDB->quote($a_id, "integer")
187 );
188 $rec = $ilDB->fetchAssoc($set);
189 if (ilObject::_lookupType($rec["lm_id"]) == "lm")
190 {
191 return ilObject::_lookupTitle($rec["lm_id"]);
192 }
193 return "";
194 }

References $ilDB, ilObject\_lookupTitle(), and ilObject\_lookupType().

+ Here is the call graph for this function:

◆ uploadHelpModule()

ilObjHelpSettings::uploadHelpModule (   $a_file)

Upload help file.

Parameters

return

Definition at line 68 of file class.ilObjHelpSettings.php.

69 {
70 $id = $this->createHelpModule();
71
72 // create and insert object in objecttree
73 /*include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
74 $newObj = new ilObjContentObject();
75 $newObj->setType("lm");
76 $newObj->setTitle("Help Module");
77 $newObj->create(true);
78 $newObj->createLMTree();*/
79
80 try
81 {
82 include_once("./Services/Export/classes/class.ilImport.php");
83 $imp = new ilImport();
84 $conf = $imp->getConfig("Services/Help");
85 $conf->setModuleId($id);
86 $new_id = $imp->importObject("", $a_file["tmp_name"], $a_file["name"], "lm", "Modules/LearningModule");
87 $newObj = new ilObjLearningModule($new_id, false);
88
89 self::writeHelpModuleLmId($id, $newObj->getId());
90 }
92 {
93 // old import
94 $t = $imp->getTemporaryImportDir();
95
96 // create and insert object in objecttree
97 include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
98 $newObj = new ilObjContentObject();
99 $newObj->setType("lm");
100 $newObj->setTitle("Help Module");
101 $newObj->create(true);
102 $newObj->createLMTree();
103
104 $mess = $newObj->importFromDirectory($t, false);
105
106 // this should only be true for help modules
107 // search the zip file
108 $dir = $t;
109 $files = ilUtil::getDir($dir);
110 foreach ($files as $file)
111 {
112 if (is_int(strpos($file["entry"], "__help_")) &&
113 is_int(strpos($file["entry"], ".zip")))
114 {
115 include_once("./Services/Export/classes/class.ilImport.php");
116 $imp = new ilImport();
117 $imp->getMapping()->addMapping('Services/Help', 'help_module', 0, $id);
118 include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
119 $chaps = ilLMObject::getObjectList($newObj->getId(), "st");
120 foreach ($chaps as $chap)
121 {
122 $chap_arr = explode("_", $chap["import_id"]);
123 $imp->getMapping()->addMapping('Services/Help', 'help_chap',
124 $chap_arr[count($chap_arr) - 1], $chap["obj_id"]);
125 }
126 $imp->importEntity($dir."/".$file["entry"], $file["entry"],
127 "help", "Services/Help", true);
128 }
129 }
130
131 // delete import directory
133
134 self::writeHelpModuleLmId($id, $newObj->getId());
135 }
136
137
138 $GLOBALS['ilAppEventHandler']->raise(
139 'Services/Help',
140 'create',
141 array(
142 'obj_id' => $id,
143 'obj_type' => 'lm'
144 )
145 );
146 }
$files
Definition: add-vimline.php:18
Import class.
static getObjectList($lm_id, $type="")
static
manifest.xml file not found-exception for import
Class ilObjContentObject.
static createHelpModule()
Create help module.
static writeHelpModuleLmId($a_id, $a_lm_id)
Write help module lm id.
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
static getDir($a_dir, $a_rec=false, $a_sub_dir="")
get directory
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
if(!file_exists("$old.txt")) if( $old===$new) if(file_exists("$new.txt")) $file

References $file, $files, $GLOBALS, ilObject\$id, $t, createHelpModule(), ilUtil\delDir(), ilUtil\getDir(), ilLMObject\getObjectList(), and writeHelpModuleLmId().

+ Here is the call graph for this function:

◆ writeHelpModuleLmId()

static ilObjHelpSettings::writeHelpModuleLmId (   $a_id,
  $a_lm_id 
)
static

Write help module lm id.

Parameters

return

Definition at line 51 of file class.ilObjHelpSettings.php.

52 {
53 global $ilDB;
54
55 $ilDB->manipulate("UPDATE help_module SET ".
56 " lm_id = ".$ilDB->quote($a_lm_id, "integer").
57 " WHERE id = ".$ilDB->quote($a_id, "integer")
58 );
59 }

References $ilDB.

Referenced by uploadHelpModule().

+ Here is the caller graph for this function:

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