ilMDCopyrightImageUploadHandlerGUI Class Reference

Inheritance diagram for ilMDCopyrightImageUploadHandlerGUI:

Collaboration diagram for ilMDCopyrightImageUploadHandlerGUI:

Public Member Functions
	__construct (string $identification)
	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
ilMDCopyrightImageStakeholder	$stakeholder
Services	$storage
string	$identification
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.ilMDCopyrightImageUploadHandlerGUI.php.

Constructor & Destructor Documentation

__construct()

ilMDCopyrightImageUploadHandlerGUI::__construct

(

string

$identification

)

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

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

    {
        global $DIC;

        $this->stakeholder = new ilMDCopyrightImageStakeholder();
        $this->storage = $DIC->resourceStorage();
        $this->identification = $identification;

        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

getInfoForExistingFiles()

ilMDCopyrightImageUploadHandlerGUI::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

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

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

References getInfoResult().

                                                            : array
    {
        $info_results = [];
        foreach ($file_ids as $identifier) {
            $info_results[] = $this->getInfoResult($identifier);
        }

        return $info_results;
    }

Here is the call graph for this function:

getInfoResult()

ilMDCopyrightImageUploadHandlerGUI::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 88 of file class.ilMDCopyrightImageUploadHandlerGUI.php.

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

Referenced by getInfoForExistingFiles().

                                                     : ?FileInfoResult
    {
        if (null !== ($id = $this->storage->manage()->find($identifier))) {
            $revision = $this->storage->manage()->getCurrentRevision($id)->getInformation();
            $title = $revision->getTitle();
            $size = $revision->getSize();
            $mime = $revision->getMimeType();
        } else {
            $title = $mime = 'unknown';
            $size = 0;
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

getRemoveResult()

ilMDCopyrightImageUploadHandlerGUI::getRemoveResult ( string  $identifier )

protected

Definition at line 78 of file class.ilMDCopyrightImageUploadHandlerGUI.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()

ilMDCopyrightImageUploadHandlerGUI::getUploadResult ( )

protected

Definition at line 47 of file class.ilMDCopyrightImageUploadHandlerGUI.php.

References $identification, $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()) {
            $resource_id = $this->storage->manage()->find($this->identification);
            if (is_null($resource_id)) {
                $new_identification = $this->storage->manage()->upload($result, $this->stakeholder)->serialize();
                $status = HandlerResult::STATUS_OK;
                $message = 'Upload ok';
            } elseif ($this->identification !== '') {
                $this->storage->manage()->replaceWithUpload($resource_id, $result, $this->stakeholder);
                $new_identification = $this->identification;
                $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

$identification

string ilMDCopyrightImageUploadHandlerGUI::$identification

protected

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

Referenced by __construct(), and getUploadResult().

$stakeholder

ilMDCopyrightImageStakeholder ilMDCopyrightImageUploadHandlerGUI::$stakeholder

protected

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

$storage

Services ilMDCopyrightImageUploadHandlerGUI::$storage

protected

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

---

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

• components/ILIAS/MetaData/classes/Settings/Copyright/class.ilMDCopyrightImageUploadHandlerGUI.php