Class ilObjFileImplementationStorage. More...

Inheritance diagram for ilObjFileImplementationStorage:

Collaboration diagram for ilObjFileImplementationStorage:

Public Member Functions
	handleChangedObjectTitle (string $new_title)

	getFile ($a_hist_entry_id=null)
	@inheritDoc More...

	getFileType ()
	@inheritDoc More...

	getDirectory ($a_version=0)
	@inheritDoc More...

	sendFile ($a_hist_entry_id=null)
	@inheritDoc More...

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

	getFileExtension ()
	@inheritDoc More...

	getVersions ($version_ids=null)
	@inheritDoc More...

	export (string $target_dir)
	@depracated More...

	getStorageID ()

Public Member Functions inherited from ilObjFileImplementationAbstract
	createDirectory ()
	@inheritDoc More...

	replaceFile ($a_upload_file, $a_filename)
	@inheritDoc More...

	addFileVersion ($a_upload_file, $a_filename)
	@inheritDoc More...

	clearDataDirectory ()
	@inheritDoc More...

	setFileType ($a_type)
	@inheritDoc More...

	setFileSize ($a_size)
	@inheritDoc More...

	getFileSize ()

	setVersion ($a_version)
	@inheritDoc More...

	getVersion ()

	setMaxVersion ($a_max_version)
	@inheritDoc More...

	getMaxVersion ()

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

	getSpecificVersion ($version_id)
	@inheritDoc More...

	getDirectory ($a_version=0)

	createDirectory ()

	replaceFile ($a_upload_file, $a_filename)

	clearDataDirectory ()

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

	setFileType ($a_type)

	getFileType ()

	getStorageID ()

	setFileSize ($a_size)

	handleChangedObjectTitle (string $new_title)

	getFileSize ()

	getFile ($a_hist_entry_id=null)

	setVersion ($a_version)

	getVersion ()

	setMaxVersion ($a_max_version)

	getMaxVersion ()

	sendFile ($a_hist_entry_id=null)

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

	storeUnzipedFile ($a_upload_file, $a_filename)

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

	export (string $target_dir)
	@depracated More...

Protected Attributes
	$resource

	$storage

	$download_with_uploaded_filename

	$obj_id

Private Member Functions
	debug ()

	isInline ($a_hist_entry_id=null)

Detailed Description

Class ilObjFileImplementationStorage.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 14 of file class.ilObjFileImplementationStorage.php.

Member Function Documentation

◆ debug()

ilObjFileImplementationStorage::debug ( )

private

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

                             : void
    {
        // debug
        $stream = $this->storage->consume()->stream($this->resource->getIdentification())->getStream();
        $container = dirname($stream->getMetadata('uri'), 2);
 
        $dir_reader = function (string $path) {
            $rii = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));
 
            $files = array();
            foreach ($rii as $file) {
                if (!$file->isDir()) {
                    $files[] = $file->getPathname();
                }
            }
 
            return $files;
        };
 
        ilUtil::sendInfo('<pre>' . print_r($dir_reader($container), true) . '</pre>');
    }

References $container, and ilUtil\sendInfo().

Here is the call graph for this function:

◆ deleteVersions()

ilObjFileImplementationStorage::deleteVersions ( $a_hist_entry_ids = null )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 161 of file class.ilObjFileImplementationStorage.php.

    {
        if (is_array($a_hist_entry_ids)) {
            foreach ($a_hist_entry_ids as $id) {
                $this->storage->manage()->removeRevision($this->resource->getIdentification(), $id);
            }
        }
    }

◆ export()

ilObjFileImplementationStorage::export ( string $target_dir )

@depracated

Implements ilObjFileImplementationInterface.

Definition at line 205 of file class.ilObjFileImplementationStorage.php.

                                               : void
    {
        global $DIC;
        $relative_dir = LegacyPathHelper::createRelativePath($target_dir);
        $filesystem = LegacyPathHelper::deriveFilesystemFrom($target_dir);
    
        if ($filesystem->has($target_dir)) {
            $directory = $relative_dir . '/objects/il_' . IL_INST_ID . "_file_" . $this->obj_id;
            $filesystem->createDir($directory);
            $stream = $DIC->resourceStorage()->consume()->stream($this->resource->getIdentification())->getStream();
            $filesystem->writeStream(
                $directory . '/' . $this->resource->getCurrentRevision()->getInformation()->getTitle(),
                $stream
            );
        }
    }

References $DIC, $obj_id, and IL_INST_ID.

◆ getDirectory()

ilObjFileImplementationStorage::getDirectory ( $a_version = 0 )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 103 of file class.ilObjFileImplementationStorage.php.

    {
        $consumer = $this->storage->consume()->stream($this->resource->getIdentification());
        if ($a_version) {
            $consumer->setRevisionNumber($a_version);
        }
        $stream = $consumer->getStream();
 
        return dirname($stream->getMetadata('uri'));
    }

◆ getFile()

ilObjFileImplementationStorage::getFile ( $a_hist_entry_id = null )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 83 of file class.ilObjFileImplementationStorage.php.

    {
        $stream = $this->storage->consume()->stream($this->resource->getIdentification());
        if ($a_hist_entry_id) {
            $stream = $stream->setRevisionNumber($a_hist_entry_id);
        }
        return $stream->getStream()->getMetadata('uri');
    }

◆ getFileExtension()

ilObjFileImplementationStorage::getFileExtension ( )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 173 of file class.ilObjFileImplementationStorage.php.

    {
        return $this->resource->getCurrentRevision()->getInformation()->getSuffix();
    }

◆ getFileType()

ilObjFileImplementationStorage::getFileType ( )

@inheritDoc

Implements ilObjFileImplementationInterface.

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

    {
        return $this->resource->getCurrentRevision()->getInformation()->getMimeType();
    }

◆ getStorageID()

ilObjFileImplementationStorage::getStorageID ( )

Implements ilObjFileImplementationInterface.

Definition at line 222 of file class.ilObjFileImplementationStorage.php.

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

◆ getVersions()

ilObjFileImplementationStorage::getVersions ( $version_ids = null )

@inheritDoc

Implements ilObjFileImplementationInterface.

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

                                                     : array
    {
        $versions = [];
        foreach ($this->resource->getAllRevisions() as $revision) {
            if (is_array($version_ids) && !in_array($revision->getVersionNumber(), $version_ids)) {
                continue;
            }
            $information = $revision->getInformation();
            $v = new ilObjFileVersion();
            $v->setVersion($revision->getVersionNumber());
            $v->setHistEntryId($revision->getVersionNumber());
            $v->setFilename($information->getTitle());
            $v->setAction($revision->getVersionNumber() === 1 ? 'create' : 'new_version');
            $v->setTitle($revision->getTitle());
            $v->setDate($information->getCreationDate()->format(DATE_ATOM));
            $v->setUserId($revision->getOwnerId() !== 0 ? $revision->getOwnerId() : 6);
            $v->setSize($information->getSize());
 
            $versions[] = $v;
        }
 
        return $versions;
    }

◆ handleChangedObjectTitle()

ilObjFileImplementationStorage::handleChangedObjectTitle ( string $new_title )

Implements ilObjFileImplementationInterface.

Definition at line 73 of file class.ilObjFileImplementationStorage.php.

    {
        $current_revision = $this->resource->getCurrentRevision();
        $current_revision->setTitle($new_title);
        $this->storage->manage()->updateRevision($current_revision);
    }

◆ isInline()

ilObjFileImplementationStorage::isInline ( $a_hist_entry_id = null )

private

Parameters

null $a_hist_entry_id

Returns: bool

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

    {
        try {
            $revision = $a_hist_entry_id ?
                $this->resource->getSpecificRevision($a_hist_entry_id) :
                $this->resource->getCurrentRevision();
            return \ilObjFileAccess::_isFileInline($revision->getTitle());
        } catch (Exception $e) {
            return false;
        }
    }

References Vendor\Package\$e.

Referenced by sendFile().

Here is the caller graph for this function:

◆ sendFile()

ilObjFileImplementationStorage::sendFile ( $a_hist_entry_id = null )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 117 of file class.ilObjFileImplementationStorage.php.

    {
        if ($this->isInline($a_hist_entry_id)) {
            $consumer = $this->storage->consume()->inline($this->resource->getIdentification());
        } else {
            $consumer = $this->storage->consume()->download($this->resource->getIdentification());
        }
 
 
        if ($a_hist_entry_id) {
            $revision = $this->resource->getSpecificRevision($a_hist_entry_id);
            $consumer->setRevisionNumber($a_hist_entry_id);
        } else {
            $revision = $this->resource->getCurrentRevision();
        }
 
        if ($this->download_with_uploaded_filename) {
            $consumer->overrideFileName($revision->getInformation()->getTitle());
        } else {
            $consumer->overrideFileName($revision->getTitle());
        }
 
        $consumer->run();
    }

References isInline().

Here is the call graph for this function:

Field Documentation

◆ $download_with_uploaded_filename

ilObjFileImplementationStorage::$download_with_uploaded_filename

protected

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

◆ $obj_id

ilObjFileImplementationStorage::$obj_id

protected

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

Referenced by export().

◆ $resource

ilObjFileImplementationStorage::$resource

protected

Definition at line 19 of file class.ilObjFileImplementationStorage.php.

◆ $storage

ilObjFileImplementationStorage::$storage

protected

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

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

Modules/File/classes/Implementation/class.ilObjFileImplementationStorage.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ debug()

◆ deleteVersions()

◆ export()

◆ getDirectory()

◆ getFile()

◆ getFileExtension()

◆ getFileType()

◆ getStorageID()

◆ getVersions()

◆ handleChangedObjectTitle()

◆ isInline()

◆ sendFile()

Field Documentation

◆ $download_with_uploaded_filename

◆ $obj_id

◆ $resource

◆ $storage