ilObjFile Class Reference

Class ilObjFile. More...

Inheritance diagram for ilObjFile:

Collaboration diagram for ilObjFile:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	ilObjFile constructor. More...
	getPresentationTitle ()
	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)
	getDownloadFilename ()
	getImportantInfo ()
	setImportantInfo (string $a_important_info)
	getVersion (bool $inclduing_drafts=false)
	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)
	getCopyrightID ()
	setCopyrightID (?string $copyright_id)
	getPageCount ()
	setPageCount (int $page_count)
	getAction ()
	directDownload ()
	getOnClickMode ()
	setOnclickMode (int $on_click_mode)
	getAmountOfDownloads ()
	setAmountOfDownloads (int $amount)
	getLPMode ()
	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)
	This Method is used to append a fileupload by it's POST-name to the current ilObjFile More...
	isHidden ()
	clearDataDirectory ()
	deleteVersions ($a_hist_entry_ids=null)
	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 ()
	Returns the extension of the file name converted to lower-case. More...
	stripTitleOfFileExtension (string $a_title)
Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...
	read ()
	create (bool $a_clone_mode=false)
	update ()
	delete ()
	cloneMetaData (ilObject $target_obj)
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...
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...
	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"
const	CLICK_MODE_DOWNLOAD = 1
const	CLICK_MODE_INFOPAGE = 2
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)
	doRead ()
	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
string	$important_info = null
int	$page_count = 0
bool	$rating = false
ilLogger	$log
string	$filename = ''
string	$filetype = ''
int	$filesize
int	$version = 0
int	$max_version = 0
string	$copyright_id = null
string	$action = ''
string	$resource_id = null
Manager	$manager
FileUpload	$upload
ilObjFileStakeholder	$stakeholder
int	$on_click_mode = self::CLICK_MODE_DOWNLOAD
int	$amount_of_downloads = 0
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Member Functions
	updateObjectFromRevision (Revision $r)
	getArrayForDatabase ()
	prepareUpload ()

Private Attributes
ilDBInterface	$database

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

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.

Constructor & Destructor Documentation

__construct()

ilObjFile::__construct	(	int	$a_id = 0,
		bool	$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 75 of file class.ilObjFile.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), initFileInfo(), and ILIAS\Repository\upload().

    {
        global $DIC;
        $this->manager = $DIC->resourceStorage()->manage();
        $this->database = $DIC->database();
        $this->implementation = new ilObjFileImplementationEmpty();
        $this->stakeholder = new ilObjFileStakeholder($DIC->user()->getId());
        $this->upload = $DIC->upload();
        $this->log = ilLoggerFactory::getLogger(self::OBJECT_TYPE);

        parent::__construct($a_id, $a_call_by_reference);
        $this->initFileInfo($a_id, $a_call_by_reference);
    }

Here is the call graph for this function:

Member Function Documentation

appendStream()

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

Exceptions

FileNamePolicyException

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

References enableNotification(), ensureSuffix(), extractSuffixFromFilename(), getResourceId(), initImplementation(), null, setResourceId(), and updateObjectFromRevision().

                                                                   : int
    {
        $title = $this->ensureSuffix(
            $title,
            $this->extractSuffixFromFilename($title)
            ?? pathinfo($stream->getMetadata('uri'))['extension']
            ?? null
        );
        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->enableNotification();
        $this->updateObjectFromRevision($revision);

        return $revision->getVersionNumber();
    }

Here is the call graph for this function:

appendSuffixToTitle()

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

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

References ensureSuffix(), and extractSuffixFromFilename().

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

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

        return $this->ensureSuffix($title, $suffix);
    }

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

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

Referenced by getUploadFile().

                                                                     : 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->enableNotification();
        $this->updateObjectFromRevision($revision);

        return $revision->getVersionNumber();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

beforeDelete()

ilObjFile::beforeDelete ( )

protected

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

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

beforeUpdate()

ilObjFile::beforeUpdate ( )

protected

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

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

                                     : bool
    {
        $suffix = $this->file_info->getSuffix();
        if (empty($suffix)) {
            $suffix = $this->extractSuffixFromFilename($this->getTitle());
        }
        $this->setTitle($this->ensureSuffix($this->getTitle(), $suffix));

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

        return true;
    }

Here is the call graph for this function:

checkFileExtension()

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

Deprecated:

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

References appendSuffixToTitle().

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

Here is the call graph for this function:

clearDataDirectory()

ilObjFile::clearDataDirectory

(

)

Deprecated:

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

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

deleteVersions()

ilObjFile::deleteVersions

(

$a_hist_entry_ids = null

)

Deprecated:

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

References getResourceId(), and updateObjectFromRevision().

                                                            : void
    {
        $this->implementation->deleteVersions($a_hist_entry_ids);
        // update file object as the deletion of versions might affect its attributes (title, max_version etc.)
        if ($this->getResourceId() && $rid = $this->manager->find($this->getResourceId())) {
            $latest_revision = $this->manager->getCurrentRevision($rid);
            $this->updateObjectFromRevision($latest_revision);
        }
    }

Here is the call graph for this function:

directDownload()

ilObjFile::directDownload

(

)

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

                                    : bool
    {
        return $this->on_click_mode === self::CLICK_MODE_DOWNLOAD;
    }

doCloneObject()

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

protected

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

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

                                                                                               : 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); // 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();

        $new_obj->getObjectProperties()->storePropertyIsOnline(new ilObjectPropertyIsOnline(true));

        // Copy learning progress settings
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
    }

Here is the call graph for this function:

doCreate()

ilObjFile::doCreate ( bool  $clone_mode = false )

protected

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

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

                                                         : void
    {
        $this->createProperties(true);
        $this->updateCopyright();
        $this->getObjectProperties()->storePropertyIsOnline(new ilObjectPropertyIsOnline(true));
        $this->notifyCreation($this->getId(), $this->getDescription());
    }

Here is the call graph for this function:

doDelete()

ilObjFile::doDelete ( )

protected

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

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

                                 : void
    {
        // delete file data entry
        $this->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 resource
        $identification = $this->getResourceId();
        if ($identification && $identification !== '-') {
            $resource = $this->manager->find($identification);
            if ($resource !== null) {
                $this->manager->remove($resource, $this->stakeholder);
            }
        }
    }

Here is the call graph for this function:

doRead()

ilObjFile::doRead ( )

protected

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

References $q, $r, ilObject\getId(), initImplementation(), ILIAS\Repository\int(), and null.

                               : void
    {
        $q = "SELECT * FROM file_data WHERE file_id = %s";
        $r = $this->database->queryF($q, ['integer'], [$this->getId()]);
        $row = $r->fetchObject();

        $this->filename = $this->secure($row->file_name ?? '');
        $this->filetype = $row->file_type ?? '';
        $this->filesize = $row->file_size ?? 0;
        $this->version = $row->version ?? 1;
        $this->max_version = $row->max_version ?? 1;
        $this->mode = $row->f_mode ?? self::MODE_OBJECT;
        $this->important_info = $row->important_info ?? "";
        $this->rating = (bool) ($row->rating ?? false);
        $this->page_count = (int) ($row->page_count ?? 0);
        $this->resource_id = $row->rid ?? null;
        $this->on_click_mode = (int) ($row->on_click_mode ?? self::CLICK_MODE_DOWNLOAD);
        $this->amount_of_downloads = (int) ($row->downloads ?? 0);

        $this->initImplementation();
    }

Here is the call graph for this function:

doUpdate()

ilObjFile::doUpdate ( )

protected

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

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

                                 : void
    {
        $a_columns = $this->getArrayForDatabase();
        $this->database->update('file_data', $a_columns, [
            'file_id' => [
                'integer',
                $this->getId(),
            ],
        ]);

        $this->notifyUpdate($this->getId(), $this->getDescription());
        $this->initImplementation();
    }

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

                                                : void
    {
        //
    }

getAction()

ilObjFile::getAction

(

)

Deprecated:

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

References $action.

                               : string
    {
        return $this->action;
    }

getAmountOfDownloads()

ilObjFile::getAmountOfDownloads

(

)

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

References $amount_of_downloads.

Referenced by getArrayForDatabase(), and sendFile().

                                          : int
    {
        return $this->amount_of_downloads;
    }

Here is the caller graph for this function:

getArrayForDatabase()

ilObjFile::getArrayForDatabase ( )

private

Returns

array{file_id: int[]|string[], file_name: string[], f_mode: string[], important_info: string[]|null[], page_count: int[]|string[], rating: bool[]|string[], rid: string[], on_click_mode: int[]|string[], downloads: int[]|string[]}

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

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

Referenced by doUpdate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCopyrightID()

ilObjFile::getCopyrightID

(

)

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

References $copyright_id.

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

getDirectory()

ilObjFile::getDirectory

(

$a_version = 0

)

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

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

getDownloadFilename()

ilObjFile::getDownloadFilename

(

)

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

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

getFile()

ilObjFile::getFile

(

?int

$a_hist_entry_id = null

)

Deprecated:

Implements ilObjFileImplementationInterface.

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

References initImplementation().

Referenced by ilCollectWorkspaceFilesJob\getFileDirs().

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

Here is the call graph for this function:

Here is the caller 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'.

Implements ilObjFileImplementationInterface.

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

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

getFileName()

ilObjFile::getFileName

(

)

Implements ilObjFileImplementationInterface.

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

Referenced by getArrayForDatabase().

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

Here is the caller graph for this function:

getFileSize()

ilObjFile::getFileSize

(

)

Implements ilObjFileImplementationInterface.

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

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

getFileType()

ilObjFile::getFileType

(

)

Implements ilObjFileImplementationInterface.

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

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

getImportantInfo()

ilObjFile::getImportantInfo

(

)

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

References $important_info.

Referenced by getArrayForDatabase().

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

Here is the caller graph for this function:

getLPMode()

ilObjFile::getLPMode

(

)

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

References ilObject\getId(), and ilObjectLP\getInstance().

                               : int
    {
        return ilObjectLP::getInstance($this->getId())->getCurrentMode();
    }

Here is the call graph for this function:

getMaxVersion()

ilObjFile::getMaxVersion

(

)

Implements ilObjFileImplementationInterface.

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

References $max_version.

                                   : int
    {
        return $this->max_version;
    }

getMode()

ilObjFile::getMode

(

)

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

References $mode.

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

                             : string
    {
        return $this->mode;
    }

Here is the caller graph for this function:

getOnClickMode()

ilObjFile::getOnClickMode

(

)

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

References $on_click_mode.

Referenced by getArrayForDatabase().

                                    : int
    {
        return $this->on_click_mode;
    }

Here is the caller graph for this function:

getPageCount()

ilObjFile::getPageCount

(

)

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

References $page_count.

Referenced by doCloneObject(), and getArrayForDatabase().

                                  : int
    {
        return $this->page_count;
    }

Here is the caller graph for this function:

getPresentationTitle()

ilObjFile::getPresentationTitle

(

)

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

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

getResourceId()

ilObjFile::getResourceId

(

)

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

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

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

Here is the caller graph for this function:

getStorageID()

ilObjFile::getStorageID

(

)

Implements ilObjFileImplementationInterface.

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

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

getUploadFile()

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

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

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

                                                                                                 : bool
    {
        $this->prepareUpload();

        $results = $this->upload->getResults();
        $upload = $results[$a_upload_file];

        $this->appendUpload($upload, $title);

        return true;
    }

Here is the call graph for this function:

getVersion()

ilObjFile::getVersion

(

bool

$inclduing_drafts = false

)

Implements ilObjFileImplementationInterface.

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

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

getVersions()

ilObjFile::getVersions

(

$version_ids = null

)

Parameters

null

$version_ids

Returns

array|ilObjFileVersion[]

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

Referenced by ilObjFileComponentBuilder\buildConfirmDeleteSpecificVersionsModal().

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

Here is the caller graph for this function:

handleChangedObjectTitle()

ilObjFile::handleChangedObjectTitle

(

string

$new_title

)

Implements ilObjFileImplementationInterface.

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

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

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

Here is the call graph for this function:

hasRating()

ilObjFile::hasRating

(

)

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

References $rating.

Referenced by getArrayForDatabase().

                               : bool
    {
        return $this->rating;
    }

Here is the caller graph for this function:

initFileInfo()

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

protected

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

Referenced by __construct(), initImplementation(), and updateObjectFromRevision().

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

Here is the caller graph for this function:

initImplementation()

ilObjFile::initImplementation ( )

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

initType()

ilObjFile::initType ( )

protected

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

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

isHidden()

ilObjFile::isHidden

(

)

Deprecated:

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

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

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

Here is the call graph for this function:

prepareUpload()

ilObjFile::prepareUpload ( )

private

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

References ILIAS\Repository\upload().

Referenced by getUploadFile().

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

            $this->upload->process();
        }
    }

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

References null.

                                                            : null
    {
        return null;
    }

replaceWithStream()

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

Exceptions

FileNamePolicyException

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

References enableNotification(), getResourceId(), and updateObjectFromRevision().

                                                                        : 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->enableNotification();
        $this->updateObjectFromRevision($revision);

        return $revision->getVersionNumber();
    }

Here is the call graph for this function:

replaceWithUpload()

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

Exceptions

FileNamePolicyException

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

References appendSuffixToTitle(), enableNotification(), ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getName(), getResourceId(), ilCountPDFPagesPreProcessors\PAGE_COUNT, setPageCount(), and updateObjectFromRevision().

                                                                          : 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->enableNotification();
        $this->updateObjectFromRevision($revision);

        return $revision->getVersionNumber();
    }

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

References getResourceId(), and updateObjectFromRevision().

                                             : 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');
        }
    }

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

References getAmountOfDownloads(), ilObject\getId(), setAmountOfDownloads(), and ilObject2\update().

                                                                               : void
    {
        // increment file download count by one.
        $this->setAmountOfDownloads($this->getAmountOfDownloads() + 1);
        $this->update();
        $info = (new ilObjFileInfoRepository())->getByObjectId($this->getId());
        $this->implementation->sendFile($a_hist_entry_id, $info->shouldDeliverInline());
    }

Here is the call graph for this function:

setAction()

ilObjFile::setAction

(

string

$a_action

)

Parameters

$a_action

Returns

never

Deprecated:

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

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

setAmountOfDownloads()

ilObjFile::setAmountOfDownloads

(

int

$amount

)

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

Referenced by sendFile().

                                                     : void
    {
        if (0 > $amount) {
            throw new LogicException("Amount cannot be a negative number.");
        }

        $this->amount_of_downloads = $amount;
    }

Here is the caller graph for this function:

setCopyrightID()

ilObjFile::setCopyrightID

(

?string

$copyright_id

)

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

References $copyright_id.

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

setFileName()

ilObjFile::setFileName

(

string

$a_name

)

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

Referenced by updateObjectFromRevision().

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

Here is the caller graph for this function:

setFileSize()

ilObjFile::setFileSize

(

int

$a_size

)

Returns

never

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

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

setFileType()

ilObjFile::setFileType

(

string

$a_type

)

Returns

never

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

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

setImportantInfo()

ilObjFile::setImportantInfo

(

string

$a_important_info

)

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

References null.

                                                              : void
    {
        $this->important_info = empty($a_important_info) ? null : $a_important_info;
    }

setMaxVersion()

ilObjFile::setMaxVersion

(

int

$a_max_version

)

Returns

never

Definition at line 351 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 307 of file class.ilObjFile.php.

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

setOnclickMode()

ilObjFile::setOnclickMode

(

int

$on_click_mode

)

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

References $on_click_mode.

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

setPageCount()

ilObjFile::setPageCount

(

int

$page_count

)

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

References $page_count.

Referenced by appendUpload(), and replaceWithUpload().

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

Here is the caller graph for this function:

setRating()

ilObjFile::setRating

(

bool

$a_value

)

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

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

setResourceId()

ilObjFile::setResourceId

(

?string

$resource_id

)

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

References $resource_id.

Referenced by appendStream(), and appendUpload().

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

Here is the caller graph for this function:

setVersion()

ilObjFile::setVersion

(

int

$a_version

)

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

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

stripTitleOfFileExtension()

ilObjFile::stripTitleOfFileExtension

(

string

$a_title

)

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

                                                              : string
    {
        return $this->secure(preg_replace('/\.[^.]*$/', '', $a_title));
    }

updateObjectFromCurrentRevision()

ilObjFile::updateObjectFromCurrentRevision

(

)

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

References updateObjectFromRevision().

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

Here is the call graph for this function:

updateObjectFromRevision()

ilObjFile::updateObjectFromRevision ( Revision  $r )

private

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

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

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

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

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

Referenced by getAction().

$amount_of_downloads

int ilObjFile::$amount_of_downloads = 0

protected

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

Referenced by getAmountOfDownloads().

$copyright_id

string ilObjFile::$copyright_id = null

protected

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

Referenced by getCopyrightID(), and setCopyrightID().

$database

ilDBInterface ilObjFile::$database

private

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

$file_info

ilObjFileInfo ilObjFile::$file_info

protected

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

$filename

string ilObjFile::$filename = ''

protected

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

$filesize

int ilObjFile::$filesize

protected

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

$filetype

string ilObjFile::$filetype = ''

protected

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

$implementation

ilObjFileImplementationInterface ilObjFile::$implementation

protected

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

$important_info

string ilObjFile::$important_info = null

protected

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

Referenced by getImportantInfo().

$log

ilLogger ilObjFile::$log

protected

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

$manager

Manager ilObjFile::$manager

protected

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

$max_version

int ilObjFile::$max_version = 0

protected

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

Referenced by getMaxVersion().

$mode

string ilObjFile::$mode = self::MODE_OBJECT

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

Referenced by getMode().

$on_click_mode

int ilObjFile::$on_click_mode = self::CLICK_MODE_DOWNLOAD

protected

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

Referenced by getOnClickMode(), and setOnclickMode().

$page_count

int ilObjFile::$page_count = 0

protected

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

Referenced by getPageCount(), and setPageCount().

$rating

bool ilObjFile::$rating = false

protected

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

Referenced by hasRating().

$resource_id

string ilObjFile::$resource_id = null

protected

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

Referenced by setResourceId().

$stakeholder

ilObjFileStakeholder ilObjFile::$stakeholder

protected

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

$upload

FileUpload ilObjFile::$upload

protected

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

$version

int ilObjFile::$version = 0

protected

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

CLICK_MODE_DOWNLOAD

const ilObjFile::CLICK_MODE_DOWNLOAD = 1

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

Referenced by ilObjFileAccess\_shouldDownloadDirectly(), ilObjFileGUI\initPropertiesForm(), ilObjFileInfoRepository\preloadData(), and ilFileObjectDatabaseObjective\step_1().

CLICK_MODE_INFOPAGE

const ilObjFile::CLICK_MODE_INFOPAGE = 2

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

Referenced by ilObjFileGUI\initPropertiesForm().

MODE_FILELIST

const ilObjFile::MODE_FILELIST = "filelist"

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

Referenced by ilModulesFileTest\testAppendStream().

MODE_OBJECT

const ilObjFile::MODE_OBJECT = "object"

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

OBJECT_TYPE

const ilObjFile::OBJECT_TYPE = "file"

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

Referenced by ilObjFileGUI\__construct(), FileObjectProperties\getObjectTypeString(), ilObjFileGUI\getParentId(), ilObjFileGUI\getType(), ilObjFileListGUI\init(), ilObjFileUploadDropzone\isCopyrightSelectionActive(), and ilObjFileGUI\setTabs().

---

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

• components/ILIAS/File/classes/class.ilObjFile.php