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...
	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc 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 (protected Container $dic)
	getFullyQualifiedClassName ()
	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
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 36 of file class.ilHelpViewLayoutProvider.php.

Member Function Documentation

getMainBarModification()

ilHelpViewLayoutProvider::getMainBarModification

(

CalledContexts

$screen_context_stack

)

No main bar in HTML exports.

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

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

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

getMetaBarModification()

ilHelpViewLayoutProvider::getMetaBarModification

(

CalledContexts

$screen_context_stack

)

@inheritDoc

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

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

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

References $DIC, and ILIAS\Repository\globalScreen().

Here is the call graph for this function:

isInterestedInContexts()

ilHelpViewLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 41 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:

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