Collaboration diagram for ILIAS\Help\Tooltips\TooltipsManager:

Public Member Functions
	__construct (InternalRepoService $repo, InternalDomainService $domain)

	isTooltipIdentifierVisible ()

	areTooltipsVisible ()

	areSubMenuTooltipsVisible ()

	getTooltipPresentationText (string $a_tt_id)

	getObjCreationTooltipText (string $a_type)
	Get object_creation tooltip tab text. More...

	getMainMenuTooltip (string $a_item_id)

	getAllTooltips (string $a_comp="", int $a_module_id=0)

	addTooltip (string $a_tt_id, string $a_text, int $a_module_id=0)

	updateTooltip (int $a_id, string $a_text, string $a_tt_id)

	getTooltipComponents (int $a_module_id=0)

	deleteTooltip (int $a_id)

	deleteTooltipsOfModule (int $module_id)

Protected Member Functions
	isTooltipMainTextVisible ()

Protected Attributes
ILIAS Help GuidedTour Admin AdminManager	$gd_admin

ilLanguage	$lng

ilObjUser	$user

ilSetting	$settings

InternalDomainService	$domain

TooltipsDBRepository	$repo

Detailed Description

Definition at line 26 of file TooltipsManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Help\Tooltips\TooltipsManager::__construct	(	InternalRepoService	$repo,
		InternalDomainService	$domain
	)

Definition at line 35 of file TooltipsManager.php.

      {
        $this->repo = $repo->tooltips();
        $this->domain = $domain;
        $this->settings = $domain->settings();
        $this->user = $domain->user();
        $this->lng = $domain->lng();
        $this->gd_admin = $domain->guidedTour()->admin();
    }

References ILIAS\Help\Tooltips\TooltipsManager\$domain, ILIAS\Help\Tooltips\TooltipsManager\$repo, ILIAS\Help\InternalDomainService\guidedTour(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addTooltip()

ILIAS\Help\Tooltips\TooltipsManager::addTooltip	(	string	$a_tt_id,
		string	$a_text,
		int	$a_module_id = `0`
	)

Definition at line 133 of file TooltipsManager.php.

     : void {
        $this->repo->addTooltip($a_tt_id, $a_text, $a_module_id);
    }

◆ areSubMenuTooltipsVisible()

ILIAS\Help\Tooltips\TooltipsManager::areSubMenuTooltipsVisible ( )

Definition at line 58 of file TooltipsManager.php.

                                               : bool
    {
        return $this->isTooltipMainTextVisible();
    }

References ILIAS\Help\Tooltips\TooltipsManager\isTooltipMainTextVisible().

Here is the call graph for this function:

◆ areTooltipsVisible()

ILIAS\Help\Tooltips\TooltipsManager::areTooltipsVisible ( )

Definition at line 52 of file TooltipsManager.php.

                                        : bool
    {
        return $this->gd_admin->areIdentifiersVisible() ||
            $this->isTooltipMainTextVisible();
    }

References ILIAS\Help\Tooltips\TooltipsManager\isTooltipMainTextVisible().

Here is the call graph for this function:

◆ deleteTooltip()

ILIAS\Help\Tooltips\TooltipsManager::deleteTooltip ( int $a_id )

Definition at line 160 of file TooltipsManager.php.

     : void {
        $this->repo->deleteTooltip($a_id);
    }

◆ deleteTooltipsOfModule()

ILIAS\Help\Tooltips\TooltipsManager::deleteTooltipsOfModule ( int $module_id )

Definition at line 166 of file TooltipsManager.php.

     : void {
        $this->repo->deleteTooltipsOfModule($module_id);
    }

◆ getAllTooltips()

ILIAS\Help\Tooltips\TooltipsManager::getAllTooltips	(	string	$a_comp = `""`,
		int	$a_module_id = `0`
	)

Definition at line 126 of file TooltipsManager.php.

     : array {
        return $this->repo->getAllTooltips($a_comp, $a_module_id);
    }

◆ getMainMenuTooltip()

ILIAS\Help\Tooltips\TooltipsManager::getMainMenuTooltip ( string $a_item_id )

Returns: string tooltip text

Definition at line 120 of file TooltipsManager.php.

     : string {
        return $a_item_id;
    }

◆ getObjCreationTooltipText()

ILIAS\Help\Tooltips\TooltipsManager::getObjCreationTooltipText ( string $a_type )

Get object_creation tooltip tab text.

Definition at line 111 of file TooltipsManager.php.

     : string {
        return $this->getTooltipPresentationText($a_type . "_create");
    }

◆ getTooltipComponents()

ILIAS\Help\Tooltips\TooltipsManager::getTooltipComponents ( int $a_module_id = 0 )

Definition at line 150 of file TooltipsManager.php.

     : array {
        $comps[""] = "- " . $this->lng->txt("help_all") . " -";
        foreach ($this->repo->getTooltipComponents($a_module_id) as $c) {
            $comps[$c] = $c;
        }
        return $comps;
    }

References $c.

◆ getTooltipPresentationText()

ILIAS\Help\Tooltips\TooltipsManager::getTooltipPresentationText ( string $a_tt_id )

Definition at line 80 of file TooltipsManager.php.

     : string {
 
        $show_main_text = $this->isTooltipMainTextVisible();
 
        if (!$show_main_text) {
            if ($this->isTooltipIdentifierVisible()) {
                return $a_tt_id;
            } else {
                return "";
            }
        }
        if ($this->domain->module()->isAuthoringMode()) {
            $module_ids = [0];
        } else {
            $module_ids = $this->domain->module()->getActiveModules();
        }
        $text = $this->repo->getTooltipPresentationText(
            $a_tt_id,
            $module_ids
        );
        if ($this->isTooltipIdentifierVisible()) {
            $text .= "[" . $a_tt_id . "]";
        }
        return $text;
    }

References ILIAS\Help\Tooltips\TooltipsManager\isTooltipIdentifierVisible().

Here is the call graph for this function:

◆ isTooltipIdentifierVisible()

ILIAS\Help\Tooltips\TooltipsManager::isTooltipIdentifierVisible ( )

Definition at line 47 of file TooltipsManager.php.

                                                : bool
    {
        return $this->gd_admin->areIdentifiersVisible();
    }

Referenced by ILIAS\Help\Tooltips\TooltipsManager\getTooltipPresentationText().

Here is the caller graph for this function:

◆ isTooltipMainTextVisible()

ILIAS\Help\Tooltips\TooltipsManager::isTooltipMainTextVisible ( )

protected

Definition at line 63 of file TooltipsManager.php.

                                                 : bool
    {
        $show_main_text = true;
        if ($this->user->getLanguage() !== "de") {
            $show_main_text = false;
        }
 
        if ($this->settings->get("help_mode") === "1") {
            $show_main_text = false;
        }
 
        if ($this->user->getPref("hide_help_tt")) {
            $show_main_text = false;
        }
        return $show_main_text;
    }

References ILIAS\Repository\settings(), and ILIAS\Repository\user().

Referenced by ILIAS\Help\Tooltips\TooltipsManager\areSubMenuTooltipsVisible(), and ILIAS\Help\Tooltips\TooltipsManager\areTooltipsVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateTooltip()

ILIAS\Help\Tooltips\TooltipsManager::updateTooltip	(	int	$a_id,
		string	$a_text,
		string	$a_tt_id
	)

Definition at line 141 of file TooltipsManager.php.

     : void {
        $this->repo->updateTooltip($a_id, $a_text, $a_tt_id);
    }

Field Documentation

◆ $domain

InternalDomainService ILIAS\Help\Tooltips\TooltipsManager::$domain

protected

Definition at line 32 of file TooltipsManager.php.

Referenced by ILIAS\Help\Tooltips\TooltipsManager\__construct().

◆ $gd_admin

ILIAS Help GuidedTour Admin AdminManager ILIAS\Help\Tooltips\TooltipsManager::$gd_admin

protected

Definition at line 28 of file TooltipsManager.php.

◆ $lng

ilLanguage ILIAS\Help\Tooltips\TooltipsManager::$lng

protected

Definition at line 29 of file TooltipsManager.php.

◆ $repo

TooltipsDBRepository ILIAS\Help\Tooltips\TooltipsManager::$repo

protected

Definition at line 33 of file TooltipsManager.php.

Referenced by ILIAS\Help\Tooltips\TooltipsManager\__construct().

◆ $settings

ilSetting ILIAS\Help\Tooltips\TooltipsManager::$settings

protected

Definition at line 31 of file TooltipsManager.php.

◆ $user

ilObjUser ILIAS\Help\Tooltips\TooltipsManager::$user

protected

Definition at line 30 of file TooltipsManager.php.

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

components/ILIAS/Help/Tooltips/TooltipsManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTooltip()

◆ areSubMenuTooltipsVisible()

◆ areTooltipsVisible()

◆ deleteTooltip()

◆ deleteTooltipsOfModule()

◆ getAllTooltips()

◆ getMainMenuTooltip()

◆ getObjCreationTooltipText()

◆ getTooltipComponents()

◆ getTooltipPresentationText()

◆ isTooltipIdentifierVisible()

◆ isTooltipMainTextVisible()

◆ updateTooltip()

Field Documentation

◆ $domain

◆ $gd_admin

◆ $lng

◆ $repo

◆ $settings

◆ $user