PageContentProvider.php

Go to the documentation of this file.

<?php 
namespace ILIAS\UICore;

use ILIAS\Data\URI;
use ILIAS\GlobalScreen\Scope\Layout\Factory\ContentModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\FooterModification;
use ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider;
use ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts;
use ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection;
use ILIAS\UI\Component\Legacy\Legacy;
use ILIAS\UI\Component\MainControls\Footer;
use ILIAS\GlobalScreen\Scope\Layout\Factory\TitleModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\ShortTitleModification;
use ILIAS\GlobalScreen\Scope\Layout\Factory\ViewTitleModification;

class PageContentProvider extends AbstractModificationProvider implements ModificationProvider
{

    private static $content = "";
    private static $perma_link = "";
    private static $title = "";
    private static $short_title = "";
    private static $view_title = "";

    public static function setContent(string $content) : void
    {
        self::$content = $content;
    }

    public static function setTitle(string $title) : void
    {
        self::$title = $title;
    }

    public static function setShortTitle(string $short_title) : void
    {
        self::$short_title = $short_title;
    }

    public static function setViewTitle(string $view_title) : void
    {
        self::$view_title = $view_title;
    }


    public static function setPermaLink(string $perma_link) : void
    {
        self::$perma_link = $perma_link;
    }


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


    public function getContentModification(CalledContexts $screen_context_stack) : ?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();
    }


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

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

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

    public function getFooterModification(CalledContexts $screen_context_stack) : ?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;
        });
    }
}