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

Inheritance diagram for ilObjFileBasedLM:

Collaboration diagram for ilObjFileBasedLM:

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

	update ($a_skip_meta=false)
	update object data More...

	read ()
	read object More...

	create ($a_skip_meta=false)
	create file based lm More...

	getDataDirectory ($mode="filesystem")

	createDataDirectory ()

	getStartFile ()

	setStartFile ($a_file, $a_omit_file_check=false)

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

	delete ()
	delete object and all related data More...

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

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone HTML learning module. More...

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

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

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

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

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

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

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

Data Fields
	$tree

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$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 Attributes
	$online

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Additional Inherited Members
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	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. 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. 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 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	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...

Detailed Description

File Based Learning Module (HTML) object.

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

$Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor public.

Parameters

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

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

References $DIC, and ilObject\setOfflineStatus().

     {
         global $DIC;
 
         // default is offline
         $this->setOfflineStatus(true);
 
         $this->db = $DIC->database();
         // 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

◆ cloneObject()

ilObjFileBasedLM::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone HTML learning module.

Parameters

int	target ref_id
int	copy id

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

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

     {
         $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
         $this->cloneMetaData($new_obj);
 
         //copy online status if object is not the root copy object
         $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
         if (!$cp_options->isRootNode($this->getRefId())) {
             $new_obj->setOfflineStatus($this->getOfflineStatus());
         }
 
         // copy content
         $new_obj->populateByDirectoy($this->getDataDirectory());
 
         $new_obj->setStartFile($this->getStartFile());
         $new_obj->update();
 
         return $new_obj;
     }

Here is the call graph for this function:

◆ create()

ilObjFileBasedLM::create ( $a_skip_meta = false )

create file based lm

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

References ilObject\$db, $ilDB, createDataDirectory(), and ilObject\createMetaData().

     {
         $ilDB = $this->db;
 
         parent::create();
         $this->createDataDirectory();
 
         $ilDB->manipulate("INSERT INTO file_based_lm (id, startfile) VALUES " .
             " (" . $ilDB->quote($this->getID(), "integer") . "," .
             $ilDB->quote($this->getStartfile(), "text") . ")");
         if (!$a_skip_meta) {
             $this->createMetaData();
         }
     }

Here is the call graph for this function:

◆ createDataDirectory()

ilObjFileBasedLM::createDataDirectory ( )

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

References getDataDirectory(), and ilUtil\makeDir().

Referenced by create().

     {
         ilUtil::makeDir($this->getDataDirectory());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObjFileBasedLM::delete ( )

delete object and all related data

this method has been tested on may 9th 2004 data directory, meta data, file based lm data have been deleted correctly as desired

public

Returns: boolean true if all object data were removed; false if only a references were removed

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

References ilObject\$db, $ilDB, ilUtil\delDir(), ilObject\deleteMetaData(), and getDataDirectory().

     {
         $ilDB = $this->db;
 
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         // Delete meta data
         $this->deleteMetaData();
 
         // delete file_based_lm record
         $ilDB->manipulate("DELETE FROM file_based_lm WHERE id = " .
             $ilDB->quote($this->getID(), "integer"));
 
         // delete data directory
         ilUtil::delDir($this->getDataDirectory());
 
         return true;
     }

Here is the call graph for this function:

◆ getDataDirectory()

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

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

References ilObject\getId(), and ilUtil\getWebspaceDir().

Referenced by cloneObject(), createDataDirectory(), delete(), populateByDirectoy(), and setStartFile().

     {
         $lm_data_dir = ilUtil::getWebspaceDir($mode) . "/lm_data";
         $lm_dir = $lm_data_dir . "/lm_" . $this->getId();
 
         return $lm_dir;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDiskUsage()

ilObjFileBasedLM::getDiskUsage ( )

Gets the disk usage of the object in bytes.

public

Returns: integer the disk usage in bytes

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

References ilObjFileBasedLMAccess\_lookupDiskUsage().

     {
         require_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php");
         return ilObjFileBasedLMAccess::_lookupDiskUsage($this->id);
     }

Here is the call graph for this function:

◆ getStartFile()

ilObjFileBasedLM::getStartFile ( )

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

Referenced by cloneObject().

     {
         return $this->start_file;
     }

Here is the caller graph for this function:

◆ populateByDirectoy()

ilObjFileBasedLM::populateByDirectoy	(	$a_dir,
		$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.

Parameters

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

References getDataDirectory(), ilUtil\rCopy(), and ilUtil\renameExecutables().

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

Here is the call graph for this function:

◆ read()

ilObjFileBasedLM::read ( )

read object

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

References ilObject\$db, $ilDB, $lm_set, ilObject\getId(), and setStartFile().

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

Here is the call graph for this function:

◆ setStartFile()

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

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

References getDataDirectory().

Referenced by read().

     {
         if ($a_file &&
             (file_exists($this->getDataDirectory() . "/" . $a_file) || $a_omit_file_check)) {
             $this->start_file = $a_file;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjFileBasedLM::update ( $a_skip_meta = false )

update object data

public

Returns: boolean

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

References ilObject\$db, $ilDB, League\Flysystem\Adapter\Polyfill\update(), and ilObject\updateMetaData().

     {
         $ilDB = $this->db;
 
         if (!$a_skip_meta) {
             $this->updateMetaData();
         }
         parent::update();
 
         $ilDB->manipulate($q = "UPDATE file_based_lm SET " .
             " startfile = " . $ilDB->quote($this->getStartFile(), "text") . " " .
             " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $online

ilObjFileBasedLM::$online

protected

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

◆ $tree

ilObjFileBasedLM::$tree

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

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

Modules/HTMLLearningModule/classes/class.ilObjFileBasedLM.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cloneObject()

◆ create()

◆ createDataDirectory()

◆ delete()

◆ getDataDirectory()

◆ getDiskUsage()

◆ getStartFile()

◆ populateByDirectoy()

◆ read()

◆ setStartFile()

◆ update()

Field Documentation

◆ $online

◆ $tree