Help settings application class. More...

Inheritance diagram for ilObjHelpSettings:

Collaboration diagram for ilObjHelpSettings:

Public Member Functions
	ilObjHelpSettings ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	initType ()
	Init type. More...

	uploadHelpModule ($a_file)
	Upload help file. More...

	getHelpModules ()
	Get help modules. More...

	lookupModuleTitle ($a_id)
	lookup module title More...

	lookupModuleLmId ($a_id)
	lookup module lm id More...

	deleteModule ($a_id)
	Delete module. More...

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

	withReferences ()

	read ($a_force_db=false)
	Read data from db. More...

	getId ()

	setId ($a_id)

	setRefId ($a_id)

	getRefId ()

	getType ()

	setType ($a_type)

	getPresentationTitle ()

	getTitle ()

	getUntranslatedTitle ()

	setTitle ($a_title)

	getDescription ()

	setDescription ($a_desc)

	getLongDescription ()

	getImportId ()

	setImportId ($a_import_id)

	getOwner ()

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)

	setOwner ($a_owner)

	getCreateDate ()

	getLastUpdateDate ()

	setObjDataRecord ($a_record)

	create ($a_clone_mode=false)

	update ()

	MDUpdateListener ($a_element)

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()

	_getIdForImportId ($a_import_id)

	_lookupOwner ($a_id)

	_lookupLastUpdate ($a_id, $a_as_string=false)

	_getLastUpdateOfObjects ($a_objs)

	_setDeletedDate ($a_ref_id)

	_resetDeletedDate ($a_ref_id)

	_lookupDeletedDate ($a_ref_id)

	_writeTitle ($a_obj_id, $a_title)

	_writeDescription ($a_obj_id, $a_desc)

	_writeImportId ($a_obj_id, $a_import_id)

	_isInTrash ($a_ref_id)

	_hasUntrashedReference ($a_obj_id)

	_getObjectsDataForType ($a_type, $a_omit_trash=false)

	putInTree ($a_parent_ref)

	setPermissions ($a_parent_ref)

	createReference ()

	countReferences ()

	delete ()

	initDefaultRoles ()

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)

	cloneMetaData ($target_obj)

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)

Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor 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 public More...

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

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

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

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

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

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title 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 public More...

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

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

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

	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	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	_getAllReferences ($a_id)

static	_lookupTitle ($a_id)

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

static	_lookupDescription ($a_id)

static	_lookupObjId ($a_id)

static	_lookupType ($a_id, $a_reference=false)

static	_lookupObjectId ($a_ref_id)

static	_exists ($a_id, $a_reference=false)

static	_getObjectsByType ($a_obj_type="", $a_owner="")

static	_prepareCloneSelection ($a_ref_ids, $new_type)

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

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

static	_lookupImportId ($a_obj_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 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 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	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

	$obj_data_record
	object_data record More...

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

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

References ilObject\$id, and $ilDB.

Referenced by uploadHelpModule().

         {
                 global $ilDB;
                 
                 $id = $ilDB->nextId("help_module");
                 
                 $ilDB->manipulate("INSERT INTO help_module ".
                         "(id) VALUES (".
                         $ilDB->quote($id, "integer").
                         ")");
                 
                 return $id;
         }

Here is the caller graph for this function:

◆ deleteModule()

ilObjHelpSettings::deleteModule ( $a_id )

Delete module.

Parameters

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

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

         {
                 global $ilDB, $ilSetting;
                 
                 // if this is the currently activated one, deactivate it first
                 if ($a_id == (int) $ilSetting->get("help_module"))
                 {
                         $ilSetting->set("help_module", "");
                 }
                 
                 $set = $ilDB->query("SELECT * FROM help_module ".
                         " WHERE id = ".$ilDB->quote($a_id, "integer")
                         );
                 $rec  = $ilDB->fetchAssoc($set);
 
                 // delete learning module
                 if (ilObject::_lookupType($rec["lm_id"]) == "lm")
                 {
                         include_once("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
                         $lm = new ilObjLearningModule($rec["lm_id"], false);
                         $lm->delete();
                 }
                 
                 // delete mappings
                 include_once("./Services/Help/classes/class.ilHelpMapping.php");
                 ilHelpMapping::deleteEntriesOfModule($a_id);
                 
                 // delete tooltips
                 include_once("./Services/Help/classes/class.ilHelp.php");
                 ilHelp::deleteTooltipsOfModule($a_id);
                 
                 // delete help module record
                 $ilDB->manipulate("DELETE FROM help_module WHERE ".
                         " id = ".$ilDB->quote($a_id, "integer"));
                 
         }

Here is the call graph for this function:

◆ getHelpModules()

ilObjHelpSettings::getHelpModules ( )

Get help modules.

Parameters

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

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

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT * FROM help_module");
                 
                 $mods = array();
                 while ($rec  = $ilDB->fetchAssoc($set))
                 {
                         if (ilObject::_lookupType($rec["lm_id"]) == "lm")
                         {
                                 $rec["title"] = ilObject::_lookupTitle($rec["lm_id"]);
                                 $rec["create_date"] = ilObject::_lookupCreationDate($rec["lm_id"]);
                         }
                         
                         $mods[] = $rec;
                 }
                 
                 return $mods;
         }

Here is the call graph for this function:

◆ ilObjHelpSettings()

ilObjHelpSettings::ilObjHelpSettings	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

         {
                 parent::__construct($a_id,$a_call_by_reference);
         }

◆ initType()

ilObjHelpSettings::initType ( )

Init type.

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

         {
                 $this->type = "hlps";
         }

◆ isHelpLM()

static ilObjHelpSettings::isHelpLM ( $a_lm_id )

static

Check if LM is a help LM.

Parameters

integer $a_lm_id lm id

Returns: bool true/false

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

References $ilDB.

Referenced by ilLMObject\_getIdForImportId().

         {
                 global $ilDB;
 
                 $set = $ilDB->query("SELECT id FROM help_module ".
                         " WHERE lm_id = ".$ilDB->quote($a_lm_id, "integer")
                 );
                 if ($rec = $ilDB->fetchAssoc($set))
                 {
                         return true;
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ lookupModuleLmId()

ilObjHelpSettings::lookupModuleLmId ( $a_id )

lookup module lm id

Parameters

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

References $ilDB.

Referenced by ilHelp\getHelpLMId().

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT lm_id FROM help_module ".
                         " WHERE id = ".$ilDB->quote($a_id, "integer")
                         );
                 $rec  = $ilDB->fetchAssoc($set);
                 return $rec["lm_id"];
         }

Here is the caller graph for this function:

◆ lookupModuleTitle()

ilObjHelpSettings::lookupModuleTitle ( $a_id )

lookup module title

Parameters

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

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

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT * FROM help_module ".
                         " WHERE id = ".$ilDB->quote($a_id, "integer")
                         );
                 $rec  = $ilDB->fetchAssoc($set);
                 if (ilObject::_lookupType($rec["lm_id"]) == "lm")
                 {
                         return ilObject::_lookupTitle($rec["lm_id"]);
                 }
                 return "";
         }

Here is the call graph for this function:

◆ uploadHelpModule()

ilObjHelpSettings::uploadHelpModule ( $a_file )

Upload help file.

Parameters

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

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

         {
                 $id = $this->createHelpModule();
                 
                 // create and insert object in objecttree
                 /*include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                 $newObj = new ilObjContentObject();
                 $newObj->setType("lm");
                 $newObj->setTitle("Help Module");
                 $newObj->create(true);
                 $newObj->createLMTree();*/
 
                 try
                 {
                         include_once("./Services/Export/classes/class.ilImport.php");
                         $imp = new ilImport();
                         $conf = $imp->getConfig("Services/Help");
                         $conf->setModuleId($id);
                         $new_id = $imp->importObject("", $a_file["tmp_name"], $a_file["name"], "lm", "Modules/LearningModule");
                         $newObj = new ilObjLearningModule($new_id, false);
 
                         self::writeHelpModuleLmId($id, $newObj->getId());
                 }
                 catch (ilManifestFileNotFoundImportException $e)
                 {
                         // old import
                         $t = $imp->getTemporaryImportDir();
 
                         // create and insert object in objecttree
                         include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                         $newObj = new ilObjContentObject();
                         $newObj->setType("lm");
                         $newObj->setTitle("Help Module");
                         $newObj->create(true);
                         $newObj->createLMTree();
 
                         $mess =  $newObj->importFromDirectory($t, false);
 
                         // this should only be true for help modules
                         // search the zip file
                         $dir = $t;
                         $files = ilUtil::getDir($dir);
                         foreach ($files as $file)
                         {
                                 if (is_int(strpos($file["entry"], "__help_")) &&
                                         is_int(strpos($file["entry"], ".zip")))
                                 {
                                         include_once("./Services/Export/classes/class.ilImport.php");
                                         $imp = new ilImport();
                                         $imp->getMapping()->addMapping('Services/Help', 'help_module', 0, $id);
                                         include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                         $chaps = ilLMObject::getObjectList($newObj->getId(), "st");
                                         foreach ($chaps as $chap)
                                         {
                                                 $chap_arr = explode("_", $chap["import_id"]);
                                                 $imp->getMapping()->addMapping('Services/Help', 'help_chap',
                                                         $chap_arr[count($chap_arr) - 1], $chap["obj_id"]);
                                         }
                                         $imp->importEntity($dir."/".$file["entry"], $file["entry"],
                                                 "help", "Services/Help", true);
                                 }
                         }
 
                         // delete import directory
                         ilUtil::delDir($t);
 
                         self::writeHelpModuleLmId($id, $newObj->getId());
                 }
 
 
                 $GLOBALS['ilAppEventHandler']->raise(
                         'Services/Help',
                         'create',
                         array(
                                 'obj_id' => $id,
                                 'obj_type' => 'lm'
                         )
                 );
         }

Here is the call graph for this function:

◆ writeHelpModuleLmId()

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

static

Write help module lm id.

Parameters

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

References $ilDB.

         {
                 global $ilDB;
                 
                 $ilDB->manipulate("UPDATE help_module SET ".
                         " lm_id = ".$ilDB->quote($a_lm_id, "integer").
                         " WHERE id = ".$ilDB->quote($a_id, "integer")
                         );
         }

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

Services/Help/classes/class.ilObjHelpSettings.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createHelpModule()

◆ deleteModule()

◆ getHelpModules()

◆ ilObjHelpSettings()

◆ initType()

◆ isHelpLM()

◆ lookupModuleLmId()

◆ lookupModuleTitle()

◆ uploadHelpModule()

◆ writeHelpModuleLmId()