class.ilContentPagePageCommandForwarder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\ContentPage\PageMetrics\Event\PageUpdatedEvent;
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Style\Content\Object\ObjectFacade;
use ILIAS\ILIASObject\Properties\Translations\Translations;

class ilContentPagePageCommandForwarder implements ilContentPageObjectConstants
{
    final public const string PRESENTATION_MODE_EDITING = 'PRESENTATION_MODE_EDITING';

    final public const string PRESENTATION_MODE_PRESENTATION = 'PRESENTATION_MODE_PRESENTATION';

    final public const string PRESENTATION_MODE_EMBEDDED_PRESENTATION = 'PRESENTATION_MODE_EMBEDDED_PRESENTATION';
    final public const string PRESENTATION_MODE_PREVIEW = 'PRESENTATION_MODE_PREVIEW';

    protected string $presentationMode = self::PRESENTATION_MODE_EDITING;
    protected string $backUrl = '';
    protected array $updateListeners = [];
    protected bool $isMediaRequest = false;

    public function __construct(
        protected GlobalHttpState $http,
        protected ilCtrlInterface $ctrl,
        protected ilTabsGUI $tabs,
        protected ilLanguage $lng,
        protected ilObjContentPage $parentObject,
        protected Translations $translation,
        protected ilObjUser $actor,
        protected Refinery $refinery,
        protected ObjectFacade $content_style_domain
    ) {
        $this->lng->loadLanguageModule('content');

        $this->backUrl = '';
        if ($this->http->wrapper()->query()->has('backurl')) {
            $this->backUrl = $this->http->wrapper()->query()->retrieve(
                'backurl',
                $this->refinery->kindlyTo()->string()
            );
        }

        if ($this->backUrl !== '') {
            $this->ctrl->setParameterByClass(ilContentPagePageGUI::class, 'backurl', rawurlencode($this->backUrl));
        }
    }

    public function setIsMediaRequest(bool $isMediaRequest): void
    {
        $this->isMediaRequest = $isMediaRequest;
    }

    public function onPageUpdate(array $parameters): void
    {
        foreach ($this->updateListeners as $listener) {
            $listener(new PageUpdatedEvent($parameters['page']));
        }
    }

    public function addPageTabs(): void
    {
        $this->ctrl->setParameterByClass(ilObjectContentStyleSettingsGUI::class, self::HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT, '1');
        $this->tabs->addTarget(
            'obj_sty',
            $this->ctrl->getLinkTargetByClass(ilObjectContentStyleSettingsGUI::class),
            'editStyleProperties',
            strtolower(ilObjectContentStyleSettingsGUI::class)
        );
        $this->ctrl->setParameterByClass(ilObjContentPageGUI::class, self::HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT, null);
    }

    public function updateContentPageOnPageUpdate(array $parameters): void
    {
        $this->parentObject->update();
    }

    public function addUpdateListener(callable $updateListener): void
    {
        $this->updateListeners[] = $updateListener;
    }

    protected function getPageObjectGUI(string $language, bool $isEmbedded = false): ilContentPagePageGUI
    {
        $pageObjectGUI = new ilContentPagePageGUI($this->parentObject->getId(), 0, $isEmbedded, $language);
        $pageObjectGUI->setStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );

        $pageObjectGUI->obj->addUpdateListener($this, 'updateContentPageOnPageUpdate', []);

        return $pageObjectGUI;
    }

    protected function doesPageExistsForLanguage(string $language): bool
    {
        return ilContentPagePage::_exists($this->parentObject->getType(), $this->parentObject->getId(), $language);
    }

    protected function ensurePageObjectExists(string $language): void
    {
        if (!$this->doesPageExistsForLanguage($language)) {
            $pageObject = new ilContentPagePage();
            $pageObject->setParentId($this->parentObject->getId());
            $pageObject->setId($this->parentObject->getId());
            $pageObject->setLanguage($language);
            $pageObject->createFromXML();
        }
    }

    protected function setBackLinkTab(): void
    {
        $backUrl = $this->ctrl->getLinkTargetByClass(ilContentPagePageGUI::class, self::UI_CMD_COPAGE_EDIT);
        if ($this->backUrl !== '') {
            $backUrlParts = parse_url(ilUtil::stripSlashes($this->backUrl));

            $script = basename($backUrlParts['path']);

            $backUrl = './' . implode('?', [
                $script, $backUrlParts['query']
            ]);
        }

        $this->tabs->setBackTarget($this->lng->txt('back'), $backUrl);
    }

    protected function buildEditingPageObjectGUI(string $language): ilContentPagePageGUI
    {
        $this->tabs->clearTargets();

        $this->setBackLinkTab();

        $this->ensurePageObjectExists($language);

        $pageObjectGUI = $this->getPageObjectGUI($language);
        $pageObjectGUI->setEnabledTabs(true);

        $page = $pageObjectGUI->getPageObject();
        $page->addUpdateListener($this, 'onPageUpdate', ['page' => $page]);

        $pageObjectGUI->setTabHook($this, 'addPageTabs');

        return $pageObjectGUI;
    }

    protected function buildPresentationPageObjectGUI(string $language): ilContentPagePageGUI
    {
        $this->ensurePageObjectExists($language);

        $pageObjectGUI = $this->getPageObjectGUI($language);
        $pageObjectGUI->setEnabledTabs(false);

        $pageObjectGUI->setStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );

        return $pageObjectGUI;
    }

    protected function buildPreviewPageObjectGUI(string $language): ilContentPagePageGUI
    {
        $this->ensurePageObjectExists($language);

        $pageObjectGUI = $this->getPageObjectGUI($language);

        $pageObjectGUI->setStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );

        $pageObjectGUI->setTabHook($this, 'addPageTabs');

        return $pageObjectGUI;
    }

    protected function buildEmbeddedPresentationPageObjectGUI(string $language): ilContentPagePageGUI
    {
        $this->ensurePageObjectExists($language);

        $pageObjectGUI = $this->getPageObjectGUI($language, true);
        $pageObjectGUI->setEnabledTabs(false);

        $pageObjectGUI->setStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );

        return $pageObjectGUI;
    }

    public function setPresentationMode(string $presentationMode): void
    {
        $this->presentationMode = $presentationMode;
    }

    public function forward(string $ctrlLink = ''): string
    {
        $language = $this->translation->getEffectiveCOPageLang($this->actor->getCurrentLanguage(), $this->parentObject->getType());

        switch ($this->presentationMode) {
            case self::PRESENTATION_MODE_EDITING:

                $pageObjectGui = $this->buildEditingPageObjectGUI($this->isMediaRequest ? $language : '');
                return (string) $this->ctrl->forwardCommand($pageObjectGui);

            case self::PRESENTATION_MODE_PREVIEW:
                $pageObjectGui = $this->buildPreviewPageObjectGUI($this->isMediaRequest ? $language : '');
                return $this->ctrl->getHTML($pageObjectGui);

            case self::PRESENTATION_MODE_PRESENTATION:
                $pageObjectGUI = $this->buildPresentationPageObjectGUI($language);

                if (is_string($ctrlLink) && $ctrlLink !== '') {
                    $pageObjectGUI->setFileDownloadLink($ctrlLink . '&cmd=' . self::UI_CMD_COPAGE_DOWNLOAD_FILE);
                    $pageObjectGUI->setFullscreenLink($ctrlLink . '&cmd=' . self::UI_CMD_COPAGE_DISPLAY_FULLSCREEN);
                    $pageObjectGUI->setSourcecodeDownloadScript($ctrlLink . '&cmd=' . self::UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH);
                }

                return $this->ctrl->getHTML($pageObjectGUI);

            case self::PRESENTATION_MODE_EMBEDDED_PRESENTATION:
                $pageObjectGUI = $this->buildEmbeddedPresentationPageObjectGUI($language);

                if (is_string($ctrlLink) && $ctrlLink !== '') {
                    $pageObjectGUI->setFileDownloadLink($ctrlLink . '&cmd=' . self::UI_CMD_COPAGE_DOWNLOAD_FILE);
                    $pageObjectGUI->setFullscreenLink($ctrlLink . '&cmd=' . self::UI_CMD_COPAGE_DISPLAY_FULLSCREEN);
                    $pageObjectGUI->setSourcecodeDownloadScript($ctrlLink . '&cmd=' . self::UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH);
                }

                return $pageObjectGUI->getHTML();

            default:
                throw new ilException('Unknown presentation mode given');
        }
    }
}