ILIAS\UI\Implementation\Render\TooltipRenderer Class Reference

This class is supposed to unify rendering of tooltips over all components and should also be usable by legacy UI components. More...

Collaboration diagram for ILIAS\UI\Implementation\Render\TooltipRenderer:

Public Member Functions
	__construct (protected HelpTextRetriever $help_text_retriever, protected $get_template)
	maybeGetTooltipEmbedding (Help\Topic ... $topics)
	This will provide functions that can be used to embed a components html into some html required for the tooltip, if there are in fact any tooltips for the given help topics. More...

Detailed Description

This class is supposed to unify rendering of tooltips over all components and should also be usable by legacy UI components.

Definition at line 30 of file TooltipRenderer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\UI\Implementation\Render\TooltipRenderer::__construct	(	protected HelpTextRetriever	$help_text_retriever,
		protected	$get_template
	)

Definition at line 32 of file TooltipRenderer.php.

      {
        if (!is_callable($this->get_template)) {
            throw new \InvalidArgumentException("\$get_template should be callable.");
        }
    }

Member Function Documentation

maybeGetTooltipEmbedding()

ILIAS\UI\Implementation\Render\TooltipRenderer::maybeGetTooltipEmbedding

(

Help\Topic ...

$topics

)

This will provide functions that can be used to embed a components html into some html required for the tooltip, if there are in fact any tooltips for the given help topics.

The first resulting function takes an id to be used as the tooltips id and the html of the component. The second resulting function takes the id of the component and creates an appropriate javascript to bind the required javascript to the component.

If there are no tooltips for the help topic, this will return nothing.

Returns

?((string, string) -> string, string -> string)

Definition at line 53 of file TooltipRenderer.php.

References $id, and null.

                                                                   : ?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("ELEMENT", $component_html);
            $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 ($id) {
            return "new il.UI.core.Tooltip(document.getElementById('$id'));";
        };

        return [$embed_html, $embed_js];
    }

---

The documentation for this class was generated from the following file:

• components/ILIAS/UI/src/Implementation/Render/TooltipRenderer.php