class.ilAssQuestionFeedbackEditingGUI.php

Go to the documentation of this file.

<?php

use ILIAS\Style\Content\Service as ContentStyle;

class ilAssQuestionFeedbackEditingGUI
{
    public const CMD_SHOW = 'showFeedbackForm';
    public const CMD_SAVE = 'saveFeedbackForm';
    public const CMD_SHOW_SYNC = 'showSync';
    private \ILIAS\TestQuestionPool\InternalRequestService $request;
    private \ILIAS\TestQuestionPool\QuestionInfoService $questioninfo;

    protected $questionGUI = null;

    protected $questionOBJ = null;

    protected $feedbackOBJ = null;

    protected $ctrl = null;

    protected $access = null;

    protected $tpl = null;

    protected $tabs = null;

    protected $lng = null;

    protected ContentStyle $content_style;

    public function __construct(assQuestionGUI $questionGUI, ilCtrl $ctrl, ilAccessHandler $access, ilGlobalTemplateInterface $tpl, ilTabsGUI $tabs, ilLanguage $lng)
    {
        $this->questionGUI = $questionGUI;
        $this->questionOBJ = $questionGUI->object;
        $this->feedbackOBJ = $questionGUI->object->feedbackOBJ;
        global $DIC;
        $this->request = $DIC->testQuestionPool()->internal()->request();
        $this->ctrl = $ctrl;
        $this->access = $access;
        $this->tpl = $tpl;
        $this->tabs = $tabs;
        $this->lng = $lng;
        $this->questioninfo = $DIC->testQuestionPool()->questionInfo();
        $this->content_style = $DIC->contentStyle();
    }

    public function executeCommand(): void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $ilHelp = $DIC['ilHelp']; /* @var ilHelpGUI $ilHelp */
        $ilHelp->setScreenIdComponent('qpl');

        $cmd = $this->ctrl->getCmd(self::CMD_SHOW);
        $nextClass = $this->ctrl->getNextClass($this);

        $this->ctrl->setParameter($this, 'q_id', $this->request->getQuestionId());

        $this->setContentStyle();

        switch ($nextClass) {
            case 'ilassspecfeedbackpagegui':
            case 'ilassgenfeedbackpagegui':
                $forwarder = new ilAssQuestionFeedbackPageObjectCommandForwarder($this->questionOBJ, $this->ctrl, $this->tabs, $this->lng);
                $forwarder->forward();
                break;

            default:
                $this->tabs->setTabActive('feedback');
                $cmd .= 'Cmd';
                $this->$cmd();
                break;
        }
    }

    protected function setContentStyle(): void
    {
        $this->content_style->gui()->addCss($this->tpl, $this->request->getRefId());
    }

    private function showFeedbackFormCmd(): void
    {
        $form = $this->buildForm();

        $this->feedbackOBJ->initGenericFormProperties($form);
        if ($this->questionOBJ->hasSpecificFeedback()) {
            $this->feedbackOBJ->initSpecificFormProperties($form);
        }

        $this->tpl->setContent($this->ctrl->getHTML($form));
    }

    private function saveFeedbackFormCmd(): void
    {
        $form = $this->buildForm();

        $form->setValuesByPost();

        if ($form->checkInput()) {
            $this->feedbackOBJ->saveGenericFormProperties($form);
            if ($this->questionOBJ->hasSpecificFeedback()) {
                $this->feedbackOBJ->saveSpecificFormProperties($form);
            }
            $this->questionOBJ->cleanupMediaObjectUsage();
            $this->questionOBJ->updateTimestamp();

            if ($this->isSyncAfterSaveRequired()) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
                $this->ctrl->redirect($this, self::CMD_SHOW_SYNC);
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            $this->ctrl->redirect($this, self::CMD_SHOW);
        }

        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
        $this->tpl->setContent($this->ctrl->getHTML($form));
    }

    private function createFeedbackPageCmd(): void
    {
        $mode = $this->request->raw('fb_mode');
        $this->ctrl->redirectToUrl(
            $this->feedbackOBJ->createFeedbackPages($mode)
        );
    }

    private function buildForm(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('feedback_generic'));
        $form->setTableWidth("100%");
        $form->setId("feedback");

        $this->feedbackOBJ->completeGenericFormProperties($form);
        if ($this->questionOBJ->hasSpecificFeedback()) {
            $this->feedbackOBJ->completeSpecificFormProperties($form);
        }

        if ($this->isFormSaveable()) {
            $form->addCommandButton(self::CMD_SAVE, $this->lng->txt("save"));
        }

        return $form;
    }

    private function isFormSaveable(): bool
    {
        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()
            && !($this->feedbackOBJ->isSaveableInPageObjectEditingMode())) {
            return false;
        }

        $hasWriteAccess = $this->access->checkAccess("write", "", $this->request->getRefId());
        $isSelfAssessmentEditingMode = $this->questionOBJ->getSelfAssessmentEditingMode();

        return $hasWriteAccess || $isSelfAssessmentEditingMode;
    }

    private function isSyncAfterSaveRequired(): bool
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];

        if (!$this->request->isset("calling_test")) {
            return false;
        }

        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            return false;
        }

        if (!$this->questioninfo->questionExistsInPool((int) $this->questionOBJ->getOriginalId())) {
            return false;
        }

        if (!$this->questioninfo->questionExistsInPool((int) $this->questionOBJ->getOriginalId())) {
            return false;
        }

        if (!assQuestion::_isWriteable($this->questionOBJ->getOriginalId(), $ilUser->getId())) {
            return false;
        }

        return true;
    }

    public function showSyncCmd(): void
    {
        $this->questionGUI->originalSyncForm('', 'true');
    }
}