Class ilFileVersionsUploadHandlerGUI. More...

Inheritance diagram for ilFileVersionsUploadHandlerGUI:

Collaboration diagram for ilFileVersionsUploadHandlerGUI:

Public Member Functions
	__construct (protected ilObjFile $file, string $upload_mode=self::MODE_APPEND)

	supportsChunkedUploads ()

Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler
	__construct ()

	getUploadURL ()

	getExistingFileInfoURL ()

	getFileRemovalURL ()

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...

	getFileIdentifierParameterName ()

	getUploadURL ()

	getExistingFileInfoURL ()

	getFileRemovalURL ()

	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	supportsChunkedUploads ()

Data Fields
const	MODE_APPEND = 'append'

const	MODE_REPLACE = 'replace'

const	P_UPLOAD_MODE = 'upload_mode'

Data Fields inherited from ILIAS\UI\Component\Input\Field\UploadHandler
const	DEFAULT_FILE_ID_PARAMETER = 'file_id'

Protected Member Functions
	getStakeholder ()

	getClassPath ()

	getUploadResult ()

	processChunckedUpload (UploadResult $result)

Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler
	getStakeholder ()

	getClassPath ()

	getUploadResult ()

	processChunckedUpload (UploadResult $result)

	getRemoveResult (string $identifier)

Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()

	getUploadResult ()

	getRemoveResult (string $identifier)

Protected Attributes
bool	$append

string	$upload_mode = self::MODE_APPEND

Protected Attributes inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler
ilFileServicesFilenameSanitizer	$sanitizer

ilLanguage	$language

ILIAS ResourceStorage Services	$irss

ResourceStakeholder	$stakeholder

ILIAS Filesystem Filesystem	$temp_filesystem

array	$class_path

Protected Attributes inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
const	CMD_UPLOAD = 'upload'

const	CMD_REMOVE = 'remove'

const	CMD_INFO = 'info'

HttpServices	$http

ilCtrl	$ctrl

FileUpload	$upload

bool	$is_chunked = false

int	$chunk_index = 0

int	$amount_of_chunks = 0

string	$chunk_id = null

int	$chunk_total_size = 0

Detailed Description

Class ilFileVersionsUploadHandlerGUI.

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

ilFileVersionsUploadHandlerGUI : ilFileVersionsGUI

Definition at line 32 of file class.ilFileVersionsUploadHandlerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileVersionsUploadHandlerGUI::__construct	(	protected ilObjFile	$file,
		string	$upload_mode = `self::MODE_APPEND`
	)

Definition at line 40 of file class.ilFileVersionsUploadHandlerGUI.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\ctrl(), and ILIAS\FileDelivery\http().

     {
         global $DIC;
         parent::__construct();
         $this->upload_mode = $this->http->wrapper()->query()->has(self::P_UPLOAD_MODE)
             ? $this->http->wrapper()->query()->retrieve(self::P_UPLOAD_MODE, $DIC->refinery()->kindlyTo()->string())
             : $upload_mode;
 
         $this->ctrl->setParameter($this, self::P_UPLOAD_MODE, $this->upload_mode);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getClassPath()

ilFileVersionsUploadHandlerGUI::getClassPath ( )

protected

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

                                      : array
     {
         return [self::class];
     }

◆ getStakeholder()

ilFileVersionsUploadHandlerGUI::getStakeholder ( )

protected

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

References $DIC.

                                        : ResourceStakeholder
     {
         global $DIC;
         return new ilObjFileStakeholder($DIC->user()->getId());
     }

◆ getUploadResult()

ilFileVersionsUploadHandlerGUI::getUploadResult ( )

protected

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

References $message, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\DTO\UploadResult\isOK(), processChunckedUpload(), and ILIAS\Repository\upload().

                                         : HandlerResult
     {
         $this->upload->register(new ilCountPDFPagesPreProcessors());
         $this->upload->process();
         $upload_mode =
 
         $result_array = $this->upload->getResults();
         $result = end($result_array);
 
         if ($result instanceof UploadResult && $result->isOK()) {
             if ($this->is_chunked) {
                 return $this->processChunckedUpload($result);
             }
 
             if ($this->upload_mode === self::MODE_REPLACE) {
                 $identifier = (string) $this->file->replaceWithUpload($result, $result->getName());
             } else {
                 $identifier = (string) $this->file->appendUpload($result, $result->getName());
             }
             $status = HandlerResult::STATUS_OK;
             $message = "file upload OK";
         } else {
             $identifier = '';
             $status = HandlerResult::STATUS_FAILED;
             $message = $result->getStatus()->getMessage();
         }
 
         return new BasicHandlerResult(
             $this->getFileIdentifierParameterName(),
             $status,
             $identifier,
             $message
         );
     }

Here is the call graph for this function:

◆ processChunckedUpload()

ilFileVersionsUploadHandlerGUI::processChunckedUpload ( UploadResult $result )

protected

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

References ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\$amount_of_chunks, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\DTO\UploadResult\getName(), and ILIAS\FileUpload\DTO\UploadResult\getPath().

Referenced by getUploadResult().

                                                                   : HandlerResult
     {
         $temp_path = "$this->chunk_id/{$result->getName()}";
 
         try {
             if ($this->temp_filesystem->has($temp_path)) {
                 $stream = fopen($this->temp_filesystem->readStream($temp_path)->getMetadata()['uri'], 'ab');
                 fwrite($stream, file_get_contents($result->getPath()));
             } else {
                 $this->temp_filesystem->write($temp_path, file_get_contents($result->getPath()));
             }
         } catch (Throwable $t) {
             return new BasicHandlerResult(
                 $this->getFileIdentifierParameterName(),
                 HandlerResult::STATUS_FAILED,
                 '',
                 $t->getMessage()
             );
         }
 
         if (($this->chunk_index + 1) === $this->amount_of_chunks) {
             $whole_file = $this->temp_filesystem->readStream($temp_path);
             if ($this->upload_mode === self::MODE_REPLACE) {
                 $revision_number = $this->file->replaceWithStream($whole_file, $result->getName());
             } else {
                 $revision_number = $this->file->appendStream($whole_file, $result->getName());
             }
 
             return new BasicHandlerResult(
                 $this->getFileIdentifierParameterName(),
                 HandlerResult::STATUS_OK,
                 (string) $revision_number,
                 "file upload OK"
             );
         }
 
         return new BasicHandlerResult(
             $this->getFileIdentifierParameterName(),
             HandlerResult::STATUS_PARTIAL,
             '',
             "chunk upload OK"
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportsChunkedUploads()

ilFileVersionsUploadHandlerGUI::supportsChunkedUploads ( )

Returns: bool if this uploadhandler chan handle Chunked Uploads. These come in multiple requests and must be combined to a single file. If your UploadHandler can handle Chunked Uploads, you can use a UI with .

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

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

                                             : bool
     {
         return true;
     }

Field Documentation

◆ $append

bool ilFileVersionsUploadHandlerGUI::$append

protected

Definition at line 37 of file class.ilFileVersionsUploadHandlerGUI.php.

◆ $upload_mode

string ilFileVersionsUploadHandlerGUI::$upload_mode = self::MODE_APPEND

protected

Definition at line 38 of file class.ilFileVersionsUploadHandlerGUI.php.

◆ MODE_APPEND

const ilFileVersionsUploadHandlerGUI::MODE_APPEND = 'append'

Definition at line 34 of file class.ilFileVersionsUploadHandlerGUI.php.

Referenced by ilFileVersionFormGUI\initForm().

◆ MODE_REPLACE

const ilFileVersionsUploadHandlerGUI::MODE_REPLACE = 'replace'

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

Referenced by ilFileVersionFormGUI\initForm().

◆ P_UPLOAD_MODE

const ilFileVersionsUploadHandlerGUI::P_UPLOAD_MODE = 'upload_mode'

Definition at line 36 of file class.ilFileVersionsUploadHandlerGUI.php.

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

Modules/File/classes/Versions/class.ilFileVersionsUploadHandlerGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getClassPath()

◆ getStakeholder()

◆ getUploadResult()

◆ processChunckedUpload()

◆ supportsChunkedUploads()

Field Documentation

◆ $append

◆ $upload_mode

◆ MODE_APPEND

◆ MODE_REPLACE

◆ P_UPLOAD_MODE