Class ilPageContentProvider. More...

Inheritance diagram for ILIAS\UICore\PageContentProvider:

Collaboration diagram for ILIAS\UICore\PageContentProvider:

Public Member Functions
	isInterestedInContexts ()

	getContentModification (CalledContexts $screen_context_stack)

	getTitleModification (CalledContexts $screen_context_stack)

	getShortTitleModification (CalledContexts $screen_context_stack)

	getViewTitleModification (CalledContexts $screen_context_stack)

	getFooterModification (CalledContexts $screen_context_stack)

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

Static Public Member Functions
static	setContent (string $content)

static	setTitle (string $title)

static	setShortTitle (string $short_title)

static	setViewTitle (string $view_title)

static	setPermaLink (string $perma_link)

Static Private Attributes
static	$content = ""

static	$perma_link = ""

static	$title = ""

static	$short_title = ""

static	$view_title = ""

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

Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	$context_collection

	$factory

Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	$dic

Detailed Description

Class ilPageContentProvider.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Definition at line 39 of file PageContentProvider.php.

Member Function Documentation

◆ getContentModification()

ILIAS\UICore\PageContentProvider::getContentModification ( CalledContexts $screen_context_stack )

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

Definition at line 117 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$content, and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

                                                                                  : ?ContentModification
     {
         return $this->globalScreen()->layout()->factory()->content()->withModification(function (?Legacy $content) : ?Legacy {
             if ($content === null) {
                 return null;
             }
             $ui = $this->dic->ui();
             return $ui->factory()->legacy(
                 $ui->renderer()->render($content) . self::$content
             );
         })->withLowPriority();
     }

Here is the call graph for this function:

◆ getFooterModification()

ILIAS\UICore\PageContentProvider::getFooterModification ( CalledContexts $screen_context_stack )

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

Definition at line 161 of file PageContentProvider.php.

References Vendor\Package\$f, ilObjLanguageAccess\_checkTranslate(), ilLink\_getStaticLink(), ilObjLanguageAccess\_getTranslationLink(), ilObjLanguageAccess\_isPageTranslation(), ilSystemSupportContactsGUI\getFooterLink(), ilAccessibilitySupportContactsGUI\getFooterLink(), ilAccessibilityControlConceptGUI\getFooterLink(), ilSystemSupportContactsGUI\getFooterText(), ilAccessibilitySupportContactsGUI\getFooterText(), ilAccessibilityControlConceptGUI\getFooterText(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and ilImprint\isActive().

                                                                                 : ?FooterModification
     {
         return $this->globalScreen()->layout()->factory()->footer()->withModification(function (?Footer $footer = null) : ?Footer {
             $f = $this->dic->ui()->factory();
 
             $links = [];
             // ILIAS Version and Text
             $ilias_version = $this->dic->settings()->get('ilias_version');
             $text = "powered by ILIAS (v{$ilias_version})";
 
             // Imprint
             if ($_REQUEST["baseClass"] !== "ilImprintGUI" && \ilImprint::isActive()) {
                 $imprint_title = $this->dic->language()->txt("imprint");
                 $imprint_url = \ilLink::_getStaticLink(0, "impr");
                 $links[] = $f->link()->standard($imprint_title, $imprint_url);
             }
 
             // system support contacts
             if (($system_support_url = \ilSystemSupportContactsGUI::getFooterLink()) !== '') {
                 $system_support_title = \ilSystemSupportContactsGUI::getFooterText();
                 $links[] = $f->link()->standard($system_support_title, $system_support_url);
             }
 
             // output translation link
             if (\ilObjLanguageAccess::_checkTranslate() && !\ilObjLanguageAccess::_isPageTranslation()) {
                 $translation_url = \ilObjLanguageAccess::_getTranslationLink();
                 $translation_title = $this->dic->language()->txt('translation');
                 $links[] = $f->link()->standard($translation_title, $translation_url)->withOpenInNewViewport(true);
             }
 
             // accessibility control concept
             if (($accessibility_control_url = \ilAccessibilityControlConceptGUI::getFooterLink()) !== '') {
                 $accessibility_control_title = \ilAccessibilityControlConceptGUI::getFooterText();
                 $links[] = $f->link()->standard($accessibility_control_title, $accessibility_control_url);
             }
 
             // report accessibility issue
             if (($accessibility_report_url = \ilAccessibilitySupportContactsGUI::getFooterLink()) !== '') {
                 $accessibility_report_title = \ilAccessibilitySupportContactsGUI::getFooterText();
                 $links[] = $f->link()->standard($accessibility_report_title, $accessibility_report_url);
             }
 
             $footer = $f->mainControls()->footer($links, $text);
 
             $tosWithdrawalGui = new \ilTermsOfServiceWithdrawalGUIHelper($this->dic->user());
             $footer = $tosWithdrawalGui->modifyFooter($footer);
 
             if (self::$perma_link !== "") {
                 $footer = $footer->withPermanentURL(new URI(self::$perma_link));
             }
 
             return $footer;
         });
     }

Here is the call graph for this function:

◆ getShortTitleModification()

ILIAS\UICore\PageContentProvider::getShortTitleModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: ShortTitleModification|null

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

Definition at line 140 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$content, and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

                                                                                     : ?ShortTitleModification
     {
         return $this->globalScreen()->layout()->factory()->short_title()->withModification(
             function (?string $content) : string {
                 return self::$short_title;
             }
         )->withLowPriority();
     }

Here is the call graph for this function:

◆ getTitleModification()

ILIAS\UICore\PageContentProvider::getTitleModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: TitleModification|null

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

Definition at line 131 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$content, and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

                                                                                : ?TitleModification
     {
         return $this->globalScreen()->layout()->factory()->title()->withModification(
             function (?string $content) : string {
                 return self::$title;
             }
         )->withLowPriority();
     }

Here is the call graph for this function:

◆ getViewTitleModification()

ILIAS\UICore\PageContentProvider::getViewTitleModification ( CalledContexts $screen_context_stack )

Parameters

CalledContexts $screen_context_stack

Returns: ViewTitleModification|null

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

Definition at line 149 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$content, and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

                                                                                    : ?ViewTitleModification
     {
         return $this->globalScreen()->layout()->factory()->view_title()->withModification(
             function (?string $content) : string {
                 return self::$view_title;
             }
         )->withLowPriority();
     }

Here is the call graph for this function:

◆ isInterestedInContexts()

ILIAS\UICore\PageContentProvider::isInterestedInContexts ( )

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 108 of file PageContentProvider.php.

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

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

Here is the call graph for this function:

◆ setContent()

static ILIAS\UICore\PageContentProvider::setContent ( string $content )

static

Parameters

string $content

Definition at line 66 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$content.

                                                        : void
     {
         self::$content = $content;
     }

◆ setPermaLink()

static ILIAS\UICore\PageContentProvider::setPermaLink ( string $perma_link )

static

Parameters

string $perma_link

Definition at line 99 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$perma_link.

                                                             : void
     {
         self::$perma_link = $perma_link;
     }

◆ setShortTitle()

static ILIAS\UICore\PageContentProvider::setShortTitle ( string $short_title )

static

Parameters

string $content

Definition at line 82 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$short_title.

                                                               : void
     {
         self::$short_title = $short_title;
     }

◆ setTitle()

static ILIAS\UICore\PageContentProvider::setTitle ( string $title )

static

Parameters

string $content

Definition at line 74 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$title.

                                                    : void
     {
         self::$title = $title;
     }

◆ setViewTitle()

static ILIAS\UICore\PageContentProvider::setViewTitle ( string $view_title )

static

Parameters

string $content

Definition at line 90 of file PageContentProvider.php.

References ILIAS\UICore\PageContentProvider\$view_title.

                                                             : void
     {
         self::$view_title = $view_title;
     }

Field Documentation

◆ $content

ILIAS\UICore\PageContentProvider::$content = ""

staticprivate

Definition at line 45 of file PageContentProvider.php.

Referenced by ILIAS\UICore\PageContentProvider\getContentModification(), ILIAS\UICore\PageContentProvider\getShortTitleModification(), ILIAS\UICore\PageContentProvider\getTitleModification(), ILIAS\UICore\PageContentProvider\getViewTitleModification(), and ILIAS\UICore\PageContentProvider\setContent().

◆ $perma_link

ILIAS\UICore\PageContentProvider::$perma_link = ""

staticprivate

Definition at line 49 of file PageContentProvider.php.

Referenced by ILIAS\UICore\PageContentProvider\setPermaLink().

◆ $short_title

ILIAS\UICore\PageContentProvider::$short_title = ""

staticprivate

Definition at line 57 of file PageContentProvider.php.

Referenced by ILIAS\UICore\PageContentProvider\setShortTitle().

◆ $title

ILIAS\UICore\PageContentProvider::$title = ""

staticprivate

Definition at line 53 of file PageContentProvider.php.

Referenced by ILIAS\UICore\PageContentProvider\setTitle().

◆ $view_title

ILIAS\UICore\PageContentProvider::$view_title = ""

staticprivate

Definition at line 61 of file PageContentProvider.php.

Referenced by ILIAS\UICore\PageContentProvider\setViewTitle().

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

Services/UICore/classes/Screen/PageContentProvider.php

Public Member Functions

Static Public Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getContentModification()

◆ getFooterModification()

◆ getShortTitleModification()

◆ getTitleModification()

◆ getViewTitleModification()

◆ isInterestedInContexts()

◆ setContent()

◆ setPermaLink()

◆ setShortTitle()

◆ setTitle()

◆ setViewTitle()

Field Documentation

◆ $content

◆ $perma_link

◆ $short_title

◆ $title

◆ $view_title