ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider Class Reference

Inheritance diagram for ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider:

Collaboration diagram for ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	getMainBarModification (CalledContexts $screen_context_stack)
	getMetaBarModification (CalledContexts $screen_context_stack)
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 ()

Data Fields
const	FORCED_STARTUP_STEP = 'forced_startup_step'

Protected Member Functions
	isForcedStartupStep (CalledContexts $called_contexts)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Additional Inherited Members
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection
DataFactory	$data
ModificationFactory	$factory

Detailed Description

Definition at line 31 of file StartUpSequenceLayoutProvider.php.

Member Function Documentation

getMainBarModification()

ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider::getMainBarModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

MainBarModification|null

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

Definition at line 45 of file StartUpSequenceLayoutProvider.php.

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider\isForcedStartupStep(), and null.

                                                                                : ?MainBarModification
    {
        if ($this->isForcedStartupStep($screen_context_stack)) {
            $main_bar = $this->globalScreen()->layout()->factory()->mainbar();
            $main_bar = $main_bar->withModification(function (?MainBar $current): ?MainBar {
                return null;
            });

            return $main_bar->withPriority(\ILIAS\GlobalScreen\Scope\Layout\Factory\LayoutModification::PRIORITY_HIGH);
        }

        return null;
    }

Here is the call graph for this function:

getMetaBarModification()

ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider::getMetaBarModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

MetaBarModification|null

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

Definition at line 59 of file StartUpSequenceLayoutProvider.php.

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider\isForcedStartupStep(), and null.

                                                                                : ?MetaBarModification
    {
        if ($this->isForcedStartupStep($screen_context_stack)) {
            $meta_bar = $this->globalScreen()->layout()->factory()->metabar();
            $meta_bar = $meta_bar->withModification(function (?MetaBar $current): ?MetaBar {
                return null;
            });

            return $meta_bar->withPriority(\ILIAS\GlobalScreen\Scope\Layout\Factory\LayoutModification::PRIORITY_HIGH);
        }

        return null;
    }

Here is the call graph for this function:

isForcedStartupStep()

ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider::isForcedStartupStep ( CalledContexts  $called_contexts )

protected

Definition at line 35 of file StartUpSequenceLayoutProvider.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current().

Referenced by ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider\getMainBarModification(), and ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider\getMetaBarModification().

                                                                           : bool
    {
        return $called_contexts->current()->getAdditionalData()->is(self::FORCED_STARTUP_STEP, true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInterestedInContexts()

ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 40 of file StartUpSequenceLayoutProvider.php.

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

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

Here is the call graph for this function:

Field Documentation

FORCED_STARTUP_STEP

const ILIAS\Init\StartupSequence\StartUpSequenceLayoutProvider::FORCED_STARTUP_STEP = 'forced_startup_step'

Definition at line 33 of file StartUpSequenceLayoutProvider.php.

Referenced by ILIAS\Init\StartupSequence\StartUpSequenceDispatcher\dispatch().

---

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

• components/ILIAS/Init/classes/StartupSequence/StartUpSequenceLayoutProvider.php