Renderer.php

Go to the documentation of this file.

<?php

namespace ILIAS\UI\Implementation\Component\MainControls\Slate;

use ILIAS\UI\Implementation\Render\AbstractComponentRenderer;
use ILIAS\UI\Renderer as RendererInterface;
use ILIAS\UI\Component;
use ILIAS\UI\Component\MainControls\Slate as ISlate;

class Renderer extends AbstractComponentRenderer
{
    public function render(Component\Component $component, RendererInterface $default_renderer): string
    {
        if (!$component instanceof ISlate\Slate) {
            $this->cannotHandleComponent($component);
        }

        switch (true) {
            case ($component instanceof ISlate\Notification):
                return $this->renderNotificationSlate($component, $default_renderer);
                break;

            case ($component instanceof ISlate\Combined):
            case ($component instanceof ISlate\Drilldown):
                $contents = $this->getCombinedSlateContents($component);
                break;

            default:
                $contents = $component->getContents();
        }

        return $this->renderSlate($component, $contents, $default_renderer);
    }

    protected function getCombinedSlateContents(
        ISlate\Slate $component
    ): array {
        $f = $this->getUIFactory();
        $contents = [];
        foreach ($component->getContents() as $entry) {
            if ($entry instanceof ISlate\Slate && !$entry instanceof ISlate\Notification) {
                $trigger_signal = $entry->getToggleSignal();
                $triggerer = $f->button()->bulky($entry->getSymbol(), $entry->getName(), '#')
                    ->withOnClick($trigger_signal)
                    ->withHelpTopics(...$entry->getHelpTopics())
                ;

                $mb_id = $entry->getMainBarTreePosition();
                if ($mb_id) {
                    $trigger_signal = $component->getTriggerSignal($mb_id);
                    $triggerer = $triggerer
                        ->withOnClick($trigger_signal)
                        ->withAdditionalOnLoadCode(
                            fn($id) => "
                                    il.UI.maincontrols.mainbar.addTriggerSignal('{$trigger_signal}');
                                    il.UI.maincontrols.mainbar.addPartIdAndEntry('{$mb_id}', 'triggerer', '{$id}');
                                "
                        );
                }
                $contents[] = [$triggerer, $entry];
            } elseif ($component instanceof ISlate\Drilldown) {
                $contents[] = $entry->withPersistenceId($component->getMainBarTreePosition());
            } else {
                $contents[] = $entry;
            }
        }
        return $contents;
    }

    protected function renderSlate(
        ISlate\Slate $component,
        $contents,
        RendererInterface $default_renderer
    ): string {
        $tpl = $this->getTemplate("Slate/tpl.slate.html", true, true);

        foreach ($contents as $content) {
            $content_html = $default_renderer->render($content);
            if ($content instanceof Component\Button\Button
                || $content instanceof Component\Link\Link
                || $content instanceof Component\Divider\Horizontal
                || is_array($content)
            ) {
                $tpl->setCurrentBlock("list_content_component");
                $tpl->setVariable("LIST_COMPONENT_CONTENT", $content_html);
            } else {
                $tpl->setCurrentBlock("none_list_content_component");
                $tpl->setVariable("NONE_LIST_COMPONENT_CONTENT", $content_html);
            }
            $tpl->parseCurrentBlock();
        }


        $aria_role = $component->getAriaRole();
        if ($aria_role != null) {
            $tpl->setCurrentBlock("with_aria_role");
            $tpl->setVariable("ARIA_ROLE", $aria_role);
            $tpl->parseCurrentBlock();
        }

        if ($component->getEngaged()) {
            $tpl->touchBlock('engaged');
        } else {
            $tpl->touchBlock('disengaged');
        }

        $slate_signals = [
            'toggle' => $component->getToggleSignal(),
            'engage' => $component->getEngageSignal(),
            'replace' => $component->getReplaceSignal()
        ];

        $mb_id = $component->getMainBarTreePosition();

        if ($mb_id) {
            $tpl->setVariable('TREE_DEPTH', $component->getMainBarTreeDepth());
        }

        $component = $component->withAdditionalOnLoadCode(
            function ($id) use ($slate_signals, $mb_id): string {
                $js = "";
                foreach ($slate_signals as $key => $signal) {
                    $js .= "$(document).on('{$signal}', function(event, signalData) { 
                        il.UI.maincontrols.slate.onSignal('{$key}', 
                        event, 
                        signalData, 
                        '{$id}'
                    ); 
                    return false;});";
                }

                if ($mb_id) {
                    $js .= "il.UI.maincontrols.mainbar.addPartIdAndEntry('{$mb_id}', 'slate', '{$id}');";
                }


                return $js;
            }
        );
        $id = $this->bindJavaScript($component);
        $tpl->setVariable('ID', $id);

        return $tpl->get();
    }

    protected function renderNotificationSlate(
        ISlate\Slate $component,
        RendererInterface $default_renderer
    ): string {
        $contents = $component->getContents();
        $tpl = $this->getTemplate("Slate/tpl.notification.html", true, true);
        $tpl->setVariable('NAME', $component->getName());
        $tpl->setVariable('CONTENTS', $default_renderer->render($contents));
        return $tpl->get();
    }

    public function registerResources(\ILIAS\UI\Implementation\Render\ResourceRegistry $registry): void
    {
        parent::registerResources($registry);
        $registry->register('assets/js/maincontrols.min.js');
    }
}