ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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)
 @inheritDoc More...
 
 getMetaBarModification (CalledContexts $called_contexts)
 @inheritDoc More...
 
 getBreadCrumbsModification (CalledContexts $called_contexts)
 @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 (protected Container $dic)
 
 getFullyQualifiedClassName ()
 
 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_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)

@inheritDoc

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

Definition at line 71 of file PrintLayoutProvider.php.

71 : ?BreadCrumbsModification
72 {
73 if (!$this->isTestContextPrint($called_contexts)) {
74 return null;
75 }
76
77 return $this->globalScreen()->layout()->factory()->breadcrumbs()->withModification(
78 static fn(?Breadcrumbs $breadcrumbs): ?Breadcrumbs => null
79 )->withPriority(self::MODIFICATION_PRIORITY);
80 }
isTestContextPrint(CalledContexts $called_contexts)

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

+ Here is the call graph for this function:

◆ getMainBarModification()

ILIAS\Test\Presentation\PrintLayoutProvider::getMainBarModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 50 of file PrintLayoutProvider.php.

50 : ?MainBarModification
51 {
52 if (!$this->isTestContextPrint($called_contexts)) {
53 return null;
54 }
55 return $this->globalScreen()->layout()->factory()->mainbar()->withModification(
56 static fn(?MainBar $mainbar): ?MainBar => null
57 )->withPriority(self::MODIFICATION_PRIORITY);
58 }

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

+ Here is the call graph for this function:

◆ getMetaBarModification()

ILIAS\Test\Presentation\PrintLayoutProvider::getMetaBarModification ( CalledContexts  $screen_context_stack)

@inheritDoc

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

Definition at line 60 of file PrintLayoutProvider.php.

60 : ?MetaBarModification
61 {
62 if (!$this->isTestContextPrint($called_contexts)) {
63 return null;
64 }
65
66 return $this->globalScreen()->layout()->factory()->metabar()->withModification(
67 static fn(?MetaBar $metabar): ?MetaBar => null
68 )->withPriority(self::MODIFICATION_PRIORITY);
69 }

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

+ 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.

39 : ContextCollection
40 {
41 return $this->context_collection->main();
42 }

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\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.

44 : bool
45 {
46 return $called_contexts->current()->getAdditionalData()
47 ->is(self::TEST_CONTEXT_PRINT, true);
48 }

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().

+ 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: