This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjHelpSettings:

Collaboration diagram for ilObjHelpSettings:

Public Member Functions
	__construct ()

	uploadHelpModule (array $a_file)

	getHelpModules ()

	deleteModule (int $a_id)

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

	read ()

	create (bool $a_clone_mode=false)

	update ()

	delete ()

	cloneMetaData (ilObject $target_obj)

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

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Static Public Member Functions
static	createHelpModule ()

static	writeHelpModuleLmId (int $a_id, int $a_lm_id)

static	lookupModuleTitle (int $a_id)

static	lookupModuleLmId (int $a_id)

static	isHelpLM (int $a_lm_id)
	Check if LM is a help LM. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Protected Member Functions
	initType ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doDelete ()

	beforeDelete ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

	beforeCloneObject ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
ilSetting	$settings

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Help settings application class

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjHelpSettings::__construct ( )

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

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

     {
         parent::__construct();
         global $DIC;
 
         $this->db = $DIC->database();
         $this->settings = $DIC->settings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createHelpModule()

static ilObjHelpSettings::createHelpModule ( )

static

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

References $DIC, ilObject\$id, and $ilDB.

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

◆ deleteModule()

ilObjHelpSettings::deleteModule ( int $a_id )

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

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

      : void {
         $ilDB = $this->db;
         $ilSetting = $this->settings;
 
         // 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") {
             $lm = new ilObjLearningModule((int) $rec["lm_id"], false);
             $lm->delete();
         }
 
         // delete mappings
         ilHelpMapping::deleteEntriesOfModule($a_id);
 
         // delete tooltips
         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 ( )

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

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

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

Here is the call graph for this function:

◆ initType()

ilObjHelpSettings::initType ( )

protected

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

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

◆ isHelpLM()

static ilObjHelpSettings::isHelpLM ( int $a_lm_id )

static

Check if LM is a help LM.

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

References $DIC, and $ilDB.

Referenced by ilLMObject\_getIdForImportId().

      : bool {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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()

static ilObjHelpSettings::lookupModuleLmId ( int $a_id )

static

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

References $DIC, and $ilDB.

Referenced by ilHelp\getHelpLMId().

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

Here is the caller graph for this function:

◆ lookupModuleTitle()

static ilObjHelpSettings::lookupModuleTitle ( int $a_id )

static

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

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

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

Here is the call graph for this function:

◆ uploadHelpModule()

ilObjHelpSettings::uploadHelpModule ( array $a_file )

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

References Vendor\Package\$e, $GLOBALS, and ilObject\$id.

      : void {
         $id = self::createHelpModule();
 
         try {
             $imp = new ilImport();
             $conf = $imp->getConfig("Services/Help");
             $conf->setModuleId($id);
             $new_id = $imp->importObject(null, $a_file["tmp_name"], $a_file["name"], "lm", "Modules/LearningModule"); //
             $newObj = new ilObjLearningModule($new_id, false);
 
             self::writeHelpModuleLmId($id, $newObj->getId());
         } catch (ilManifestFileNotFoundImportException $e) {
             throw new ilLMOldExportFileException("This file seems to be from ILIAS version 5.0.x or lower. Import is not supported anymore.");
         }
 
 
         $GLOBALS['ilAppEventHandler']->raise(
             'Services/Help',
             'create',
             array(
                 'obj_id' => $id,
                 'obj_type' => 'lm'
             )
         );
     }

◆ writeHelpModuleLmId()

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

static

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

References $DIC, and $ilDB.

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

Field Documentation

◆ $settings

ilSetting ilObjHelpSettings::$settings

protected

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

Referenced by deleteModule().

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

Services/Help/classes/class.ilObjHelpSettings.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createHelpModule()

◆ deleteModule()

◆ getHelpModules()

◆ initType()

◆ isHelpLM()

◆ lookupModuleLmId()

◆ lookupModuleTitle()

◆ uploadHelpModule()

◆ writeHelpModuleLmId()

Field Documentation

◆ $settings