class.ilAssQuestionHintPageObjectCommandForwarder.php

Go to the documentation of this file.

<?php

class ilAssQuestionHintPageObjectCommandForwarder extends ilAssQuestionAbstractPageObjectCommandForwarder
{
    public const PRESENTATION_MODE_AUTHOR = 'PRESENTATION_MODE_AUTHOR';

    public const PRESENTATION_MODE_PREVIEW = 'PRESENTATION_MODE_PREVIEW';

    public const PRESENTATION_MODE_REQUEST = 'PRESENTATION_MODE_REQUEST';

    protected $presentationMode;

    protected $questionHint;

    public function __construct(assQuestion $questionOBJ, ilCtrl $ctrl, ilTabsGUI $tabs, ilLanguage $lng)
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
        parent::__construct($questionOBJ, $ctrl, $tabs, $lng);

        $this->questionHint = new ilAssQuestionHint();

        if (!$this->request->isset('hint_id') || !(int) $this->request->raw('hint_id') || !$this->questionHint->load((int) $this->request->raw('hint_id'))) {
            $main_tpl->setOnScreenMessage('failure', 'invalid hint id given: ' . (int) $this->request->raw('hint_id'), true);
            $this->ctrl->redirectByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST);
        }
    }

    public function forward(): void
    {
        switch ($this->getPresentationMode()) {
            case self::PRESENTATION_MODE_AUTHOR:

                $pageObjectGUI = $this->buildAuthorPresentationPageObjectGUI();
                break;

            case self::PRESENTATION_MODE_PREVIEW:

                $pageObjectGUI = $this->buildPreviewPresentationPageObjectGUI();
                break;

            case self::PRESENTATION_MODE_REQUEST:

                $pageObjectGUI = $this->buildRequestPresentationPageObjectGUI();
                break;
        }

        $this->ctrl->setParameter($pageObjectGUI, 'hint_id', $this->questionHint->getId());

        $this->ctrl->forwardCommand($pageObjectGUI);
    }

    private function buildPreviewPresentationPageObjectGUI(): ilAssHintPageGUI
    {
        $this->tabs->setBackTarget(
            $this->lng->txt('tst_question_hints_back_to_hint_list'),
            $this->ctrl->getLinkTargetByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST)
        );

        $pageObjectGUI = $this->getPageObjectGUI(
            $this->questionHint->getPageObjectType(),
            $this->questionHint->getId()
        );

        $pageObjectGUI->setEnabledTabs(false);

        $pageObjectGUI->setPresentationTitle(
            ilAssQuestionHint::getHintIndexLabel($this->lng, $this->questionHint->getIndex())
        );

        return $pageObjectGUI;
    }

    private function buildRequestPresentationPageObjectGUI(): ilAssHintPageGUI
    {
        $this->tabs->setBackTarget(
            $this->lng->txt('tst_question_hints_back_to_hint_list'),
            $this->ctrl->getLinkTargetByClass('ilAssQuestionHintRequestGUI', ilAssQuestionHintRequestGUI::CMD_SHOW_LIST)
        );

        $pageObjectGUI = $this->getPageObjectGUI(
            $this->questionHint->getPageObjectType(),
            $this->questionHint->getId()
        );

        $pageObjectGUI->setEnabledTabs(false);
        $pageObjectGUI->setEnableEditing(false);
        $pageObjectGUI->setTemplateTargetVar('ADM_CONTENT');
        $pageObjectGUI->setTemplateOutput(true);

        $pageObjectGUI->setPresentationTitle(
            ilAssQuestionHint::getHintIndexLabel($this->lng, $this->questionHint->getIndex())
        );

        return $pageObjectGUI;
    }

    private function buildAuthorPresentationPageObjectGUI(): ilAssHintPageGUI
    {
        $this->tabs->setBackTarget(
            $this->lng->txt('tst_question_hints_back_to_hint_list'),
            $this->ctrl->getLinkTargetByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST)
        );

        $this->ensurePageObjectExists(
            $this->questionHint->getPageObjectType(),
            $this->questionHint->getId()
        );

        $pageObjectGUI = $this->getPageObjectGUI(
            $this->questionHint->getPageObjectType(),
            $this->questionHint->getId()
        );
        $pageObjectGUI->setTemplateTargetVar('ADM_CONTENT');
        $pageObjectGUI->setTemplateOutput(true);
        $pageObjectGUI->setEnabledTabs(true);

        return $pageObjectGUI;
    }

    public function getPresentationMode(): ?string
    {
        return $this->presentationMode;
    }

    public function setPresentationMode($presentationMode): void
    {
        switch ($presentationMode) {
            case self::PRESENTATION_MODE_AUTHOR:
            case self::PRESENTATION_MODE_PREVIEW:
            case self::PRESENTATION_MODE_REQUEST:

                $this->presentationMode = $presentationMode;
                break;

            default: throw new ilTestQuestionPoolException('invalid presentation mode given: ' . $presentationMode);
        }
    }

    protected function getPageObjectGUI($pageObjectType, $pageObjectId): ilAssHintPageGUI
    {
        $pageObjectGUI = new ilAssHintPageGUI($pageObjectId);
        $pageObjectGUI->obj->addUpdateListener(
            $this->questionOBJ,
            'updateTimestamp'
        );
        return $pageObjectGUI;
    }

    protected function ensurePageObjectExists($pageObjectType, $pageObjectId): void
    {
        if (!ilAssHintPage::_exists($pageObjectType, $pageObjectId, '', true)) {
            $pageObject = new ilAssHintPage();
            $pageObject->setParentId($this->questionOBJ->getId());
            $pageObject->setId($pageObjectId);
            $pageObject->createFromXML();
        }
    }
}