class.ilAssMultiOptionQuestionFeedback.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

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

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

    public function getSpecificAnswerFeedbackTestPresentation($questionId, $questionIndex, $answerIndex)
    {
        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            $specificAnswerFeedbackTestPresentationHTML = $this->getPageObjectContent(
                $this->getSpecificAnswerFeedbackPageObjectType(),
                $this->getSpecificAnswerFeedbackPageObjectId($questionId, $questionIndex, $answerIndex)
            );
        } else {
            $specificAnswerFeedbackTestPresentationHTML = $this->getSpecificAnswerFeedbackContent(
                $questionId,
                $questionIndex,
                $answerIndex
            );
        }

        return $specificAnswerFeedbackTestPresentationHTML;
    }

    public function completeSpecificFormProperties(ilPropertyFormGUI $form)
    {
        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)
    {
        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)
    {
        if (!$this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                $this->saveSpecificAnswerFeedbackContent(
                    $this->questionOBJ->getId(),
                    0,
                    $index,
                    $form->getInput("feedback_answer_$index")
                );
            }
        }
    }

    public function getSpecificAnswerFeedbackContent($questionId, $questionIndex, $answerIndex)
    {
        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",
            array('integer','integer','integer'),
            array($questionId, $questionIndex, $answerIndex)
        );

        $feedbackContent = '';
        while ($row = $this->db->fetchAssoc($res)) {
            if (array_key_exists('feedback', $row) && $row['feedback'] !== null) {
                $feedbackContent = ilRTE::_replaceMediaObjectImageSrc($this->questionOBJ->getHtmlQuestionContentPurifier()->purify($row['feedback']), 1);
                break;
            }
        }

        return $feedbackContent;
    }

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

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

        $allFeedbackContents = '';

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

        return $allFeedbackContents;
    }

    public function saveSpecificAnswerFeedbackContent($questionId, $questionIndex, $answerIndex, $feedbackContent)
    {
        require_once 'Services/RTE/classes/class.ilRTE.php';

        if (strlen($feedbackContent)) {
            $feedbackContent = ilRTE::_replaceMediaObjectImageSrc($this->questionOBJ->getHtmlQuestionContentPurifier()->purify($feedbackContent), 0);
        }

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

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

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

        return $feedbackId;
    }

    public function deleteSpecificAnswerFeedbacks($questionId, $isAdditionalContentEditingModePageObject)
    {
        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",
            array('integer'),
            array($questionId)
        );
    }

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

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

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

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

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

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

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

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

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

    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($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",
            array('integer' ,'integer'),
            array($this->questionOBJ->getId(), $feedbackId)
        ));

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

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

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

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

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

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

        return $pageObjectId;
    }

    public function getSpecificAnswerFeedbackExportPresentation($questionId, $questionIndex, $answerIndex)
    {
        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($questionId, $questionIndex, $answerIndex, $feedbackContent)
    {
        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()
    {
        return (bool) strlen(
            $this->getAllSpecificAnswerFeedbackContents($this->questionOBJ->getId())
        );
    }
}