ilHelpViewLayoutProvider Class Reference

HTML export view layout provider, hides main and meta bar. More...

Inheritance diagram for ilHelpViewLayoutProvider:

Collaboration diagram for ilHelpViewLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	getMainBarModification (CalledContexts $screen_context_stack)
	No main bar in HTML exports. More...
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	getContentModification (CalledContexts $screen_context_stack)
	getLogoModification (CalledContexts $screen_context_stack)
	getResponsiveLogoModification (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	getMetaBarModification (CalledContexts $screen_context_stack)
	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	getFooterModification (CalledContexts $screen_context_stack)
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	getTitleModification (CalledContexts $screen_context_stack)
	getShortTitleModification (CalledContexts $screen_context_stack)
	getViewTitleModification (CalledContexts $screen_context_stack)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection
DataFactory	$data
ModificationFactory	$factory

Detailed Description

HTML export view layout provider, hides main and meta bar.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 34 of file class.ilHelpViewLayoutProvider.php.

Member Function Documentation

getMainBarModification()

ilHelpViewLayoutProvider::getMainBarModification

(

CalledContexts

$screen_context_stack

)

No main bar in HTML exports.

Implements ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider.

Definition at line 47 of file class.ilHelpViewLayoutProvider.php.

References $DIC, Vendor\Package\$f, $id, ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol\hasSymbol(), null, and ILIAS\UI\Component\JavaScriptBindable\withAdditionalOnLoadCode().

     : ?MainBarModification {
        global $DIC;

        if (!$this->showHelpTool()) {
            return null;
        }

        $f = $DIC->ui()->factory();
        $ttm = $DIC->help()->internal()->domain()->tooltips();

        $this->globalScreen()->collector()->mainmenu()->collectOnce();
        foreach ($this->globalScreen()->collector()->mainmenu()->getRawItems() as $item) {
            if ($item instanceof isDecorateable) {
                $p = $item->getProviderIdentification();

                $tt_text = $ttm->getMainMenuTooltip($p->getInternalIdentifier());
                $tt_text = addslashes(str_replace(array("\n", "\r"), '', $tt_text));
                if ($tt_text !== "") {
                    //$item->withTopics($DIC->ui()->factory()->helpTopics($p->getInternalIdentifier()));
                    $item->withTopics(...$DIC->ui()->factory()->helpTopics($tt_text));
                }
            }

            if ($tt_text !== "" && $item instanceof hasSymbol && $item->hasSymbol()) {
                $item->addSymbolDecorator(static function (Symbol $symbol) use ($tt_text, $f): Symbol {
                    /*  This does not work for multiple reasons, first, symbols do no
                        accept help topics. Even if they would, it would be the wrong ui element to attach
                        a help tooltip, since the symbol may be smaller than the parent button or link
                        we need a $item->hasLink() and $item->hasButton() and Link and Button decorators instead
                    return $symbol->withHelpTopics(
                        ...$f->helpTopics($tt_text)
                    );*/
                    return $symbol->withAdditionalOnLoadCode(static function ($id) use ($tt_text): string {
                        return "il.Tooltip.addToNearest('$id', 'button,a', { context:'', my:'bottom center', at:'top center', text:'$tt_text' });";
                    });
                });
            }
        }

        return null;
    }

Here is the call graph for this function:

isInterestedInContexts()

ilHelpViewLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 39 of file class.ilHelpViewLayoutProvider.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\main().

                                            : ContextCollection
    {
        return $this->context_collection->main();
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Help/GlobalScreen/classes/class.ilHelpViewLayoutProvider.php