class.ilAssQuestionFeedbackEditingGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\TestQuestionPool\RequestDataCollector;
use ILIAS\Style\Content\Service as ContentStyle;

class ilAssQuestionFeedbackEditingGUI
{
    public const CMD_SHOW = 'showFeedbackForm';
    public const CMD_SAVE = 'saveFeedbackForm';
    public const CMD_SHOW_SYNC = 'confirmSync';
    public const CMD_SYNC = 'sync';

    protected ?assQuestion $question_obj = null;
    protected ?ilAssQuestionFeedback $feedback_obj = null;

    public function __construct(
        protected readonly assQuestionGUI $question_gui,
        protected readonly ilCtrl $ctrl,
        protected readonly ilAccessHandler $access,
        protected readonly ilGlobalTemplateInterface $tpl,
        protected readonly ilTabsGUI $tabs,
        protected readonly ilLanguage $lng,
        protected readonly ilHelpGUI $help,
        private readonly RequestDataCollector $request,
        private readonly ContentStyle $content_style,
        private readonly bool $in_pool_context = false
    ) {
        $this->question_obj = $question_gui->getObject();
        $this->feedback_obj = $question_gui->getObject()->feedbackOBJ;
    }

    public function executeCommand(): void
    {
        $this->help->setScreenIdComponent('qpl');

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

        $this->ctrl->setParameter($this, 'q_id', $this->question_gui->getObject()->getId());

        $this->setContentStyle();

        switch ($nextClass) {
            case 'ilassspecfeedbackpagegui':
            case 'ilassgenfeedbackpagegui':
                $forwarder = new ilAssQuestionFeedbackPageObjectCommandForwarder($this->question_obj, $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(string $additional_content = ''): void
    {
        $form = $this->buildForm();

        $this->feedback_obj->initGenericFormProperties($form);
        if ($this->question_obj->hasSpecificFeedback()) {
            $this->feedback_obj->initSpecificFormProperties($form);
        }

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

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

        if ($form->checkInput()) {
            $this->feedback_obj->saveGenericFormProperties($form);
            if ($this->question_obj->hasSpecificFeedback()) {
                $this->feedback_obj->saveSpecificFormProperties($form);
            }
            $this->question_obj->cleanupMediaObjectUsage();
            $this->question_obj->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->feedback_obj->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->feedback_obj->completeGenericFormProperties($form);
        if ($this->question_obj->hasSpecificFeedback()) {
            $this->feedback_obj->completeSpecificFormProperties($form);
        }

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

        return $form;
    }

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

    private function isSyncAfterSaveRequired(): bool
    {
        if ($this->in_pool_context) {
            return false;
        }

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

        if (!$this->question_gui->needsSyncQuery()) {
            return false;
        }

        return true;
    }

    public function confirmSyncCmd(): void
    {
        $modal = $this->question_gui->getQuestionSyncModal(self::CMD_SYNC, self::class);
        $this->showFeedbackFormCmd($modal);
    }

    public function syncCmd(): void
    {
        $this->question_obj->syncWithOriginal();
        $this->showFeedbackFormCmd();
    }
}