File Based Learning Module (HTML) object. More...

Inheritance diagram for ilObjFileBasedLM:

Collaboration diagram for ilObjFileBasedLM:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	update (bool $a_skip_meta=false)

	read ()

	create (bool $a_skip_meta=false)

	getDataDirectory (string $mode="filesystem")

	createDataDirectory ()

	getStartFile ()

	setStartFile (string $a_file, bool $a_omit_file_check=false)

	getRID ()

	getResource ()

	setRID (string $rid)

	delete ()

	populateByDirectoy (string $a_dir, string $a_filename="")
	Populate by directory. More...

	isInfoEnabled ()

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

	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 $description)

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

Protected Attributes
string	$start_file = null

string	$rid = null

bool	$online

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

LOMServices	$lom_services

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 = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Private Attributes
ILIAS ResourceStorage Services	$irss

ILIAS Filesystem Util Archive Archives	$archives

Additional Inherited Members
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	getIconForType (string $type)

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)

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

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

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Detailed Description

File Based Learning Module (HTML) object.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFileBasedLM::__construct	(	int	$a_id = `0`,
		bool	$a_call_by_reference = `true`
	)

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

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

       {
         global $DIC;
 
 
         $this->db = $DIC->database();
         $this->irss = $DIC->resourceStorage();
         $this->archives = $DIC->archives();
         // this also calls read() method! (if $a_id is set)
         $this->type = "htlm";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilObjFileBasedLM::create ( bool $a_skip_meta = false )

Definition at line 81 of file class.ilObjFileBasedLM.php.

References $id, ilObject\createMetaData(), ilObject\getId(), getResource(), getRID(), getStartFile(), ilObject\getTitle(), null, setRID(), setStartFile(), and ilObject\update().

                                                      : int
     {
         $id = parent::create();
 
         // create empty container resource. empty zips are not allowed, we need at least one file which is hidden
         $empty_zip = $this->archives->zip(
             []
         );
 
         $rid = $this->irss->manageContainer()->containerFromStream(
             $empty_zip->get(),
             new ilHTLMStakeholder(),
             $this->getTitle()
         );
         $this->setRID($rid->serialize());
 
         $this->db->insert(
             'file_based_lm',
             [
                 'id' => ['integer', $this->getId()],
                 'startfile' => ['text', $this->getStartFile()],
                 'rid' => ['text', $this->getRID()]
             ]
         );
 
 
         if (!$a_skip_meta) {
             $this->createMetaData();
         }
         return $id;
     }

Here is the call graph for this function:

◆ createDataDirectory()

ilObjFileBasedLM::createDataDirectory ( )

Definition at line 136 of file class.ilObjFileBasedLM.php.

◆ delete()

ilObjFileBasedLM::delete ( )

Definition at line 176 of file class.ilObjFileBasedLM.php.

References ilFileUtils\delDir(), ilObject\deleteMetaData(), getDataDirectory(), and ilObject\getId().

                             : bool
     {
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         // Delete meta data
         $this->deleteMetaData();
 
         // delete file_based_lm record
         $this->db->manipulateF(
             "DELETE FROM file_based_lm WHERE id = %s",
             ["integer"],
             [$this->getId()]
         );
 
         // delete data directory
         ilFileUtils::delDir($this->getDataDirectory()); // for legacy reasons
         // TODO remove RID
 
         return true;
     }

Here is the call graph for this function:

◆ getDataDirectory()

ilObjFileBasedLM::getDataDirectory ( string $mode = "filesystem" )

Definition at line 131 of file class.ilObjFileBasedLM.php.

References CLIENT_WEB_DIR, and ilObject\getId().

Referenced by delete(), and populateByDirectoy().

                                                                  : string
     {
         return CLIENT_WEB_DIR . "/lm_data" . "/lm_" . $this->getId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResource()

ilObjFileBasedLM::getResource ( )

Definition at line 158 of file class.ilObjFileBasedLM.php.

References getRID(), and null.

Referenced by create().

                                  : ?StorableContainerResource
     {
         if ($this->getRID() === null) {
             return null;
         }
         $rid = $this->irss->manage()->find($this->getRID());
         if ($rid === null) {
             return null;
         }
         return $this->irss->manage()->getResource($rid);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRID()

ilObjFileBasedLM::getRID ( )

Definition at line 153 of file class.ilObjFileBasedLM.php.

References $rid.

Referenced by create(), getResource(), and update().

                             : ?string
     {
         return $this->rid;
     }

Here is the caller graph for this function:

◆ getStartFile()

ilObjFileBasedLM::getStartFile ( )

Definition at line 141 of file class.ilObjFileBasedLM.php.

References $start_file.

Referenced by create(), populateByDirectoy(), and update().

                                   : ?string
     {
         return $this->start_file;
     }

Here is the caller graph for this function:

◆ isInfoEnabled()

ilObjFileBasedLM::isInfoEnabled ( )

Definition at line 242 of file class.ilObjFileBasedLM.php.

References ilObject\getId(), and ilObjContentObjectAccess\isInfoEnabled().

                                    : bool
     {
         return ilObjContentObjectAccess::isInfoEnabled($this->getId());
     }

Here is the call graph for this function:

◆ populateByDirectoy()

ilObjFileBasedLM::populateByDirectoy	(	string	$a_dir,
		string	$a_filename = `""`
	)

Populate by directory.

Add a filename to do a special check for ILIAS HTML export files. If the corresponding directory is found within the passed directory path (i.e. "htlm_<id>") this subdirectory is used instead.

Definition at line 206 of file class.ilObjFileBasedLM.php.

References ilCopyWizardOptions\_getInstance(), ilObject\cloneMetaData(), getDataDirectory(), ilObject\getOfflineStatus(), getStartFile(), ilFileUtils\rCopy(), and ilFileUtils\renameExecutables().

      : void {
         preg_match("/.*htlm_([0-9]*)\.zip/", $a_filename, $match);
         if (is_dir($a_dir . "/htlm_" . ($match[1] ?? ""))) {
             $a_dir .= "/htlm_" . ($match[1] ?? "");
         }
         ilFileUtils::rCopy($a_dir, $this->getDataDirectory());
         ilFileUtils::renameExecutables($this->getDataDirectory());
     }

Here is the call graph for this function:

◆ read()

ilObjFileBasedLM::read ( )

Definition at line 70 of file class.ilObjFileBasedLM.php.

References $lm_set, $q, ilObject\getId(), setRID(), and setStartFile().

                           : void
     {
         parent::read();
 
         $q = "SELECT * FROM file_based_lm WHERE id = " . $this->db->quote($this->getId(), "integer");
         $lm_set = $this->db->query($q);
         $lm_rec = $this->db->fetchAssoc($lm_set);
         $this->setStartFile((string) ($lm_rec["startfile"] ?? ''));
         $this->setRID((string) ($lm_rec["rid"] ?? ''));
     }

Here is the call graph for this function:

◆ setRID()

ilObjFileBasedLM::setRID ( string $rid )

Definition at line 170 of file class.ilObjFileBasedLM.php.

References $rid.

Referenced by create(), and read().

                                        : void
     {
         $this->rid = $rid;
     }

Here is the caller graph for this function:

◆ setStartFile()

ilObjFileBasedLM::setStartFile	(	string	$a_file,
		bool	$a_omit_file_check = `false`
	)

Definition at line 146 of file class.ilObjFileBasedLM.php.

Referenced by create(), and read().

      : void {
         $this->start_file = $a_file;
     }

Here is the caller graph for this function:

◆ update()

ilObjFileBasedLM::update ( bool $a_skip_meta = false )

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

References ilObject\getId(), getRID(), getStartFile(), and ilObject\updateMetaData().

                                                      : bool
     {
         if (!$a_skip_meta) {
             $this->updateMetaData();
         }
         parent::update();
 
         $this->db->update(
             'file_based_lm',
             [
                 'startfile' => ['text', $this->getStartFile()],
                 'rid' => ['text', $this->getRID() ?? '']
             ],
             ['id' => ['integer', $this->getId()]]
         );
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $archives

ILIAS Filesystem Util Archive Archives ilObjFileBasedLM::$archives

private

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

◆ $irss

ILIAS ResourceStorage Services ilObjFileBasedLM::$irss

private

Definition at line 30 of file class.ilObjFileBasedLM.php.

◆ $online

bool ilObjFileBasedLM::$online

protected

Definition at line 34 of file class.ilObjFileBasedLM.php.

◆ $rid

string ilObjFileBasedLM::$rid = null

protected

Definition at line 33 of file class.ilObjFileBasedLM.php.

Referenced by getRID(), and setRID().

◆ $start_file

string ilObjFileBasedLM::$start_file = null

protected

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

Referenced by getStartFile().

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

components/ILIAS/HTMLLearningModule/classes/class.ilObjFileBasedLM.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ createDataDirectory()

◆ delete()

◆ getDataDirectory()

◆ getResource()

◆ getRID()

◆ getStartFile()

◆ isInfoEnabled()

◆ populateByDirectoy()

◆ read()

◆ setRID()

◆ setStartFile()

◆ update()

Field Documentation

◆ $archives

◆ $irss

◆ $online

◆ $rid

◆ $start_file