class.ilContentPagePageCommandForwarder.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */

use Psr\Http\Message\ServerRequestInterface;
use ILIAS\ContentPage\PageMetrics\Event\PageUpdatedEvent;

class ilContentPagePageCommandForwarder implements ilContentPageObjectConstants
{
    const PRESENTATION_MODE_EDITING = 'PRESENTATION_MODE_EDITING';

    const PRESENTATION_MODE_PRESENTATION = 'PRESENTATION_MODE_PRESENTATION';

    const PRESENTATION_MODE_EMBEDDED_PRESENTATION = 'PRESENTATION_MODE_EMBEDDED_PRESENTATION';
    public const PRESENTATION_MODE_PREVIEW = 'PRESENTATION_MODE_PREVIEW';

    protected $presentationMode = self::PRESENTATION_MODE_EDITING;
    protected $ctrl;
    protected $lng;
    protected $tabs;
    protected $parentObject;
    protected $backUrl = '';
    protected $actor;
    protected $updateListeners = [];
    protected $isMediaRequest = false;

    public function __construct(
        ServerRequestInterface $request,
        ilCtrl $ctrl,
        ilTabsGUI $tabs,
        ilLanguage $lng,
        ilObjContentPage $parentObject,
        ilObjUser $actor
    ) {
        $this->ctrl = $ctrl;
        $this->tabs = $tabs;
        $this->lng = $lng;
        $this->parentObject = $parentObject;
        $this->actor = $actor;

        $this->lng->loadLanguageModule('content');

        $this->backUrl = $request->getQueryParams()['backurl'] ?? '';

        if (strlen($this->backUrl) > 0) {
            $this->ctrl->setParameterByClass('ilcontentpagepagegui', 'backurl', rawurlencode($this->backUrl));
        }
    }

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

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

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

    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(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );

        $pageObjectGUI->obj->addUpdateListener($this->parentObject, 'update');

        return $pageObjectGUI;
    }

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

    protected function ensurePageObjectExists(string $language)
    {
        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 (strlen($this->backUrl) > 0) {
            $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(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );

        return $pageObjectGUI;
    }

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

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

        $pageObjectGUI->setStyleId(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );

        $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(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );

        return $pageObjectGUI;
    }

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

    public function forward(string $ctrlLink = '') : string
    {
        $ot = ilObjectTranslation::getInstance($this->parentObject->getId());
        $language = $ot->getEffectiveContentLang($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 (string) $this->ctrl->getHTML($pageObjectGui);

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

                if (is_string($ctrlLink) && strlen($ctrlLink) > 0) {
                    $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) && strlen($ctrlLink) > 0) {
                    $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');
        }
    }
}