class.ilFileStandardDropzoneInputGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilFileStandardDropzoneInputGUI extends ilFileInputGUI implements ilToolbarItem
{
    use \ILIAS\Modules\OrgUnit\ARHelper\DIC;

    const ASYNC_FILEUPLOAD = "async_fileupload";
    protected static $count = 0;
    protected $upload_url = '';
    protected $max_files = 1;
    protected $max_file_size;
    protected $dropzone_message = '';

    protected $cancel_command;

    public function __construct($cancel_command, $a_title = "", $a_postvar = "")
    {
        $this->cancel_command = $cancel_command;
        parent::__construct($a_title, $a_postvar);
    }

    public function getUploadUrl()
    {
        return $this->upload_url;
    }


    public function setUploadUrl($upload_url)
    {
        $this->upload_url = $upload_url;

        return $this;
    }


    public function getMaxFiles()
    {
        return $this->max_files;
    }


    public function setMaxFiles($max_files)
    {
        $this->max_files = $max_files;
    }


    public function getMaxFilesize()
    {
        return $this->max_file_size;
    }


    public function setMaxFilesize(\ILIAS\Data\DataSize $max_file_size)
    {
        $this->max_file_size = $max_file_size;
    }


    public function getDropzoneMessage()
    {
        return $this->dropzone_message;
    }


    public function setDropzoneMessage($dropzone_message)
    {
        $this->dropzone_message = $dropzone_message;
    }


    public function render($a_mode = "")
    {
        $this->handleUploadURL();
        $this->handleSuffixes();

        $f = $this->ui()->factory();
        $r = $this->ui()->renderer();

        $this->initDropzoneMessage();

        $dropzone = $f->dropzone()
                      ->file()
                      ->standard($this->getUploadUrl())
                      ->withParameterName($this->getPostVar())
                      ->withMaxFiles($this->getMaxFiles())
                      ->withMessage($this->getDropzoneMessage())
                      ->withAllowedFileTypes($this->getSuffixes());
        $dropzone = $this->handleMaxFileSize($dropzone);
        if ($this->isFileNameSelectionEnabled()) {
            $dropzone = $dropzone->withUserDefinedFileNamesEnabled(true);
        }

        $render = $r->render($dropzone);

        $n = ++self::$count;
        $out = "<div id='ilFileStandardDropzoneInputGUIWrapper{$n}'>" . $render . '</div>';
        // We need some javascript magic

        $this->ui()->mainTemplate()->addJavaScript('./Services/Form/js/ilFileStandardDropzoneInputGUI.js');
        $this->ui()->mainTemplate()->addOnLoadCode("ilFileStandardDropzoneInputGUI.init('ilFileStandardDropzoneInputGUIWrapper{$n}', '{$this->cancel_command}');");

        return $out;
    }


    public function checkInput()
    {
        $hasUploads = $this->dic()->upload()->hasUploads();
        if ($this->getRequired() && !$hasUploads) {
            return false; // No file uploaded but is was required
        }

        if ($hasUploads) {
            try {
                $_POST[$this->getPostVar()] = $_FILES[$this->getPostVar()];
            } catch (Exception $e) {
                return false;
            }

            return true;
        }

        return true;
    }


    protected function handleUploadURL()
    {
        if (!$this->getUploadUrl()) {
            $parentWrapper = $this;
            while (!$parentWrapper instanceof ilPropertyFormGUI && $parentWrapper !== null) {
                $parentWrapper = $parentWrapper->getParent();
            }

            $str_replace = str_replace("&amp;", "&", $parentWrapper->getFormAction());
            $this->setUploadUrl($str_replace . "&" . self::ASYNC_FILEUPLOAD . "=true");
        }
    }


    protected function handleSuffixes()
    {
        if (!is_array($this->getSuffixes())) {
            $this->setSuffixes(array());
        }
    }


    protected function handleMaxFileSize($dropzone)
    {
        if ($this->getMaxFilesize()) {
            $dropzone = $dropzone->withFileSizeLimit($this->getMaxFilesize());
        }

        return $dropzone;
    }


    protected function initDropzoneMessage()
    {
        if (!$this->getDropzoneMessage()) {
            if ($this->getMaxFiles() === 1) {
                $this->setDropzoneMessage($this->lng()->txt('drag_file_here'));
            } else {
                $this->setDropzoneMessage($this->lng()->txt('drag_files_here'));
            }
        }
    }
}