Renderer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Dropzone\File;

use ILIAS\UI\Implementation\Render\AbstractComponentRenderer;
use ILIAS\UI\Implementation\Render\ResourceRegistry;
use ILIAS\UI\Implementation\Render\Template;
use ILIAS\UI\Component\Dropzone\File\File as FileInterface;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Renderer as RenderInterface;
use LogicException;

class Renderer extends AbstractComponentRenderer
{
    public function render(Component $component, RenderInterface $default_renderer): string
    {
        if ($component instanceof \ILIAS\UI\Component\Dropzone\File\Wrapper) {
            return $this->renderWrapper($component, $default_renderer);
        }
        if ($component instanceof \ILIAS\UI\Component\Dropzone\File\Standard) {
            return $this->renderStandard($component, $default_renderer);
        }
        $this->cannotHandleComponent($component);
    }

    public function registerResources(ResourceRegistry $registry): void
    {
        $registry->register("assets/js/dropzone.js");

        parent::registerResources($registry);
    }

    protected function renderWrapper(Wrapper $dropzone, RenderInterface $default_renderer): string
    {
        $modal = $dropzone->getModal();

        $template = $this->getTemplate("tpl.dropzone.html", true, true);
        $template->setVariable('MODAL', $default_renderer->render($modal));
        $template->setVariable('CONTENT', $default_renderer->render($dropzone->getContent()));
        $template->setVariable('WRAPPER_CLASS', 'ui-dropzone-wrapper');

        $dropzone = $this->initClientsideDropzone($dropzone);
        $dropzone = $dropzone->withAdditionalDrop($modal->getShowSignal());

        $this->bindAndApplyJavaScript($dropzone, $template);

        return $template->get();
    }

    protected function renderStandard(Standard $dropzone, RenderInterface $default_renderer): string
    {
        $modal = $dropzone->getModal();

        $template = $this->getTemplate("tpl.dropzone.html", true, true);
        $template->setVariable('MODAL', $default_renderer->render($modal));
        $template->setCurrentBlock('with_message');
        $template->setVariable('MESSAGE', $dropzone->getMessage());
        $template->parseCurrentBlock();

        $upload_button = $dropzone->getUploadButton();
        if (null !== $upload_button) {
            // override default onClick behaviour with modal signal
            // to prevent the action from triggering.
            $upload_button = $upload_button->withOnClick(
                $modal->getShowSignal()
            );

            $template->setVariable('BUTTON', $default_renderer->render($upload_button));
        }

        if ($dropzone->isBulky()) {
            $template->touchBlock('bulky');
        }

        $dropzone = $this->initClientsideDropzone($dropzone);
        $dropzone = $dropzone->withAdditionalDrop($modal->getShowSignal());

        $this->bindAndApplyJavaScript($dropzone, $template);

        return $template->get();
    }

    protected function initClientsideDropzone(FileInterface $dropzone): FileInterface
    {
        return $dropzone->withAdditionalOnLoadCode(static function ($id) use ($dropzone) {
            return "
                il.UI.Dropzone.init('$id');
                
                // @TODO: we need to refactor the signal-management to prevent using jQuery here.
                $(document).on('{$dropzone->getClearSignal()}', function () {
                    il.UI.Dropzone.removeAllFilesFromQueue('$id');
                });
            ";
        });
    }

    protected function bindAndApplyJavaScript(FileInterface $dropzone, Template $template): void
    {
        $template->setVariable('ID', $this->bindJavaScript($dropzone));
    }
}