Modules/TestQuestionPool/classes/class.assTextSubset.php

Go to the documentation of this file.

<?php
 /*
   +----------------------------------------------------------------------------+
   | ILIAS open source                                                          |
   +----------------------------------------------------------------------------+
   | Copyright (c) 1998-2001 ILIAS open source, University of Cologne           |
   |                                                                            |
   | This program is free software; you can redistribute it and/or              |
   | modify it under the terms of the GNU General Public License                |
   | as published by the Free Software Foundation; either version 2             |
   | of the License, or (at your option) any later version.                     |
   |                                                                            |
   | This program is distributed in the hope that it will be useful,            |
   | but WITHOUT ANY WARRANTY; without even the implied warranty of             |
   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              |
   | GNU General Public License for more details.                               |
   |                                                                            |
   | You should have received a copy of the GNU General Public License          |
   | along with this program; if not, write to the Free Software                |
   | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
   +----------------------------------------------------------------------------+
*/
include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
include_once "./Modules/Test/classes/inc.AssessmentConstants.php";

class assTextSubset extends assQuestion
{
        var $answers;
        
        var $correctanswers;

        var $text_rating;

        function assTextSubset(
                $title = "",
                $comment = "",
                $author = "",
                $owner = -1,
                $question = ""
          )
        {
                $this->assQuestion($title, $comment, $author, $owner, $question);
                $this->answers = array();
                $this->correctanswers = 0;
        }

        function isComplete()
        {
                if (($this->title) and ($this->author) and ($this->question) and (count($this->answers) >= $this->correctanswers) and ($this->getMaximumPoints() > 0))
                {
                        return true;
                }
                        else
                {
                        return false;
                }
        }

        function saveToDb($original_id = "")
        {
                global $ilDB;

                $complete = 0;
                if ($this->isComplete())
                {
                        $complete = 1;
                }
                $estw_time = $this->getEstimatedWorkingTime();
                $estw_time = sprintf("%02d:%02d:%02d", $estw_time['h'], $estw_time['m'], $estw_time['s']);

                if ($original_id)
                {
                        $original_id = $ilDB->quote($original_id);
                }
                else
                {
                        $original_id = "NULL";
                }

                // cleanup RTE images which are not inserted into the question text
                include_once("./Services/RTE/classes/class.ilRTE.php");
                if ($this->id == -1)
                {
                        // Neuen Datensatz schreiben
                        $now = getdate();
                        $question_type = $this->getQuestionTypeID();
                        $created = sprintf("%04d%02d%02d%02d%02d%02d", $now['year'], $now['mon'], $now['mday'], $now['hours'], $now['minutes'], $now['seconds']);
                        $query = sprintf("INSERT INTO qpl_questions (question_id, question_type_fi, obj_fi, title, comment, author, owner, question_text, points, working_time, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
                                $ilDB->quote($question_type),
                                $ilDB->quote($this->obj_id),
                                $ilDB->quote($this->title),
                                $ilDB->quote($this->comment),
                                $ilDB->quote($this->author),
                                $ilDB->quote($this->owner),
                                $ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->question, 0)),
                                $ilDB->quote($this->getMaximumPoints() . ""),
                                $ilDB->quote($estw_time),
                                $ilDB->quote("$complete"),
                                $ilDB->quote($created),
                                $original_id
                        );
                        $result = $ilDB->query($query);
                        
                        if ($result == DB_OK)
                        {
                                $this->id = $ilDB->getLastInsertId();
                                $query = sprintf("INSERT INTO qpl_question_textsubset (question_fi, textgap_rating, correctanswers) VALUES (%s, %s, %s)",
                                        $ilDB->quote($this->id . ""),
                                        $ilDB->quote($this->getTextRating() . ""),
                                        $ilDB->quote($this->getCorrectAnswers() . "")
                                );
                                $ilDB->query($query);

                                // create page object of question
                                $this->createPageObject();

                                // Falls die Frage in einen Test eingefügt werden soll, auch diese Verbindung erstellen
                                if ($this->getTestId() > 0)
                                {
                                $this->insertIntoTest($this->getTestId());
                                }
                        }
                }
                else
                {
                        // Vorhandenen Datensatz aktualisieren
                        $query = sprintf("UPDATE qpl_questions SET obj_fi = %s, title = %s, comment = %s, author = %s, question_text = %s, points = %s, working_time=%s, complete = %s WHERE question_id = %s",
                                $ilDB->quote($this->obj_id. ""),
                                $ilDB->quote($this->title),
                                $ilDB->quote($this->comment),
                                $ilDB->quote($this->author),
                                $ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->question, 0)),
                                $ilDB->quote($this->getMaximumPoints() . ""),
                                $ilDB->quote($estw_time),
                                $ilDB->quote("$complete"),
                                $ilDB->quote($this->id)
                        );
                        $result = $ilDB->query($query);
                        $query = sprintf("UPDATE qpl_question_textsubset SET textgap_rating = %s, correctanswers = %s WHERE question_fi = %s",
                                $ilDB->quote($this->getTextRating() . ""),
                                $ilDB->quote($this->getCorrectAnswers() . ""),
                                $ilDB->quote($this->id . "")
                        );
                        $result = $ilDB->query($query);
                }
                if ($result == DB_OK)
                {
                        // Write Ranges to the database
                        
                        // 1. delete old ranges
                        $query = sprintf("DELETE FROM qpl_answer_textsubset WHERE question_fi = %s",
                                $ilDB->quote($this->id)
                        );
                        $result = $ilDB->query($query);

                        // 2. write ranges
                        foreach ($this->answers as $key => $value)
                        {
                                $answer_obj = $this->answers[$key];
                                $query = sprintf("INSERT INTO qpl_answer_textsubset (answer_id, question_fi, answertext, points, aorder) VALUES (NULL, %s, %s, %s, %s)",
                                        $ilDB->quote($this->id),
                                        $ilDB->quote($answer_obj->getAnswertext()),
                                        $ilDB->quote($answer_obj->getPoints() . ""),
                                        $ilDB->quote($answer_obj->getOrder() . "")
                                );
                                $answer_result = $ilDB->query($query);
                        }
                }
                parent::saveToDb($original_id);
        }

        function loadFromDb($question_id)
        {
                global $ilDB;

    $query = sprintf("SELECT qpl_questions.*, qpl_question_textsubset.* FROM qpl_questions, qpl_question_textsubset WHERE question_id = %s AND qpl_questions.question_id = qpl_question_textsubset.question_fi",
                        $ilDB->quote($question_id)
                );
                $result = $ilDB->query($query);
                if (strcmp(strtolower(get_class($result)), db_result) == 0)
                {
                        if ($result->numRows() == 1)
                        {
                                $data = $result->fetchRow(DB_FETCHMODE_OBJECT);
                                $this->id = $question_id;
                                $this->title = $data->title;
                                $this->comment = $data->comment;
                                $this->solution_hint = $data->solution_hint;
                                $this->original_id = $data->original_id;
                                $this->obj_id = $data->obj_fi;
                                $this->author = $data->author;
                                $this->owner = $data->owner;
                                $this->points = $data->points;
                                include_once("./Services/RTE/classes/class.ilRTE.php");
                                $this->question = ilRTE::_replaceMediaObjectImageSrc($data->question_text, 1);
                                $this->correctanswers = $data->correctanswers;
                                $this->text_rating = $data->textgap_rating;
                                $this->setEstimatedWorkingTime(substr($data->working_time, 0, 2), substr($data->working_time, 3, 2), substr($data->working_time, 6, 2));
                        }

                        $query = sprintf("SELECT * FROM qpl_answer_textsubset WHERE question_fi = %s ORDER BY aorder ASC",
                                $ilDB->quote($question_id)
                        );
                        $result = $ilDB->query($query);

                        include_once "./Modules/TestQuestionPool/classes/class.assAnswerSimple.php";
                        if (strcmp(strtolower(get_class($result)), db_result) == 0)
                        {
                                while ($data = $result->fetchRow(DB_FETCHMODE_ASSOC))
                                {
                                        array_push($this->answers, new ASS_AnswerSimple($data["answertext"], $data["points"], $data["aorder"]));
                                }
                        }
                }
                parent::loadFromDb($question_id);
        }

        function addAnswer($answertext, $points, $answerorder)
        {
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerSimple.php";
                array_push($this->answers, new ASS_AnswerSimple($answertext, $points, $answerorder));
        }
        
        function duplicate($for_test = true, $title = "", $author = "", $owner = "")
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $this_id = $this->getId();
                $clone = $this;
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                $original_id = assQuestion::_getOriginalId($this->id);
                $clone->id = -1;
                if ($title)
                {
                        $clone->setTitle($title);
                }

                if ($author)
                {
                        $clone->setAuthor($author);
                }
                if ($owner)
                {
                        $clone->setOwner($owner);
                }

                if ($for_test)
                {
                        $clone->saveToDb($original_id);
                }
                else
                {
                        $clone->saveToDb();
                }

                // copy question page content
                $clone->copyPageOfQuestion($this_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
                // duplicate the generic feedback
                $clone->duplicateFeedbackGeneric($this_id);

                return $clone->id;
        }

        function copyObject($target_questionpool, $title = "")
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $clone = $this;
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                $original_id = assQuestion::_getOriginalId($this->id);
                $clone->id = -1;
                $source_questionpool = $this->getObjId();
                $clone->setObjId($target_questionpool);
                if ($title)
                {
                        $clone->setTitle($title);
                }
                $clone->saveToDb();

                // copy question page content
                $clone->copyPageOfQuestion($original_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
                // duplicate the generic feedback
                $clone->duplicateFeedbackGeneric($original_id);

                return $clone->id;
        }
        
        function getAnswerCount()
        {
                return count($this->answers);
        }

        function getAnswer($index = 0)
        {
                if ($index < 0) return NULL;
                if (count($this->answers) < 1) return NULL;
                if ($index >= count($this->answers)) return NULL;

                return $this->answers[$index];
        }

        function deleteAnswer($index = 0)
        {
                if ($index < 0) return;
                if (count($this->answers) < 1) return;
                if ($index >= count($this->answers)) return;
                unset($this->answers[$index]);
                $this->answers = array_values($this->answers);
                for ($i = 0; $i < count($this->answers); $i++)
                {
                        if ($this->answers[$i]->getOrder() > $index)
                        {
                                $this->answers[$i]->setOrder($i);
                        }
                }
        }

        function flushAnswers()
        {
                $this->answers = array();
        }

        function getMaximumPoints()
        {
                $points = array();
                foreach ($this->answers as $answer)
                {
                        if ($answer->getPoints() > 0)
                        {
                                array_push($points, $answer->getPoints());
                        }
                }
                rsort($points, SORT_NUMERIC);
                $maxpoints = 0;
                for ($counter = 0; $counter < $this->getCorrectAnswers(); $counter++)
                {
                        $maxpoints += $points[$counter];
                }
                return $maxpoints;
        }
        
        function &getAvailableAnswers()
        {
                $available_answers = array();
                foreach ($this->answers as $answer)
                {
                        array_push($available_answers, $answer->getAnswertext());
                }
                return $available_answers;
        }

        function isAnswerCorrect($answers, $answer)
        {
                include_once "./Services/Utilities/classes/class.ilStr.php";
                $result = 0;
                $textrating = $this->getTextRating();
                foreach ($answers as $key => $value)
                {
                        switch ($textrating)
                        {
                                case TEXTGAP_RATING_CASEINSENSITIVE:
                                        if (strcmp(ilStr::strToLower($value), ilStr::strToLower($answer)) == 0) return $key;
                                        break;
                                case TEXTGAP_RATING_CASESENSITIVE:
                                        if (strcmp($value, $answer) == 0) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN1:
                                        if (levenshtein($value, $answer) <= 1) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN2:
                                        if (levenshtein($value, $answer) <= 2) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN3:
                                        if (levenshtein($value, $answer) <= 3) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN4:
                                        if (levenshtein($value, $answer) <= 4) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN5:
                                        if (levenshtein($value, $answer) <= 5) return $key;
                                        break;
                        }
                }
                return FALSE;
        }

        function getTextRating()
        {
                return $this->text_rating;
        }
        
        function setTextRating($a_text_rating)
        {
                switch ($a_text_rating)
                {
                        case TEXTGAP_RATING_CASEINSENSITIVE:
                        case TEXTGAP_RATING_CASESENSITIVE:
                        case TEXTGAP_RATING_LEVENSHTEIN1:
                        case TEXTGAP_RATING_LEVENSHTEIN2:
                        case TEXTGAP_RATING_LEVENSHTEIN3:
                        case TEXTGAP_RATING_LEVENSHTEIN4:
                        case TEXTGAP_RATING_LEVENSHTEIN5:
                                $this->text_rating = $a_text_rating;
                                break;
                        default:
                                $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
                                break;
                }
        }
        
        function calculateReachedPoints($active_id, $pass = NULL)
        {
                global $ilDB;
                
                $available_answers =& $this->getAvailableAnswers();
                $found_counter = 0;
                
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                $query = sprintf("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                        $ilDB->quote($active_id . ""),
                        $ilDB->quote($this->getId() . ""),
                        $ilDB->quote($pass . "")
                );
                $result = $ilDB->query($query);
                $points = 0;
                while ($data = $result->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $enteredtext = $data["value1"];
                        $index = $this->isAnswerCorrect($available_answers, $enteredtext);
                        if ($index !== FALSE)
                        {
                                unset($available_answers[$index]);
                                $points += $this->answers[$index]->getPoints();
                        }
                }

                $points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
                return $points;
        }
        
        function setCorrectAnswers($a_correct_answers)
        {
                $this->correctanswers = $a_correct_answers;
        }
        
        function getCorrectAnswers()
        {
                return $this->correctanswers;
        }
        
        function saveWorkingData($active_id, $pass = NULL)
        {
                global $ilDB;
                global $ilUser;

                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }
                $entered_values = 0;
                
                $query = sprintf("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                        $ilDB->quote($active_id . ""),
                        $ilDB->quote($this->getId() . ""),
                        $ilDB->quote($pass . "")
                );
                $result = $ilDB->query($query);
                foreach ($_POST as $key => $value)
                {
                        if (preg_match("/^TEXTSUBSET_(\d+)/", $key, $matches))
                        {
                                if (strlen($value))
                                {
                                        $query = sprintf("INSERT INTO tst_solutions (solution_id, active_fi, question_fi, value1, value2, pass, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL, %s, NULL)",
                                                $ilDB->quote($active_id),
                                                $ilDB->quote($this->getId()),
                                                $ilDB->quote(trim($value)),
                                                $ilDB->quote($pass . "")
                                        );
                                        $result = $ilDB->query($query);
                                        $entered_values++;
                                }
                        }
                }
                if ($entered_values)
                {
                        include_once ("./classes/class.ilObjAssessmentFolder.php");
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                }
                else
                {
                        include_once ("./classes/class.ilObjAssessmentFolder.php");
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                }
    parent::saveWorkingData($active_id, $pass);
                return true;
        }

        function getQuestionType()
        {
                return "assTextSubset";
        }
        
        function &joinAnswers()
        {
                $join = array();
                foreach ($this->answers as $answer)
                {
                        if (!is_array($join[$answer->getPoints() . ""]))
                        {
                                $join[$answer->getPoints() . ""] = array();
                        }
                        array_push($join[$answer->getPoints() . ""], $answer->getAnswertext());
                }
                return $join;
        }
        
        function getMaxTextboxWidth()
        {
                $maxwidth = 0;
                foreach ($this->answers as $answer)
                {
                        $len = strlen($answer->getAnswertext());
                        if ($len > $maxwidth) $maxwidth = $len;
                }
                return $maxwidth + 3;
        }

        function getAdditionalTableName()
        {
                return "qpl_question_textsubset";
        }

        function getAnswerTableName()
        {
                return "qpl_answer_textsubset";
        }

        function getRTETextWithMediaObjects()
        {
                return parent::getRTETextWithMediaObjects();
        }
}

?>