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 ()
	@inheritDoc More...
	getMainBarModification (CalledContexts $called_contexts)
	No main bar in HTML exports. More...
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	@inheritDoc More...
	getContentModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getLogoModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getResponsiveLogoModification (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getFooterModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getShortTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getViewTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	@inheritDoc More...
	getFullyQualifiedClassName ()
	@inheritDoc More...
	getProviderNameForPresentation ()
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
	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)
	isInterestedInContexts ()

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

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 16 of file class.ilHelpViewLayoutProvider.php.

Member Function Documentation

getMainBarModification()

ilHelpViewLayoutProvider::getMainBarModification

(

CalledContexts

$called_contexts

)

No main bar in HTML exports.

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

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

                                                                            : ?MainBarModification
    {
        if (!$this->showHelpTool()) {
            return null;
        }
        $this->globalScreen()->collector()->mainmenu()->collectOnce();
        foreach ($this->globalScreen()->collector()->mainmenu()->getRawItems() as $item) {
            $p = $item->getProviderIdentification();
 
            $tt_text = ilHelp::getMainMenuTooltip($p->getInternalIdentifier());
            $tt_text = addslashes(str_replace(array("\n", "\r"), '', $tt_text));
 
            if ($tt_text != "") {
                if ($item instanceof hasSymbol && $item->hasSymbol()) {
                    $item->addSymbolDecorator(static function (Symbol $symbol) use ($tt_text) : Symbol {
                        if ($symbol instanceof JavaScriptBindable) {
                            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 $symbol;
                    });
                }
            }
        }
 
        ilTooltipGUI::init();
 
        return null;
    }

References ilHelp\getMainMenuTooltip(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol\hasSymbol(), ilTooltipGUI\init(), and ILIAS\UI\Component\JavaScriptBindable\withAdditionalOnLoadCode().

Here is the call graph for this function:

isInterestedInContexts()

ilHelpViewLayoutProvider::isInterestedInContexts

(

)

@inheritDoc

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

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

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

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

Here is the call graph for this function:

---

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

• Services/Help/GlobalScreen/classes/class.ilHelpViewLayoutProvider.php