ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
ilTestPlayerLayoutProvider Class Reference
+ Inheritance diagram for ilTestPlayerLayoutProvider:
+ Collaboration diagram for ilTestPlayerLayoutProvider:

Public Member Functions

 isInterestedInContexts ()
 
 getLogoModification (CalledContexts $calledContexts)
 @inheritDoc More...
 
 getMainBarModification (CalledContexts $calledContexts)
 @inheritDoc More...
 
 getMetaBarModification (CalledContexts $calledContexts)
 @inheritDoc More...
 
 getFooterModification (CalledContexts $calledContexts)
 @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 ()
 

Data Fields

const TEST_PLAYER_KIOSK_MODE_ENABLED = 'test_player_kiosk_mode_enabled'
 

Protected Member Functions

 isKioskModeEnabled (CalledContexts $calledContexts)
 
- Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
 globalScreen ()
 

Additional Inherited Members

- Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
 $context_collection
 
 $factory
 
- Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
 $dic
 

Detailed Description

Definition at line 26 of file class.ilTestPlayerLayoutProvider.php.

Member Function Documentation

◆ getFooterModification()

ilTestPlayerLayoutProvider::getFooterModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 85 of file class.ilTestPlayerLayoutProvider.php.

86 {
87 if ($this->isKioskModeEnabled($calledContexts)) {
88 $footer = $this->globalScreen()->layout()->factory()->footer();
89
90 $footer = $footer->withModification(function (Footer $current) {
91 return null;
92 });
93
94 return $footer->withHighPriority();
95 }
96
97 return null;
98 }
isKioskModeEnabled(CalledContexts $calledContexts)
This describes the Footer.
Definition: Footer.php:12

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

+ Here is the call graph for this function:

◆ getLogoModification()

ilTestPlayerLayoutProvider::getLogoModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 37 of file class.ilTestPlayerLayoutProvider.php.

38 {
39 if ($this->isKioskModeEnabled($calledContexts)) {
40 $logo = $this->globalScreen()->layout()->factory()->logo();
41
42 $logo = $logo->withModification(function (Image $current) {
43 return null;
44 });
45
46 return $logo->withHighPriority();
47 }
48
49 return null;
50 }

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

+ Here is the call graph for this function:

◆ getMainBarModification()

ilTestPlayerLayoutProvider::getMainBarModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 53 of file class.ilTestPlayerLayoutProvider.php.

54 {
55 if ($this->isKioskModeEnabled($calledContexts)) {
56 $mainBar = $this->globalScreen()->layout()->factory()->mainbar();
57
58 $mainBar = $mainBar->withModification(function (MainBar $current) {
59 return null;
60 });
61
62 return $mainBar->withHighPriority();
63 }
64
65 return null;
66 }
This describes the MainBar.
Definition: MainBar.php:16

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

+ Here is the call graph for this function:

◆ getMetaBarModification()

ilTestPlayerLayoutProvider::getMetaBarModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 69 of file class.ilTestPlayerLayoutProvider.php.

70 {
71 if ($this->isKioskModeEnabled($calledContexts)) {
72 $metaBar = $this->globalScreen()->layout()->factory()->metabar();
73
74 $metaBar = $metaBar->withModification(function (MetaBar $current) {
75 return null;
76 });
77
78 return $metaBar->withHighPriority();
79 }
80
81 return null;
82 }
This describes the MetaBar.
Definition: MetaBar.php:15

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

+ Here is the call graph for this function:

◆ isInterestedInContexts()

ilTestPlayerLayoutProvider::isInterestedInContexts ( )

◆ isKioskModeEnabled()

ilTestPlayerLayoutProvider::isKioskModeEnabled ( CalledContexts  $calledContexts)
protected
Parameters
CalledContexts$calledContexts
Returns
bool

Definition at line 106 of file class.ilTestPlayerLayoutProvider.php.

106 : bool
107 {
108 $additionalData = $calledContexts->current()->getAdditionalData();
109 $isKioskModeEnabled = $additionalData->is(self::TEST_PLAYER_KIOSK_MODE_ENABLED, true);
110
111 return $isKioskModeEnabled;
112 }

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

Referenced by getFooterModification(), getLogoModification(), getMainBarModification(), and getMetaBarModification().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ TEST_PLAYER_KIOSK_MODE_ENABLED

const ilTestPlayerLayoutProvider::TEST_PLAYER_KIOSK_MODE_ENABLED = 'test_player_kiosk_mode_enabled'

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