Inheritance diagram for ILIAS\UICore\PageContentProvider:

Collaboration diagram for ILIAS\UICore\PageContentProvider:

Public Member Functions
	isInterestedInContexts ()

	getContentModification (CalledContexts $screen_context_stack)
	@inheritDoc More...

	getFooterModification (CalledContexts $screen_context_stack)
	@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 (Container $dic)
	@inheritDoc More...

	getFullyQualifiedClassName ()
	@inheritDoc More...

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

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)

Private Member Functions
	buildTabTitle ()
	@description This method was introduced due to A11y problems, see https://mantis.ilias.de/view.php?id=31534. More...

Static Private Attributes
static string	$content = ""

static string	$perma_link = ""

static string	$title = ""

static string	$short_title = ""

static string	$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
ContextCollection	$context_collection

ILIAS GlobalScreen Scope Layout Factory ModificationFactory	$factory

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

Detailed Description

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 40 of file PageContentProvider.php.

Member Function Documentation

◆ buildTabTitle()

ILIAS\UICore\PageContentProvider::buildTabTitle ( )

private

@description This method was introduced due to A11y problems, see https://mantis.ilias.de/view.php?id=31534.

This is definitely only a workaround, but since this is currently the only way to implement it, it is just introduced... We keep all the logic within this method because we don't want this to become common or even used elsewhere. Hence certain things as anonymous functions...

Definition at line 126 of file PageContentProvider.php.

                                    : string
    {
        // This anonymous function generates a translated title from a "tab" array.
        // in some cases the tabs are already translated (dir_text = true), in others not...
        $tab_title_generator = function (array $tab): string {
            if (($tab['dir_text'] ?? false) === false) {
                $tab_title = $this->dic->language()->txt($tab['text']);
            } else {
                $tab_title = $tab['text'] ?? '';
            }
            $tab_title .= ': ';
            return $tab_title;
        };
 
        // we only know the 'id' of the active tab and don't want to rely on the array index, so we
        // loop over tabs or subtabs to find the "right" one
        $tab_looper = static function (array $tabs, string $active_tab) use ($tab_title_generator): string {
            $tab_title = '';
            foreach ($tabs as $tab) {
                if ($tab['id'] === $active_tab) {
                    $tab_title = $tab_title_generator($tab);
                    break;
                }
            }
            return $tab_title;
        };
 
        // TABS
        $tabs = $this->dic->tabs()->target; // this only works because target is currently public...
        $active_tab = $this->dic->tabs()->getActiveTab();
        if ($active_tab === '' && isset($tabs[0])) {
            $active_tab = $tabs[0]['id']; // if no tab is active, use the first one
        }
 
        $tab_title = $tab_looper($tabs, $active_tab);
 
        // SUBTABS
        $subtab_title = '';
        $subtabs = $this->dic->tabs()->sub_target; // this only works because subtarget is currently public...
        if (count($subtabs) > 1) { // we only need to do something if there are more than one subtabs
            $active_subtab = array_values(
                array_filter($subtabs, static function (array $subtab): bool {
                    return $subtab['activate'] ?? false;
                })
            )[0]['id'] ?? '';
 
            if ($active_subtab === '' && isset($subtabs[0])) {
                $active_subtab = $subtabs[0]['id']; // if no tab is active, use the first one
            }
            $subtab_title = $tab_looper($subtabs, $active_subtab);
        }
 
        return $subtab_title . $tab_title;
    }

◆ getContentModification()

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

@inheritDoc

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

Definition at line 78 of file PageContentProvider.php.

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

References ILIAS\UICore\PageContentProvider\$content, ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and ILIAS\UI\examples\MainControls\Slate\Legacy\legacy().

Here is the call graph for this function:

◆ getFooterModification()

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

@inheritDoc

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

Definition at line 182 of file PageContentProvider.php.

                                                                               : ?FooterModification
    {
        return $this->globalScreen()->layout()->factory()->footer()->withModification(function (?Footer $footer): ?Footer {
            $f = $this->dic->ui()->factory();
 
            $links = [];
            // ILIAS Version and Text
            $ilias_version = ILIAS_VERSION;
            $text = "powered by ILIAS (v{$ilias_version})";
 
            // Imprint
            $base_class = ($this->dic->http()->wrapper()->query()->has(\ilCtrlInterface::PARAM_BASE_CLASS)) ?
                $this->dic->http()->wrapper()->query()->retrieve(
                    \ilCtrlInterface::PARAM_BASE_CLASS,
                    $this->dic->refinery()->kindlyTo()->string()
                ) : null;
 
            if ($base_class !== \ilImprintGUI::class && \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;
        });
    }

References Vendor\Package\$f, ilObjLanguageAccess\_checkTranslate(), ilLink\_getStaticLink(), ilObjLanguageAccess\_getTranslationLink(), ilObjLanguageAccess\_isPageTranslation(), ilAccessibilitySupportContactsGUI\getFooterLink(), ilSystemSupportContactsGUI\getFooterLink(), ilAccessibilityControlConceptGUI\getFooterLink(), ilAccessibilitySupportContactsGUI\getFooterText(), ilSystemSupportContactsGUI\getFooterText(), ilAccessibilityControlConceptGUI\getFooterText(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\GlobalScreen\has(), ILIAS_VERSION, ilImprint\isActive(), ilCtrlInterface\PARAM_BASE_CLASS, and ILIAS\UI\Component\MainControls\Footer\withPermanentURL().

Here is the call graph for this function:

◆ isInterestedInContexts()

ILIAS\UICore\PageContentProvider::isInterestedInContexts ( )

Returns: ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 73 of file PageContentProvider.php.

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

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

Here is the call graph for this function:

◆ setContent()

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

static

Definition at line 48 of file PageContentProvider.php.

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

References ILIAS\UICore\PageContentProvider\$content.

◆ setPermaLink()

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

static

Definition at line 68 of file PageContentProvider.php.

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

References ILIAS\UICore\PageContentProvider\$perma_link.

◆ setShortTitle()

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

static

Definition at line 58 of file PageContentProvider.php.

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

References ILIAS\UICore\PageContentProvider\$short_title.

◆ setTitle()

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

static

Definition at line 53 of file PageContentProvider.php.

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

References ILIAS\UICore\PageContentProvider\$title.

◆ setViewTitle()

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

static

Definition at line 63 of file PageContentProvider.php.

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

References ILIAS\UICore\PageContentProvider\$view_title.

Field Documentation

◆ $content

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

staticprivate

Definition at line 42 of file PageContentProvider.php.

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

◆ $perma_link

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

staticprivate

Definition at line 43 of file PageContentProvider.php.

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

◆ $short_title

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

staticprivate

Definition at line 45 of file PageContentProvider.php.

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

◆ $title

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

staticprivate

Definition at line 44 of file PageContentProvider.php.

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

◆ $view_title

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

staticprivate

Definition at line 46 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

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildTabTitle()

◆ getContentModification()

◆ getFooterModification()

◆ isInterestedInContexts()

◆ setContent()

◆ setPermaLink()

◆ setShortTitle()

◆ setTitle()

◆ setViewTitle()

Field Documentation

◆ $content

◆ $perma_link

◆ $short_title

◆ $title

◆ $view_title