class.ilHelpViewLayoutProvider.php

Go to the documentation of this file.

<?php
 
use ILIAS\GlobalScreen\Scope\Layout\Factory\MainBarModification;
use ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol;
use ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts;
use ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection;
use ILIAS\UI\Component\JavaScriptBindable;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Renderer\Hasher;
use ILIAS\GlobalScreen\Scope\isDecorateable;
use ILIAS\GlobalScreen\Scope\Layout\Factory\MetaBarModification;
use ILIAS\UI\Component\Component;
 
class ilHelpViewLayoutProvider extends AbstractModificationProvider
{
    use Hasher;
    use ilHelpDisplayed;
 
    public function isInterestedInContexts(): ContextCollection
    {
        return $this->context_collection->main();
    }
 
    public function getMainBarModification(
        CalledContexts $screen_context_stack
    ): ?MainBarModification {
        global $DIC;
 
        $f = $DIC->ui()->factory();
        $ttm = $DIC->help()->internal()->domain()->tooltips();
        if (!$ttm->areTooltipsVisible()) {
            return null;
        }
 
 
        $this->globalScreen()->collector()->mainmenu()->collectOnce();
        foreach ($this->globalScreen()->collector()->mainmenu()->getRawItems() as $item) {
            if (!($item instanceof ILIAS\GlobalScreen\Scope\MainMenu\Factory\TopItem\TopParentItem)
                && !($item instanceof ILIAS\GlobalScreen\Scope\MainMenu\Factory\TopItem\TopLinkItem)
                && !$ttm->areSubMenuTooltipsVisible()
            ) {
                continue;
            }
            if ($item instanceof isDecorateable) {
                $p = $item->getProviderIdentification();
 
                $tt_text = $ttm->getMainMenuTooltip($p->getInternalIdentifier());
                if ($tt_text !== "") {
                    $item->withTopics(...$DIC->ui()->factory()->helpTopics($tt_text));
                }
            }
        }
 
        return null;
    }
 
    public function getMetaBarModification(CalledContexts $screen_context_stack): ?MetaBarModification
    {
        global $DIC;
 
        $ttm = $DIC->help()->internal()->domain()->tooltips();
 
        if (!$this->showHelpTool() && !$ttm->isTooltipIdentifierVisible()) {
            return null;
        }
 
        // add id mapping of all main menu items to gui
        $this->globalScreen()->collector()->metaBar()->collectOnce();
        foreach ($this->globalScreen()->collector()->metaBar()->getRawItems() as $item) {
            if ($item instanceof isDecorateable) {
                $p = $item->getProviderIdentification();
 
                $tt_text = $ttm->getMainMenuTooltip($p->getInternalIdentifier());
                if ($tt_text !== "") {
                    $item->withTopics(...$DIC->ui()->factory()->helpTopics($tt_text));
                }
            }
        }
        return null;
    }
 
}