AbstractCtrlAwareUploadHandler.php

Go to the documentation of this file.

<?php declare(strict_types=1);

namespace ILIAS\FileUpload\Handler;

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\FileUpload\FileUpload;

abstract class AbstractCtrlAwareUploadHandler implements ilCtrlAwareUploadHandler
{
    protected const CMD_UPLOAD = 'upload';
    protected const CMD_REMOVE = 'remove';
    protected const CMD_INFO = 'info';
    protected $http;
    protected $ctrl;
    protected $upload;


    public function __construct()
    {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->upload = $DIC->upload();
        $this->http = $DIC->http();
    }


    public function getFileIdentifierParameterName() : string
    {
        return self::DEFAULT_FILE_ID_PARAMETER;
    }


    public function getUploadURL() : string
    {
        return $this->ctrl->getLinkTargetByClass([static::class], self::CMD_UPLOAD);
    }


    public function getExistingFileInfoURL() : string
    {
        return $this->ctrl->getLinkTargetByClass([static::class], self::CMD_INFO);
    }


    public function getFileRemovalURL() : string
    {
        return $this->ctrl->getLinkTargetByClass([static::class], self::CMD_REMOVE);
    }


    public function executeCommand() : void
    {
        switch ($this->ctrl->getCmd()) {
            case self::CMD_UPLOAD:
                // Here you must save the file and tell the input item the
                // file-id which will be a FileStorage-ID in a later version
                // of ILIAS and for now you must implement an own ID which allows
                // identifying the file after the request
                $content = json_encode($this->getUploadResult());
                break;
            case self::CMD_REMOVE:
                // here you delete the previously uploaded file again, you know
                // which file to delete since you defined what 'my_file_id' is.
                $file_identifier = $this->http->request()->getQueryParams()[$this->getFileIdentifierParameterName()];
                $content = json_encode($this->getRemoveResult($file_identifier));
                break;
            case self::CMD_INFO:
                // here you give info about an already existing file
                // return a JsonEncoded \ILIAS\FileUpload\Handler\FileInfoResult
                $file_identifier = $this->http->request()->getQueryParams()[$this->getFileIdentifierParameterName()];
                $content = json_encode($this->getInfoResult($file_identifier));
                break;
            default:
                $content = '';
                break;
        }
        $response = $this->http->response()->withBody(Streams::ofString($content));
        $this->http->saveResponse($response);
        $this->http->sendResponse();
        $this->http->close();
    }


    abstract protected function getUploadResult() : HandlerResult;


    abstract protected function getRemoveResult(string $identifier) : HandlerResult;


    abstract protected function getInfoResult(string $identifier) : FileInfoResult;


    abstract public function getInfoForExistingFiles(array $file_ids) : array;
}