ilForumPageCommandForwarder Class Reference

Inheritance diagram for ilForumPageCommandForwarder:

Collaboration diagram for ilForumPageCommandForwarder:

Public Member Functions
	__construct (protected GlobalHttpState $http, protected ilCtrlInterface $ctrl, protected ilTabsGUI $tabs, protected ilLanguage $lng, protected ilObjForum $parentObject, protected ilObjUser $actor, protected ObjectFacade $content_style_domain)
	onPageUpdate (array $parameters)
	updateForumOnPageUpdate (array $parameters)
	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	DEFAULT_LANGUAGE = '-'
Data Fields inherited from ilForumObjectConstants
const	OBJ_TYPE = 'frm'
const	UI_TAB_ID_INFO = 'info_short'
const	UI_TAB_ID_SETTINGS = 'settings'
const	UI_TAB_ID_MODERATORS = 'frm_moderators'
const	UI_TAB_ID_THREADS = 'forums_threads'
const	UI_TAB_ID_STATS = 'frm_statistics'
const	UI_TAB_ID_EXPORT = 'export'
const	UI_TAB_ID_PERMISSIONS = 'perm_settings'
const	UI_SUB_TAB_ID_BASIC_SETTINGS = 'general'
const	UI_SUB_TAB_ID_NOTIFICATIONS = 'notifications'
const	UI_SUB_TAB_ID_NEWS = 'cont_news_settings'
const	UI_SUB_TAB_ID_STYLE = 'cont_style'
const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'
const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'
const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

Protected Member Functions
	getPageObjectGUI (string $language, bool $isEmbedded=false)
	doesPageExistsForLanguage (string $language)
	ensurePageObjectExists (string $language)
	setBackLinkTab ()
	buildEditingPageObjectGUI (string $language)
	buildPresentationPageObjectGUI (string $language)
	buildEmbeddedPresentationPageObjectGUI (string $language)

Protected Attributes
string	$presentationMode = self::PRESENTATION_MODE_EDITING
string	$backUrl = ''

Detailed Description

Definition at line 24 of file class.ilForumPageCommandForwarder.php.

Constructor & Destructor Documentation

__construct()

ilForumPageCommandForwarder::__construct	(	protected GlobalHttpState	$http,
		protected ilCtrlInterface	$ctrl,
		protected ilTabsGUI	$tabs,
		protected ilLanguage	$lng,
		protected ilObjForum	$parentObject,
		protected ilObjUser	$actor,
		protected ObjectFacade	$content_style_domain
	)

Definition at line 45 of file class.ilForumPageCommandForwarder.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

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

        $this->backUrl = '';
        if (isset($this->http->request()->getQueryParams()['backurl'])) {
            $this->backUrl = $this->http->request()->getQueryParams()['backurl'];
        }

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

Here is the call graph for this function:

Member Function Documentation

buildEditingPageObjectGUI()

ilForumPageCommandForwarder::buildEditingPageObjectGUI ( string  $language )

protected

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

References ensurePageObjectExists(), getPageObjectGUI(), setBackLinkTab(), and ILIAS\Repository\tabs().

Referenced by forward().

                                                                  : ilForumPageGUI
    {
        $this->tabs->clearTargets();

        $this->setBackLinkTab();

        $this->ensurePageObjectExists($language);

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

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

        return $pageObjectGUI;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildEmbeddedPresentationPageObjectGUI()

ilForumPageCommandForwarder::buildEmbeddedPresentationPageObjectGUI ( string  $language )

protected

Definition at line 155 of file class.ilForumPageCommandForwarder.php.

References ensurePageObjectExists(), and getPageObjectGUI().

Referenced by forward().

                                                                               : ilForumPageGUI
    {
        $this->ensurePageObjectExists($language);

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

        return $pageObjectGUI;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPresentationPageObjectGUI()

ilForumPageCommandForwarder::buildPresentationPageObjectGUI ( string  $language )

protected

Definition at line 142 of file class.ilForumPageCommandForwarder.php.

References ensurePageObjectExists(), and getPageObjectGUI().

Referenced by forward().

                                                                       : ilForumPageGUI
    {
        $this->ensurePageObjectExists($language);

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

        return $pageObjectGUI;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doesPageExistsForLanguage()

ilForumPageCommandForwarder::doesPageExistsForLanguage ( string  $language )

protected

Definition at line 93 of file class.ilForumPageCommandForwarder.php.

References ilPageObject\_exists().

Referenced by ensurePageObjectExists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ensurePageObjectExists()

ilForumPageCommandForwarder::ensurePageObjectExists ( string  $language )

protected

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

References doesPageExistsForLanguage().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

forward()

ilForumPageCommandForwarder::forward

(

string

$ctrlLink = ''

)

Exceptions

ilCtrlException
ilException

Definition at line 177 of file class.ilForumPageCommandForwarder.php.

References buildEditingPageObjectGUI(), buildEmbeddedPresentationPageObjectGUI(), buildPresentationPageObjectGUI(), and ILIAS\Repository\ctrl().

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

                $pageObjectGui = $this->buildEditingPageObjectGUI(self::DEFAULT_LANGUAGE);
                return (string) $this->ctrl->forwardCommand($pageObjectGui);

            case self::PRESENTATION_MODE_PRESENTATION:
                $pageObjectGUI = $this->buildPresentationPageObjectGUI(self::DEFAULT_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(self::DEFAULT_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');
        }
    }

Here is the call graph for this function:

getPageObjectGUI()

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

protected

Definition at line 81 of file class.ilForumPageCommandForwarder.php.

References ilPageObjectGUI\setStyleId().

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

                                                                                   : ilForumPageGUI
    {
        $pageObjectGUI = new ilForumPageGUI($this->parentObject->getId(), 0, $isEmbedded, $language);
        $pageObjectGUI->setStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );

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

        return $pageObjectGUI;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

onPageUpdate()

ilForumPageCommandForwarder::onPageUpdate

(

array

$parameters

)

Parameters

array<string,mixed>

$parameters

Definition at line 69 of file class.ilForumPageCommandForwarder.php.

                                                   : void
    {
    }

setBackLinkTab()

ilForumPageCommandForwarder::setBackLinkTab ( )

protected

Definition at line 109 of file class.ilForumPageCommandForwarder.php.

References $backUrl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilUtil\stripSlashes(), and ILIAS\Repository\tabs().

Referenced by buildEditingPageObjectGUI().

                                       : void
    {
        $backUrl = $this->ctrl->getLinkTargetByClass(ilObjForumGUI::class, 'showThreads');
        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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPresentationMode()

ilForumPageCommandForwarder::setPresentationMode

(

string

$presentationMode

)

Definition at line 168 of file class.ilForumPageCommandForwarder.php.

References $presentationMode.

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

updateForumOnPageUpdate()

ilForumPageCommandForwarder::updateForumOnPageUpdate

(

array

$parameters

)

Parameters

array<string,mixed>

$parameters

Definition at line 76 of file class.ilForumPageCommandForwarder.php.

                                                              : void
    {
        $this->parentObject->update();
    }

Field Documentation

$backUrl

string ilForumPageCommandForwarder::$backUrl = ''

protected

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

Referenced by setBackLinkTab().

$presentationMode

string ilForumPageCommandForwarder::$presentationMode = self::PRESENTATION_MODE_EDITING

protected

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

Referenced by setPresentationMode().

DEFAULT_LANGUAGE

const ilForumPageCommandForwarder::DEFAULT_LANGUAGE = '-'

Definition at line 40 of file class.ilForumPageCommandForwarder.php.

PRESENTATION_MODE_EDITING

const ilForumPageCommandForwarder::PRESENTATION_MODE_EDITING = 'PRESENTATION_MODE_EDITING'

presentation mode for authoring

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

PRESENTATION_MODE_EMBEDDED_PRESENTATION

const ilForumPageCommandForwarder::PRESENTATION_MODE_EMBEDDED_PRESENTATION = 'PRESENTATION_MODE_EMBEDDED_PRESENTATION'

presentation mode for embedded presentation, e.g.

in a kiosk mode

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

PRESENTATION_MODE_PRESENTATION

const ilForumPageCommandForwarder::PRESENTATION_MODE_PRESENTATION = 'PRESENTATION_MODE_PRESENTATION'

presentation mode for requesting

Definition at line 34 of file class.ilForumPageCommandForwarder.php.

Referenced by ilObjForumGUI\renderThreadOverview().

---

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

• components/ILIAS/Forum/classes/CoPage/class.ilForumPageCommandForwarder.php