Inheritance diagram for ilRepoStandardUploadHandlerGUI:

Collaboration diagram for ilRepoStandardUploadHandlerGUI:

Public Member Functions
	__construct (Closure $result_handler, string $file_id_parameter, string $logger_id="", array $ctrl_path=[])

	getUploadURL ()

	getExistingFileInfoURL ()

	getFileRemovalURL ()

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	getFileIdentifierParameterName ()

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

Protected Member Functions
	getCtrlPath ()

	debug (string $mess)

	getUploadResult ()

	getRemoveResult (string $identifier)

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

	getUploadResult ()

	getRemoveResult (string $identifier)

Protected Attributes
array	$ctrl_path

ilLogger	$log = null

Closure	$result_handler

string	$file_id_parameter = ""

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

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

Detailed Description

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 33 of file class.ilRepoStandardUploadHandlerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRepoStandardUploadHandlerGUI::__construct	(	Closure	$result_handler,
		string	$file_id_parameter,
		string	$logger_id = `""`,
		array	$ctrl_path = `[]`
	)

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

References $ctrl_path, $DIC, $file_id_parameter, $result_handler, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ilLoggerFactory\getLogger().

       {
         global $DIC;
         $this->ctrl_path = $ctrl_path;
         parent::__construct();
 
         if ($logger_id !== "") {
             $this->log = ilLoggerFactory::getLogger($logger_id);
         }
         $this->result_handler = $result_handler;
         $this->file_id_parameter = $file_id_parameter;
     }

Here is the call graph for this function:

Member Function Documentation

◆ debug()

ilRepoStandardUploadHandlerGUI::debug ( string $mess )

protected

Definition at line 86 of file class.ilRepoStandardUploadHandlerGUI.php.

Referenced by getUploadResult().

                                           : void
     {
         if (!is_null($this->log)) {
             $this->log->debug($mess);
         }
     }

Here is the caller graph for this function:

◆ getCtrlPath()

ilRepoStandardUploadHandlerGUI::getCtrlPath ( )

protected

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

References $ctrl_path, and $path.

Referenced by getExistingFileInfoURL(), getFileRemovalURL(), and getUploadURL().

                                     : array
     {
         $path = $this->ctrl_path;
         $path[] = static::class;
         return $path;
     }

Here is the caller graph for this function:

◆ getExistingFileInfoURL()

ilRepoStandardUploadHandlerGUI::getExistingFileInfoURL ( )

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

Definition at line 72 of file class.ilRepoStandardUploadHandlerGUI.php.

References ILIAS\Repository\ctrl(), and getCtrlPath().

                                             : string
     {
         return $this->ctrl->getLinkTargetByClass($this->getCtrlPath(), self::CMD_INFO);
     }

Here is the call graph for this function:

◆ getFileIdentifierParameterName()

ilRepoStandardUploadHandlerGUI::getFileIdentifierParameterName ( )

Returns: string defaults to self::DEFAULT_FILE_ID_PARAMETER

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

Definition at line 141 of file class.ilRepoStandardUploadHandlerGUI.php.

References $file_id_parameter.

Referenced by getRemoveResult(), and getUploadResult().

                                                     : string
     {
         return $this->file_id_parameter;
     }

Here is the caller graph for this function:

◆ getFileRemovalURL()

ilRepoStandardUploadHandlerGUI::getFileRemovalURL ( )

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

Definition at line 81 of file class.ilRepoStandardUploadHandlerGUI.php.

References ILIAS\Repository\ctrl(), and getCtrlPath().

                                        : string
     {
         return $this->ctrl->getLinkTargetByClass($this->getCtrlPath(), self::CMD_REMOVE);
     }

Here is the call graph for this function:

◆ getInfoForExistingFiles()

ilRepoStandardUploadHandlerGUI::getInfoForExistingFiles ( array $file_ids )

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

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

Definition at line 136 of file class.ilRepoStandardUploadHandlerGUI.php.

◆ getInfoResult()

ilRepoStandardUploadHandlerGUI::getInfoResult ( string $identifier )

Returns: null|FileInfoResult for the file with the given identifier or null if the file does not exist.

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

Definition at line 131 of file class.ilRepoStandardUploadHandlerGUI.php.

                                                      : ?FileInfoResult
     {
         return null;
     }

◆ getRemoveResult()

ilRepoStandardUploadHandlerGUI::getRemoveResult ( string $identifier )

protected

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

References getFileIdentifierParameterName().

                                                           : HandlerResult
     {
         return new BasicHandlerResult(
             $this->getFileIdentifierParameterName(),
             HandlerResult::STATUS_OK,
             $identifier,
             ''
         );
     }

Here is the call graph for this function:

◆ getUploadResult()

ilRepoStandardUploadHandlerGUI::getUploadResult ( )

protected

Definition at line 93 of file class.ilRepoStandardUploadHandlerGUI.php.

References Vendor\Package\$e, $result_handler, debug(), getFileIdentifierParameterName(), and ILIAS\Repository\upload().

                                         : HandlerResult
     {
         $this->debug("checking for uploads...");
         if ($this->upload->hasUploads()) {
             $this->debug("has upload...");
             try {
                 $this->upload->process();
                 $this->debug("nr of results: " . count($this->upload->getResults()));
                 foreach ($this->upload->getResults(
                 ) as $result) { // in this version, there will only be one upload at the time
                     $rh = $this->result_handler;
                     $result = $rh($this->upload, $result);
                 }
             } catch (Exception $e) {
                 $result = new BasicHandlerResult(
                     $this->getFileIdentifierParameterName(),
                     BasicHandlerResult::STATUS_FAILED,
                     '',
                     $e->getMessage()
                 );
             }
             $this->debug("end of 'has_uploads'");
         } else {
             $this->debug("has no upload...");
         }
         return $result;
     }

Here is the call graph for this function:

◆ getUploadURL()

ilRepoStandardUploadHandlerGUI::getUploadURL ( )

Returns: string of the URL where dropped files are sent to. This URL must make sure the upload is handled and a is returned as JSON.

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

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

References ILIAS\Repository\ctrl(), and getCtrlPath().

                                   : string
     {
         return $this->ctrl->getLinkTargetByClass($this->getCtrlPath(), self::CMD_UPLOAD);
     }

Here is the call graph for this function:

Field Documentation

◆ $ctrl_path

array ilRepoStandardUploadHandlerGUI::$ctrl_path

protected

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

Referenced by __construct(), and getCtrlPath().

◆ $file_id_parameter

string ilRepoStandardUploadHandlerGUI::$file_id_parameter = ""

protected

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

Referenced by __construct(), and getFileIdentifierParameterName().

◆ $log

ilLogger ilRepoStandardUploadHandlerGUI::$log = null

protected

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

◆ $result_handler

Closure ilRepoStandardUploadHandlerGUI::$result_handler

protected

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

Referenced by __construct(), and getUploadResult().

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

Services/Repository/Service/Form/class.ilRepoStandardUploadHandlerGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ debug()

◆ getCtrlPath()

◆ getExistingFileInfoURL()

◆ getFileIdentifierParameterName()

◆ getFileRemovalURL()

◆ getInfoForExistingFiles()

◆ getInfoResult()

◆ getRemoveResult()

◆ getUploadResult()

◆ getUploadURL()

Field Documentation

◆ $ctrl_path

◆ $file_id_parameter

◆ $log

◆ $result_handler