CustomIconUploadHandlerGUI Class Reference

Inheritance diagram for CustomIconUploadHandlerGUI:

Collaboration diagram for CustomIconUploadHandlerGUI:

Public Member Functions
	getInfoResult (string $file_name)
	getInfoForExistingFiles (array $file_names)
Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...
	getFileIdentifierParameterName ()
	@inheritDoc More...
	getUploadURL ()
	@inheritDoc More...
	getExistingFileInfoURL ()
	@inheritDoc More...
	getFileRemovalURL ()
	@inheritDoc More...
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
	supportsChunkedUploads ()
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getFileIdentifierParameterName ()
	getUploadURL ()
	getFileRemovalURL ()
	getExistingFileInfoURL ()
	getInfoForExistingFiles (array $file_ids)
	getInfoResult (string $identifier)
	supportsChunkedUploads ()

Protected Member Functions
	getUploadResult ()
	@inheritDoc More...
	getRemoveResult (string $file_name)
Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()
	getUploadResult ()
	getRemoveResult (string $identifier)

Protected Attributes
ilLanguage	$language
bool	$has_access = false
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

Stephan Kergomard webma.nosp@m.ster.nosp@m.@kerg.nosp@m.omar.nosp@m.d.ch

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

Member Function Documentation

getInfoForExistingFiles()

CustomIconUploadHandlerGUI::getInfoForExistingFiles

(

array

$file_names

)

Returns

\ILIAS\FileUpload\Handler\BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 143 of file class.CustomIconUploadHandlerGUI.php.

                                                              : array
    {
        return [$this->getInfoResult('custom_icon')];
    }

References getInfoResult().

Here is the call graph for this function:

getInfoResult()

CustomIconUploadHandlerGUI::getInfoResult

(

string

$identifier

)

Returns

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

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 123 of file class.CustomIconUploadHandlerGUI.php.

                                                    : ?FileInfoResult
    {
        if ($this->has_access === false) {
            return null;
        }
 
        $file_path = $this->custom_icon->getFullPath();
 
        return new BasicFileInfoResult(
            $this->getFileIdentifierParameterName(),
            'custom_icon',
            $this->language->txt('custom_icon'),
            filesize($file_path),
            MimeType::IMAGE__SVG_XML
        );
    }

References ILIAS\UI\examples\Symbol\Icon\Custom\custom_icon(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by getInfoForExistingFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

getRemoveResult()

CustomIconUploadHandlerGUI::getRemoveResult ( string  $file_name )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 105 of file class.CustomIconUploadHandlerGUI.php.

                                                         : HandlerResult
    {
        if ($this->has_access === false) {
            return $this->getAccessFailureResult(
                $this->getFileIdentifierParameterName(),
                $file_name,
                $this->language
            );
        }
 
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_OK,
            $file_name,
            'There is nothing to do here.'
        );
    }

References ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

getUploadResult()

CustomIconUploadHandlerGUI::getUploadResult ( )

protected

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 69 of file class.CustomIconUploadHandlerGUI.php.

                                        : HandlerResult
    {
        $tempfile = '';
        if ($this->has_access === false) {
            return $this->getAccessFailureResult(
                $this->getFileIdentifierParameterName(),
                $tempfile,
                $this->language
            );
        }
 
        $this->upload->process();
 
        $result_array = $this->upload->getResults();
        $result = end($result_array);
 
        if ($result instanceof UploadResult
            && in_array($result->getMimeType(), Icon::SUPPORTED_MIME_TYPES)
            && $result->isOK()) {
            $status = HandlerResult::STATUS_OK;
            $message = 'Upload ok';
            $tempfile = \ilFileUtils::ilTempnam();
            rename($result->getPath(), $tempfile);
        } else {
            $status = HandlerResult::STATUS_FAILED;
            $message = $result->getStatus()->getMessage();
        }
 
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            $status,
            basename($tempfile),
            $message
        );
    }

References $message, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ilFileUtils\ilTempnam(), ILIAS\FileUpload\DTO\UploadResult\isOK(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\upload().

Here is the call graph for this function:

Field Documentation

$has_access

bool CustomIconUploadHandlerGUI::$has_access = false

protected

Definition at line 41 of file class.CustomIconUploadHandlerGUI.php.

$language

ilLanguage CustomIconUploadHandlerGUI::$language

protected

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

---

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

• components/ILIAS/ILIASObject/classes/Properties/class.CustomIconUploadHandlerGUI.php