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, $answerIndex)
        {
                if( $this->questionOBJ->isAdditionalContentEditingModePageObject() )
                {
                        $specificAnswerFeedbackTestPresentationHTML = $this->getPageObjectContent(
                                        $this->getSpecificAnswerFeedbackPageObjectType(),
                                        $this->getSpecificAnswerFeedbackPageObjectId($questionId, $answerIndex)
                        );
                }
                else
                {
                        $specificAnswerFeedbackTestPresentationHTML = $this->getSpecificAnswerFeedbackContent(
                                $questionId, $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(), $index)
                                        );
                                }
                                else
                                {
                                        $value = $this->questionOBJ->prepareTextareaOutput(
                                                        $this->getSpecificAnswerFeedbackContent($this->questionOBJ->getId(), $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(), $index, $form->getInput("feedback_answer_$index")
                                );
                        }
                }
        }

        public function getSpecificAnswerFeedbackContent($questionId, $answerIndex)
        {
                require_once 'Services/RTE/classes/class.ilRTE.php';
                
                $res = $this->db->queryF(
                        "SELECT * FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s AND answer = %s",
                        array('integer','integer'), array($questionId, $answerIndex)
                );
                
                while( $row = $this->db->fetchAssoc($res) )
                {
                        $feedbackContent = ilRTE::_replaceMediaObjectImageSrc($row['feedback'], 1);
                        break;
                }
                
                return $feedbackContent;
        }
        
        public function getAllSpecificAnswerFeedbackContents($questionId)
        {
                require_once 'Services/RTE/classes/class.ilRTE.php';
                
                $res = $this->db->queryF(
                        "SELECT * 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, $answerIndex, $feedbackContent)
        {
                require_once 'Services/RTE/classes/class.ilRTE.php';
                
                if( strlen($feedbackContent) )
                {
                        $feedbackContent = ilRTE::_replaceMediaObjectImageSrc($feedbackContent, 0);
                }
                
                $feedbackId = $this->getSpecificAnswerFeedbackId($questionId, $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),
                                'answer' => array('integer', $answerIndex),
                                'feedback' => array('text', $feedbackContent),
                                'tstamp' => array('integer', time())
                        ));
                }
                
                return $feedbackId;
        }
                
        public function deleteSpecificAnswerFeedbacks($questionId, $isAdditionalContentEditingModePageObject)
        {
                if( $isAdditionalContentEditingModePageObject )
                {
                        foreach( $this->getSpecificAnswerFeedbackIdByAnswerIndexMap($questionId) as $answerIndex => $pageObjectId )
                        {
                                $this->ensurePageObjectDeleted($this->getSpecificAnswerFeedbackPageObjectType(), $pageObjectId);
                        }
                }
                
                $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),
                                '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),
                                'answer' => array('integer',$row['answer']),
                                'feedback' => array('text',$row['feedback']),
                                'tstamp' => array('integer',time())
                        ));
                }
        }
        
        final protected function getSpecificAnswerFeedbackId($questionId, $answerIndex)
        {
                $res = $this->db->queryF(
                        "SELECT feedback_id FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s AND answer = %s",
                        array('integer','integer'), array($questionId, $answerIndex)
                );
                
                $feedbackId = null;
                
                while( $row = $this->db->fetchAssoc($res) )
                {
                        $feedbackId = $row['feedback_id'];
                        break;
                }
                
                return $feedbackId;
        }
        
        protected function isSpecificAnswerFeedbackId($feedbackId)
        {
                $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 getSpecificAnswerFeedbackIdByAnswerIndexMap($questionId)
        {
                $res = $this->db->queryF(
                        "SELECT feedback_id, answer FROM {$this->getSpecificFeedbackTableName()} WHERE question_fi = %s",
                        array('integer'), array($questionId)
                );
                
                $feedbackIdByAnswerIndexMap = array();
                
                while( $row = $this->db->fetchAssoc($res) )
                {
                        $feedbackIdByAnswerIndexMap[ $row['answer'] ] = $row['feedback_id'];
                }
                
                return $feedbackIdByAnswerIndexMap;
        }

        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, $answerIndex)
        {
                $pageObjectId = $this->getSpecificAnswerFeedbackId($questionId, $answerIndex);
                
                if( !$pageObjectId )
                {
                        $pageObjectId = $this->saveSpecificAnswerFeedbackContent($questionId, $answerIndex, null);
                }
                
                return $pageObjectId;
        }
        
        public function getSpecificAnswerFeedbackExportPresentation($questionId, $answerIndex)
        {
                if( $this->questionOBJ->isAdditionalContentEditingModePageObject() )
                {
                        $specificAnswerFeedbackExportPresentation = $this->getPageObjectXML(
                                        $this->getSpecificAnswerFeedbackPageObjectType(),
                                        $this->getSpecificAnswerFeedbackPageObjectId($questionId, $answerIndex)
                        );
                }
                else
                {
                        $specificAnswerFeedbackExportPresentation = $this->getSpecificAnswerFeedbackContent(
                                $questionId, $answerIndex
                        );
                }
                                
                return $specificAnswerFeedbackExportPresentation;
        }
        
        public function importSpecificAnswerFeedback($questionId, $answerIndex, $feedbackContent)
        {
                if( $this->questionOBJ->isAdditionalContentEditingModePageObject() )
                {
                        $pageObjectId = $this->getSpecificAnswerFeedbackPageObjectId($questionId, $answerIndex);
                        $pageObjectType = $this->getSpecificAnswerFeedbackPageObjectType();
                        
                        $this->createPageObject($pageObjectType, $pageObjectId, $feedbackContent);
                }
                else
                {
                        $this->saveSpecificAnswerFeedbackContent($questionId, $answerIndex, $feedbackContent);
                }
        }

        public function specificAnswerFeedbackExists($answerIndexes)
        {
                foreach($answerIndexes as $answerIndex)
                {
                        $fb = $this->getSpecificAnswerFeedbackExportPresentation($this->questionOBJ->getId(), $answerIndex);
                        
                        if( strlen($fb) )
                        {
                                return true;
                        }
                }
                
                return false;
        }
}