Inheritance diagram for ilLSViewLayoutProvider:

Collaboration diagram for ilLSViewLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	@inheritDoc More...

	getMainBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getContentModification (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 (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 ()

Protected Member Functions
	isKioskModeEnabled (CalledContexts $screen_context_stack)

Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Protected Attributes
	$data_collection

Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	$context_collection

	$factory

Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	$dic

Detailed Description

Class ilLSViewLayoutProvider.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 38 of file class.ilLSViewLayoutProvider.php.

Member Function Documentation

◆ getBreadCrumbsModification()

ilLSViewLayoutProvider::getBreadCrumbsModification ( CalledContexts $screen_context_stack )

@inheritDoc

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

Definition at line 114 of file class.ilLSViewLayoutProvider.php.

                                                                                     : ?BreadCrumbsModification
    {
        if (!$this->isKioskModeEnabled($screen_context_stack)) {
            return null;
        }
 
        return $this->globalScreen()->layout()->factory()->breadcrumbs()
            ->withModification(
                function (?Breadcrumbs $current) : ?Breadcrumbs {
                    return null;
                }
            )
            ->withHighPriority();
    }

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and isKioskModeEnabled().

Here is the call graph for this function:

◆ getContentModification()

ilLSViewLayoutProvider::getContentModification ( CalledContexts $screen_context_stack )

@inheritDoc

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

Definition at line 129 of file class.ilLSViewLayoutProvider.php.

                                                                                 : ?ContentModification
    {
        if (!$this->isKioskModeEnabled($screen_context_stack)) {
            return null;
        }
        $html = $this->data_collection->get(\ilLSPlayer::GS_DATA_LS_CONTENT);
        // TODO: Once we have more control over the content, we could just setContent
        // in ilObjLearningSequenceLearnerGUI like any other object and later strip
        // away the header here.
        return $this->globalScreen()->layout()->factory()->content()
            ->withModification(
                function (?Legacy $content) use ($html) : Legacy {
                    $ui = $this->dic->ui();
                    return $ui->factory()->legacy($html);
                }
            )
            ->withHighPriority();
    }

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ilLSPlayer\GS_DATA_LS_CONTENT, isKioskModeEnabled(), and legacy().

Here is the call graph for this function:

◆ getMainBarModification()

ilLSViewLayoutProvider::getMainBarModification ( CalledContexts $screen_context_stack )

@inheritDoc

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

Definition at line 65 of file class.ilLSViewLayoutProvider.php.

                                                                                 : ?MainBarModification
    {
        if (!$this->isKioskModeEnabled($screen_context_stack)) {
            return null;
        }
        return $this->globalScreen()->layout()->factory()->mainbar()
            ->withModification(
                function (?MainBar $mainbar) : ?MainBar {
                    if ($mainbar === null) {
                        $ui = $this->dic->ui();
                        $mainbar = $ui->factory()->mainControls()->mainbar();
                    }
                    $entries = $this->data_collection->get(\ilLSPlayer::GS_DATA_LS_MAINBARCONTROLS);
                    $tools = $mainbar->getToolEntries();
                    $mainbar = $mainbar->withClearedEntries();
 
                    foreach ($entries as $key => $entry) {
                        $mainbar = $mainbar->withAdditionalEntry($key, $entry);
                    }
                    foreach ($tools as $key => $entry) {
                        $mainbar = $mainbar->withAdditionalToolEntry($key, $entry);
                    }
                    return $mainbar;
                }
            )
            ->withHighPriority();
    }

References ILIAS\UI\Component\MainControls\MainBar\getToolEntries(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ilLSPlayer\GS_DATA_LS_MAINBARCONTROLS, isKioskModeEnabled(), mainbar(), ILIAS\UI\Component\MainControls\MainBar\withAdditionalEntry(), ILIAS\UI\Component\MainControls\MainBar\withAdditionalToolEntry(), and ILIAS\UI\Component\MainControls\MainBar\withClearedEntries().

Here is the call graph for this function:

◆ getMetaBarModification()

ilLSViewLayoutProvider::getMetaBarModification ( CalledContexts $screen_context_stack )

@inheritDoc

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

Definition at line 93 of file class.ilLSViewLayoutProvider.php.

                                                                                 : ?MetaBarModification
    {
        if (!$this->isKioskModeEnabled($screen_context_stack)) {
            return null;
        }
        return $this->globalScreen()->layout()->factory()->metabar()
            ->withModification(
                function (?MetaBar $metabar) : ?Metabar {
                    if ($metabar === null) {
                        return null;
                    }
                    $metabar = $metabar->withClearedEntries();
                    foreach ($this->data_collection->get(\ilLSPlayer::GS_DATA_LS_METABARCONTROLS) as $key => $entry) {
                        $metabar = $metabar->withAdditionalEntry($key, $entry);
                    }
                    return $metabar;
                }
            )
            ->withHighPriority();
    }

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ilLSPlayer\GS_DATA_LS_METABARCONTROLS, isKioskModeEnabled(), and ILIAS\UI\Component\MainControls\MetaBar\withClearedEntries().

Here is the call graph for this function:

◆ isInterestedInContexts()

ilLSViewLayoutProvider::isInterestedInContexts ( )

@inheritDoc

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

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

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

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

Here is the call graph for this function:

◆ isKioskModeEnabled()

ilLSViewLayoutProvider::isKioskModeEnabled ( CalledContexts $screen_context_stack )

protected

Parameters

CalledContexts $calledContexts

Returns: bool

Definition at line 59 of file class.ilLSViewLayoutProvider.php.

                                                                                : bool
    {
        $this->data_collection = $screen_context_stack->current()->getAdditionalData();
        return $this->data_collection->is(\ilLSPlayer::GS_DATA_LS_KIOSK_MODE, true);
    }