ilMDVocabularyUploadHandlerGUI Class Reference

Inheritance diagram for ilMDVocabularyUploadHandlerGUI:

Collaboration diagram for ilMDVocabularyUploadHandlerGUI:

Public Member Functions
	__construct ()
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
Public Member Functions inherited from ILIAS\MetaData\OERExposer\OAIPMH\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
	getUploadResult ()
	getRemoveResult (string $identifier)
Protected Member Functions inherited from ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()
	getUploadResult ()
	getRemoveResult (string $identifier)

Protected Attributes
Filesystem	$temp
Protected Attributes inherited from ILIAS\MetaData\OERExposer\OAIPMH\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

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

Constructor & Destructor Documentation

__construct()

ilMDVocabularyUploadHandlerGUI::__construct

(

)

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $this->temp = $DIC->filesystem()->temp();
        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

getInfoForExistingFiles()

ilMDVocabularyUploadHandlerGUI::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

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

Definition at line 110 of file class.ilMDVocabularyUploadHandlerGUI.php.

                                                            : array
    {
        return [];
    }

getInfoResult()

ilMDVocabularyUploadHandlerGUI::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 82 of file class.ilMDVocabularyUploadHandlerGUI.php.

References ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\MetaData\OERExposer\OAIPMH\Handler\FileInfoResult\getSize().

                                                     : ?FileInfoResult
    {
        $title = $mime = 'unknown';
        $size = 0;

        $files = $this->temp->hasDir($identifier) ?
            $this->temp->listContents($identifier) :
            [];

        foreach ($files as $file) {
            if (!$file->isFile()) {
                continue;
            }
            $title = $file->getFilename();
            $size = $file->getSize();
            $mime = $file->getMimeType();
            break;
        }

        return new BasicFileInfoResult(
            $this->getFileIdentifierParameterName(),
            $identifier,
            $title,
            $size,
            $mime
        );
    }

Here is the call graph for this function:

getRemoveResult()

ilMDVocabularyUploadHandlerGUI::getRemoveResult ( string  $identifier )

protected

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

References ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName().

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

Here is the call graph for this function:

getUploadResult()

ilMDVocabularyUploadHandlerGUI::getUploadResult ( )

protected

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

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

                                        : HandlerResult
    {
        $status = HandlerResult::STATUS_FAILED;
        $new_identification = 'unknown';
        $message = 'file upload failed';

        $this->upload->process();
        $uploadResults = $this->upload->getResults();
        $result = end($uploadResults);

        if ($result instanceof UploadResult && $result->isOK() && $result->getSize()) {
            $new_identification = uniqid('md_vocab_');
            $move_success = $this->upload->moveOneFileTo(
                $result,
                $new_identification,
                Location::TEMPORARY
            );
            if ($move_success) {
                $status = HandlerResult::STATUS_OK;
                $message = 'Upload ok';
            }
        }
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            $status,
            $new_identification,
            $message
        );
    }

Here is the call graph for this function:

Field Documentation

$temp

Filesystem ilMDVocabularyUploadHandlerGUI::$temp

protected

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

---

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

• components/ILIAS/MetaData/classes/Settings/Vocabularies/class.ilMDVocabularyUploadHandlerGUI.php