class.ilTooltipGUI.php

Go to the documentation of this file.

<?php

class ilTooltipGUI
{
    protected static bool $initialized = false;
    protected static bool $library_initialized = false;

    public static function addTooltip(
        string $a_el_id,
        string $a_text,
        string $a_container = "",
        string $a_my = "bottom center",
        string $a_at = "top center",
        bool $a_use_htmlspecialchars = true
    ): void {
        // to get rid of globals here, we need to change the
        // process in learning modules, e.g. which does not work with $DIC (since it does not
        // use the standard template)
        $tpl = $GLOBALS["tpl"];

        self::init();

        $code = self::getToolTip(
            $a_el_id,
            $a_text,
            $a_container,
            $a_my,
            $a_at,
            $a_use_htmlspecialchars
        );
        $tpl->addOnLoadCode($code);
    }

    public static function getToolTip(
        string $a_el_id,
        string $a_text,
        string $a_container = "",
        string $a_my = "bottom center",
        string $a_at = "top center",
        bool $a_use_htmlspecialchars = true
    ): string {
        $addstr = "";

        // not needed, just make sure the position plugin is included
        //              $addstr.= ", position: {viewport: $('#fixed_content')}";

        if ($a_container !== "") {
            $addstr .= ", container: '" . $a_container . "'";
        }

        if ($a_use_htmlspecialchars) {
            $a_text = htmlspecialchars(str_replace(array("\n", "\r"), "", $a_text));
        } else {
            $a_text = str_replace(array("\n", "\r", "'", '"'), array("", "", "\'", '\"'), $a_text);
        }
        return 'il.Tooltip.add("' . $a_el_id . '", {' .
            ' context:"' . $a_el_id . '",' .
            ' my:"' . $a_my . '",' .
            ' at:"' . $a_at . '",' .
            ' text:"' . $a_text . '" ' . $addstr . '} );';
    }

    public static function init(): void
    {
        // for globals use, see comment above
        $tpl = $GLOBALS["tpl"];

        if (!self::$initialized) {
            $tpl->addCss("./node_modules/qtip2/dist/jquery.qtip.min.css");
            $tpl->addJavascript("./node_modules/qtip2/dist/jquery.qtip.min.js");
            $tpl->addJavascript("./Services/UIComponent/Tooltip/js/ilTooltip.js");

            // use setTimeout as a workaround, since the last parameter is ignored
            $tpl->addOnLoadCode('setTimeout(function() {il.Tooltip.init();}, 500);', 3);
            self::$initialized = true;
        }
    }
}