Inheritance diagram for ilTestPlayerLayoutProvider:

Collaboration diagram for ilTestPlayerLayoutProvider:

Public Member Functions
	isInterestedInContexts ()

	getMainBarModification (CalledContexts $called_contexts)

	getMetaBarModification (CalledContexts $called_contexts)

	getFooterModification (CalledContexts $called_contexts)

	getShortTitleModification (CalledContexts $called_contexts)

	getViewTitleModification (CalledContexts $called_contexts)

	getTitleModification (CalledContexts $called_contexts)

	getLogoModification (CalledContexts $called_contexts)

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	TEST_PLAYER_KIOSK_MODE_ENABLED = 'test_player_kiosk_mode_enabled'

const	TEST_PLAYER_TITLE = 'test_player_title'

const	TEST_PLAYER_VIEW_TITLE = 'test_player_view_title'

const	TEST_PLAYER_SHORT_TITLE = 'test_player_instance_name'

const	TEST_PLAYER_QUESTIONLIST = 'test_player_questionlist'

Protected Member Functions
	isKioskModeEnabled (CalledContexts $called_contexts)

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

Private Attributes
const	MODIFICATION_PRIORITY = 5

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 44 of file class.ilTestPlayerLayoutProvider.php.

Member Function Documentation

◆ getFooterModification()

ilTestPlayerLayoutProvider::getFooterModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: FooterModification|null

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

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

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

                                                                           : ?FooterModification
     {
         if (!$this->isKioskModeEnabled($called_contexts)) {
             return null;
         }
 
         return $this->globalScreen()->layout()->factory()->footer()
             ->withModification(
                 function (?Footer $current): ?Footer {
                     return null;
                 }
             )->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ getLogoModification()

ilTestPlayerLayoutProvider::getLogoModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: LogoModification|null

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

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

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), isKioskModeEnabled(), null, and ILIAS\UI\Component\Image\Image\withAction().

                                                                         : ?LogoModification
     {
         if (!$this->isKioskModeEnabled($called_contexts)) {
             return null;
         }
         return $this->globalScreen()->layout()->factory()->logo()->withModification(
             static function (?Image $logo): ?Image {
                 return $logo->withAction('');
             }
         )->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ getMainBarModification()

ilTestPlayerLayoutProvider::getMainBarModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: MainBarModification|null

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

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

References Vendor\Package\$f, $lng, $r, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), isKioskModeEnabled(), null, ILIAS\UI\Component\MainControls\MainBar\withClearedEntries(), ILIAS\UI\Implementation\Component\Button\withEngagedState(), and ILIAS\UI\Component\MainControls\MainBar\withToolsButton().

                                                                            : ?MainBarModification
     {
         $mainbar = $this->globalScreen()->layout()->factory()->mainbar();
         $has_question_list = $called_contexts->current()->getAdditionalData()
             ->exists(self::TEST_PLAYER_QUESTIONLIST);
 
         if (!$this->isKioskModeEnabled($called_contexts)) {
             return null;
         }
 
         $mainbar_modification = static fn(?MainBar $mainbar): ?MainBar => null;
         if ($has_question_list) {
             $f = $this->dic->ui()->factory();
             $r = $this->dic->ui()->renderer();
             $lng = $this->dic->language();
             $question_listing = $called_contexts->current()->getAdditionalData()->get(self::TEST_PLAYER_QUESTIONLIST);
 
             $mainbar_modification = static function (?MainBar $mainbar) use ($f, $r, $lng, $question_listing): ?MainBar {
                 $mainbar = $mainbar->withClearedEntries();
 
                 $icon = $f->symbol()->icon()->standard('tst', $lng->txt("more"));
                 $tools_button = $f->button()->bulky($icon, $lng->txt("tools"), "#")
                     ->withEngagedState(true);
 
                 $question_listing = $f->legacy()->content($r->render($question_listing));
 
                 $label = $lng->txt('mainbar_button_label_questionlist');
                 $entry = $f->maincontrols()->slate()->legacy(
                     $label,
                     $f->symbol()->icon()->standard('tst', $label),
                     $question_listing
                 );
 
                 return $mainbar
                     ->withToolsButton($tools_button)
                     ->withAdditionalToolEntry('questionlist', $entry);
             };
         }
 
         return $mainbar
             ->withModification($mainbar_modification)
             ->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ getMetaBarModification()

ilTestPlayerLayoutProvider::getMetaBarModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: MetaBarModification|null

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

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

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

                                                                            : ?MetaBarModification
     {
         if (!$this->isKioskModeEnabled($called_contexts)) {
             return null;
         }
 
         return $this->globalScreen()->layout()->factory()->metabar()
             ->withModification(
                 function (?MetaBar $current): ?MetaBar {
                     return null;
                 }
             )->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ getShortTitleModification()

ilTestPlayerLayoutProvider::getShortTitleModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: ShortTitleModification|null

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

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

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), isKioskModeEnabled(), and null.

                                                                               : ?ShortTitleModification
     {
         if (!$this->isKioskModeEnabled($called_contexts)) {
             return null;
         }
 
         $title = $called_contexts->current()->getAdditionalData()->get(self::TEST_PLAYER_SHORT_TITLE);
         if ($title === null) {
             $title = '';
         }
         return $this->globalScreen()->layout()->factory()->short_title()
             ->withModification(
                 function (?string $content) use ($title): ?string {
                     return $title;
                 }
             )->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ getTitleModification()

ilTestPlayerLayoutProvider::getTitleModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: TitleModification|null

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

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

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and null.

                                                                          : ?TitleModification
     {
         if (!$called_contexts->current()->getAdditionalData()->exists(self::TEST_PLAYER_TITLE)) {
             return null;
         }
 
         $title = $called_contexts->current()->getAdditionalData()->get(self::TEST_PLAYER_TITLE);
         if ($title == null) {
             $title = '';
         }
         return $this->globalScreen()->layout()->factory()->view_title()
             ->withModification(
                 function (?string $content) use ($title): ?string {
                     return $title;
                 }
             )->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ getViewTitleModification()

ilTestPlayerLayoutProvider::getViewTitleModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: ViewTitleModification|null

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

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

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and null.

                                                                              : ?ViewTitleModification
     {
         if (!$called_contexts->current()->getAdditionalData()->exists(self::TEST_PLAYER_VIEW_TITLE)) {
             return null;
         }
 
         $title = $called_contexts->current()->getAdditionalData()->get(self::TEST_PLAYER_VIEW_TITLE);
         if ($title === null) {
             $title = '';
         }
         return $this->globalScreen()->layout()->factory()->view_title()
             ->withModification(
                 function (?string $content) use ($title): ?string {
                     return $title;
                 }
             )->withPriority(self::MODIFICATION_PRIORITY);
     }

Here is the call graph for this function:

◆ isInterestedInContexts()

ilTestPlayerLayoutProvider::isInterestedInContexts ( )

Returns: ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

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

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

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

Here is the call graph for this function:

◆ isKioskModeEnabled()

ilTestPlayerLayoutProvider::isKioskModeEnabled ( CalledContexts $called_contexts )

protected

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

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

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

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