ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
DashboardLayoutProvider Class Reference

Class DashboardLayoutProvider. More...

+ Inheritance diagram for DashboardLayoutProvider:
+ Collaboration diagram for DashboardLayoutProvider:

Public Member Functions

 isInterestedInContexts ()
 @inheritDoc More...
 
 getMainBarModification (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 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
 

Additional Inherited Members

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

Detailed Description

Member Function Documentation

◆ getMainBarModification()

DashboardLayoutProvider::getMainBarModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 29 of file DashboardLayoutProvider.php.

30 {
31 $this->data_collection = $screen_context_stack->current()->getAdditionalData();
32 if (!$this->data_collection->is(\ilDashboardGUI::DISENGAGE_MAINBAR, true)) {
33 return null;
34 }
35
36 return $this->globalScreen()->layout()->factory()->mainbar()
37 ->withModification(
38 function (MainBar $mainbar) : ?MainBar {
39 return $mainbar->withActive($mainbar::NONE_ACTIVE);
40 }
41 )
42 ->withLowPriority();
43 }
This describes the MainBar.
Definition: MainBar.php:16

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

+ Here is the call graph for this function:

◆ isInterestedInContexts()

DashboardLayoutProvider::isInterestedInContexts ( )

Field Documentation

◆ $data_collection

DashboardLayoutProvider::$data_collection
protected

Definition at line 19 of file DashboardLayoutProvider.php.


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