class.ilAssMultiOptionQuestionFeedback.php

Go to the documentation of this file.

<?php

require_once 'Modules/TestQuestionPool/classes/feedback/class.ilAssQuestionFeedback.php';

abstract class ilAssMultiOptionQuestionFeedback extends ilAssQuestionFeedback
{
    public const TABLE_NAME_SPECIFIC_FEEDBACK = 'qpl_fb_specific';

    public function getSpecificAnswerFeedbackTestPresentation(int $questionId, int $questionIndex, int $answerIndex): string
    {
        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            return $this->cleanupPageContent(
                $this->getPageObjectContent(
                    $this->getSpecificAnswerFeedbackPageObjectType(),
                    $this->getSpecificAnswerFeedbackPageObjectId($questionId, $questionIndex, $answerIndex)
                )
            );
        }
        return $this->getSpecificAnswerFeedbackContent(
            $questionId,
            $questionIndex,
            $answerIndex
        );
    }

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

            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                $propertyLabel = $this->questionOBJ->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()) {
            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
                    $value = $this->getPageObjectNonEditableValueHTML(
                        $this->getSpecificAnswerFeedbackPageObjectType(),
                        $this->getSpecificAnswerFeedbackPageObjectId($this->questionOBJ->getId(), 0, $index)
                    );
                } else {
                    $value = $this->questionOBJ->prepareTextareaOutput(
                        $this->getSpecificAnswerFeedbackContent($this->questionOBJ->getId(), 0, $index)
                    );
                }

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

    public function saveSpecificFormProperties(ilPropertyFormGUI $form): void
    {
        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 getSpecificAnswerFeedbackContent(int $questionId, int $questionIndex, int $answerIndex): string
    {
        require_once 'Services/RTE/classes/class.ilRTE.php';

        $res = $this->db->queryF(
            "SELECT * FROM {$this->getSpecificFeedbackTableName()}
                                        WHERE question_fi = %s AND question = %s AND answer = %s",
            ['integer', 'integer', 'integer'],
            [$questionId, $questionIndex, $answerIndex]
        );

        $feedbackContent = '';

        if ($this->db->numRows($res) > 0) {
            $row = $this->db->fetchAssoc($res);
            $feedbackContent = ilRTE::_replaceMediaObjectImageSrc(
                $this->questionOBJ->getHtmlQuestionContentPurifier()->purify($row['feedback'] ?? ''),
                1
            );
        }

        return $feedbackContent;
    }

    public function getAllSpecificAnswerFeedbackContents(int $questionId): string
    {
        require_once 'Services/RTE/classes/class.ilRTE.php';

        $res = $this->db->queryF(
            "SELECT feedback FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
            ['integer'],
            [$questionId]
        );

        $allFeedbackContents = '';

        while ($row = $this->db->fetchAssoc($res)) {
            $allFeedbackContents .= ilRTE::_replaceMediaObjectImageSrc($row['feedback'] ?? '', 1);
        }

        return $allFeedbackContents;
    }

    public function saveSpecificAnswerFeedbackContent(int $questionId, int $questionIndex, int $answerIndex, string $feedbackContent): int
    {
        if ($feedbackContent !== '') {
            $feedbackContent = ilRTE::_replaceMediaObjectImageSrc(
                $this->questionOBJ->getHtmlQuestionContentPurifier()->purify($feedbackContent),
                0
            );
        }

        $feedbackId = $this->getSpecificAnswerFeedbackId($questionId, $questionIndex, $answerIndex);

        if ($feedbackId !== -1) {
            $this->db->update(
                $this->getSpecificFeedbackTableName(),
                [
                    'feedback' => ['text', $feedbackContent],
                    'tstamp' => ['integer', time()]
                ],
                [
                    'feedback_id' => ['integer', $feedbackId],
                ]
            );
        } else {
            $feedbackId = $this->db->nextId($this->getSpecificFeedbackTableName());

            $this->db->insert($this->getSpecificFeedbackTableName(), [
                'feedback_id' => ['integer', $feedbackId],
                'question_fi' => ['integer', $questionId],
                'question' => ['integer', $questionIndex],
                'answer' => ['integer', $answerIndex],
                'feedback' => ['text', $feedbackContent],
                'tstamp' => ['integer', time()]
            ]);
        }

        return $feedbackId;
    }

    public function deleteSpecificAnswerFeedbacks(int $questionId, bool $isAdditionalContentEditingModePageObject): void
    {
        if ($isAdditionalContentEditingModePageObject) {
            require_once 'Modules/TestQuestionPool/classes/feedback/class.ilAssSpecificFeedbackIdentifierList.php';
            $feedbackIdentifiers = new ilAssSpecificFeedbackIdentifierList();
            $feedbackIdentifiers->load($questionId);

            foreach ($feedbackIdentifiers as $identifier) {
                $this->ensurePageObjectDeleted(
                    $this->getSpecificAnswerFeedbackPageObjectType(),
                    $identifier->getFeedbackId()
                );
            }
        }

        $this->db->manipulateF(
            "DELETE FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
            ['integer'],
            [$questionId]
        );
    }

    protected function duplicateSpecificFeedback(int $originalQuestionId, int $duplicateQuestionId): void
    {
        $res = $this->db->queryF(
            "SELECT * FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
            ['integer'],
            [$originalQuestionId]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $nextId = $this->db->nextId($this->getSpecificFeedbackTableName());

            $this->db->insert($this->getSpecificFeedbackTableName(), [
                'feedback_id' => ['integer', $nextId],
                'question_fi' => ['integer', $duplicateQuestionId],
                'question' => ['integer', $row['question']],
                'answer' => ['integer', $row['answer']],
                'feedback' => ['text', $row['feedback']],
                'tstamp' => ['integer', time()]
            ]);

            if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
                $pageObjectType = $this->getSpecificAnswerFeedbackPageObjectType();
                $this->duplicatePageObject($pageObjectType, $row['feedback_id'], $nextId, $duplicateQuestionId);
            }
        }
    }

    protected function syncSpecificFeedback(int $originalQuestionId, int $duplicateQuestionId): void
    {
        // delete specific feedback of the original
        $this->db->manipulateF(
            "DELETE FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
            ['integer'],
            [$originalQuestionId]
        );

        // get specific feedback of the actual question
        $res = $this->db->queryF(
            "SELECT * FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
            ['integer'],
            [$duplicateQuestionId]
        );

        // save specific feedback to the original
        while ($row = $this->db->fetchAssoc($res)) {
            $nextId = $this->db->nextId($this->getSpecificFeedbackTableName());

            $this->db->insert($this->getSpecificFeedbackTableName(), [
                'feedback_id' => ['integer', $nextId],
                'question_fi' => ['integer', $originalQuestionId],
                'question' => ['integer', $row['question']],
                'answer' => ['integer', $row['answer']],
                'feedback' => ['text', $row['feedback']],
                'tstamp' => ['integer', time()]
            ]);
        }
    }

    final protected function getSpecificAnswerFeedbackId(int $questionId, int $questionIndex, int $answerIndex): int
    {
        $res = $this->db->queryF(
            "SELECT feedback_id FROM {$this->getSpecificFeedbackTableName()}
                                        WHERE question_fi = %s AND question = %s AND answer = %s",
            ['integer', 'integer', 'integer'],
            [$questionId, $questionIndex, $answerIndex]
        );

        $row = $this->db->fetchAssoc($res);
        return $row['feedback_id'] ?? -1;
    }

    protected function getSpecificFeedbackContentForFeedbackIds(array $feedback_ids): array
    {
        $res = $this->db->query(
            "SELECT feedback_id, feedback FROM {$this->getSpecificFeedbackTableName()} WHERE "
                . $this->db->in('feedback_id', $feedback_ids, false, ilDBConstants::T_INTEGER)
        );

        $content = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $content[$row['feedback_id']] = $row['feedback'];
        }
        return $content;
    }

    protected function isSpecificAnswerFeedbackId(int $feedbackId): bool
    {
        $row = $this->db->fetchAssoc($this->db->queryF(
            "SELECT COUNT(feedback_id) cnt FROM {$this->getSpecificFeedbackTableName()}
                                        WHERE question_fi = %s AND feedback_id = %s",
            ['integer', 'integer'],
            [$this->questionOBJ->getId(), $feedbackId]
        ));

        return (bool) $row['cnt'];
    }

    final protected function getSpecificFeedbackTableName(): string
    {
        return self::TABLE_NAME_SPECIFIC_FEEDBACK;
    }

    public function getAnswerOptionsByAnswerIndex(): array
    {
        return $this->questionOBJ->getAnswers();
    }

    protected function buildAnswerOptionLabel(int $index, $answer): string
    {
        return $answer->getAnswertext();
    }

    final protected function getSpecificAnswerFeedbackPageObjectId(int $questionId, int $questionIndex, int $answerIndex): int
    {
        $pageObjectId = $this->getSpecificAnswerFeedbackId($questionId, $questionIndex, $answerIndex);

        if ($pageObjectId === -1) {
            $pageObjectId = $this->saveSpecificAnswerFeedbackContent($questionId, $questionIndex, $answerIndex, '');
        }

        return $pageObjectId;
    }

    public function getSpecificAnswerFeedbackExportPresentation(int $questionId, int $questionIndex, int $answerIndex): string
    {
        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            $specificAnswerFeedbackExportPresentation = $this->getPageObjectXML(
                $this->getSpecificAnswerFeedbackPageObjectType(),
                $this->getSpecificAnswerFeedbackPageObjectId($questionId, $questionIndex, $answerIndex)
            );
        } else {
            $specificAnswerFeedbackExportPresentation = $this->getSpecificAnswerFeedbackContent(
                $questionId,
                $questionIndex,
                $answerIndex
            );
        }

        return $specificAnswerFeedbackExportPresentation;
    }

    public function importSpecificAnswerFeedback(int $questionId, int $questionIndex, int $answerIndex, string $feedbackContent): void
    {
        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            $pageObjectId = $this->getSpecificAnswerFeedbackPageObjectId($questionId, $questionIndex, $answerIndex);
            $pageObjectType = $this->getSpecificAnswerFeedbackPageObjectType();

            $this->createPageObject($pageObjectType, $pageObjectId, $feedbackContent);
        } else {
            $this->saveSpecificAnswerFeedbackContent($questionId, $questionIndex, $answerIndex, $feedbackContent);
        }
    }

    public function specificAnswerFeedbackExists(): bool
    {
        $res = $this->db->queryF(
            "SELECT answer FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
            ['integer'],
            [$this->questionOBJ->getId()]
        );

        $allFeedbackContents = '';

        while ($row = $this->db->fetchAssoc($res)) {
            $allFeedbackContents .= $this->getSpecificAnswerFeedbackExportPresentation(
                $this->questionOBJ->getId(),
                0,
                $row['answer']
            );
        }

        return (bool) strlen(trim(strip_tags($allFeedbackContents)));
    }
}