TooltipRenderer.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\Implementation\Render;
 
use ILIAS\UI\HelpTextRetriever;
use ILIAS\UI\Help;
 
class TooltipRenderer
{
    protected const string ROLE_TOOLTIP = 'tooltip';
    protected const string ROLE_STATUS = 'status';
 
    public function __construct(
        protected HelpTextRetriever $help_text_retriever,
        protected $get_template
    ) {
        if (!is_callable($this->get_template)) {
            throw new \InvalidArgumentException("\$get_template should be callable.");
        }
    }
 
    public function getHelpTopicTooltipEmbedding(Help\Topic ...$topics): ?array
    {
        if (count($topics) === 0) {
            return null;
        }
 
        $tooltips = $this->help_text_retriever->getHelpText(Help\Purpose::Tooltip(), ...$topics);
        if (count($tooltips) === 0) {
            return null;
        }
 
        $get_template = $this->get_template;
        $embed_html = static function (string $tooltip_id, string $component_html) use ($tooltips, $get_template): string {
            $tpl = $get_template("components/ILIAS/UI/src/templates/default/tpl.tooltip.html", true, true);
            $tpl->setVariable("COMPONENT_HTML", $component_html);
            $tpl->setVariable("TOOLTIP_ROLE", self::ROLE_TOOLTIP);
            $tpl->setVariable("TOOLTIP_ID", $tooltip_id);
 
            foreach ($tooltips as $tooltip) {
                $tpl->setCurrentBlock("tooltip");
                $tpl->setVariable("TOOLTIP", $tooltip);
                $tpl->parseCurrentBlock();
            }
 
            return $tpl->get();
        };
 
        $embed_js = static function (string $id) {
            return "il.UI.Tooltip.createHoverTooltip(document.getElementById('$id'));";
        };
 
        return [$embed_html, $embed_js];
    }
 
    public function getStatusTooltipEmbedding(string $tooltip): array
    {
        $get_template = $this->get_template;
        $embed_html = static function (string $tooltip_id, string $component_html) use ($tooltip, $get_template): string {
            $tpl = $get_template("components/ILIAS/UI/src/templates/default/tpl.tooltip.html", true, true);
            $tpl->setVariable("COMPONENT_HTML", $component_html);
            $tpl->setVariable("TOOLTIP_ROLE", self::ROLE_STATUS);
            $tpl->setVariable("TOOLTIP_ID", $tooltip_id);
            $tpl->setVariable("TOOLTIP", $tooltip);
 
            return $tpl->get();
        };
 
        $embed_js = static function (string $component_id) {
            return "il.UI.Tooltip.createClickTooltip(document.getElementById('$component_id'));";
        };
 
        return [$embed_html, $embed_js];
    }
}