ilTooltipGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilTooltipGUI:

Static Public Member Functions
static	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)
static	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)
	Get tooltip js code. More...
static	init ()
	Initializes the needed tooltip libraries. More...

Static Protected Attributes
static bool	$initialized = false
static bool	$library_initialized = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This is a utility class for the yui tooltips. this only works, if a parent has class="yui-skin-sam" attached.

Definition at line 23 of file class.ilTooltipGUI.php.

Member Function Documentation

addTooltip()

static ilTooltipGUI::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  )

static

Definition at line 28 of file class.ilTooltipGUI.php.

References $GLOBALS, and $tpl.

Referenced by ilRatingGUI\addTooltip(), ilTable2GUI\fillHeader(), ilObjectListGUI\getHeaderAction(), ilGroupedListGUI\getHTML(), ilAdvancedSelectionListGUI\getHTML(), ilPageObjectGUI\getTinyMenu(), ilBadgeManagementGUI\listBadges(), ilTabsGUI\removeNonTabbedLinks(), and ilPortfolioPageGUI\renderMyCourses().

     : 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);
    }

Here is the caller graph for this function:

getToolTip()

static ilTooltipGUI::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  )

static

Get tooltip js code.

Definition at line 57 of file class.ilTooltipGUI.php.

Referenced by ilGroupedListGUI\getHTML().

     : 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 . '} );';
    }

Here is the caller graph for this function:

init()

static ilTooltipGUI::init ( )

static

Initializes the needed tooltip libraries.

Definition at line 89 of file class.ilTooltipGUI.php.

References $GLOBALS, and $tpl.

Referenced by ilHelpViewLayoutProvider\getMainBarModification(), and ilPreviewGUI\initPreview().

                                 : 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;
        }
    }

Here is the caller graph for this function:

Field Documentation

$initialized

bool ilTooltipGUI::$initialized = false

staticprotected

Definition at line 25 of file class.ilTooltipGUI.php.

$library_initialized

bool ilTooltipGUI::$library_initialized = false

staticprotected

Definition at line 26 of file class.ilTooltipGUI.php.

---

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

• Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php