ILIAS\Help\GuidedTour\GlobalScreen\LayoutProvider Class Reference

Inheritance diagram for ILIAS\Help\GuidedTour\GlobalScreen\LayoutProvider:

Collaboration diagram for ILIAS\Help\GuidedTour\GlobalScreen\LayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	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

Definition at line 36 of file LayoutProvider.php.

Member Function Documentation

getMetaBarModification()

ILIAS\Help\GuidedTour\GlobalScreen\LayoutProvider::getMetaBarModification

(

CalledContexts

$screen_context_stack

)

@inheritDoc

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

Definition at line 72 of file LayoutProvider.php.

                                                                                : ?MetaBarModification
    {
        $tm = $this->dic->help()->internal()->domain()->guidedTour()->tour();
        if (!$tm->anyActive()) {
            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) {
                $name = $item->getProviderIdentification()->getInternalIdentifier();
                $item->addComponentDecorator(static function (Component $c) use ($name): ?Component {
                    return $c->withAdditionalOnLoadCode(static function (string $id) use ($name): string {
                        return "il.guidedTour.addMapping('$name', '$id');";
                    });
                });
            }
        }
        return null;
    }

References $c, $id, and ILIAS\Repository\globalScreen().

Here is the call graph for this function:

isInterestedInContexts()

ILIAS\Help\GuidedTour\GlobalScreen\LayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 40 of file LayoutProvider.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/GuidedTour/GlobalScreen/LayoutProvider.php