ilTestPlayerLayoutProvider Class Reference

Inheritance diagram for ilTestPlayerLayoutProvider:

Collaboration diagram for ilTestPlayerLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	getLogoModification (CalledContexts $called_contexts)
	getResponsiveLogoModification (CalledContexts $called_contexts)
	getMainBarModification (CalledContexts $called_contexts)
	getMetaBarModification (CalledContexts $called_contexts)
	getFooterModification (CalledContexts $called_contexts)
	getShortTitleModification (CalledContexts $called_contexts)
	getViewTitleModification (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 (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_SHORT_TITLE = 'test_player_instance_name'

Protected Member Functions
	isKioskModeEnabled (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
ILIAS GlobalScreen Scope Layout Factory ModificationFactory	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

Detailed Description

Definition at line 42 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 113 of file class.ilTestPlayerLayoutProvider.php.

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

                                                                          : ?FooterModification
    {
        if ($this->isKioskModeEnabled($called_contexts)) {
            $footer = $this->globalScreen()->layout()->factory()->footer();

            $footer = $footer->withModification(function (?Footer $current): ?Footer {
                return null;
            });

            return $footer->withHighPriority();
        }

        return null;
    }

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

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

                                                                        : ?LogoModification
    {
        if ($this->isKioskModeEnabled($called_contexts)) {
            $logo = $this->globalScreen()->layout()->factory()->logo();

            $logo = $logo->withModification(function (?Image $current): ?Image {
                return null;
            });

            return $logo->withHighPriority();
        }

        return null;
    }

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

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

                                                                           : ?MainBarModification
    {
        if ($this->isKioskModeEnabled($called_contexts)) {
            $mainBar = $this->globalScreen()->layout()->factory()->mainbar();

            $mainBar = $mainBar->withModification(function (?MainBar $current): ?MainBar {
                return null;
            });

            return $mainBar->withHighPriority();
        }

        return null;
    }

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

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

                                                                           : ?MetaBarModification
    {
        if ($this->isKioskModeEnabled($called_contexts)) {
            $metaBar = $this->globalScreen()->layout()->factory()->metabar();

            $metaBar = $metaBar->withModification(function (?MetaBar $current): ?MetaBar {
                return null;
            });

            return $metaBar->withHighPriority();
        }

        return null;
    }

Here is the call graph for this function:

getResponsiveLogoModification()

ilTestPlayerLayoutProvider::getResponsiveLogoModification

(

CalledContexts

$called_contexts

)

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

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

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

                                                                                  : ?LogoModification
    {
        if ($this->isKioskModeEnabled($called_contexts)) {
            $logo = $this->globalScreen()->layout()->factory()->logo();

            $logo = $logo->withModification(function (?Image $current): ?Image {
                return null;
            });

            return $logo->withHighPriority();
        }

        return null;
    }

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

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

                                                                              : ?ShortTitleModification
    {
        if ($this->isKioskModeEnabled($called_contexts)) {
            $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;
                }
            )
            ->withHighPriority();
        }
        return null;
    }

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

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

                                                                             : ?ViewTitleModification
    {
        if ($called_contexts->current()->getAdditionalData()->exists(self::TEST_PLAYER_TITLE)) {
            $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;
                }
            )
            ->withHighPriority();
        }
        return null;
    }

Here is the call graph for this function:

isInterestedInContexts()

ilTestPlayerLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

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

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

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

Here is the call graph for this function:

isKioskModeEnabled()

ilTestPlayerLayoutProvider::isKioskModeEnabled ( CalledContexts  $called_contexts )

protected

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

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

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

                                                                          : bool
    {
        $additionalData = $called_contexts->current()->getAdditionalData();
        $isKioskModeEnabled = $additionalData->is(self::TEST_PLAYER_KIOSK_MODE_ENABLED, true);

        return $isKioskModeEnabled;
    }

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'

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

Referenced by ilTestOutputGUI\executeCommand().

TEST_PLAYER_SHORT_TITLE

const ilTestPlayerLayoutProvider::TEST_PLAYER_SHORT_TITLE = 'test_player_instance_name'

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

Referenced by ilTestOutputGUI\executeCommand().

TEST_PLAYER_TITLE

const ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE = 'test_player_title'

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

Referenced by ilTestPlayerAbstractGUI\backToInfoScreenCmd(), ilTestOutputGUI\executeCommand(), ilTestPlayerAbstractGUI\outQuestionSummaryCmd(), ilTestSubmissionReviewGUI\show(), ilAssQuestionHintRequestGUI\showHintCmd(), ilAssQuestionHintRequestGUI\showListCmd(), and ilTestPasswordProtectionGUI\showPasswordFormCmd().

---

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

• Modules/Test/classes/Screen/class.ilTestPlayerLayoutProvider.php