DashboardLayoutProvider Class Reference

Inheritance diagram for DashboardLayoutProvider:

Collaboration diagram for DashboardLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	getMainBarModification (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 (Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Protected Attributes
Collection	$data_collection
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection
ILIAS GlobalScreen Scope Layout Factory ModificationFactory	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

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

Detailed Description

Definition at line 27 of file DashboardLayoutProvider.php.

Member Function Documentation

getMainBarModification()

DashboardLayoutProvider::getMainBarModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

MainBarModification|null

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

Definition at line 36 of file DashboardLayoutProvider.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ilDashboardGUI\DISENGAGE_MAINBAR, ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and ILIAS\UI\Component\MainControls\MainBar\withActive().

                                                                                : ?MainBarModification
    {
        $this->data_collection = $screen_context_stack->current()->getAdditionalData();
        if (!$this->data_collection->is(\ilDashboardGUI::DISENGAGE_MAINBAR, true)) {
            return null;
        }

        return $this->globalScreen()->layout()->factory()->mainbar()
            ->withModification(
                function (?MainBar $mainbar): ?MainBar {
                    return $mainbar !== null ? $mainbar->withActive($mainbar::NONE_ACTIVE) : null;
                }
            )
            ->withLowPriority();
    }

Here is the call graph for this function:

isInterestedInContexts()

DashboardLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 31 of file DashboardLayoutProvider.php.

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

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

Here is the call graph for this function:

Field Documentation

$data_collection

Collection DashboardLayoutProvider::$data_collection

protected

Definition at line 29 of file DashboardLayoutProvider.php.

---

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

• Services/Dashboard/GlobalScreen/classes/DashboardLayoutProvider.php