class.assTextQuestion.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 assTextQuestion extends assQuestion
{
        var $maxNumOfChars;

        var $keywords;

        var $text_rating;
        
        /* method for automatic string matching */
        private $matchcondition;

        function __construct(
                $title = "",
                $comment = "",
                $author = "",
                $owner = -1,
                $question = ""
        )
        {
                parent::__construct($title, $comment, $author, $owner, $question);
                $this->maxNumOfChars = 0;
                $this->points = 0;
                $this->keywords = "";
                $this->matchcondition = 0;
        }

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

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

                $this->saveQuestionDataToDb($original_id);

                // save additional data
                $affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s", 
                        array("integer"),
                        array($this->getId())
                );

                $affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, maxnumofchars, keywords, textgap_rating, matchcondition) VALUES (%s, %s, %s, %s, %s)",
                        array("integer", "integer", "text", "text", 'integer'),
                        array(
                                $this->getId(),
                                $this->getMaxNumOfChars(),
                                (strlen($this->getKeywords())) ? $this->getKeywords() : NULL,
                                $this->getTextRating(),
                                $this->matchcondition
                        )
                );

                parent::saveToDb($original_id);
        }

        function loadFromDb($question_id)
        {
                global $ilDB;

                $result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
                        array("integer"),
                        array($question_id)
                );
                if ($result->numRows() == 1)
                {
                        $data = $ilDB->fetchAssoc($result);
                        $this->setId($question_id);
                        $this->setObjId($data["obj_fi"]);
                        $this->setTitle($data["title"]);
                        $this->setComment($data["description"]);
                        $this->setOriginalId($data["original_id"]);
                        $this->setNrOfTries($data['nr_of_tries']);
                        $this->setAuthor($data["author"]);
                        $this->setPoints($data["points"]);
                        $this->setOwner($data["owner"]);
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                        $this->setShuffle($data["shuffle"]);
                        $this->setMaxNumOfChars($data["maxnumofchars"]);
                        $this->setKeywords($data["keywords"]);
                        $this->setTextRating($data["textgap_rating"]);
                        $this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
                        $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                }
                parent::loadFromDb($question_id);
        }

        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);
                $clone->onDuplicate($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);
                $clone->onCopy($this->getObjId(), $this->getId());

                return $clone->id;
        }

        function getMaxNumOfChars()
        {
                if (strcmp($this->maxNumOfChars, "") == 0)
                {
                        return 0;
                }
                else
                {
                        return $this->maxNumOfChars;
                }
        }

        function setMaxNumOfChars($maxchars = 0)
        {
                $this->maxNumOfChars = $maxchars;
        }

        function getMaximumPoints()
        {
                return $this->points;
        }

        function setReachedPoints($active_id, $points, $pass = NULL)
        {
                global $ilDB;
                
                if (($points > 0) && ($points <= $this->getPoints()))
                {
                        if (is_null($pass))
                        {
                                $pass = $this->getSolutionMaxPass($active_id);
                        }
                        $affectedRows = $ilDB->manipulateF("UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                                array('float','integer','integer','integer'),
                                array($points, $active_id, $this->getId(), $pass)
                        );
                        $this->_updateTestPassResults($active_id, $pass);
                        return TRUE;
                }
                        else
                {
                        return TRUE;
                }
        }

        function isKeywordMatching($answertext, $a_keyword)
        {
                $result = FALSE;
                $textrating = $this->getTextRating();
                include_once "./Services/Utilities/classes/class.ilStr.php";
                switch ($textrating)
                {
                        case TEXTGAP_RATING_CASEINSENSITIVE:
                                if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) return TRUE;
                                break;
                        case TEXTGAP_RATING_CASESENSITIVE:
                                if (ilStr::strPos($answertext, $a_keyword) !== false) return TRUE;
                                break;
                }
                $answerwords = array();
                if (preg_match_all("/([^\s.]+)/", $answertext, $matches))
                {
                        foreach ($matches[1] as $answerword)
                        {
                                array_push($answerwords, trim($answerword));
                        }
                }
                foreach ($answerwords as $a_original)
                {
                        switch ($textrating)
                        {
                                case TEXTGAP_RATING_LEVENSHTEIN1:
                                        if (levenshtein($a_original, $a_keyword) <= 1) return TRUE;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN2:
                                        if (levenshtein($a_original, $a_keyword) <= 2) return TRUE;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN3:
                                        if (levenshtein($a_original, $a_keyword) <= 3) return TRUE;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN4:
                                        if (levenshtein($a_original, $a_keyword) <= 4) return TRUE;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN5:
                                        if (levenshtein($a_original, $a_keyword) <= 5) return TRUE;
                                        break;
                        }
                }
                return $result;
        }

        function calculateReachedPoints($active_id, $pass = NULL)
        {
                global $ilDB;

                $points = 0;
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                $result = $ilDB->queryF("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                        array('integer','integer','integer'),
                        array($active_id, $this->getId(), $pass)
                );
                if ($result->numRows() == 1)
                {
                        $row = $ilDB->fetchAssoc($result);
                        if ($row["points"])
                        {
                                $points = $row["points"];
                        }
                        else
                        {
                                $keywords =& $this->getKeywordList();
                                if (count($keywords))
                                {
                                        if ($this->matchcondition == 0)
                                        {
                                                $foundkeyword = false;
                                        }
                                        else
                                        {
                                                $foundkeyword = true;
                                        }
                                        foreach ($keywords as $keyword)
                                        {
                                                if ($this->matchcondition == 0)
                                                {
                                                        // OR: only one keyword needs to match
                                                        $foundkeyword = $foundkeyword | $this->isKeywordMatching($row["value1"], $keyword);
                                                }
                                                else
                                                {
                                                        // AND: all keywords needs to match
                                                        $foundkeyword = $foundkeyword & $this->isKeywordMatching($row["value1"], $keyword);
                                                }
                                        }
                                        if ($foundkeyword) $points = $this->getMaximumPoints();
                                }
                        }
                }

                $points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
                return $points;
        }

        function saveWorkingData($active_id, $pass = NULL)
        {
                global $ilDB;
                global $ilUser;

                include_once "./Services/Utilities/classes/class.ilStr.php";
                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }
                $affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                        array('integer','integer','integer'),
                        array($active_id, $this->getId(), $pass)
                );
                $text = ilUtil::stripSlashes($_POST["TEXT"], FALSE);
                if ($this->getMaxNumOfChars())
                {
                        include_once "./Services/Utilities/classes/class.ilStr.php";
                        $text_without_tags = preg_replace("/<[^>*?]>/is", "", $text);
                        $len_with_tags = ilStr::strLen($text);
                        $len_without_tags = ilStr::strLen($text_without_tags);
                        if ($this->getMaxNumOfChars() < $len_without_tags)
                        {
                                if (!$this->isHTML($text))
                                {
                                        $text = ilStr::subStr($text, 0, $this->getMaxNumOfChars()); 
                                }
                        }
                }
                if ($this->isHTML($text))
                {
                        $text = preg_replace("/<[^>]*$/ims", "", $text);
                }
                else
                {
                        //$text = htmlentities($text, ENT_QUOTES, "UTF-8");
                }
                $entered_values = 0;
                if (strlen($text))
                {
                        $next_id = $ilDB->nextId('tst_solutions');
                        $affectedRows = $ilDB->insert("tst_solutions", array(
                                "solution_id" => array("integer", $next_id),
                                "active_fi" => array("integer", $active_id),
                                "question_fi" => array("integer", $this->getId()),
                                "value1" => array("clob", trim($text)),
                                "value2" => array("clob", null),
                                "pass" => array("integer", $pass),
                                "tstamp" => array("integer", time())
                        ));
                        $entered_values++;
                }
                if ($entered_values)
                {
                        include_once ("./Modules/Test/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 ("./Modules/Test/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 createRandomSolution($test_id, $user_id)
        {
        }

        function getQuestionType()
        {
                return "assTextQuestion";
        }
        
        function getKeywords()
        {
                return $this->keywords;
        }
        
        function setKeywords($a_keywords)
        {
                $this->keywords = $a_keywords;
        }
        
        function &getKeywordList()
        {
                $keywords = array();
                if (preg_match_all("/([^\s]+)/", $this->keywords, $matches))
                {
                        foreach ($matches[1] as $keyword)
                        {
                                array_push($keywords, trim($keyword));
                        }
                }
                return $keywords;
        }

        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 getAdditionalTableName()
        {
                return "qpl_qst_essay";
        }

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

        public function setExportDetailsXLS(&$adapter, $startrow, $active_id, $pass)
        {
                $solutions = $this->getSolutionValues($active_id, $pass);
                $adapter->setCellValue($startrow, 0, $this->lng->txt($this->getQuestionType()), CELL_FORMAT_TITLE);
                $adapter->setCellValue($startrow, 1, $this->getTitle(), CELL_FORMAT_TITLE);
                $i = 1;
                $adapter->setCellValue($startrow + $i, 0, $this->lng->txt("result"), CELL_FORMAT_BOLD);
                if (strlen($solutions[0]["value1"]))
                {
                        $adapter->setCellValue($startrow + $i, 1, $solutions[0]["value1"]);
                }
                $i++;
                return $startrow + $i + 1;
        }
        
        public function toJSON()
        {
                include_once("./Services/RTE/classes/class.ilRTE.php");
                $result = array();
                $result['id'] = (int) $this->getId();
                $result['type'] = (string) $this->getQuestionType();
                $result['title'] = (string) $this->getTitle();
                $result['question'] =  (string) ilRTE::_replaceMediaObjectImageSrc($this->getQuestion(), 0);
                $result['nr_of_tries'] = (int) $this->getNrOfTries();
                $result['shuffle'] = (bool) $this->getShuffle();
                $result['maxlength'] = (int) $this->getMaxNumOfChars();
                return json_encode($result);
        }

}

?>