Renderer.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\Implementation\Component\Button;
 
use ILIAS\UI\Implementation\Render\AbstractComponentRenderer;
use ILIAS\UI\Implementation\Render\TooltipRenderer;
use ILIAS\UI\Renderer as RendererInterface;
use ILIAS\UI\Component;
use ILIAS\UI\Implementation\Render\ResourceRegistry;
use ILIAS\UI\Implementation\Render\Template;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Component\Symbol\Icon\Icon;
 
class Renderer extends AbstractComponentRenderer
{
    public function render(Component\Component $component, RendererInterface $default_renderer): string
    {
        if ($component instanceof Component\Triggerer) {
            $component = $this->addTriggererOnLoadCode($component);
        }
        if ($component instanceof Component\Button\Close) {
            return $this->renderClose($component);
        } elseif ($component instanceof Component\Button\Minimize) {
            return $this->renderMinimize($component);
        } elseif ($component instanceof Component\Button\Toggle) {
            return $this->renderToggle($component);
        } elseif ($component instanceof Component\Button\Month) {
            return $this->renderMonth($component);
        } elseif ($component instanceof Component\Button\Button) {
            return $this->renderButton($component, $default_renderer);
        }
        $this->cannotHandleComponent($component);
    }
 
    protected function renderButton(Component\Button\Button $component, RendererInterface $default_renderer): string
    {
        $tpl_name = "";
        if ($component instanceof Component\Button\Primary) {
            $tpl_name = "tpl.primary.html";
        }
        if ($component instanceof Component\Button\Standard) {
            $tpl_name = "tpl.standard.html";
        }
        if ($component instanceof Component\Button\Shy) {
            $tpl_name = "tpl.shy.html";
        }
        if ($component instanceof Component\Button\Tag) {
            $tpl_name = "tpl.tag.html";
        }
        if ($component instanceof Component\Button\Bulky) {
            $tpl_name = "tpl.bulky.html";
        }
 
        $tpl = $this->getTemplate($tpl_name, true, true);
 
        $this->renderButtonType($component, $tpl);
 
        $action = $component->getAction();
        // The action is always put in the data-action attribute to have it available
        // on the client side, even if it is not available on rendering.
        if (is_string($action)) {
            $tpl->setCurrentBlock("with_data_action");
            $tpl->setVariable("ACTION", $action);
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable("LABEL", $component->getLabel());
        $symbol = $component->getSymbol();
        if ($symbol !== null) {
            // use label of symbol as aria-label if the button does not provide one
            if ('' === $component->getLabel() && '' === $component->getAriaLabel()) {
                $component = $component->withAriaLabel($this->getSymbolLabel($symbol));
            }
            // unset the symbol label, button provide label (semantic meaning)
            $symbol = $symbol->withLabel('');
            $tpl->setVariable("SYMBOL", $default_renderer->render($symbol));
        }
 
        if ($component->isActive()) {
            // The actions might also be a list of signals, these will be appended by
            // bindJavascript in maybeRenderId.
            if (is_string($action) && $action != "") {
                $component = $component->withAdditionalOnLoadCode(function ($id) use ($action) {
                    $action = str_replace("&amp;", "&", $action);
 
                    return "$('#$id').on('click', function(event) {
                            window.location = '$action';
                            return false;
                    });";
                });
            }
 
            if ($component instanceof Component\Button\LoadingAnimationOnClick && $component->hasLoadingAnimationOnClick()) {
                $component = $component->withAdditionalOnLoadCode(fn($id) => "$('#$id').click(function(e) { il.UI.button.activateLoadingAnimation('$id')});");
            }
        } else {
            $tpl->touchBlock("disabled");
        }
        $aria_label = $component->getAriaLabel();
        if ($aria_label != null) {
            $tpl->setCurrentBlock("with_aria_label");
            $tpl->setVariable("ARIA_LABEL", $aria_label);
            $tpl->parseCurrentBlock();
        }
 
        if ($component instanceof Component\Button\Engageable
            && $component->isEngageable()
        ) {
            if ($component->isEngaged()) {
                $tpl->touchBlock("engaged");
                $aria_pressed = 'true';
            } else {
                $aria_pressed = 'false';
            }
 
            //Note that Bulky Buttons need to handle aria_pressed seperatly due to possible aria_role conflicts
            if (!($component instanceof Bulky)) {
                $tpl->setCurrentBlock("with_aria_pressed");
                $tpl->setVariable("ARIA_PRESSED", $aria_pressed);
                $tpl->parseCurrentBlock();
            }
        }
 
        $tooltip_embedding = $this->getTooltipRenderer()->getHelpTopicTooltipEmbedding(...$component->getHelpTopics());
        if ($tooltip_embedding) {
            $component = $component->withAdditionalOnLoadCode($tooltip_embedding[1]);
        }
 
        $this->maybeRenderId($component, $tpl);
 
        if ($component instanceof Component\Button\Tag) {
            $this->additionalRenderTag($component, $tpl);
        }
 
        if ($component instanceof Component\Button\Bulky) {
            $this->additionalRenderBulky($component, $default_renderer, $tpl);
        }
 
        if (!$tooltip_embedding) {
            return $tpl->get();
        }
 
        $tooltip_id = $this->createId();
        $tpl->setCurrentBlock("with_aria_describedby");
        $tpl->setVariable("ARIA_DESCRIBED_BY", $tooltip_id);
        $tpl->parseCurrentBlock();
 
        return $tooltip_embedding[0]($tooltip_id, $tpl->get());
    }
 
    public function registerResources(ResourceRegistry $registry): void
    {
        parent::registerResources($registry);
        $registry->register('assets/js/button.js');
    }
 
    protected function renderClose(Component\Button\Close $component): string
    {
        $tpl = $this->getTemplate("tpl.close.html", true, true);
        // This is required as the rendering seems to only create any output at all
        // if any var was set or block was touched.
        $tpl->setVariable("FORCE_RENDERING", "");
        $tpl->setVariable("ARIA_LABEL", $this->txt("close"));
        $this->maybeRenderId($component, $tpl);
        return $tpl->get();
    }
 
    protected function renderMinimize(Component\Button\Minimize $component): string
    {
        $tpl = $this->getTemplate("tpl.minimize.html", true, true);
        $tpl->setVariable("ARIA_LABEL", $this->txt("minimize"));
        $this->maybeRenderId($component, $tpl);
        return $tpl->get();
    }
 
    protected function renderToggle(Component\Button\Toggle $component): string
    {
        $tpl = $this->getTemplate("tpl.toggle.html", true, true);
 
        $this->renderButtonType($component, $tpl);
 
        $on_action = $component->getActionOn();
        $off_action = $component->getActionOff();
 
        $on_url = (is_string($on_action))
            ? $on_action
            : "";
 
        $off_url = (is_string($off_action))
            ? $off_action
            : "";
 
        $signals = [];
 
        foreach ($component->getTriggeredSignals() as $s) {
            $signals[] = [
                "signal_id" => $s->getSignal()->getId(),
                "event" => $s->getEvent(),
                "options" => $s->getSignal()->getOptions()
            ];
        }
 
        $signals = json_encode($signals);
 
        $button_status = 'off';
        if ($component->isEngaged()) {
            $button_status = 'on';
        }
 
        if ($component->isActive()) {
            $component = $component->withAdditionalOnLoadCode(
                fn($id) =>
                "$('#$id').on('click', function(event) {
                    il.UI.button.handleToggleClick(event, '$id', '$on_url', '$off_url', $signals);
                    return false; // stop event propagation
                });"
            );
            $tpl->setCurrentBlock("with_on_off_label");
            $tpl->setVariable("ON_LABEL", $this->txt("toggle_on"));
            $tpl->setVariable("OFF_LABEL", $this->txt("toggle_off"));
            $tpl->parseCurrentBlock();
        } else {
            $tpl->touchBlock("disabled");
            $button_status = 'unavailable';
        }
 
        $tpl->touchBlock($button_status);
 
        $label = $component->getLabel();
        if (!empty($label)) {
            $tpl->setCurrentBlock("with_label");
            $tpl->setVariable("LABEL", $label);
            $tpl->parseCurrentBlock();
        }
        $aria_label = $component->getAriaLabel();
        if ($aria_label != null) {
            $tpl->setCurrentBlock("with_aria_label");
            $tpl->setVariable("ARIA_LABEL", $aria_label);
            $tpl->parseCurrentBlock();
        }
 
        $tooltip_embedding = $this->getTooltipRenderer()->getHelpTopicTooltipEmbedding(...$component->getHelpTopics());
        if ($tooltip_embedding) {
            $component = $component->withAdditionalOnLoadCode($tooltip_embedding[1]);
            $tooltip_id = $this->createId();
            $tpl->setCurrentBlock("with_aria_describedby");
            $tpl->setVariable("ARIA_DESCRIBED_BY", $tooltip_id);
            $tpl->parseCurrentBlock();
 
            $this->maybeRenderId($component, $tpl);
            return $tooltip_embedding[0]($tooltip_id, $tpl->get());
        }
 
        $this->maybeRenderId($component, $tpl);
        return $tpl->get();
    }
 
    protected function maybeRenderId(Component\JavaScriptBindable $component, Template $tpl): void
    {
        $id = $this->bindJavaScript($component);
        if ($id !== null) {
            $tpl->setCurrentBlock("with_id");
            $tpl->setVariable("ID", $id);
            $tpl->parseCurrentBlock();
        }
    }
 
    protected function renderMonth(Component\Button\Month $component): string
    {
        $tpl = $this->getTemplate("tpl.month.html", true, true);
 
        $component = $component->withAdditionalOnLoadCode(fn($id) => "il.UI.button.initMonth('$id');");
        $id = $this->bindJavaScript($component);
        $tpl->setVariable("ID", $id);
 
        $def = $component->getDefault();
        $value = implode('-', array_reverse(explode("-", $def)));
        $tpl->setVariable("DEFAULT", $value);
 
        return $tpl->get();
    }
 
    protected function additionalRenderTag(Component\Button\Tag $component, Template $tpl): void
    {
        $tpl->touchBlock('rel_' . $component->getRelevance());
 
        $classes = trim(join(' ', $component->getClasses()));
        if ($classes !== '') {
            $tpl->setVariable("CLASSES", $classes);
        }
 
        $bgcol = $component->getBackgroundColor();
        if ($bgcol) {
            $tpl->setVariable("BGCOL", $bgcol->asHex());
        }
        $forecol = $component->getForegroundColor();
        if ($forecol) {
            $tpl->setVariable("FORECOL", $forecol->asHex());
        }
    }
 
    protected function additionalRenderBulky(
        Component\Button\Button $component,
        RendererInterface $default_renderer,
        Template $tpl
    ): void {
        $aria_role = $component->getAriaRole();
        if ($aria_role != null) {
            $tpl->setCurrentBlock("with_aria_role");
            $tpl->setVariable("ARIA_ROLE", $aria_role);
            $tpl->parseCurrentBlock();
        }
        if ($component->isEngageable()) {
            if ($aria_role == Bulky::MENUITEM) {
                $tpl->touchBlock("with_aria_haspopup");
            } else {
                //Note that aria-role='menuitems MUST-NOT have Aria-pressed to true;
                $tpl->setCurrentBlock("with_aria_pressed");
                if ($component->isEngaged()) {
                    $tpl->setVariable("ARIA_PRESSED", "true");
                } else {
                    $tpl->setVariable("ARIA_PRESSED", "false");
                }
                $tpl->parseCurrentBlock();
            }
        }
    }
 
    protected function renderButtonType(Component\Button\Button $component, Template $tpl): void
    {
        // omit type attribute by default
    }
 
    protected function getSymbolLabel(Symbol $symbol): string
    {
        if (!$symbol instanceof Glyph) {
            return $symbol->getLabel();
        }
        // @todo: this breaks custom labels, translation should happen in factory...
        $label = $this->txt($symbol->getLabel());
        foreach ($symbol->getCounters() as $counter) {
            if ($counter->getNumber() > 0) {
                $label .= $this->txt("counter_" . $counter->getType()) . " " . $counter->getNumber() . "; ";
            }
        }
        return trim($label);
    }
}