Class ilObjFileImplementationStorage. More...

Inheritance diagram for ilObjFileImplementationStorage:

Collaboration diagram for ilObjFileImplementationStorage:

Public Member Functions
	__construct (protected StorableResource $resource)
	ilObjFileImplementationStorage constructor. More...

	handleChangedObjectTitle (string $new_title)

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

	getFileName ()

	getFileSize ()

	getFileType ()
	@inheritDoc More...

	getDirectory (int $a_version=0)

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

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

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

	getVersions (?array $version_ids=null)

	getStorageID ()

	getVersion (bool $inclduing_drafts=false)

	getMaxVersion ()

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

	getFileName ()

	getFile (?int $a_hist_entry_id=null)

	getVersion (bool $inclduing_drafts=false)

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

Protected Attributes
Services	$storage

Detailed Description

Class ilObjFileImplementationStorage.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFileImplementationStorage::__construct ( protected StorableResource $resource )

ilObjFileImplementationStorage constructor.

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

    {
        global $DIC;
        $settings = new General();
        $this->storage = $DIC->resourceStorage();
    }

References $DIC.

Member Function Documentation

◆ deleteVersions()

ilObjFileImplementationStorage::deleteVersions ( ?array $a_hist_entry_ids = null )

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

Parameters

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

Deprecated:

Implements ilObjFileImplementationInterface.

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

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

References $id.

◆ getDirectory()

ilObjFileImplementationStorage::getDirectory ( int $a_version = 0 )

Deprecated:

Implements ilObjFileImplementationInterface.

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

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

◆ getFile()

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

@inheritDoc

Implements ilObjFileImplementationInterface.

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

                                                         : string
    {
        $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 ( )

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

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

Implements ilObjFileImplementationInterface.

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

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

◆ getFileName()

ilObjFileImplementationStorage::getFileName ( )

Implements ilObjFileImplementationInterface.

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

                                 : string
    {
        return $this->resource->getCurrentRevision()->getInformation()->getTitle();
    }

◆ getFileSize()

ilObjFileImplementationStorage::getFileSize ( )

Implements ilObjFileImplementationInterface.

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

                                 : int
    {
        return $this->resource->getCurrentRevision()->getInformation()->getSize() ?: 0;
    }

◆ getFileType()

ilObjFileImplementationStorage::getFileType ( )

@inheritDoc

Implements ilObjFileImplementationInterface.

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

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

◆ getMaxVersion()

ilObjFileImplementationStorage::getMaxVersion ( )

Implements ilObjFileImplementationInterface.

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

                                   : int
    {
        return $this->resource->getMaxRevision(false);
    }

◆ getStorageID()

ilObjFileImplementationStorage::getStorageID ( )

Implements ilObjFileImplementationInterface.

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

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

◆ getVersion()

ilObjFileImplementationStorage::getVersion ( bool $inclduing_drafts = false )

Implements ilObjFileImplementationInterface.

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

                                                              : int
    {
        try {
            if ($inclduing_drafts) {
                return $this->resource->getCurrentRevisionIncludingDraft()->getVersionNumber();
            }
            return $this->resource->getCurrentRevision()->getVersionNumber();
        } catch (Throwable) {
            return 0;
        }
    }

◆ getVersions()

ilObjFileImplementationStorage::getVersions ( ?array $version_ids = null )

Returns: \ilObjFileVersion[]

Implements ilObjFileImplementationInterface.

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

                                                           : array
    {
        $versions = [];
        $current_revision = $this->resource->getCurrentRevisionIncludingDraft();
        foreach ($this->resource->getAllRevisionsIncludingDraft() 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());
            if ($revision->getStatus() === RevisionStatus::DRAFT) {
                $v->setAction('draft');
            } else {
                $version_number = $revision->getVersionNumber();
                match ($version_number) {
                    1 => $v->setAction('create'),
                    $current_revision->getVersionNumber() => $v->setAction('published_version'),
                    default => $v->setAction('intermediate_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;
    }

References ILIAS\ResourceStorage\Revision\DRAFT.

◆ handleChangedObjectTitle()

ilObjFileImplementationStorage::handleChangedObjectTitle ( string $new_title )

Implements ilObjFileImplementationInterface.

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

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

◆ sendFile()

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

Parameters

bool $inline

Deprecated:

Implements ilObjFileImplementationInterface.

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

                                                                               : void
    {
        if ($inline) {
            $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();
        }
        $consumer->overrideFileName($revision->getTitle());
 
        $consumer->run();
    }

Field Documentation

◆ $storage

Services ilObjFileImplementationStorage::$storage

protected

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

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

components/ILIAS/File/classes/Implementation/class.ilObjFileImplementationStorage.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteVersions()

◆ getDirectory()

◆ getFile()

◆ getFileExtension()

◆ getFileName()

◆ getFileSize()

◆ getFileType()

◆ getMaxVersion()

◆ getStorageID()

◆ getVersion()

◆ getVersions()

◆ handleChangedObjectTitle()

◆ sendFile()

Field Documentation

◆ $storage