Inheritance diagram for ilObjFile:

Collaboration diagram for ilObjFile:

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

	updateObjectFromCurrentRevision ()

	appendSuffixToTitle (string $title, string $filename)

	appendStream (FileStream $stream, string $title)

	appendUpload (UploadResult $result, string $title)

	replaceWithStream (FileStream $stream, string $title)

	replaceWithUpload (UploadResult $result, string $title)

	getFile (?int $a_hist_entry_id=null)

	getDirectory ($a_version=0)

	getVersion ()

	setVersion (int $a_version)

	getFileName ()

	setFileName (string $a_name)

	setRating (bool $a_value)

	setResourceId (?string $resource_id)

	getResourceId ()

	getStorageID ()

	getMode ()

	setMode (string $a_mode)

	getFileSize ()

	setFileSize (int $a_size)

	getFileType ()

	setFileType (string $a_type)

	hasRating ()

	getMaxVersion ()

	setMaxVersion (int $a_max_version)

	getPageCount ()

	setPageCount (int $page_count)

	getAction ()

	setAction (string $a_action)

	handleChangedObjectTitle (string $new_title)

	replaceFile ($a_upload_file, $a_filename)

	getUploadFile ($a_upload_file, string $title, bool $a_prevent_preview=false)
	@description This Method is used to append a fileupload by it's POST-name to the current ilObjFile More...

	isHidden ()

	clearDataDirectory ()
	@ineritdoc More...

	deleteVersions ($a_hist_entry_ids=null)
	@ineritdoc More...

	sendFile (?int $a_hist_entry_id=null, bool $inline=true)

	export (string $a_target_dir)

	getVersions ($version_ids=null)

	rollback (int $version_id)
	Makes the specified version the current one. More...

	checkFileExtension (string $new_filename, string $new_title)

	getFileExtension ()

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

	read ()

	create (bool $a_clone_mode=false)

	update ()

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

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

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

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

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

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

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

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

	setOwner (int $usr_id)

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

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

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

	update ()

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

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

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

	createReference ()
	creates reference for object More...

	countReferences ()

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

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

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

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

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

	selfOrParentWithRatingEnabled ()

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

Public Member Functions inherited from ilObjFileImplementationInterface
	getDirectory (int $a_version=0)

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

	getFileType ()

	getStorageID ()

	getFileSize ()

	getFile (?int $a_hist_entry_id=null)

	getVersion ()

	getMaxVersion ()

	sendFile (?int $a_hist_entry_id=null, bool $inline=true)

	handleChangedObjectTitle (string $new_title)

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

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

Data Fields
const	MODE_FILELIST = "filelist"

const	MODE_OBJECT = "object"

const	OBJECT_TYPE = "file"

string	$mode = self::MODE_OBJECT

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
	initFileInfo (int $id, bool $is_ref_id)

	initImplementation ()

	doCreate (bool $clone_mode=false)

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

	doUpdate ()

	beforeUpdate ()

	beforeDelete ()

	doDelete ()

	initType ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

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

	doUpdate ()

	beforeUpdate ()

	doDelete ()

	beforeDelete ()

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

	beforeCloneObject ()

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

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
ilObjFileInfo	$file_info

ilObjFileImplementationInterface	$implementation

int	$page_count = 0

bool	$rating = false

ilLogger	$log

string	$filename = ''

string	$filetype = ''

int	$filesize

int	$version = 1

int	$max_version = 1

string	$action = ''

string	$resource_id = null

Manager	$manager

FileUpload	$upload

ilObjFileStakeholder	$stakeholder

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Private Member Functions
	updateObjectFromRevision (Revision $r, bool $create_previews=true)

	getArrayForDatabase ()

	prepareUpload ()

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

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 34 of file class.ilObjFile.php.

Member Function Documentation

◆ appendStream()

ilObjFile::appendStream	(	FileStream	$stream,
		string	$title
	)

Exceptions

FileNamePolicyException

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

                                                                   : int
    {
        if ($this->getResourceId() && $i = $this->manager->find($this->getResourceId())) {
            $revision = $this->manager->appendNewRevisionFromStream($i, $stream, $this->stakeholder, $title);
        } else {
            $i = $this->manager->stream($stream, $this->stakeholder, $title);
            $revision = $this->manager->getCurrentRevision($i);
            $this->setResourceId($i->serialize());
            $this->initImplementation();
        }
        $this->updateObjectFromRevision($revision);
 
        return $revision->getVersionNumber();
    }

References $i, ilObject\$title, getResourceId(), initImplementation(), setResourceId(), and updateObjectFromRevision().

Here is the call graph for this function:

◆ appendSuffixToTitle()

ilObjFile::appendSuffixToTitle	(	string	$title,
		string	$filename
	)

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

                                                                        : string
    {
        $suffix = $this->file_info->getSuffix();
        $filename_suffix = $this->extractSuffixFromFilename($filename);
        if (empty($suffix) || $suffix !== $filename_suffix) {
            $suffix = $filename_suffix;
        }
 
        $title = $this->ensureSuffix($title, $suffix);
 
        return $title;
    }

References ilObject\$title, ensureSuffix(), and extractSuffixFromFilename().

Referenced by appendUpload(), checkFileExtension(), and replaceWithUpload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendUpload()

ilObjFile::appendUpload	(	UploadResult	$result,
		string	$title
	)

Exceptions

FileNamePolicyException

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

                                                                     : int
    {
        $title = $this->appendSuffixToTitle($title, $result->getName());
        if ($this->getResourceId() && $i = $this->manager->find($this->getResourceId())) {
            $revision = $this->manager->appendNewRevision($i, $result, $this->stakeholder, $title);
        } else {
            $i = $this->manager->upload($result, $this->stakeholder, $title);
            $revision = $this->manager->getCurrentRevision($i);
            $this->setResourceId($i->serialize());
            $this->initImplementation();
        }
        if ($result->getMetaData()->has(ilCountPDFPagesPreProcessors::PAGE_COUNT)) {
            $this->setPageCount((int) $result->getMetaData()->get(ilCountPDFPagesPreProcessors::PAGE_COUNT));
        }
        $this->updateObjectFromRevision($revision);
 
        return $revision->getVersionNumber();
    }

References $i, ilObject\$title, appendSuffixToTitle(), ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getName(), getResourceId(), initImplementation(), ilCountPDFPagesPreProcessors\PAGE_COUNT, setPageCount(), setResourceId(), and updateObjectFromRevision().

Referenced by getUploadFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeDelete()

ilObjFile::beforeDelete ( )

protected

Reimplemented from ilObject2.

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

                                     : bool
    {
        // check, if file is used somewhere
        $usages = $this->getUsages();
        return count($usages) === 0;
    }

◆ beforeUpdate()

ilObjFile::beforeUpdate ( )

protected

Reimplemented from ilObject2.

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

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

References ensureSuffix(), getMode(), ilObject\getTitle(), ilObject\setTitle(), and ilObject\updateMetaData().

Here is the call graph for this function:

◆ checkFileExtension()

ilObjFile::checkFileExtension	(	string	$new_filename,
		string	$new_title
	)

Deprecated:

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

                                                                               : string
    {
        return $this->appendSuffixToTitle($new_title, $new_filename);
    }

References appendSuffixToTitle().

Here is the call graph for this function:

◆ clearDataDirectory()

ilObjFile::clearDataDirectory ( )

@ineritdoc

Deprecated:

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

                                        : void
    {
        $this->implementation->clearDataDirectory();
    }

◆ deleteVersions()

ilObjFile::deleteVersions ( $a_hist_entry_ids = null )

@ineritdoc

Deprecated:

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

                                                            : void
    {
        $this->implementation->deleteVersions($a_hist_entry_ids);
    }

◆ doCloneObject()

ilObjFile::doCloneObject	(	ilObject2	$new_obj,
		int	$a_target_id,
		?int	$a_copy_id = `0`
	)

protected

Reimplemented from ilObject2.

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

                                                                                               : void
    {
        assert($new_obj instanceof ilObjFile);
        $identification = $this->manager->find($this->resource_id);
        if ($identification === null) {
            throw new RuntimeException('Cannot clone file since no corresponding resource identification was found');
        }
 
        $this->cloneMetaData($new_obj);
        // object created now copy other settings
        $new_obj->updateFileData();
 
        // Copy Resource
        $cloned_title = $new_obj->getTitle();
        $new_resource_identification = $this->manager->clone($identification);
        $new_current_revision = $this->manager->getCurrentRevision($new_resource_identification);
        $new_obj->setResourceId($new_resource_identification->serialize());
        $new_obj->initImplementation();
        $new_obj->updateObjectFromRevision($new_current_revision, false); // Previews are already copied in 453
        $new_obj->setTitle($cloned_title); // see https://mantis.ilias.de/view.php?id=31375
        $new_obj->setPageCount($this->getPageCount());
        $new_obj->update();
 
        // Copy learning progress settings
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
    }

References ilObject2\cloneMetaData(), ilObject\getId(), getPageCount(), ilObject\getTitle(), ilObject\setTitle(), and ilObject2\update().

Here is the call graph for this function:

◆ doCreate()

ilObjFile::doCreate ( bool $clone_mode = false )

protected

Reimplemented from ilObject2.

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

                                                         : void
    {
        $this->createProperties(true);
        $this->notifyCreation($this->getId(), $this->getDescription());
    }

References createProperties(), ilObject\getDescription(), ilObject\getId(), and notifyCreation().

Here is the call graph for this function:

◆ doDelete()

ilObjFile::doDelete ( )

protected

Reimplemented from ilObject2.

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

                                 : void
    {
        global $DIC;
 
        // delete file data entry
        $DIC->database()->manipulateF("DELETE FROM file_data WHERE file_id = %s", ['integer'], [$this->getId()]);
 
        // delete history entries
        ilHistory::_removeEntriesForObject($this->getId());
 
        // delete meta data
        if ($this->getMode() != self::MODE_FILELIST) {
            $this->deleteMetaData();
        }
 
        // delete preview
        $this->deletePreview();
 
        // delete resource
        $identification = $this->getResourceId();
        if ($identification && $identification != '-') {
            $resource = $this->manager->find($identification);
            if ($resource !== null) {
                $this->manager->remove($resource, $this->stakeholder);
            }
        }
    }

References $DIC, ilHistory\_removeEntriesForObject(), ilObject\deleteMetaData(), ilObject\getId(), getMode(), and getResourceId().

Here is the call graph for this function:

◆ doUpdate()

ilObjFile::doUpdate ( )

protected

Reimplemented from ilObject2.

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

                                 : void
    {
        global $DIC;
 
        $a_columns = $this->getArrayForDatabase();
        $DIC->database()->update('file_data', $a_columns, [
            'file_id' => [
                'integer',
                $this->getId(),
            ],
        ]);
 
        // update metadata with the current file version
        $meta_version_column = ['meta_version' => ['integer', $this->getVersion()]];
        $DIC->database()->update('il_meta_lifecycle', $meta_version_column, [
            'rbac_id' => [
                'integer',
                $this->getId(),
            ],
        ]);
 
        $this->notifyUpdate($this->getId(), $this->getDescription());
        $this->initImplementation();
    }

References $DIC, getArrayForDatabase(), ilObject\getDescription(), ilObject\getId(), getVersion(), initImplementation(), and notifyUpdate().

Here is the call graph for this function:

◆ export()

ilObjFile::export ( string $a_target_dir )

Deprecated:: no longer available since it's unclear/unspecified how to export

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

◆ getAction()

ilObjFile::getAction ( )

Deprecated:

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

                               : string
    {
        return $this->action;
    }

References $action.

◆ getArrayForDatabase()

ilObjFile::getArrayForDatabase ( )

private

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

                                          : array
    {
        return [
            'file_id' => ['integer', $this->getId()],
            'file_name' => ['text', $this->getFileName()],
            'f_mode' => ['text', $this->getMode()],
            'page_count' => ['text', $this->getPageCount()],
            'rating' => ['integer', $this->hasRating()],
            'rid' => ['text', $this->resource_id ?? ''],
        ];
    }

References getFileName(), ilObject\getId(), getMode(), getPageCount(), and hasRating().

Referenced by doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDirectory()

ilObjFile::getDirectory ( $a_version = 0 )

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

                                                : string
    {
        return $this->implementation->getDirectory($a_version);
    }

◆ getFile()

ilObjFile::getFile ( ?int $a_hist_entry_id = null )

Deprecated:

Implements ilObjFileImplementationInterface.

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

                                                         : string
    {
        $this->initImplementation();
        return $this->implementation->getFile($a_hist_entry_id);
    }

References initImplementation().

Here is the call graph for this function:

◆ getFileExtension()

ilObjFile::getFileExtension ( )

Deprecated:

Implements ilObjFileImplementationInterface.

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

                                      : string
    {
        return $this->implementation->getFileExtension();
    }

◆ getFileName()

ilObjFile::getFileName ( )

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

                                 : string
    {
        return $this->filename;
    }

References $filename.

Referenced by getArrayForDatabase().

Here is the caller graph for this function:

◆ getFileSize()

ilObjFile::getFileSize ( )

Implements ilObjFileImplementationInterface.

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

                                 : int
    {
        return $this->implementation->getFileSize();
    }

◆ getFileType()

ilObjFile::getFileType ( )

Implements ilObjFileImplementationInterface.

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

                                 : string
    {
        return $this->implementation->getFileType();
    }

◆ getMaxVersion()

ilObjFile::getMaxVersion ( )

Implements ilObjFileImplementationInterface.

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

                                   : int
    {
        return $this->max_version;
    }

References $max_version.

◆ getMode()

ilObjFile::getMode ( )

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

                             : string
    {
        return $this->mode;
    }

References $mode.

Referenced by beforeUpdate(), doDelete(), and getArrayForDatabase().

Here is the caller graph for this function:

◆ getPageCount()

ilObjFile::getPageCount ( )

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

                                  : int
    {
        return $this->page_count;
    }

References $page_count.

Referenced by doCloneObject(), and getArrayForDatabase().

Here is the caller graph for this function:

◆ getPresentationTitle()

ilObjFile::getPresentationTitle ( )

get presentation title Normally same as title Overwritten for sessions

Reimplemented from ilObject.

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

                                          : string
    {
        return $this->file_info->getHeaderTitle();
    }

◆ getResourceId()

ilObjFile::getResourceId ( )

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

                                   : string
    {
        return $this->resource_id ?? '-';
    }

Referenced by appendStream(), appendUpload(), doDelete(), replaceWithStream(), replaceWithUpload(), and rollback().

Here is the caller graph for this function:

◆ getStorageID()

ilObjFile::getStorageID ( )

Implements ilObjFileImplementationInterface.

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

                                  : ?string
    {
        return $this->implementation->getStorageID();
    }

◆ getUploadFile()

ilObjFile::getUploadFile	(		$a_upload_file,
		string	$title,
		bool	$a_prevent_preview = `false`
	)

@description This Method is used to append a fileupload by it's POST-name to the current ilObjFile

Deprecated:

See also: appendUpload(), appendStream()

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

                                                                                                 : bool
    {
        $this->prepareUpload();
 
        $results = $this->upload->getResults();
        $upload = $results[$a_upload_file];
 
        $this->appendUpload($upload, $title);
 
        return true;
    }

References $results, ilObject\$title, appendUpload(), prepareUpload(), and ILIAS\Repository\upload().

Here is the call graph for this function:

◆ getVersion()

ilObjFile::getVersion ( )

Implements ilObjFileImplementationInterface.

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

                                : int
    {
        return $this->implementation->getVersion();
    }

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getVersions()

ilObjFile::getVersions ( $version_ids = null )

Parameters

null $version_ids

Returns: array|ilObjFileVersion[]

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

                                                    : array
    {
        return $this->implementation->getVersions($version_ids);
    }

◆ handleChangedObjectTitle()

ilObjFile::handleChangedObjectTitle ( string $new_title )

Implements ilObjFileImplementationInterface.

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

                                                               : void
    {
        $new_title = $this->ensureSuffix($new_title, $this->file_info->getSuffix());
        $this->setTitle($new_title);
        $this->implementation->handleChangedObjectTitle($new_title);
    }

References ensureSuffix(), and ilObject\setTitle().

Here is the call graph for this function:

◆ hasRating()

ilObjFile::hasRating ( )

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

                               : bool
    {
        return $this->rating;
    }

References $rating.

Referenced by getArrayForDatabase().

Here is the caller graph for this function:

◆ initFileInfo()

ilObjFile::initFileInfo	(	int	$id,
		bool	$is_ref_id
	)

protected

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

                                                             : void
    {
        $repository = new ilObjFileInfoRepository(true);
        if ($is_ref_id) {
            $this->file_info = $repository->getByRefId($id);
        } else {
            $this->file_info = ($repository)->getByObjectId($id);
        }
    }

References ilObject\$id.

Referenced by initImplementation(), and updateObjectFromRevision().

Here is the caller graph for this function:

◆ initImplementation()

ilObjFile::initImplementation ( )

protected

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

                                           : void
    {
        if ($this->resource_id && ($id = $this->manager->find($this->resource_id)) !== null) {
            $resource = $this->manager->getResource($id);
            $this->implementation = new ilObjFileImplementationStorage($resource);
            $this->max_version = $resource->getMaxRevision();
            $this->version = $resource->getMaxRevision();
        }
        $this->initFileInfo($this->getId(), false);
    }

References ilObject\$id, ilObject\getId(), and initFileInfo().

Referenced by appendStream(), appendUpload(), doUpdate(), and getFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initType()

ilObjFile::initType ( )

protected

Reimplemented from ilObject2.

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

                                 : void
    {
        $this->type = self::OBJECT_TYPE;
    }

References OBJECT_TYPE.

◆ isHidden()

ilObjFile::isHidden ( )

Deprecated:

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

                              : bool
    {
        return ilObjFileAccess::_isFileHidden($this->getTitle());
    }

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

Here is the call graph for this function:

◆ prepareUpload()

ilObjFile::prepareUpload ( )

private

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

                                    : void
    {
        if (!$this->upload->hasBeenProcessed()) {
            if (defined('PATH_TO_GHOSTSCRIPT') && PATH_TO_GHOSTSCRIPT !== "") {
                $this->upload->register(new ilCountPDFPagesPreProcessors());
            }
 
            $this->upload->process();
        }
    }

References ILIAS\Repository\upload().

Referenced by getUploadFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replaceFile()

ilObjFile::replaceFile	(	$a_upload_file,
		$a_filename
	)

Returns: null

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

    {
        return null;
    }

◆ replaceWithStream()

ilObjFile::replaceWithStream	(	FileStream	$stream,
		string	$title
	)

Exceptions

FileNamePolicyException

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

                                                                        : int
    {
        if ($this->getResourceId() && $i = $this->manager->find($this->getResourceId())) {
            $revision = $this->manager->replaceWithStream($i, $stream, $this->stakeholder, $title);
        } else {
            throw new LogicException('only files with existing resource and revision can be replaced');
        }
        $this->updateObjectFromRevision($revision);
 
        return $revision->getVersionNumber();
    }

References $i, ilObject\$title, getResourceId(), and updateObjectFromRevision().

Here is the call graph for this function:

◆ replaceWithUpload()

ilObjFile::replaceWithUpload	(	UploadResult	$result,
		string	$title
	)

Exceptions

FileNamePolicyException

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

                                                                          : int
    {
        $title = $this->appendSuffixToTitle($title, $result->getName());
        if ($this->getResourceId() && $i = $this->manager->find($this->getResourceId())) {
            $revision = $this->manager->replaceWithUpload($i, $result, $this->stakeholder, $title);
        } else {
            throw new LogicException('only files with existing resource and revision can be replaced');
        }
        if ($result->getMetaData()->has(ilCountPDFPagesPreProcessors::PAGE_COUNT)) {
            $this->setPageCount((int) $result->getMetaData()->get(ilCountPDFPagesPreProcessors::PAGE_COUNT));
        }
        $this->updateObjectFromRevision($revision);
 
        return $revision->getVersionNumber();
    }

References $i, ilObject\$title, appendSuffixToTitle(), ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getName(), getResourceId(), ilCountPDFPagesPreProcessors\PAGE_COUNT, setPageCount(), and updateObjectFromRevision().

Here is the call graph for this function:

◆ rollback()

ilObjFile::rollback ( int $version_id )

Makes the specified version the current one.

Parameters

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

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

                                             : void
    {
        if ($this->getResourceId() && $i = $this->manager->find($this->getResourceId())) {
            $this->manager->rollbackRevision($i, $version_id);
            $latest_revision = $this->manager->getCurrentRevision($i);
            $this->updateObjectFromRevision($latest_revision);
        } else {
            throw new LogicException('only files with existing resource and revision can be replaced');
        }
    }

References $i, getResourceId(), and updateObjectFromRevision().

Here is the call graph for this function:

◆ sendFile()

ilObjFile::sendFile	(	?int	$a_hist_entry_id = `null`,
		bool	$inline = `true`
	)

Parameters

bool $inline

Deprecated:

Implements ilObjFileImplementationInterface.

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

                                                                               : void
    {
        $info = (new ilObjFileInfoRepository())->getByObjectId($this->getId());
 
        $this->implementation->sendFile($a_hist_entry_id, $info->shouldDeliverInline());
    }

References ilObject\getId().

Here is the call graph for this function:

◆ setAction()

ilObjFile::setAction ( string $a_action )

Parameters

$a_action

Deprecated:

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

                                               : void
    {
        throw new LogicException('cannot change action');
    }

◆ setFileName()

ilObjFile::setFileName ( string $a_name )

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

                                               : void
    {
        $this->filename = $a_name;
    }

Referenced by updateObjectFromRevision().

Here is the caller graph for this function:

◆ setFileSize()

ilObjFile::setFileSize ( int $a_size )

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

                                            : void
    {
        throw new LogicException('cannot change filesize');
    }

◆ setFileType()

ilObjFile::setFileType ( string $a_type )

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

                                               : void
    {
        throw new LogicException('cannot change filetype');
    }

◆ setMaxVersion()

ilObjFile::setMaxVersion ( int $a_max_version )

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

                                                     : void
    {
        throw new LogicException('cannot change max-version');
    }

◆ setMode()

ilObjFile::setMode ( string $a_mode )

Parameters

string $a_mode self::MODE_FILELIST or self::MODE_OBJECT

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

                                           : void
    {
        $this->mode = $a_mode;
    }

◆ setPageCount()

ilObjFile::setPageCount ( int $page_count )

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

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

References $page_count.

Referenced by appendUpload(), and replaceWithUpload().

Here is the caller graph for this function:

◆ setRating()

ilObjFile::setRating ( bool $a_value )

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

                                            : void
    {
        $this->rating = $a_value;
    }

◆ setResourceId()

ilObjFile::setResourceId ( ?string $resource_id )

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

                                                       : self
    {
        $this->resource_id = $resource_id;
        return $this;
    }

References $resource_id.

Referenced by appendStream(), and appendUpload().

Here is the caller graph for this function:

◆ setVersion()

ilObjFile::setVersion ( int $a_version )

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

                                              : void
    {
        $this->version = $a_version;
    }

◆ updateObjectFromCurrentRevision()

ilObjFile::updateObjectFromCurrentRevision ( )

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

                                                     : void
    {
        $this->updateObjectFromRevision(
            $this->manager->getCurrentRevision($this->manager->find($this->getResourceId())),
            false
        );
    }

References updateObjectFromRevision().

Here is the call graph for this function:

◆ updateObjectFromRevision()

ilObjFile::updateObjectFromRevision	(	Revision	$r,
		bool	$create_previews = `true`
	)

private

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

                                                                                        : void
    {
        $this->initFileInfo($this->getId(), false);
        $this->setTitle(
            $this->ensureSuffix(
                $r->getTitle(),
                $this->extractSuffixFromFilename($r->getInformation()->getTitle())
            )
        );
        $this->setFileName($r->getInformation()->getTitle());
        $this->update();
        if ($create_previews) {
            $this->createPreview(true);
        }
    }

References ensureSuffix(), ilObject\getId(), ILIAS\ResourceStorage\Revision\Revision\getInformation(), ILIAS\ResourceStorage\Revision\Revision\getTitle(), initFileInfo(), setFileName(), ilObject\setTitle(), and ilObject2\update().

Referenced by appendStream(), appendUpload(), replaceWithStream(), replaceWithUpload(), rollback(), and updateObjectFromCurrentRevision().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $action

string ilObjFile::$action = ''

protected

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

Referenced by getAction().

◆ $file_info

ilObjFileInfo ilObjFile::$file_info

protected

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

◆ $filename

string ilObjFile::$filename = ''

protected

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

Referenced by getFileName().

◆ $filesize

int ilObjFile::$filesize

protected

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

◆ $filetype

string ilObjFile::$filetype = ''

protected

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

◆ $implementation

ilObjFileImplementationInterface ilObjFile::$implementation

protected

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

◆ $log

ilLogger ilObjFile::$log

protected

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

◆ $manager

Manager ilObjFile::$manager

protected

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

◆ $max_version

int ilObjFile::$max_version = 1

protected

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

Referenced by getMaxVersion().

◆ $mode

string ilObjFile::$mode = self::MODE_OBJECT

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

Referenced by getMode().

◆ $page_count

int ilObjFile::$page_count = 0

protected

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

Referenced by getPageCount(), and setPageCount().

◆ $rating

bool ilObjFile::$rating = false

protected

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

Referenced by hasRating().

◆ $resource_id

string ilObjFile::$resource_id = null

protected

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

Referenced by setResourceId().

◆ $stakeholder

ilObjFileStakeholder ilObjFile::$stakeholder

protected

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

◆ $upload

FileUpload ilObjFile::$upload

protected

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

◆ $version

int ilObjFile::$version = 1

protected

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

◆ MODE_FILELIST

const ilObjFile::MODE_FILELIST = "filelist"

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

Referenced by ilModulesFileTest\testAppendStream().

◆ MODE_OBJECT

const ilObjFile::MODE_OBJECT = "object"

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

Referenced by ilDclFileuploadRecordFieldModel\parseValue().

◆ OBJECT_TYPE

const ilObjFile::OBJECT_TYPE = "file"

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

Referenced by ilObjFileGUI\__construct(), ilObjFileGUI\edit(), ilObjFileGUI\getType(), ilObjFileListGUI\init(), ilObjFileGUI\initCreationForms(), initType(), and ilObjFileGUI\setTabs().

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

Modules/File/classes/class.ilObjFile.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ appendStream()

◆ appendSuffixToTitle()

◆ appendUpload()

◆ beforeDelete()

◆ beforeUpdate()

◆ checkFileExtension()

◆ clearDataDirectory()

◆ deleteVersions()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doUpdate()

◆ export()

◆ getAction()

◆ getArrayForDatabase()

◆ getDirectory()

◆ getFile()

◆ getFileExtension()

◆ getFileName()

◆ getFileSize()

◆ getFileType()

◆ getMaxVersion()

◆ getMode()

◆ getPageCount()

◆ getPresentationTitle()

◆ getResourceId()

◆ getStorageID()

◆ getUploadFile()

◆ getVersion()

◆ getVersions()

◆ handleChangedObjectTitle()

◆ hasRating()

◆ initFileInfo()

◆ initImplementation()

◆ initType()

◆ isHidden()

◆ prepareUpload()

◆ replaceFile()

◆ replaceWithStream()

◆ replaceWithUpload()

◆ rollback()

◆ sendFile()

◆ setAction()

◆ setFileName()

◆ setFileSize()

◆ setFileType()

◆ setMaxVersion()

◆ setMode()

◆ setPageCount()

◆ setRating()

◆ setResourceId()

◆ setVersion()

◆ updateObjectFromCurrentRevision()

◆ updateObjectFromRevision()

Field Documentation

◆ $action

◆ $file_info

◆ $filename

◆ $filesize

◆ $filetype

◆ $implementation

◆ $log

◆ $manager

◆ $max_version

◆ $mode

◆ $page_count

◆ $rating

◆ $resource_id

◆ $stakeholder

◆ $upload

◆ $version

◆ MODE_FILELIST