class.ilAssConfigurableMultiOptionQuestionFeedback.php

Go to the documentation of this file.

<?php

abstract class ilAssConfigurableMultiOptionQuestionFeedback extends ilAssMultiOptionQuestionFeedback
{
    public const FEEDBACK_SETTING_ALL = 1;
    public const FEEDBACK_SETTING_CHECKED = 2;
    public const FEEDBACK_SETTING_CORRECT = 3;

    abstract protected function getSpecificQuestionTableName(): string;

    public function completeSpecificFormProperties(ilPropertyFormGUI $form): void
    {
        if (!$this->questionOBJ->getSelfAssessmentEditingMode()) {
            $header = new ilFormSectionHeaderGUI();
            $header->setTitle($this->lng->txt('feedback_answers'));
            $form->addItem($header);

            $feedback = new ilRadioGroupInputGUI($this->lng->txt('feedback_setting'), 'feedback_setting');
            $feedback->addOption(
                new ilRadioOption($this->lng->txt('feedback_all'), self::FEEDBACK_SETTING_ALL)
            );
            $feedback->addOption(
                new ilRadioOption($this->lng->txt('feedback_checked'), self::FEEDBACK_SETTING_CHECKED)
            );
            $feedback->addOption(
                new ilRadioOption($this->lng->txt($this->questionOBJ->getSpecificFeedbackAllCorrectOptionLabel()), self::FEEDBACK_SETTING_CORRECT)
            );

            $feedback->setRequired(true);
            $form->addItem($feedback);

            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                $propertyLabel = ilLegacyFormElementsUtil::prepareTextareaOutput(
                    $this->buildAnswerOptionLabel($index, $answer),
                    true
                );

                $propertyPostVar = "feedback_answer_$index";

                $form->addItem($this->buildFeedbackContentFormProperty(
                    $propertyLabel,
                    $propertyPostVar,
                    $this->questionOBJ->isAdditionalContentEditingModePageObject()
                ));
            }
        }
    }

    public function initSpecificFormProperties(ilPropertyFormGUI $form): void
    {
        if (!$this->questionOBJ->getSelfAssessmentEditingMode()) {
            $form->getItemByPostVar('feedback_setting')->setValue(
                $this->questionOBJ->getSpecificFeedbackSetting()
            );

            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
                    $value = $this->getPageObjectNonEditableValueHTML(
                        $this->getSpecificAnswerFeedbackPageObjectType(),
                        $this->getSpecificAnswerFeedbackPageObjectId($this->questionOBJ->getId(), 0, $index)
                    );
                } else {
                    $value = ilLegacyFormElementsUtil::prepareTextareaOutput(
                        $this->getSpecificAnswerFeedbackContent($this->questionOBJ->getId(), 0, $index)
                    );
                }

                $form->getItemByPostVar("feedback_answer_$index")->setValue($value);
            }
        }
    }

    public function saveSpecificFormProperties(ilPropertyFormGUI $form): void
    {
        $feedback_setting = $form->getInput('feedback_setting');

        /* sk 03.03.2023: This avoids Problems with questions in Learning Module
         * See: https://mantis.ilias.de/view.php?id=34724
         */
        if ($feedback_setting === '') {
            return;
        }

        $this->saveSpecificFeedbackSetting($this->questionOBJ->getId(), (int) $feedback_setting);

        if (!$this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                $this->saveSpecificAnswerFeedbackContent(
                    $this->questionOBJ->getId(),
                    0,
                    $index,
                    (string) ($form->getInput("feedback_answer_$index") ?? '')
                );
            }
        }
    }

    public function isSaveableInPageObjectEditingMode(): bool
    {
        return true;
    }

    public function saveSpecificFeedbackSetting(int $questionId, int $specificFeedbackSetting): void
    {
        $this->db->update(
            $this->getSpecificQuestionTableName(),
            array('feedback_setting' => array('integer', $specificFeedbackSetting)),
            array('question_fi' => array('integer', $questionId))
        );
    }

    protected function duplicateSpecificFeedback(int $originalQuestionId, int $duplicateQuestionId): void
    {
        $this->syncSpecificFeedbackSetting($originalQuestionId, $duplicateQuestionId);
        parent::duplicateSpecificFeedback($originalQuestionId, $duplicateQuestionId);
    }

    protected function syncSpecificFeedback(int $originalQuestionId, int $duplicateQuestionId): void
    {
        $this->syncSpecificFeedbackSetting($duplicateQuestionId, $originalQuestionId);
        parent::syncSpecificFeedback($originalQuestionId, $duplicateQuestionId);
    }

    private function syncSpecificFeedbackSetting(int $sourceQuestionId, int $targetQuestionId): void
    {
        $res = $this->db->queryF(
            "SELECT feedback_setting FROM {$this->getSpecificQuestionTableName()} WHERE question_fi = %s",
            array('integer'),
            array($sourceQuestionId)
        );

        $row = $this->db->fetchAssoc($res);

        if ($this->db->numRows($res) < 1) {
            return;
        }

        $this->db->update(
            $this->getSpecificQuestionTableName(),
            array( 'feedback_setting' => array('integer', $row['feedback_setting']) ),
            array( 'question_fi' => array('integer', $targetQuestionId) )
        );
    }
}