Class ilContentPagePageCommandForwarder. More...

Inheritance diagram for ilContentPagePageCommandForwarder:

Collaboration diagram for ilContentPagePageCommandForwarder:

Public Member Functions
	__construct (\Psr\Http\Message\ServerRequestInterface $request, \ilCtrl $ctrl, \ilTabsGUI $tabs, \ilLanguage $lng, \ilObjContentPage $parentObject)
	ilContentPagePageCommandForwarder constructor. More...

	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...

Data Fields inherited from ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'

const	UI_CMD_VIEW = 'view'

const	UI_CMD_EDIT = 'edit'

const	UI_CMD_UPDATE = 'update'

const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'

const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'

const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

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_LP = 'learning_progress'

const	UI_TAB_ID_EXPORT = 'export'

const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Protected Member Functions
	getPageObjectGUI ($isEmbedded=false)

	ensurePageObjectExists ()

	setBackLinkTab ()

	buildEditingPageObjectGUI ()

	buildPresentationPageObjectGUI ()

	buildEmbeddedPresentationPageObjectGUI ()

Protected Attributes
	$presentationMode = self::PRESENTATION_MODE_EDITING

	$ctrl

	$lng

	$tabs

	$parentObject

	$backUrl = ''

Detailed Description

Class ilContentPagePageCommandForwarder.

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

Constructor & Destructor Documentation

◆ __construct()

ilContentPagePageCommandForwarder::__construct	(	\Psr\Http\Message\ServerRequestInterface	$request,
		\ilCtrl	$ctrl,
		\ilTabsGUI	$tabs,
		\ilLanguage	$lng,
		\ilObjContentPage	$parentObject
	)

ilContentPagePageCommandForwarder constructor.

Parameters

\Psr\Http\Message\ServerRequestInterface	$request
\ilCtrl	$ctrl
\ilTabsGUI	$tabs
\ilLanguage	$lng
\ilObjContentPage	$parentObject

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

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

       {
         $this->ctrl = $ctrl;
         $this->tabs = $tabs;
         $this->lng = $lng;
         $this->parentObject = $parentObject;
 
         $this->lng->loadLanguageModule('content');
 
         $this->backUrl = $request->getQueryParams()['backurl'] ?? '';
 
         if (strlen($this->backUrl) > 0) {
             $this->ctrl->setParameterByClass('ilcontentpagepagegui', 'backurl', rawurlencode($this->backUrl));
         }
     }

Member Function Documentation

◆ buildEditingPageObjectGUI()

ilContentPagePageCommandForwarder::buildEditingPageObjectGUI ( )

protected

Returns

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

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

Referenced by forward().

                                                    : \ilContentPagePageGUI
     {
         $this->tabs->clearTargets();
 
         $this->setBackLinkTab();
 
         $this->ensurePageObjectExists();
 
         $pageObjectGUI = $this->getPageObjectGUI();
         $pageObjectGUI->setEnabledTabs(true);
 
         return $pageObjectGUI;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildEmbeddedPresentationPageObjectGUI()

ilContentPagePageCommandForwarder::buildEmbeddedPresentationPageObjectGUI ( )

protected

Returns

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

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

Referenced by forward().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPresentationPageObjectGUI()

ilContentPagePageCommandForwarder::buildPresentationPageObjectGUI ( )

protected

Returns

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

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

Referenced by forward().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensurePageObjectExists()

ilContentPagePageCommandForwarder::ensurePageObjectExists ( )

protected

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

References ilPageObject\_exists().

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

     {
         if (!\ilContentPagePage::_exists($this->parentObject->getType(), $this->parentObject->getId())) {
             $pageObject = new \ilContentPagePage();
             $pageObject->setParentId($this->parentObject->getId());
             $pageObject->setId($this->parentObject->getId());
             $pageObject->createFromXML();
         }
     }

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 205 of file class.ilContentPagePageCommandForwarder.php.

References buildEditingPageObjectGUI(), buildEmbeddedPresentationPageObjectGUI(), and buildPresentationPageObjectGUI().

                                                    : string
     {
         switch ($this->presentationMode) {
             case self::PRESENTATION_MODE_EDITING:
 
                 $pageObjectGui = $this->buildEditingPageObjectGUI();
                 return (string) $this->ctrl->forwardCommand($pageObjectGui);
 
             case self::PRESENTATION_MODE_PRESENTATION:
                 $pageObjectGUI = $this->buildPresentationPageObjectGUI();
 
                 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();
 
                 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');
                 break;
         }
     }

Here is the call graph for this function:

◆ getPageObjectGUI()

ilContentPagePageCommandForwarder::getPageObjectGUI ( $isEmbedded = false )

protected

Parameters

bool $isEmbedded

Returns

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

References ilObjStyleSheet\getEffectiveContentStyleId(), and ilPageObjectGUI\setStyleId().

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

                                                              : \ilContentPagePageGUI
     {
         $pageObjectGUI = new \ilContentPagePageGUI($this->parentObject->getId(), 0, $isEmbedded);
         $pageObjectGUI->setStyleId(
             \ilObjStyleSheet::getEffectiveContentStyleId(
                 $this->parentObject->getStyleSheetId(),
                 $this->parentObject->getType()
             )
         );
 
         $pageObjectGUI->obj->addUpdateListener($this->parentObject, 'update');
 
         return $pageObjectGUI;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBackLinkTab()

ilContentPagePageCommandForwarder::setBackLinkTab ( )

protected

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

References $backUrl, and ilUtil\stripSlashes().

Referenced by buildEditingPageObjectGUI().

     {
         $backUrl = $this->ctrl->getLinkTargetByClass('ilObjContentPageGUI', self::UI_CMD_VIEW);
         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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPresentationMode()

ilContentPagePageCommandForwarder::setPresentationMode ( string $presentationMode )

Parameters

string $presentationMode

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

References $presentationMode.

     {
         $this->presentationMode = $presentationMode;
     }

Field Documentation

◆ $backUrl

ilContentPagePageCommandForwarder::$backUrl = ''

protected

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

Referenced by setBackLinkTab().

◆ $ctrl

ilContentPagePageCommandForwarder::$ctrl

protected

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

Referenced by __construct().

◆ $lng

ilContentPagePageCommandForwarder::$lng

protected

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

Referenced by __construct().

◆ $parentObject

ilContentPagePageCommandForwarder::$parentObject

protected

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

Referenced by __construct().

◆ $presentationMode

ilContentPagePageCommandForwarder::$presentationMode = self::PRESENTATION_MODE_EDITING

protected

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

Referenced by setPresentationMode().

◆ $tabs

ilContentPagePageCommandForwarder::$tabs

protected

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

Referenced by __construct().

◆ PRESENTATION_MODE_EDITING

const ilContentPagePageCommandForwarder::PRESENTATION_MODE_EDITING = 'PRESENTATION_MODE_EDITING'

presentation mode for authoring

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

◆ 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 22 of file class.ilContentPagePageCommandForwarder.php.

Referenced by ilContentPageKioskModeView\render().

◆ PRESENTATION_MODE_PRESENTATION

const ilContentPagePageCommandForwarder::PRESENTATION_MODE_PRESENTATION = 'PRESENTATION_MODE_PRESENTATION'

presentation mode for requesting

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

Referenced by ilObjContentPageGUI\getContent().

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

◆ buildEditingPageObjectGUI()

◆ buildEmbeddedPresentationPageObjectGUI()

◆ buildPresentationPageObjectGUI()

◆ ensurePageObjectExists()

◆ forward()

◆ getPageObjectGUI()

◆ setBackLinkTab()

◆ setPresentationMode()

Field Documentation

◆ $backUrl

◆ $ctrl

◆ $lng

◆ $parentObject

◆ $presentationMode

◆ $tabs

◆ PRESENTATION_MODE_EDITING

◆ PRESENTATION_MODE_EMBEDDED_PRESENTATION

◆ PRESENTATION_MODE_PRESENTATION