ILIAS\Test\Presentation\PrintLayoutProvider Class Reference

Inheritance diagram for ILIAS\Test\Presentation\PrintLayoutProvider:

Collaboration diagram for ILIAS\Test\Presentation\PrintLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	getMainBarModification (CalledContexts $called_contexts)
	getMetaBarModification (CalledContexts $called_contexts)
	getBreadCrumbsModification (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_CONTEXT_PRINT = 'test_context_print'

Protected Member Functions
	isTestContextPrint (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 33 of file PrintLayoutProvider.php.

Member Function Documentation

getBreadCrumbsModification()

ILIAS\Test\Presentation\PrintLayoutProvider::getBreadCrumbsModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

BreadCrumbsModification|null

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

Definition at line 71 of file PrintLayoutProvider.php.

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\Test\Presentation\PrintLayoutProvider\isTestContextPrint(), and null.

                                                                               : ?BreadCrumbsModification
    {
        if (!$this->isTestContextPrint($called_contexts)) {
            return null;
        }

        return $this->globalScreen()->layout()->factory()->breadcrumbs()->withModification(
            static fn(?Breadcrumbs $breadcrumbs): ?Breadcrumbs => null
        )->withPriority(self::MODIFICATION_PRIORITY);
    }

Here is the call graph for this function:

getMainBarModification()

ILIAS\Test\Presentation\PrintLayoutProvider::getMainBarModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

MainBarModification|null

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

Definition at line 50 of file PrintLayoutProvider.php.

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\Test\Presentation\PrintLayoutProvider\isTestContextPrint(), and null.

                                                                           : ?MainBarModification
    {
        if (!$this->isTestContextPrint($called_contexts)) {
            return null;
        }
        return $this->globalScreen()->layout()->factory()->mainbar()->withModification(
            static fn(?MainBar $mainbar): ?MainBar => null
        )->withPriority(self::MODIFICATION_PRIORITY);
    }

Here is the call graph for this function:

getMetaBarModification()

ILIAS\Test\Presentation\PrintLayoutProvider::getMetaBarModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

MetaBarModification|null

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

Definition at line 60 of file PrintLayoutProvider.php.

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\Test\Presentation\PrintLayoutProvider\isTestContextPrint(), and null.

                                                                           : ?MetaBarModification
    {
        if (!$this->isTestContextPrint($called_contexts)) {
            return null;
        }

        return $this->globalScreen()->layout()->factory()->metabar()->withModification(
            static fn(?MetaBar $metabar): ?MetaBar => null
        )->withPriority(self::MODIFICATION_PRIORITY);
    }

Here is the call graph for this function:

isInterestedInContexts()

ILIAS\Test\Presentation\PrintLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 39 of file PrintLayoutProvider.php.

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

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

Here is the call graph for this function:

isTestContextPrint()

ILIAS\Test\Presentation\PrintLayoutProvider::isTestContextPrint ( CalledContexts  $called_contexts )

protected

Definition at line 44 of file PrintLayoutProvider.php.

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

Referenced by ILIAS\Test\Presentation\PrintLayoutProvider\getBreadCrumbsModification(), ILIAS\Test\Presentation\PrintLayoutProvider\getMainBarModification(), and ILIAS\Test\Presentation\PrintLayoutProvider\getMetaBarModification().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

MODIFICATION_PRIORITY

const ILIAS\Test\Presentation\PrintLayoutProvider::MODIFICATION_PRIORITY = 5

private

Definition at line 37 of file PrintLayoutProvider.php.

TEST_CONTEXT_PRINT

const ILIAS\Test\Presentation\PrintLayoutProvider::TEST_CONTEXT_PRINT = 'test_context_print'

Definition at line 35 of file PrintLayoutProvider.php.

---

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

• components/ILIAS/Test/src/Presentation/PrintLayoutProvider.php