Class ilContentPagePageCommandForwarder. More...

Inheritance diagram for ilContentPagePageCommandForwarder:

Collaboration diagram for ilContentPagePageCommandForwarder:

Public Member Functions
	__construct (ServerRequestInterface $request, ilCtrl $ctrl, ilTabsGUI $tabs, ilLanguage $lng, ilObjContentPage $parentObject, ilObjUser $actor)
	ilContentPagePageCommandForwarder constructor. More...

	setIsMediaRequest (bool $isMediaRequest)

	onPageUpdate (array $parameters)

	addPageTabs ()

	addUpdateListener (callable $updateListener)

	setPresentationMode (string $presentationMode)

	forward (string $ctrlLink='')

Data Fields
const	PRESENTATION_MODE_EDITING = 'PRESENTATION_MODE_EDITING'
	presentation mode for authoring More...

const	PRESENTATION_MODE_PRESENTATION = 'PRESENTATION_MODE_PRESENTATION'
	presentation mode for requesting More...

const	PRESENTATION_MODE_EMBEDDED_PRESENTATION = 'PRESENTATION_MODE_EMBEDDED_PRESENTATION'
	presentation mode for embedded presentation, e.g. More...

const	PRESENTATION_MODE_PREVIEW = 'PRESENTATION_MODE_PREVIEW'

Data Fields inherited from ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'

const	HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT = 'page_editor_style'

const	UI_CMD_VIEW = 'view'

const	UI_CMD_EDIT = 'edit'

const	UI_CMD_UPDATE = 'update'

const	UI_CMD_COPAGE_EDIT = 'edit'

const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'

const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'

const	UI_CMD_COPAGE_DISPLAY_MEDIA = 'displayMedia'

const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

const	UI_CMD_STYLES_EDIT = 'editStyleProperties'

const	UI_TAB_ID_CONTENT = 'content'

const	UI_TAB_ID_INFO = 'info_short'

const	UI_TAB_ID_SETTINGS = 'settings'

const	UI_TAB_ID_ICON = 'icon'

const	UI_TAB_ID_STYLE = 'style'

const	UI_TAB_ID_I18N = 'i18n'

const	UI_TAB_ID_LP = 'learning_progress'

const	UI_TAB_ID_EXPORT = 'export'

const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Protected Member Functions
	getPageObjectGUI (string $language, bool $isEmbedded=false)

	doesPageExistsForLanguage (string $language)

	ensurePageObjectExists (string $language)

	setBackLinkTab ()

	buildEditingPageObjectGUI (string $language)

	buildPresentationPageObjectGUI (string $language)

	buildPreviewPageObjectGUI (string $language)

	buildEmbeddedPresentationPageObjectGUI (string $language)

Protected Attributes
	$presentationMode = self::PRESENTATION_MODE_EDITING

	$ctrl

	$lng

	$tabs

	$parentObject

	$backUrl = ''

	$actor

	$updateListeners = []

	$isMediaRequest = false

Detailed Description

Class ilContentPagePageCommandForwarder.

Definition at line 10 of file class.ilContentPagePageCommandForwarder.php.

Constructor & Destructor Documentation

◆ __construct()

ilContentPagePageCommandForwarder::__construct	(	ServerRequestInterface	$request,
		ilCtrl	$ctrl,
		ilTabsGUI	$tabs,
		ilLanguage	$lng,
		ilObjContentPage	$parentObject,
		ilObjUser	$actor
	)

ilContentPagePageCommandForwarder constructor.

Parameters

ServerRequestInterface	$request
ilCtrl	$ctrl
ilTabsGUI	$tabs
ilLanguage	$lng
ilObjContentPage	$parentObject
ilObjUser	$actor

Definition at line 55 of file class.ilContentPagePageCommandForwarder.php.

      {
        $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));
        }
    }

References $actor, $ctrl, $lng, $parentObject, and $tabs.

Member Function Documentation

◆ addPageTabs()

ilContentPagePageCommandForwarder::addPageTabs ( )

Definition at line 98 of file class.ilContentPagePageCommandForwarder.php.

                                  : 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);
    }

◆ addUpdateListener()

ilContentPagePageCommandForwarder::addUpdateListener ( callable $updateListener )

Parameters

callable $updateListener

Definition at line 115 of file class.ilContentPagePageCommandForwarder.php.

                                                                : void
    {
        $this->updateListeners[] = $updateListener;
    }

◆ buildEditingPageObjectGUI()

ilContentPagePageCommandForwarder::buildEditingPageObjectGUI ( string $language )

protected

Parameters

string $language

Returns: ilContentPagePageGUI

Definition at line 186 of file class.ilContentPagePageCommandForwarder.php.

                                                                   : 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;
    }

References ensurePageObjectExists(), getPageObjectGUI(), and setBackLinkTab().

Referenced by forward().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildEmbeddedPresentationPageObjectGUI()

ilContentPagePageCommandForwarder::buildEmbeddedPresentationPageObjectGUI ( string $language )

protected

Parameters

string $language

Returns: ilContentPagePageGUI

Definition at line 248 of file class.ilContentPagePageCommandForwarder.php.

                                                                                : ilContentPagePageGUI
    {
        $this->ensurePageObjectExists($language);
 
        $pageObjectGUI = $this->getPageObjectGUI($language, true);
        $pageObjectGUI->setEnabledTabs(false);
 
        $pageObjectGUI->setStyleId(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );
 
        return $pageObjectGUI;
    }

References ensurePageObjectExists(), ilObjStyleSheet\getEffectiveContentStyleId(), and getPageObjectGUI().

Referenced by forward().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPresentationPageObjectGUI()

ilContentPagePageCommandForwarder::buildPresentationPageObjectGUI ( string $language )

protected

Parameters

string $language

Returns: ilContentPagePageGUI

Definition at line 209 of file class.ilContentPagePageCommandForwarder.php.

                                                                        : ilContentPagePageGUI
    {
        $this->ensurePageObjectExists($language);
 
        $pageObjectGUI = $this->getPageObjectGUI($language);
        $pageObjectGUI->setEnabledTabs(false);
 
        $pageObjectGUI->setStyleId(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );
 
        return $pageObjectGUI;
    }

References ensurePageObjectExists(), ilObjStyleSheet\getEffectiveContentStyleId(), and getPageObjectGUI().

Referenced by forward().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPreviewPageObjectGUI()

ilContentPagePageCommandForwarder::buildPreviewPageObjectGUI ( string $language )

protected

Definition at line 226 of file class.ilContentPagePageCommandForwarder.php.

                                                                   : ilContentPagePageGUI
    {
        $this->ensurePageObjectExists($language);
 
        $pageObjectGUI = $this->getPageObjectGUI($language);
 
        $pageObjectGUI->setStyleId(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->parentObject->getStyleSheetId(),
                $this->parentObject->getType()
            )
        );
 
        $pageObjectGUI->setTabHook($this, 'addPageTabs');
 
        return $pageObjectGUI;
    }

References ensurePageObjectExists(), ilObjStyleSheet\getEffectiveContentStyleId(), and getPageObjectGUI().

Referenced by forward().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doesPageExistsForLanguage()

ilContentPagePageCommandForwarder::doesPageExistsForLanguage ( string $language )

protected

Parameters

string $language

Returns: bool|mixed

Definition at line 144 of file class.ilContentPagePageCommandForwarder.php.

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

References ilPageObject\_exists().

Referenced by ensurePageObjectExists().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensurePageObjectExists()

ilContentPagePageCommandForwarder::ensurePageObjectExists ( string $language )

protected

Parameters

string $language

Definition at line 152 of file class.ilContentPagePageCommandForwarder.php.

    {
        if (!$this->doesPageExistsForLanguage($language)) {
            $pageObject = new ilContentPagePage();
            $pageObject->setParentId($this->parentObject->getId());
            $pageObject->setId($this->parentObject->getId());
            $pageObject->setLanguage($language);
            $pageObject->createFromXML();
        }
    }

References doesPageExistsForLanguage().

Referenced by buildEditingPageObjectGUI(), buildEmbeddedPresentationPageObjectGUI(), buildPresentationPageObjectGUI(), and buildPreviewPageObjectGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forward()

ilContentPagePageCommandForwarder::forward ( string $ctrlLink = '' )

Parameters

string $ctrlLink

Returns: string

Exceptions

ilCtrlException
ilException

Definition at line 279 of file class.ilContentPagePageCommandForwarder.php.

                                                   : 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');
        }
    }

References buildEditingPageObjectGUI(), buildEmbeddedPresentationPageObjectGUI(), buildPresentationPageObjectGUI(), buildPreviewPageObjectGUI(), ilObjectTranslation\getInstance(), PRESENTATION_MODE_EDITING, PRESENTATION_MODE_EMBEDDED_PRESENTATION, PRESENTATION_MODE_PRESENTATION, and PRESENTATION_MODE_PREVIEW.

Here is the call graph for this function:

◆ getPageObjectGUI()

ilContentPagePageCommandForwarder::getPageObjectGUI	(	string	$language,
		bool	$isEmbedded = `false`
	)

protected

Parameters

string	$language
bool	$isEmbedded

Returns: ilContentPagePageGUI

Definition at line 125 of file class.ilContentPagePageCommandForwarder.php.

                                                                                    : 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;
    }

References ilObjStyleSheet\getEffectiveContentStyleId().

Referenced by buildEditingPageObjectGUI(), buildEmbeddedPresentationPageObjectGUI(), buildPresentationPageObjectGUI(), and buildPreviewPageObjectGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onPageUpdate()

ilContentPagePageCommandForwarder::onPageUpdate ( array $parameters )

Parameters

array<string,mixed> $parameters

Definition at line 86 of file class.ilContentPagePageCommandForwarder.php.

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

◆ setBackLinkTab()

ilContentPagePageCommandForwarder::setBackLinkTab ( )

protected

Definition at line 166 of file class.ilContentPagePageCommandForwarder.php.

                                        : 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);
    }

References $backUrl, and ilUtil\stripSlashes().

Referenced by buildEditingPageObjectGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsMediaRequest()

ilContentPagePageCommandForwarder::setIsMediaRequest ( bool $isMediaRequest )

Definition at line 78 of file class.ilContentPagePageCommandForwarder.php.

                                                            : void
    {
        $this->isMediaRequest = $isMediaRequest;
    }

References $isMediaRequest.

◆ setPresentationMode()

ilContentPagePageCommandForwarder::setPresentationMode ( string $presentationMode )

Parameters

string $presentationMode

Definition at line 268 of file class.ilContentPagePageCommandForwarder.php.

                                                                  : void
    {
        $this->presentationMode = $presentationMode;
    }

References $presentationMode.

Field Documentation

◆ $actor

ilContentPagePageCommandForwarder::$actor

protected

Definition at line 41 of file class.ilContentPagePageCommandForwarder.php.

Referenced by __construct().

◆ $backUrl

ilContentPagePageCommandForwarder::$backUrl = ''

protected

Definition at line 39 of file class.ilContentPagePageCommandForwarder.php.

Referenced by setBackLinkTab().

◆ $ctrl

ilContentPagePageCommandForwarder::$ctrl

protected

Definition at line 31 of file class.ilContentPagePageCommandForwarder.php.

Referenced by __construct().

◆ $isMediaRequest

ilContentPagePageCommandForwarder::$isMediaRequest = false

protected

Definition at line 44 of file class.ilContentPagePageCommandForwarder.php.

Referenced by setIsMediaRequest().

◆ $lng

ilContentPagePageCommandForwarder::$lng

protected

Definition at line 33 of file class.ilContentPagePageCommandForwarder.php.

Referenced by __construct().

◆ $parentObject

ilContentPagePageCommandForwarder::$parentObject

protected

Definition at line 37 of file class.ilContentPagePageCommandForwarder.php.

Referenced by __construct().

◆ $presentationMode

ilContentPagePageCommandForwarder::$presentationMode = self::PRESENTATION_MODE_EDITING

protected

Definition at line 29 of file class.ilContentPagePageCommandForwarder.php.

Referenced by setPresentationMode().

◆ $tabs

ilContentPagePageCommandForwarder::$tabs

protected

Definition at line 35 of file class.ilContentPagePageCommandForwarder.php.

Referenced by __construct().

◆ $updateListeners

ilContentPagePageCommandForwarder::$updateListeners = []

protected

Definition at line 43 of file class.ilContentPagePageCommandForwarder.php.

◆ PRESENTATION_MODE_EDITING

const ilContentPagePageCommandForwarder::PRESENTATION_MODE_EDITING = 'PRESENTATION_MODE_EDITING'

presentation mode for authoring

Definition at line 15 of file class.ilContentPagePageCommandForwarder.php.

Referenced by forward().

◆ PRESENTATION_MODE_EMBEDDED_PRESENTATION

const ilContentPagePageCommandForwarder::PRESENTATION_MODE_EMBEDDED_PRESENTATION = 'PRESENTATION_MODE_EMBEDDED_PRESENTATION'

presentation mode for embedded presentation, e.g.

in a kiosk mode

Definition at line 25 of file class.ilContentPagePageCommandForwarder.php.

Referenced by forward().

◆ PRESENTATION_MODE_PRESENTATION

const ilContentPagePageCommandForwarder::PRESENTATION_MODE_PRESENTATION = 'PRESENTATION_MODE_PRESENTATION'

presentation mode for requesting

Definition at line 20 of file class.ilContentPagePageCommandForwarder.php.

Referenced by forward(), and ilObjContentPageGUI\getContent().

◆ PRESENTATION_MODE_PREVIEW

const ilContentPagePageCommandForwarder::PRESENTATION_MODE_PREVIEW = 'PRESENTATION_MODE_PREVIEW'

Definition at line 26 of file class.ilContentPagePageCommandForwarder.php.

Referenced by ilObjContentPageGUI\editStyleProperties(), and forward().

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

Modules/ContentPage/classes/class.ilContentPagePageCommandForwarder.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPageTabs()

◆ addUpdateListener()

◆ buildEditingPageObjectGUI()

◆ buildEmbeddedPresentationPageObjectGUI()

◆ buildPresentationPageObjectGUI()

◆ buildPreviewPageObjectGUI()

◆ doesPageExistsForLanguage()

◆ ensurePageObjectExists()

◆ forward()

◆ getPageObjectGUI()

◆ onPageUpdate()

◆ setBackLinkTab()

◆ setIsMediaRequest()

◆ setPresentationMode()

Field Documentation

◆ $actor

◆ $backUrl

◆ $ctrl

◆ $isMediaRequest

◆ $lng

◆ $parentObject

◆ $presentationMode

◆ $tabs

◆ $updateListeners

◆ PRESENTATION_MODE_EDITING

◆ PRESENTATION_MODE_EMBEDDED_PRESENTATION

◆ PRESENTATION_MODE_PRESENTATION

◆ PRESENTATION_MODE_PREVIEW