Inheritance diagram for ilObjFile:

Collaboration diagram for ilObjFile:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	ilObjFile constructor. More...

	initType ()

	createProperties ($a_upload=false)
	The basic properties of a file object are stored in table object_data. More...

	setNoMetaDataCreation ($a_status)

	getDirectory ($a_version=0)

	createDirectory ()

	raiseUploadError ($a_raise=true)

	replaceFile ($a_upload_file, $a_filename)

	addFileVersion ($a_upload_file, $a_filename)

	copy ($a_source, $a_destination)
	copy file More...

	clearDataDirectory ()
	clear data directory More...

	deleteVersions ($a_hist_entry_ids=null)
	Deletes the specified history entries or all entries if no ids are specified. More...

	setFileName ($a_name)

	getFileName ()

	setFileType ($a_type)

	getFileType ()

	setFileSize ($a_size)

	getFileSize ()

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

	getFile ($a_hist_entry_id=null)

	setVersion ($a_version)

	getVersion ()

	setMode ($a_mode)
	mode is object or filelist More...

	getMode ()
	mode is object or filelist More...

	determineFileSize ($a_hist_entry_id=null)
	Determine File Size. More...

	getFileExtension ()
	Returns the extension of the file name converted to lower-case. More...

	isInline ()
	Returns true, if this file should be displayed inline in a browser window. More...

	isHidden ()
	Returns true, if this file should be hidden in the repository view. More...

	guessFileType ($a_file="")
	Guesses the file type based on the current values returned by getFileType() and getFileExtension(). More...

	export ($a_target_dir)
	export files of object to target directory note: target directory must be the export target directory, "/objects/il_<inst>_file_<file_id>/..." will be appended to this directory More...

	getUsages ()
	get all usages of file object More...

	getXMLZip ()

	addNewsNotification ($a_lang_var)

	initFileStorage ()
	init file storage object More...

	storeUnzipedFile ($a_upload_file, $a_filename)
	storeUnzipedFile More...

	checkFileExtension ($new_filename, $new_title)
	Check if the file extension does still exist after an update of the title. More...

	getVersions ($version_ids=null)
	Gets the file versions for this object. More...

	getSpecificVersion ($version_id)
	Gets a specific file version. More...

	rollback ($version_id)
	Makes the specified version the current one and returns theSummary of rollbackVersion. More...

	compareVersions ($v1, $v2)
	Compares two file versions. More...

	parseInfoParams ($entry)
	Parses the info parameters ("info_params") of the specified history entry. More...

	setRating ($a_value)

	hasRating ()

	getPageCount ()

	setPageCount ($page_count)

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

	withReferences ()

	read ()
	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 ()

	setOwner ($a_owner)

	getCreateDate ()

	getLastUpdateDate ()

	create ($a_clone_mode=false)

	update ()

	MDUpdateListener ($a_element)

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()

	putInTree ($a_parent_ref)

	setPermissions ($a_parent_ref)

	createReference ()

	countReferences ()

	delete ()

	initDefaultRoles ()

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

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

Static Public Member Functions
static	_writeFileType ($a_id, $a_format)

static	_lookupFileName ($a_id)

static	_lookupFileSize ($a_id)
	Lookups the file size of the file in bytes. More...

static	_lookupVersion ($a_id)
	lookup version More...

static	_deleteAllUsages ($a_type, $a_id, $a_usage_hist_nr=0, $a_usage_lang="-")
	static delete all usages of More...

static	_saveUsage ($a_file_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_usage_lang="-")
	save usage More...

static	_getFilesOfObject ($a_type, $a_id, $a_usage_hist_nr=0, $a_usage_lang="-")
	get all files of an object More...

static	_lookupAbsolutePath ($obj_id, $a_version=null)

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

static	_lookupOwnerName ($a_owner_id)

static	_getIdForImportId ($a_import_id)

static	_getAllReferences ($a_id)

static	_lookupTitle ($a_id)

static	_lookupOwner ($a_id)

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

static	_lookupDescription ($a_id)

static	_lookupLastUpdate ($a_id, $a_as_string=false)

static	_getLastUpdateOfObjects ($a_objs)

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)

static	_resetDeletedDate ($a_ref_id)

static	_lookupDeletedDate ($a_ref_id)

static	_writeTitle ($a_obj_id, $a_title)

static	_writeDescription ($a_obj_id, $a_desc)

static	_writeImportId ($a_obj_id, $a_import_id)

static	_lookupType ($a_id, $a_reference=false)

static	_isInTrash ($a_ref_id)

static	_hasUntrashedReference ($a_obj_id)

static	_lookupObjectId ($a_ref_id)

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)

static	_exists ($a_id, $a_reference=false, $a_type=null)

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

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)

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

Data Fields
const	MODE_FILELIST = "filelist"

const	MODE_OBJECT = "object"

	$raise_upload_error

	$mode = self::MODE_OBJECT

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 Member Functions
	doCreate ($a_upload=false)
	create object More...

	beforeCreateMetaData ()

	beforeUpdateMetaData ()

	doCreateMetaData ()
	create file object meta data More...

	beforeMDUpdateListener ($a_element)

	doMDUpdateListener ($a_element)

	doRead ()

	beforeUpdate ()

	doUpdate ()

	doUpdateMetaData ()
	update meta data More...

	doCloneObject ($a_new_obj, $a_target_id, $a_copy_id=0)
	Clone. More...

	beforeDelete ()

	doDelete ()

	updateWithVersion ($version)
	Updates the file object with the specified file version. More...

	createPreview ($force=false)
	Creates a preview for the file object. More...

	deletePreview ()
	Deletes the preview of the file object. 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 ()

Static Protected Member Functions
static	handleQuotaUpdate (ilObjFile $a_file)

Protected Attributes
	$no_meta_data_creation

	$filename = ''

	$filetype = ''

	$filemaxsize = "20000000"

	$filesize

	$page_count = 0

	$rating = false

	$log = null

	$version = 1

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Private Member Functions
	getArrayForDatabase ()

Private Attributes
	$file_storage = null

Detailed Description

Class ilObjFile.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

ilObjFile constructor.

Parameters

int	$a_id	ID of the object, ref_id or obj_id possible
bool	$a_call_by_reference	defines the $a_id a ref_id

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

References ilObject2\getId(), ilLoggerFactory\getLogger(), and initFileStorage().

     {
         $this->version = 0;
         $this->raise_upload_error = true;
 
         $this->log = ilLoggerFactory::getLogger('file');
 
         parent::__construct($a_id, $a_call_by_reference);
 
         if ($this->getId()) {
             $this->initFileStorage();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAllUsages()

static ilObjFile::_deleteAllUsages	(	$a_type,
		$a_id,
		$a_usage_hist_nr = `0`,
		$a_usage_lang = `"-"`
	)

static

static delete all usages of

Definition at line 970 of file class.ilObjFile.php.

References $a_type, $DIC, $ilDB, $row, and array.

Referenced by ilPCFileList\beforePageDelete(), and ilPCFileList\saveFileUsage().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $and_hist = ($a_usage_hist_nr !== false) ? " AND usage_hist_nr = "
             . $ilDB->quote($a_usage_hist_nr, "integer") : "";
 
         $file_ids = array();
         $set = $ilDB->query("SELECT id FROM file_usage" . " WHERE usage_type = "
             . $ilDB->quote($a_type, "text") . " AND usage_id= "
             . $ilDB->quote($a_id, "integer") . " AND usage_lang= "
             . $ilDB->quote($a_usage_lang, "text") . $and_hist);
         while ($row = $ilDB->fetchAssoc($set)) {
             $file_ids[] = $row["id"];
         }
 
         $ilDB->manipulate("DELETE FROM file_usage WHERE usage_type = "
             . $ilDB->quote($a_type, "text") . " AND usage_id = "
             . $ilDB->quote((int) $a_id, "integer") . " AND usage_lang= "
             . $ilDB->quote($a_usage_lang, "text") . " AND usage_hist_nr = "
             . $ilDB->quote((int) $a_usage_hist_nr, "integer"));
 
         foreach ($file_ids as $file_id) {
             self::handleQuotaUpdate(new self($file_id, false));
         }
     }

Here is the caller graph for this function:

◆ _getFilesOfObject()

static ilObjFile::_getFilesOfObject	(	$a_type,
		$a_id,
		$a_usage_hist_nr = `0`,
		$a_usage_lang = `"-"`
	)

static

get all files of an object

Parameters

string	$a_type	object type (e.g. "lm:pg")
int	$a_id	object id

Returns: array array of file ids

Definition at line 1057 of file class.ilObjFile.php.

References $a_type, $DIC, $ilDB, $ret, and array.

Referenced by ilPCFileList\afterPageUpdate(), ilCOPageHTMLExport\collectPageElements(), ilPageObjectGUI\downloadFile(), ilObjGlossary\exportHTMLGlossaryTerms(), ilObjContentObject\exportHTMLGlossaryTerms(), ilObjContentObject\exportHTMLPages(), ilPageObject\getLastUpdateOfIncludedElements(), and ilCOPageExporter\getXmlExportHeadDependencies().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $lstr = "";
         if ($a_usage_lang != "") {
             $lstr = "usage_lang = " . $ilDB->quote((string) $a_usage_lang, "text") . " AND ";
         }
 
         // get usages in learning modules
         $q = "SELECT * FROM file_usage WHERE " . "usage_id = " . $ilDB->quote((int) $a_id, "integer")
             . " AND " . "usage_type = " . $ilDB->quote((string) $a_type, "text") . " AND " . $lstr
             . "usage_hist_nr = " . $ilDB->quote((int) $a_usage_hist_nr, "integer");
         $file_set = $ilDB->query($q);
         $ret = array();
         while ($file_rec = $ilDB->fetchAssoc($file_set)) {
             $ret[$file_rec["id"]] = $file_rec["id"];
         }
 
         return $ret;
     }

Here is the caller graph for this function:

◆ _lookupAbsolutePath()

static ilObjFile::_lookupAbsolutePath	(	$obj_id,
		$a_version = `null`
	)

static

Parameters

int	$obj_id
int	$a_version

Returns: string

Exceptions

Definition at line 1171 of file class.ilObjFile.php.

References $s.

Referenced by ilFolderDownloadBackgroundTaskHandler\copyFile(), ilContainerGUI\copyFile(), and ilObjFolder\recurseFolder().

     {
         $file_object = new self($obj_id, false);
         $s = new FilePathSanitizer($file_object);
         $s->sanitizeIfNeeded();
 
         return $file_object->getFile($a_version);
     }

Here is the caller graph for this function:

◆ _lookupFileName()

static ilObjFile::_lookupFileName ( $a_id )

static

Parameters

$a_id

Returns: string

Deprecated:: Static methods will be removed in a future version of ILIAS

Definition at line 672 of file class.ilObjFile.php.

References $DIC, $ilDB, $r, $row, ilDBConstants\FETCHMODE_OBJECT, and ilUtil\stripSlashes().

Referenced by ilSCORM2004PageGUI\setDefaultLinkXml(), and ilFilePreviewRenderer\supports().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $q = "SELECT * FROM file_data WHERE file_id = " . $ilDB->quote($a_id, 'integer');
         $r = $ilDB->query($q);
         $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
         $strip_slashes = ilUtil::stripSlashes($row->file_name);
 
         return $strip_slashes;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupFileSize()

static ilObjFile::_lookupFileSize ( $a_id )

static

Lookups the file size of the file in bytes.

Definition at line 688 of file class.ilObjFile.php.

References ilObjFileAccess\_lookupFileSize().

Referenced by ilPageObject\addFileSizes(), ilObjFileDAV\getContentLength(), and ilObjFileGUI\infoScreenForward().

     {
         require_once("./Modules/File/classes/class.ilObjFileAccess.php");
 
         return ilObjFileAccess::_lookupFileSize($a_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupVersion()

static ilObjFile::_lookupVersion ( $a_id )

static

lookup version

Definition at line 699 of file class.ilObjFile.php.

References ilObjFileAccess\_lookupVersion().

     {
         require_once("./Modules/File/classes/class.ilObjFileAccess.php");
 
         return ilObjFileAccess::_lookupVersion($a_id);
     }

Here is the call graph for this function:

◆ _saveUsage()

static ilObjFile::_saveUsage	(	$a_file_id,
		$a_type,
		$a_id,
		$a_usage_hist_nr = `0`,
		$a_usage_lang = `"-"`
	)

static

save usage

Definition at line 1002 of file class.ilObjFile.php.

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

Referenced by ilPCFileList\saveFileUsage().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         // check if file really exists
         if (ilObject::_lookupType($a_file_id) != "file") {
             return;
         }
         // #15143
         $ilDB->replace("file_usage", array(
             "id"            => array("integer", (int) $a_file_id),
             "usage_type"    => array("text", (string) $a_type),
             "usage_id"      => array("integer", (int) $a_id),
             "usage_hist_nr" => array("integer", (int) $a_usage_hist_nr),
             "usage_lang"    => array("text", $a_usage_lang),
         ), array());
 
         self::handleQuotaUpdate(new self($a_file_id, false));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeFileType()

static ilObjFile::_writeFileType	(	$a_id,
		$a_format
	)

static

Definition at line 655 of file class.ilObjFile.php.

References $DIC, $ilDB, and $res.

Referenced by doMDUpdateListener().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $q = "UPDATE file_data SET " . " file_type = " . $ilDB->quote($a_format, 'text')
             . " WHERE file_id = " . $ilDB->quote($a_id, 'integer');
         $res = $ilDB->manipulate($q);
     }

Here is the caller graph for this function:

◆ addFileVersion()

ilObjFile::addFileVersion	(	$a_upload_file,
		$a_filename
	)

Definition at line 360 of file class.ilObjFile.php.

References $result, ilHistory\_createEntry(), addNewsNotification(), createPreview(), ilObject2\getId(), and getVersion().

     {
         if ($result = $this->getUploadFile($a_upload_file, $a_filename, true)) {
             ilHistory::_createEntry($this->getId(), "new_version", $result->getName() . "," . $this->getVersion());
             $this->addNewsNotification("file_updated");
 
             // create preview
             $this->createPreview($this->getVersion() > 1);
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ addNewsNotification()

ilObjFile::addNewsNotification ( $a_lang_var )

Definition at line 1096 of file class.ilObjFile.php.

References $DIC, $ilUser, ilObject2\getDescription(), ilObject2\getId(), ilObject2\getType(), isHidden(), NEWS_NOTICE, and NEWS_USERS.

Referenced by addFileVersion(), createProperties(), replaceFile(), and rollback().

     {
         // BEGIN WebDAV Suppress news notification for hidden files
         if ($this->isHidden()) {
             return;
         }
         // END WebDAV Suppress news notification for hidden files
 
         global $DIC;
         $ilUser = $DIC['ilUser'];
 
         // Add Notification to news
         include_once("./Services/News/classes/class.ilNewsItem.php");
         include_once("./Modules/File/classes/class.ilObjFileAccess.php");
         $news_item = new ilNewsItem();
         $news_item->setContext($this->getId(), $this->getType());
         $news_item->setPriority(NEWS_NOTICE);
         $news_item->setTitle($a_lang_var);
         $news_item->setContentIsLangVar(true);
         if ($this->getDescription() != "") {
             $news_item->setContent("<p>" . $this->getDescription() . "</p>");
         }
         $news_item->setUserId($ilUser->getId());
         $news_item->setVisibility(NEWS_USERS);
         $news_item->create();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeCreateMetaData()

ilObjFile::beforeCreateMetaData ( )

protected

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

     {
         return !(bool) $this->no_meta_data_creation;
     }

◆ beforeDelete()

ilObjFile::beforeDelete ( )

protected

Definition at line 900 of file class.ilObjFile.php.

References $DIC, $ilDB, and getUsages().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         // check, if file is used somewhere
         $usages = $this->getUsages();
         if (count($usages) == 0) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ beforeMDUpdateListener()

ilObjFile::beforeMDUpdateListener ( $a_element )

protected

Definition at line 195 of file class.ilObjFile.php.

References ilObject\$title, checkFileExtension(), getFileName(), ilObject2\getId(), and ilObject2\getType().

     {
         // Check file extension
         // Removing the file extension is not allowed
         include_once 'Services/MetaData/classes/class.ilMD.php';
         $md = new ilMD($this->getId(), 0, $this->getType());
         if (!is_object($md_gen = $md->getGeneral())) {
             return false;
         }
         $title = $this->checkFileExtension($this->getFileName(), $md_gen->getTitle());
         $md_gen->setTitle($title);
         $md_gen->update();
 
         return true;
     }

Here is the call graph for this function:

◆ beforeUpdate()

ilObjFile::beforeUpdate ( )

protected

Definition at line 477 of file class.ilObjFile.php.

References getMode(), and ilObject2\updateMetaData().

     {
         // no meta data handling for file list files
         if ($this->getMode() != self::MODE_FILELIST) {
             $this->updateMetaData();
         }
 
         return true;
     }

Here is the call graph for this function:

◆ beforeUpdateMetaData()

ilObjFile::beforeUpdateMetaData ( )

protected

Definition at line 172 of file class.ilObjFile.php.

     {
         return !(bool) $this->no_meta_data_creation;
     }

◆ checkFileExtension()

ilObjFile::checkFileExtension	(	$new_filename,
		$new_title
	)

Check if the file extension does still exist after an update of the title.

Returns

Definition at line 1186 of file class.ilObjFile.php.

References ilObjFileAccess\_getFileExtension(), and getFileName().

Referenced by beforeMDUpdateListener(), and updateWithVersion().

     {
         include_once './Modules/File/classes/class.ilObjFileAccess.php';
         $fileExtension = ilObjFileAccess::_getFileExtension($new_filename);
         $titleExtension = ilObjFileAccess::_getFileExtension($new_title);
         if ($titleExtension != $fileExtension && strlen($fileExtension) > 0) {
             // remove old extension
             $pi = pathinfo($this->getFileName());
             $suffix = $pi["extension"];
             if ($suffix != "") {
                 if (substr($new_title, strlen($new_title) - strlen($suffix) - 1) == "." . $suffix) {
                     $new_title = substr($new_title, 0, strlen($new_title) - strlen($suffix) - 1);
                 }
             }
             $new_title .= '.' . $fileExtension;
         }
 
         return $new_title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearDataDirectory()

ilObjFile::clearDataDirectory ( )

clear data directory

Definition at line 386 of file class.ilObjFile.php.

References createDirectory(), ilUtil\delDir(), and getDirectory().

Referenced by deleteVersions().

     {
         ilUtil::delDir($this->getDirectory());
         $this->createDirectory();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compareVersions()

ilObjFile::compareVersions	(	$v1,
		$v2
	)

Compares two file versions.

Parameters

array	$v1	First file version to compare.
array	$v2	Second file version to compare.

Returns: int Returns an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

Definition at line 1367 of file class.ilObjFile.php.

     {
         // v2 - v1 because version should be descending
         return (int) $v2["version"] - (int) $v1["version"];
     }

◆ copy()

ilObjFile::copy	(	$a_source,
		$a_destination
	)

copy file

Definition at line 377 of file class.ilObjFile.php.

References getDirectory().

Referenced by rollback().

     {
         return copy($a_source, $this->getDirectory() . "/" . $a_destination);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDirectory()

ilObjFile::createDirectory ( )

Definition at line 265 of file class.ilObjFile.php.

References getDirectory(), and ilUtil\makeDirParents().

Referenced by clearDataDirectory().

     {
         ilUtil::makeDirParents($this->getDirectory());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPreview()

ilObjFile::createPreview ( $force = false )

protected

Creates a preview for the file object.

Parameters

bool $force true, to force the creation of the preview; false, to create the preview only if the file is newer.

Definition at line 1445 of file class.ilObjFile.php.

References ilPreview\createPreview(), and getMode().

Referenced by addFileVersion(), raiseUploadError(), replaceFile(), storeUnzipedFile(), and updateWithVersion().

     {
         // only normal files are supported
         if ($this->getMode() != self::MODE_OBJECT) {
             return;
         }
 
         require_once("./Services/Preview/classes/class.ilPreview.php");
         ilPreview::createPreview($this, $force);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createProperties()

ilObjFile::createProperties ( $a_upload = false )

The basic properties of a file object are stored in table object_data.

This is not sufficient for a file object. Therefore we create additional properties in table file_data. This method has been put into a separate operation, to allow a WebDAV Null resource (class.ilObjNull.php) to become a file object.

Definition at line 119 of file class.ilObjFile.php.

References $_GET, $DIC, ilHistory\_createEntry(), ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_write(), addNewsNotification(), ilObject2\createMetaData(), ilLogLevel\DEBUG, getArrayForDatabase(), ilStr\getBytesForString(), getFileName(), getFileSize(), getFileType(), ilObject2\getId(), getMode(), and initFileStorage().

Referenced by doCreate().

     {
         global $DIC;
 
         // Create file directory
         $this->initFileStorage();
         $this->file_storage->create();
 
         if ($a_upload) {
             return true;
         }
 
         // not upload mode
         ilHistory::_createEntry($this->getId(), "create", $this->getFileName() . ",1");
         $this->addNewsNotification("file_created");
 
         // New Item
         $default_visibility = ilNewsItem::_getDefaultVisibilityForRefId($_GET['ref_id']);
         if ($default_visibility == "public") {
             ilBlockSetting::_write("news", "public_notifications", 1, 0, $this->getId());
         }
 
         // log creation
         $this->log->debug("ilObjFile::createProperties, ID: " . $this->getId() . ", Name: "
             . $this->getFileName() . ", Type: " . $this->getFileType() . ", Size: "
             . $this->getFileSize() . ", Mode: " . $this->getMode() . ", Name(Bytes): "
             . implode(":", ilStr::getBytesForString($this->getFileName())));
         $this->log->logStack(ilLogLevel::DEBUG);
 
         $DIC->database()->insert('file_data', $this->getArrayForDatabase());
 
         // no meta data handling for file list files
         if ($this->getMode() != self::MODE_FILELIST) {
             $this->createMetaData();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deletePreview()

ilObjFile::deletePreview ( )

protected

Deletes the preview of the file object.

Definition at line 1460 of file class.ilObjFile.php.

References ilPreview\deletePreview(), ilObject2\getId(), and getMode().

Referenced by doDelete().

     {
         // only normal files are supported
         if ($this->getMode() != self::MODE_OBJECT) {
             return;
         }
 
         require_once("./Services/Preview/classes/class.ilPreview.php");
         ilPreview::deletePreview($this->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteVersions()

ilObjFile::deleteVersions ( $a_hist_entry_ids = null )

Deletes the specified history entries or all entries if no ids are specified.

Parameters

array $a_hist_entry_ids The ids of the entries to delete or null to delete all entries

Definition at line 398 of file class.ilObjFile.php.

References $DIC, $ilDB, $index, $version, ilHistory\_removeEntriesForObject(), ilHistory\_removeEntryByHistoryID(), clearDataDirectory(), ilUtil\delDir(), getDirectory(), ilObject2\getId(), getVersion(), getVersions(), setVersion(), and updateWithVersion().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if ($a_hist_entry_ids == null || count($a_hist_entry_ids) < 1) {
             $ilDB->manipulate("UPDATE file_data SET version = 1 WHERE file_id = "
                 . $ilDB->quote($this->getId(), 'integer'));
             $this->setVersion(0);
             $this->clearDataDirectory();
 
             ilHistory::_removeEntriesForObject($this->getId());
 
             self::handleQuotaUpdate($this);
         } else {
             $actualVersionDeleted = false;
 
             // get all versions
             $versions = $this->getVersions();
 
             // delete each version
             foreach ($a_hist_entry_ids as $hist_id) {
                 $entry = null;
 
                 // get version
                 foreach ($versions as $index => $version) {
                     if ($version["hist_entry_id"] == $hist_id) {
                         // remove each history entry
                         ilHistory::_removeEntryByHistoryID($hist_id);
 
                         // delete directory
                         $version_dir = $this->getDirectory($version["version"]);
                         ilUtil::delDir($version_dir);
 
                         // is actual version?
                         if ($version["version"] == $this->getVersion()) {
                             $actualVersionDeleted = true;
                         }
 
                         // remove from array
                         unset($versions[$index]);
                         break;
                     }
                 }
             }
 
             // update actual version if it was deleted before
             if ($actualVersionDeleted) {
                 // get newest version (already sorted by getVersions)
                 $version = reset($versions);
                 $this->updateWithVersion($version);
             } else {
                 // updateWithVersion() will trigger quota, too
                 self::handleQuotaUpdate($this);
             }
         }
     }

Here is the call graph for this function:

◆ determineFileSize()

ilObjFile::determineFileSize ( $a_hist_entry_id = null )

Determine File Size.

Definition at line 710 of file class.ilObjFile.php.

References $data, $DIC, $file, $s, ilHistory\_getEntryByHistoryID(), ilFileDelivery\DISP_ATTACHMENT, ilFileDelivery\DISP_INLINE, getDirectory(), getFileName(), ilObject2\getTitle(), ilFileUtils\getValidFilename(), getVersion(), guessFileType(), isInline(), parseInfoParams(), and setFileSize().

Referenced by updateWithVersion().

     {
         if (is_null($a_hist_entry_id)) {
             $file = $this->getDirectory($this->getVersion()) . "/" . $this->getFileName();
         } else {
             require_once("./Services/History/classes/class.ilHistory.php");
             $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
 
             if ($entry === false) {
                 return false;
             }
 
             $data = $this->parseInfoParams($entry);
             $file = $this->getDirectory($data["version"]) . "/" . $data["filename"];
         }
         if (is_file($file)) {
             $this->setFileSize(filesize($file));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCloneObject()

ilObjFile::doCloneObject	(	$a_new_obj,
		$a_target_id,
		$a_copy_id = `0`
	)

protected

Clone.

public

Parameters

object	clone
int	target id
int	copy id

Definition at line 857 of file class.ilObjFile.php.

References $DIC, $ilDB, $query, $res, ilHistory\_copyEntriesForObject(), ilObject2\cloneMetaData(), ilPreview\copyPreviews(), getDirectory(), ilObject2\getId(), and ilUtil\rCopy().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $a_new_obj->createDirectory();
         $this->cloneMetaData($a_new_obj);
 
         // Copy all file versions
         ilUtil::rCopy($this->getDirectory(), $a_new_obj->getDirectory());
 
         // object created now copy other settings
         $query = "INSERT INTO file_data (file_id,file_name,file_type,file_size,version,rating,f_mode) VALUES ("
             . $ilDB->quote($a_new_obj->getId(), 'integer') . ","
             . $ilDB->quote($this->getFileName(), 'text') . ","
             . $ilDB->quote($this->getFileType(), 'text') . ","
             . $ilDB->quote((int) $this->getFileSize(), 'integer') . ", "
             . $ilDB->quote($this->getVersion(), 'integer') . ", "
             . $ilDB->quote($this->hasRating(), 'integer') . ", "
             . $ilDB->quote($this->getMode(), 'text') . ")";
         $res = $ilDB->manipulate($query);
 
         // copy all previews
         require_once("./Services/Preview/classes/class.ilPreview.php");
         ilPreview::copyPreviews($this->getId(), $a_new_obj->getId());
 
         // copy history entries
         require_once("./Services/History/classes/class.ilHistory.php");
         ilHistory::_copyEntriesForObject($this->getId(), $a_new_obj->getId());
 
         // Copy learning progress settings
         include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
         $obj_settings = new ilLPObjSettings($this->getId());
         $obj_settings->cloneSettings($a_new_obj->getId());
         unset($obj_settings);
 
         // add news notification
         $a_new_obj->addNewsNotification("file_created");
 
         return $a_new_obj;
     }

Here is the call graph for this function:

◆ doCreate()

ilObjFile::doCreate ( $a_upload = false )

protected

create object

Parameters

bool	upload mode (if enabled no entries in file_data will be done)

Definition at line 106 of file class.ilObjFile.php.

References createProperties().

     {
         $this->createProperties($a_upload);
     }

Here is the call graph for this function:

◆ doCreateMetaData()

ilObjFile::doCreateMetaData ( )

protected

create file object meta data

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

References $format, getFileSize(), getFileType(), ilObject2\getId(), and ilObject2\getType().

     {
         // add technical section with file size and format
         $md_obj = new ilMD($this->getId(), 0, $this->getType());
         $technical = $md_obj->addTechnical();
         $technical->setSize($this->getFileSize());
         $technical->save();
         $format = $technical->addFormat();
         $format->setFormat($this->getFileType());
         $format->save();
         $technical->update();
     }

Here is the call graph for this function:

◆ doDelete()

ilObjFile::doDelete ( )

protected

Definition at line 915 of file class.ilObjFile.php.

References $DIC, $ilDB, ilHistory\_removeEntriesForObject(), ilUtil\delDir(), ilObject2\deleteMetaData(), deletePreview(), getDirectory(), ilObject2\getId(), and getMode().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         // delete file data entry
         $q = "DELETE FROM file_data WHERE file_id = " . $ilDB->quote($this->getId(), 'integer');
         $this->ilias->db->query($q);
 
         // delete history entries
         require_once("./Services/History/classes/class.ilHistory.php");
         ilHistory::_removeEntriesForObject($this->getId());
 
         self::handleQuotaUpdate($this);
 
         // delete entire directory and its content
         if (@is_dir($this->getDirectory())) {
             ilUtil::delDir($this->getDirectory());
         }
 
         // delete meta data
         if ($this->getMode() != self::MODE_FILELIST) {
             $this->deleteMetaData();
         }
 
         // delete preview
         $this->deletePreview();
     }

Here is the call graph for this function:

◆ doMDUpdateListener()

ilObjFile::doMDUpdateListener ( $a_element )

protected

Definition at line 212 of file class.ilObjFile.php.

References ilObject\$id, _writeFileType(), ilObject2\getId(), ilObject2\getType(), and setFileType().

     {
         // handling for technical section
         include_once 'Services/MetaData/classes/class.ilMD.php';
 
         switch ($a_element) {
             case 'Technical':
 
                 // Update Format (size is not stored in db)
                 $md = new ilMD($this->getId(), 0, $this->getType());
                 if (!is_object($md_technical = $md->getTechnical())) {
                     return false;
                 }
 
                 foreach ($md_technical->getFormatIds() as $id) {
                     $md_format = $md_technical->getFormat($id);
                     ilObjFile::_writeFileType($this->getId(), $md_format->getFormat());
                     $this->setFileType($md_format->getFormat());
                     break;
                 }
 
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ doRead()

ilObjFile::doRead ( )

protected

Definition at line 457 of file class.ilObjFile.php.

References $DIC, $r, $row, ilObject2\getId(), initFileStorage(), setFileName(), setFileSize(), setFileType(), setMode(), setPageCount(), setRating(), and setVersion().

     {
         global $DIC;
 
         $q = "SELECT * FROM file_data WHERE file_id = %s";
         $r = $DIC->database()->queryF($q, ['integer'], [$this->getId()]);
         $row = $r->fetchObject();
 
         $this->setFileName($row->file_name);
         $this->setFileType($row->file_type);
         $this->setFileSize($row->file_size);
         $this->setVersion($row->version ? $row->version : 1);
         $this->setMode($row->f_mode);
         $this->setRating($row->rating);
         $this->setPageCount($row->page_count);
 
         $this->initFileStorage();
     }

Here is the call graph for this function:

◆ doUpdate()

ilObjFile::doUpdate ( )

protected

Definition at line 488 of file class.ilObjFile.php.

References $DIC, getArrayForDatabase(), and ilObject2\getId().

Referenced by raiseUploadError().

     {
         global $DIC;
 
         $a_columns = $this->getArrayForDatabase();
         $DIC->database()->update('file_data', $a_columns, [
             'file_id' => [
                 'integer',
                 $this->getId(),
             ],
         ]);
 
         self::handleQuotaUpdate($this);
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdateMetaData()

ilObjFile::doUpdateMetaData ( )

protected

update meta data

Definition at line 509 of file class.ilObjFile.php.

References $format, getFileSize(), getFileType(), ilObject2\getId(), and ilObject2\getType().

     {
         // add technical section with file size and format
         $md_obj = new ilMD($this->getId(), 0, $this->getType());
         if (!is_object($technical = $md_obj->getTechnical())) {
             $technical = $md_obj->addTechnical();
             $technical->save();
         }
         $technical->setSize($this->getFileSize());
 
         $format_ids = $technical->getFormatIds();
         if (count($format_ids) > 0) {
             $format = $technical->getFormat($format_ids[0]);
             $format->setFormat($this->getFileType());
             $format->update();
         } else {
             $format = $technical->addFormat();
             $format->setFormat($this->getFileType());
             $format->save();
         }
         $technical->update();
     }

Here is the call graph for this function:

◆ export()

ilObjFile::export ( $a_target_dir )

export files of object to target directory note: target directory must be the export target directory, "/objects/il_<inst>_file_<file_id>/..." will be appended to this directory

Parameters

string $a_target_dir target directory

Definition at line 952 of file class.ilObjFile.php.

References getDirectory(), ilObject2\getId(), getVersion(), ilUtil\makeDir(), and ilUtil\rCopy().

     {
         $subdir = "il_" . IL_INST_ID . "_file_" . $this->getId();
         ilUtil::makeDir($a_target_dir . "/objects/" . $subdir);
 
         $filedir = $this->getDirectory($this->getVersion());
 
         if (@!is_dir($filedir)) {
             $filedir = $this->getDirectory();
         }
 
         ilUtil::rCopy($filedir, $a_target_dir . "/objects/" . $subdir);
     }

Here is the call graph for this function:

◆ getArrayForDatabase()

ilObjFile::getArrayForDatabase ( )

private

Returns: array

Definition at line 1511 of file class.ilObjFile.php.

References getFileName(), getFileSize(), getFileType(), ilObject2\getId(), getMode(), getPageCount(), getVersion(), and hasRating().

Referenced by createProperties(), and doUpdate().

     {
         return [
             'file_id'    => ['integer', $this->getId()],
             'file_name'  => ['text', $this->getFileName()],
             'file_type'  => ['text', $this->getFileType()],
             'file_size'  => ['integer', (int) $this->getFileSize()],
             'version'    => ['integer', (int) $this->getVersion()],
             'f_mode'     => ['text', $this->getMode()],
             'page_count' => ['text', $this->getPageCount()],
             'rating'     => ['integer', $this->hasRating()],
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDirectory()

ilObjFile::getDirectory ( $a_version = 0 )

Parameters

int $a_version

Returns: string

Definition at line 245 of file class.ilObjFile.php.

References initFileStorage().

Referenced by clearDataDirectory(), copy(), createDirectory(), deleteVersions(), determineFileSize(), doCloneObject(), doDelete(), export(), getFile(), getXMLZip(), raiseUploadError(), rollback(), and storeUnzipedFile().

     {
         $version_subdir = "";
 
         if ($a_version) {
             // BEGIN WebDAV Avoid double slash before version subdirectory
             $version_subdir = sprintf("%03d", $a_version);
             // END WebDAV Avoid  double slash before version subdirectory
         }
 
         if (!is_object($this->file_storage)) {
             $this->initFileStorage();
         }
 
         $str = $this->file_storage->getAbsolutePath() . '/' . $version_subdir;
 
         return $str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDiskUsage()

ilObjFile::getDiskUsage ( )

Gets the disk usage of the object in bytes.

public

Returns: integer the disk usage in bytes

Definition at line 590 of file class.ilObjFile.php.

References ilObjFileAccess\_lookupDiskUsage().

Referenced by handleQuotaUpdate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFile()

ilObjFile::getFile ( $a_hist_entry_id = null )

Definition at line 599 of file class.ilObjFile.php.

References $data, $file, ilHistory\_getEntryByHistoryID(), getDirectory(), getFileName(), getVersion(), and parseInfoParams().

     {
         if (is_null($a_hist_entry_id)) {
             $file = $this->getDirectory($this->getVersion()) . "/" . $this->getFileName();
         } else {
             require_once("./Services/History/classes/class.ilHistory.php");
             $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
 
             if ($entry === false) {
                 return false;
             }
 
             $data = $this->parseInfoParams($entry);
             $file = $this->getDirectory($data["version"]) . "/" . $data["filename"];
         }
 
         return $file;
     }

Here is the call graph for this function:

◆ getFileExtension()

ilObjFile::getFileExtension ( )

Returns the extension of the file name converted to lower-case.

e.g. returns 'pdf' for 'document.pdf'.

Definition at line 793 of file class.ilObjFile.php.

References ilObjFileAccess\_getFileExtension(), and ilObject2\getTitle().

Referenced by guessFileType().

     {
         require_once 'Modules/File/classes/class.ilObjFileAccess.php';
 
         return ilObjFileAccess::_getFileExtension($this->getTitle());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileName()

ilObjFile::getFileName ( )

Returns: string

Definition at line 545 of file class.ilObjFile.php.

References $filename.

Referenced by beforeMDUpdateListener(), checkFileExtension(), createProperties(), determineFileSize(), getArrayForDatabase(), getFile(), and getXMLZip().

     {
         return $this->filename;
     }

Here is the caller graph for this function:

◆ getFileSize()

ilObjFile::getFileSize ( )

Definition at line 578 of file class.ilObjFile.php.

References $filesize.

Referenced by createProperties(), doCreateMetaData(), doUpdateMetaData(), and getArrayForDatabase().

     {
         return $this->filesize;
     }

Here is the caller graph for this function:

◆ getFileType()

ilObjFile::getFileType ( )

Returns: string

Definition at line 563 of file class.ilObjFile.php.

References $filetype.

Referenced by createProperties(), doCreateMetaData(), doUpdateMetaData(), getArrayForDatabase(), and guessFileType().

     {
         return $this->filetype;
     }

Here is the caller graph for this function:

◆ getMode()

ilObjFile::getMode ( )

mode is object or filelist

Returns: string mode

Definition at line 649 of file class.ilObjFile.php.

References $mode.

Referenced by beforeUpdate(), createPreview(), createProperties(), deletePreview(), doDelete(), and getArrayForDatabase().

     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getPageCount()

ilObjFile::getPageCount ( )

Returns: int

Definition at line 1493 of file class.ilObjFile.php.

References $page_count.

Referenced by getArrayForDatabase().

     {
         return $this->page_count;
     }

Here is the caller graph for this function:

◆ getSpecificVersion()

ilObjFile::getSpecificVersion ( $version_id )

Gets a specific file version.

Parameters

int $version_id The version id to get.

Returns: array The specific version or false if the version was not found.

Definition at line 1248 of file class.ilObjFile.php.

References $params, $version, ilHistory\_getEntryByHistoryID(), and parseInfoParams().

Referenced by rollback().

     {
         include_once("./Services/History/classes/class.ilHistory.php");
         $version = ilHistory::_getEntryByHistoryID($version_id);
         if ($version === false) {
             return false;
         }
 
         // ilHistory returns different keys in _getEntryByHistoryID and _getEntriesForObject
         // so this makes it the same
         $version["hist_entry_id"] = $version["id"];
         $version["user_id"] = $version["usr_id"];
         $version["date"] = $version["hdate"];
         unset($version["id"], $version["usr_id"], $version["hdate"]);
 
         // parse params
         $params = $this->parseInfoParams($version);
 
         return array_merge($version, $params);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUsages()

ilObjFile::getUsages ( )

get all usages of file object

Definition at line 1027 of file class.ilObjFile.php.

References $DIC, $ilDB, $ret, array, and ilObject2\getId().

Referenced by beforeDelete(), and handleQuotaUpdate().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         // get usages in learning modules
         $q = "SELECT * FROM file_usage WHERE id = " . $ilDB->quote($this->getId(), "integer");
         $us_set = $ilDB->query($q);
         $ret = array();
         while ($us_rec = $ilDB->fetchAssoc($us_set)) {
             $ret[] = array(
                 "type"    => $us_rec["usage_type"],
                 "id"      => $us_rec["usage_id"],
                 "lang"    => $us_rec["usage_lang"],
                 "hist_nr" => $us_rec["usage_hist_nr"],
             );
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVersion()

ilObjFile::getVersion ( )

Definition at line 627 of file class.ilObjFile.php.

References $version.

Referenced by addFileVersion(), deleteVersions(), determineFileSize(), export(), getArrayForDatabase(), getFile(), raiseUploadError(), replaceFile(), rollback(), and storeUnzipedFile().

     {
         return $this->version;
     }

Here is the caller graph for this function:

◆ getVersions()

ilObjFile::getVersions ( $version_ids = null )

Gets the file versions for this object.

Parameters

array $version_ids The file versions to get. If not specified all versions are returned.

Returns: The file versions.

Definition at line 1215 of file class.ilObjFile.php.

References $index, $params, $version, ilHistory\_getEntriesForObject(), array, ilObject2\getId(), ilObject2\getType(), and parseInfoParams().

Referenced by deleteVersions().

     {
         include_once("./Services/History/classes/class.ilHistory.php");
         $versions = ilHistory::_getEntriesForObject($this->getId(), $this->getType());
 
         if ($version_ids != null && count($version_ids) > 0) {
             foreach ($versions as $index => $version) {
                 if (!in_array($version["hist_entry_id"], $version_ids, true)) {
                     unset($versions[$index]);
                 }
             }
         }
 
         // add custom entries
         foreach ($versions as $index => $version) {
             $params = $this->parseInfoParams($version);
             $versions[$index] = array_merge($version, $params);
         }
 
         // sort by version number (hist_entry_id will do for that)
         usort($versions, array($this, "compareVersions"));
 
         return $versions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXMLZip()

ilObjFile::getXMLZip ( )

Definition at line 1082 of file class.ilObjFile.php.

References $DIC, ilUtil\escapeShellArg(), getDirectory(), and getFileName().

     {
         global $DIC;
         $ilias = $DIC['ilias'];
 
         $zip = PATH_TO_ZIP;
 
         exec($zip . ' ' . ilUtil::escapeShellArg($this->getDirectory() . '/' . $this->getFileName())
             . " " . ilUtil::escapeShellArg($this->getDirectory() . '/' . '1.zip'));
 
         return $this->getDirectory() . '/1.zip';
     }

Here is the call graph for this function:

◆ guessFileType()

ilObjFile::guessFileType ( $a_file = "" )

Guesses the file type based on the current values returned by getFileType() and getFileExtension().

If getFileType() returns 'application/octet-stream', the file extension is used to guess a more accurate file type.

Definition at line 832 of file class.ilObjFile.php.

References $filename, $path, getFileExtension(), getFileType(), and ilMimeTypeUtil\getMimeType().

Referenced by determineFileSize(), and updateWithVersion().

     {
         $path = pathinfo($a_file);
         if ($path["extension"] != "") {
             $filename = $path["basename"];
         } else {
             $filename = "dummy." . $this->getFileExtension();
         }
         include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
         $mime = ilMimeTypeUtil::getMimeType($a_file, $filename, $this->getFileType());
 
         return $mime;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleQuotaUpdate()

static ilObjFile::handleQuotaUpdate ( ilObjFile $a_file )

staticprotected

Definition at line 1417 of file class.ilObjFile.php.

References array, getDiskUsage(), ilObject2\getId(), ilObject2\getType(), getUsages(), and ilDiskQuotaHandler\handleUpdatedSourceObject().

Referenced by raiseUploadError().

     {
         include_once "Services/MediaObjects/classes/class.ilObjMediaObject.php";
         $mob = new ilObjMediaObject();
 
         // file itself could be workspace item
         $parent_obj_ids = array($a_file->getId());
 
         foreach ($a_file->getUsages() as $item) {
             $parent_obj_id = $mob->getParentObjectIdForUsage($item);
             if ($parent_obj_id
                 && !in_array($parent_obj_id, $parent_obj_ids)
             ) {
                 $parent_obj_ids[] = $parent_obj_id;
             }
         }
 
         include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
         ilDiskQuotaHandler::handleUpdatedSourceObject($a_file->getType(), $a_file->getId(), $a_file->getDiskUsage(), $parent_obj_ids);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasRating()

ilObjFile::hasRating ( )

Returns: bool

Definition at line 1484 of file class.ilObjFile.php.

References $rating.

Referenced by getArrayForDatabase().

     {
         return $this->rating;
     }

Here is the caller graph for this function:

◆ initFileStorage()

ilObjFile::initFileStorage ( )

init file storage object

public

Definition at line 1130 of file class.ilObjFile.php.

References ilObject2\getId().

Referenced by __construct(), createProperties(), doRead(), and getDirectory().

     {
         $this->file_storage = new ilFSStorageFile($this->getId());
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initType()

ilObjFile::initType ( )

Definition at line 95 of file class.ilObjFile.php.

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

◆ isHidden()

ilObjFile::isHidden ( )

Returns true, if this file should be hidden in the repository view.

Definition at line 817 of file class.ilObjFile.php.

References ilObjFileAccess\_isFileHidden(), and ilObject2\getTitle().

Referenced by addNewsNotification().

     {
         require_once 'Modules/File/classes/class.ilObjFileAccess.php';
 
         return ilObjFileAccess::_isFileHidden($this->getTitle());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInline()

ilObjFile::isInline ( )

Returns true, if this file should be displayed inline in a browser window.

This is especially useful for PDF documents, HTML pages, and for images which are directly supported by the browser.

Definition at line 806 of file class.ilObjFile.php.

References ilObjFileAccess\_isFileInline(), and ilObject2\getTitle().

Referenced by determineFileSize().

     {
         require_once 'Modules/File/classes/class.ilObjFileAccess.php';
 
         return ilObjFileAccess::_isFileInline($this->getTitle());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseInfoParams()

ilObjFile::parseInfoParams ( $entry )

Parses the info parameters ("info_params") of the specified history entry.

Parameters

array $entry The history entry.

Returns: array Returns an array containing the "filename" and "version" contained within the "info_params".

Definition at line 1382 of file class.ilObjFile.php.

References $data, $result, and array.

Referenced by determineFileSize(), getFile(), getSpecificVersion(), and getVersions().

     {
         $data = preg_split("/(.*),(.*)/", $entry["info_params"], 0, PREG_SPLIT_DELIM_CAPTURE
             | PREG_SPLIT_NO_EMPTY);
 
         // bugfix: first created file had no version number
         // this is a workaround for all files created before the bug was fixed
         if (empty($data[1])) {
             $data[1] = "1";
         }
 
         $result = array(
             "filename"         => $data[0],
             "version"          => $data[1],
             "rollback_version" => "",
             "rollback_user_id" => "",
         );
 
         // if rollback, the version contains the rollback version as well
         if ($entry["action"] == "rollback") {
             $tokens = explode("|", $result["version"]);
             if (count($tokens) > 1) {
                 $result["version"] = $tokens[0];
                 $result["rollback_version"] = $tokens[1];
 
                 if (count($tokens) > 2) {
                     $result["rollback_user_id"] = $tokens[2];
                 }
             }
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ raiseUploadError()

ilObjFile::raiseUploadError ( $a_raise = true )

Definition at line 271 of file class.ilObjFile.php.

References $DIC, $metadata, $result, createPreview(), doUpdate(), getDirectory(), getVersion(), handleQuotaUpdate(), ilUtil\makeDirParents(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, ilCountPDFPagesPreProcessors\PAGE_COUNT, setFileName(), setPageCount(), and setVersion().

     {
         $this->raise_upload_error = $a_raise;
     }

Here is the call graph for this function:

◆ replaceFile()

ilObjFile::replaceFile	(	$a_upload_file,
		$a_filename
	)

Parameters

$a_upload_file
$a_filename

Exceptions

Definition at line 346 of file class.ilObjFile.php.

References $result, ilHistory\_createEntry(), addNewsNotification(), createPreview(), ilObject2\getId(), and getVersion().

     {
         if ($result = $this->getUploadFile($a_upload_file, $a_filename, true)) {
             ilHistory::_createEntry($this->getId(), "replace", $a_filename . "," . $this->getVersion());
             $this->addNewsNotification("file_updated");
 
             // create preview
             $this->createPreview(true);
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ rollback()

ilObjFile::rollback ( $version_id )

Makes the specified version the current one and returns theSummary of rollbackVersion.

Parameters

int $version_id The id of the version to make the current one.

Returns: array The new actual version.

Definition at line 1277 of file class.ilObjFile.php.

References $DIC, $ilDB, $ilUser, $source, ilHistory\_changeUserId(), ilHistory\_createEntry(), ilHistory\_getEntriesForObject(), addNewsNotification(), copy(), getDirectory(), ilObject2\getId(), getSpecificVersion(), getVersion(), ilUtil\makeDir(), and updateWithVersion().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilUser = $DIC['ilUser'];
 
         $source = $this->getSpecificVersion($version_id);
         if ($source === false) {
             $this->ilErr->raiseError($this->lng->txt("obj_not_found"), $this->ilErr->MESSAGE);
         }
 
         // get the new version number
         $new_version_nr = $this->getVersion() + 1;
 
         // copy file
         $source_path = $this->getDirectory($source["version"]) . "/" . $source["filename"];
         $dest_dir = $this->getDirectory($new_version_nr);
         if (@!is_dir($dest_dir)) {
             ilUtil::makeDir($dest_dir);
         }
 
         copy($source_path, $dest_dir . "/" . $source["filename"]);
 
         // create new history entry based on the old one
         include_once("./Services/History/classes/class.ilHistory.php");
         ilHistory::_createEntry($this->getId(), "rollback", $source["filename"] . ","
             . $new_version_nr . "|"
             . $source["version"] . "|"
             . $ilUser->getId());
 
         // get id of newest entry
         // bugfix mantis 23596
         $entries = ilHistory::_getEntriesForObject($this->getId());
         $newest_entry_id = 0;
         foreach ($entries as $entry) {
             if ($entry["action"] == "rollback") {
                 $newest_entry_id = $entry["hist_entry_id"];
             }
         }
         $new_version = $this->getSpecificVersion($newest_entry_id);
 
         // change user back to the original uploader
         ilHistory::_changeUserId($new_version["hist_entry_id"], $source["user_id"]);
 
         // update this file with the new version
         $this->updateWithVersion($new_version);
 
         $this->addNewsNotification("file_updated");
 
         return $new_version;
     }

Here is the call graph for this function:

◆ setFileName()

ilObjFile::setFileName ( $a_name )

Parameters

string $a_name

Definition at line 536 of file class.ilObjFile.php.

Referenced by doRead(), raiseUploadError(), and updateWithVersion().

     {
         $this->filename = $a_name;
     }

Here is the caller graph for this function:

◆ setFileSize()

ilObjFile::setFileSize ( $a_size )

Parameters

$a_size

Definition at line 572 of file class.ilObjFile.php.

Referenced by determineFileSize(), and doRead().

     {
         $this->filesize = $a_size;
     }

Here is the caller graph for this function:

◆ setFileType()

ilObjFile::setFileType ( $a_type )

Parameters

string $a_type

Definition at line 554 of file class.ilObjFile.php.

References $a_type.

Referenced by doMDUpdateListener(), doRead(), and updateWithVersion().

     {
         $this->filetype = $a_type;
     }

Here is the caller graph for this function:

◆ setMode()

ilObjFile::setMode ( $a_mode )

mode is object or filelist

Parameters

string $a_mode mode

Definition at line 638 of file class.ilObjFile.php.

Referenced by doRead().

     {
         $this->mode = $a_mode;
     }

Here is the caller graph for this function:

◆ setNoMetaDataCreation()

ilObjFile::setNoMetaDataCreation ( $a_status )

Parameters

bool $a_status

Definition at line 160 of file class.ilObjFile.php.

     {
         $this->no_meta_data_creation = (bool) $a_status;
     }

◆ setPageCount()

ilObjFile::setPageCount ( $page_count )

Parameters

int $page_count

Definition at line 1502 of file class.ilObjFile.php.

References $page_count.

Referenced by doRead(), and raiseUploadError().

     {
         $this->page_count = $page_count;
     }

Here is the caller graph for this function:

◆ setRating()

ilObjFile::setRating ( $a_value )

Parameters

bool $a_value

Definition at line 1475 of file class.ilObjFile.php.

Referenced by doRead().

     {
         $this->rating = (bool) $a_value;
     }

Here is the caller graph for this function:

◆ setVersion()

ilObjFile::setVersion ( $a_version )

Definition at line 621 of file class.ilObjFile.php.

Referenced by deleteVersions(), doRead(), raiseUploadError(), storeUnzipedFile(), and updateWithVersion().

     {
         $this->version = $a_version;
     }

Here is the caller graph for this function:

◆ storeUnzipedFile()

ilObjFile::storeUnzipedFile	(	$a_upload_file,
		$a_filename
	)

storeUnzipedFile

Stores Files unzipped from uploaded archive in filesystem

Parameters

string	$a_upload_file
string	$a_filename

Definition at line 1147 of file class.ilObjFile.php.

References $file, createPreview(), getDirectory(), getVersion(), ilUtil\makeDir(), ilFileUtils\rename(), and setVersion().

     {
         $this->setVersion($this->getVersion() + 1);
 
         if (@!is_dir($this->getDirectory($this->getVersion()))) {
             ilUtil::makeDir($this->getDirectory($this->getVersion()));
         }
 
         $file = $this->getDirectory($this->getVersion()) . "/" . $a_filename;
 
         ilFileUtils::rename($a_upload_file, $file);
 
         // create preview
         $this->createPreview();
     }

Here is the call graph for this function:

◆ updateWithVersion()

ilObjFile::updateWithVersion ( $version )

protected

Updates the file object with the specified file version.

Parameters

array $version The version to update the file object with.

Definition at line 1335 of file class.ilObjFile.php.

References $version, checkFileExtension(), createPreview(), determineFileSize(), ilObject2\getTitle(), guessFileType(), setFileName(), setFileType(), ilObject2\setTitle(), setVersion(), and ilObject2\update().

Referenced by deleteVersions(), and rollback().

     {
         // update title (checkFileExtension must be called before setFileName!)
         $this->setTitle($this->checkFileExtension($version["filename"], $this->getTitle()));
 
         $this->setVersion($version["version"]);
         $this->setFileName($version["filename"]);
 
         // evaluate mime type (reset file type before)
         $this->setFileType("");
         $this->setFileType($this->guessFileType($version["filename"]));
 
         // set filesize
         $this->determineFileSize();
 
         $this->update();
 
         // refresh preview
         $this->createPreview(true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $file_storage

ilObjFile::$file_storage = null

private

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

◆ $filemaxsize

ilObjFile::$filemaxsize = "20000000"

protected

Definition at line 39 of file class.ilObjFile.php.

◆ $filename

ilObjFile::$filename = ''

protected

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

Referenced by getFileName(), and guessFileType().

◆ $filesize

ilObjFile::$filesize

protected

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

Referenced by getFileSize().

◆ $filetype

ilObjFile::$filetype = ''

protected

Definition at line 35 of file class.ilObjFile.php.

Referenced by getFileType().

◆ $log

ilObjFile::$log = null

protected

Definition at line 67 of file class.ilObjFile.php.

◆ $mode

ilObjFile::$mode = self::MODE_OBJECT

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

Referenced by getMode().

◆ $no_meta_data_creation

ilObjFile::$no_meta_data_creation

protected

Definition at line 27 of file class.ilObjFile.php.

◆ $page_count

ilObjFile::$page_count = 0

protected

Definition at line 55 of file class.ilObjFile.php.

Referenced by getPageCount(), and setPageCount().

◆ $raise_upload_error

ilObjFile::$raise_upload_error

Definition at line 47 of file class.ilObjFile.php.

◆ $rating

ilObjFile::$rating = false

protected

Definition at line 59 of file class.ilObjFile.php.

Referenced by hasRating().

◆ $version

ilObjFile::$version = 1

protected

Definition at line 71 of file class.ilObjFile.php.

Referenced by deleteVersions(), getSpecificVersion(), getVersion(), getVersions(), and updateWithVersion().

◆ MODE_FILELIST

const ilObjFile::MODE_FILELIST = "filelist"

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

◆ MODE_OBJECT

const ilObjFile::MODE_OBJECT = "object"

Definition at line 23 of file class.ilObjFile.php.

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

Modules/File/classes/class.ilObjFile.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteAllUsages()

◆ _getFilesOfObject()

◆ _lookupAbsolutePath()

◆ _lookupFileName()

◆ _lookupFileSize()

◆ _lookupVersion()

◆ _saveUsage()

◆ _writeFileType()

◆ addFileVersion()

◆ addNewsNotification()

◆ beforeCreateMetaData()

◆ beforeDelete()

◆ beforeMDUpdateListener()

◆ beforeUpdate()

◆ beforeUpdateMetaData()

◆ checkFileExtension()

◆ clearDataDirectory()

◆ compareVersions()

◆ copy()

◆ createDirectory()

◆ createPreview()

◆ createProperties()

◆ deletePreview()

◆ deleteVersions()

◆ determineFileSize()

◆ doCloneObject()

◆ doCreate()

◆ doCreateMetaData()

◆ doDelete()

◆ doMDUpdateListener()

◆ doRead()

◆ doUpdate()

◆ doUpdateMetaData()

◆ export()

◆ getArrayForDatabase()

◆ getDirectory()

◆ getDiskUsage()

◆ getFile()

◆ getFileExtension()

◆ getFileName()

◆ getFileSize()

◆ getFileType()

◆ getMode()

◆ getPageCount()

◆ getSpecificVersion()

◆ getUsages()

◆ getVersion()

◆ getVersions()

◆ getXMLZip()

◆ guessFileType()

◆ handleQuotaUpdate()

◆ hasRating()

◆ initFileStorage()

◆ initType()

◆ isHidden()

◆ isInline()

◆ parseInfoParams()

◆ raiseUploadError()

◆ replaceFile()

◆ rollback()

◆ setFileName()

◆ setFileSize()

◆ setFileType()

◆ setMode()

◆ setNoMetaDataCreation()

◆ setPageCount()

◆ setRating()

◆ setVersion()