class.assNumeric.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/class.assQuestion.php';
require_once './Modules/Test/classes/inc.AssessmentConstants.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilObjQuestionScoringAdjustable.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilObjAnswerScoringAdjustable.php';
require_once './Modules/TestQuestionPool/interfaces/interface.iQuestionCondition.php';
require_once './Modules/TestQuestionPool/classes/class.ilUserQuestionResult.php';

class assNumeric extends assQuestion implements ilObjQuestionScoringAdjustable, ilObjAnswerScoringAdjustable, iQuestionCondition
{
        protected $lower_limit;
        protected $upper_limit;

        var $maxchars;

        function __construct(
                $title = "",
                $comment = "",
                $author = "",
                $owner = -1,
                $question = ""
        )
        {
                parent::__construct($title, $comment, $author, $owner, $question);
                $this->maxchars = 6;
        }

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

        public function saveToDb($original_id = "")
        {
                $this->saveQuestionDataToDb($original_id);
                $this->saveAdditionalQuestionDataToDb();
                $this->saveAnswerSpecificDataToDb();
                parent::saveToDb($original_id);
        }

        public 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->setNrOfTries($data['nr_of_tries']);
                        $this->setOriginalId($data["original_id"]);
                        $this->setAuthor($data["author"]);
                        $this->setPoints($data["points"]);
                        $this->setOwner($data["owner"]);
                        require_once './Services/RTE/classes/class.ilRTE.php';
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                        $this->setMaxChars($data["maxnumofchars"]);
                        $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                        
                        try
                        {
                                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
                        }
                        catch(ilTestQuestionPoolException $e)
                        {
                        }
                }

                $result = $ilDB->queryF("SELECT * FROM qpl_num_range WHERE question_fi = %s ORDER BY aorder ASC",
                        array('integer'),
                        array($question_id)
                );

                require_once './Modules/TestQuestionPool/classes/class.assNumericRange.php';
                if ($result->numRows() > 0)
                {
                        while ($data = $ilDB->fetchAssoc($result))
                        {
                                $this->setPoints($data['points']);
                                $this->setLowerLimit($data['lowerlimit']);
                                $this->setUpperLimit($data['upperlimit']);
                        }
                }

                parent::loadFromDb($question_id);
        }

        public function duplicate($for_test = true, $title = "", $author = "", $owner = "", $testObjId = null)
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $this_id = $this->getId();
                $thisObjId = $this->getObjId();
                
                $clone = $this;
                require_once './Modules/TestQuestionPool/classes/class.assQuestion.php';
                $original_id = assQuestion::_getOriginalId($this->id);
                $clone->id = -1;
                
                if( (int)$testObjId > 0 )
                {
                        $clone->setObjId($testObjId);
                }
                
                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);

                $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());

                return $clone->id;
        }

        public function copyObject($target_questionpool_id, $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_id = $this->getObjId();
                $clone->setObjId($target_questionpool_id);
                if ($title)
                {
                        $clone->setTitle($title);
                }
                $clone->saveToDb();

                // copy question page content
                $clone->copyPageOfQuestion($original_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($original_id);

                $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());

                return $clone->id;
        }

        public function createNewOriginalFromThisDuplicate($targetParentId, $targetQuestionTitle = "")
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }

                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");

                $sourceQuestionId = $this->id;
                $sourceParentId = $this->getObjId();

                // duplicate the question in database
                $clone = $this;
                $clone->id = -1;

                $clone->setObjId($targetParentId);

                if ($targetQuestionTitle)
                {
                        $clone->setTitle($targetQuestionTitle);
                }

                $clone->saveToDb();
                // copy question page content
                $clone->copyPageOfQuestion($sourceQuestionId);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);

                $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());

                return $clone->id;
        }

        public function getLowerLimit()
        {
                return $this->lower_limit;
        }

        public function getUpperLimit()
        {
                return $this->upper_limit;
        }

        public function setLowerLimit($a_limit)
        {
                $a_limit = str_replace(',', '.', $a_limit);
                $this->lower_limit = $a_limit;
        }

        public function setUpperLimit($a_limit)
        {
                $a_limit = str_replace(',', '.', $a_limit);
                $this->upper_limit = $a_limit;
        }

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

        public function calculateReachedPointsFromPreviewSession(ilAssQuestionPreviewSession $previewSession)
        {
                $points = 0;
                if ($this->contains($previewSession->getParticipantsSolution()))
                {
                        $points = $this->getPoints();
                }

                $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $points);
                
                return $this->ensureNonNegativePoints($reachedPoints);
        }

        public function calculateReachedPoints($active_id, $pass = NULL, $authorizedSolution = true, $returndetails = FALSE)
        {
                if( $returndetails )
                {
                        throw new ilTestException('return details not implemented for '.__METHOD__);
                }

                global $ilDB;

                $found_values = array();
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
                $data = $ilDB->fetchAssoc($result);

                $enteredvalue = $data["value1"];

                $points = 0;
                if ($this->contains($enteredvalue))
                {
                        $points = $this->getPoints();
                }

                return $points;
        }

        public function contains($value) 
        {
                require_once './Services/Math/classes/class.EvalMath.php';
                $eval = new EvalMath();
                $eval->suppress_errors = TRUE;
                $result = $eval->e($value);
                if (($result === FALSE) || ($result === TRUE)) 
                {
                        return FALSE;
                }

                if (($result >= $eval->e($this->getLowerLimit())) && ($result <= $eval->e($this->getUpperLimit())))
                {
                        return TRUE;
                }
                return FALSE;
        }
        
        protected function isValidNumericSubmitValue($submittedValue)
        {
                if( is_numeric($submittedValue) )
                {
                        return true;
                }
                
                if( preg_match('/^[-+]{0,1}\d+\/\d+$/', $submittedValue) )
                {
                        return true;
                }
                
                return false;
        }
        
        public function validateSolutionSubmit()
        {
                if( strlen($this->getSolutionSubmit()) && !$this->isValidNumericSubmitValue($this->getSolutionSubmit()) )
                {
                        ilUtil::sendFailure($this->lng->txt("err_no_numeric_value"), true);
                        return false;
                }
                
                return true;
        }
        
        public function getSolutionSubmit()
        {
                return trim(str_replace(",",".",$_POST["numeric_result"]));
        }
        
        public function isValidSolutionSubmit($numeric_solution)
        {
                require_once './Services/Math/classes/class.EvalMath.php';
                $math = new EvalMath();
                $math->suppress_errors = TRUE;
                $result = $math->evaluate($numeric_solution);
                
                return !(
                        ($result === FALSE || $result === TRUE) && strlen($numeric_solution) > 0
                );
        }

        public function saveWorkingData($active_id, $pass = NULL, $authorized = true)
        {
                global $ilDB;

                if (is_null($pass))
                {
                        require_once './Modules/Test/classes/class.ilObjTest.php';
                        $pass = ilObjTest::_getPass($active_id);
                }

                $entered_values = 0;

                $returnvalue = true;

                $numeric_result = $this->getSolutionSubmit();

                $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function() use (&$entered_values, $numeric_result, $ilDB, $active_id, $pass, $authorized) {

                        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized);

                        $row    = $ilDB->fetchAssoc($result);
                        $update = $row["solution_id"];
                        if($update)
                        {
                                if(strlen($numeric_result))
                                {
                                        $this->updateCurrentSolution($update, trim($numeric_result), null, $authorized);
                                        $entered_values++;
                                }
                                else
                                {
                                        $this->removeSolutionRecordById($update);
                                }
                        }
                        else
                        {
                                if(strlen($numeric_result))
                                {
                                        $this->saveCurrentSolution($active_id, $pass, trim($numeric_result), null, $authorized);
                                        $entered_values++;
                                }
                        }

                });

                if ($entered_values)
                {
                        require_once './Modules/Test/classes/class.ilObjAssessmentFolder.php';
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                assQuestion::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())
                        {
                                assQuestion::logAction($this->lng->txtlng(
                                        "assessment",
                                        "log_user_not_entered_values",
                                        ilObjAssessmentFolder::_getLogLanguage()
                                ),
                                        $active_id,
                                        $this->getId()
                                );
                        }
                }

                return $returnvalue;
        }

        protected function savePreviewData(ilAssQuestionPreviewSession $previewSession)
        {
                $numericSolution = $this->getSolutionSubmit();
                $previewSession->setParticipantsSolution($numericSolution);
        }

        public function saveAdditionalQuestionDataToDb()
        {
                global $ilDB;

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

                $ilDB->manipulateF( "INSERT INTO " . $this->getAdditionalTableName(
                                                                                                   ) . " (question_fi, maxnumofchars) VALUES (%s, %s)",
                                                        array( "integer", "integer" ),
                                                        array(
                                                                $this->getId(),
                                                                ($this->getMaxChars()) ? $this->getMaxChars() : 0
                                                        )
                );
        }

        public function saveAnswerSpecificDataToDb()
        {
                global $ilDB;

                // Write range to the database
                $ilDB->manipulateF( "DELETE FROM qpl_num_range WHERE question_fi = %s",
                                                        array( 'integer' ),
                                                        array( $this->getId() )
                );

                $next_id = $ilDB->nextId( 'qpl_num_range' );
                $ilDB->manipulateF( "INSERT INTO qpl_num_range (range_id, question_fi, lowerlimit, upperlimit, points, aorder, tstamp) 
                                                         VALUES (%s, %s, %s, %s, %s, %s, %s)",
                                                        array( 'integer', 'integer', 'text', 'text', 'float', 'integer', 'integer' ),
                                                        array( $next_id, $this->id, $this->getLowerLimit(), $this->getUpperLimit(
                                                        ), $this->getPoints(), 0, time() )
                );
        }

        protected function reworkWorkingData($active_id, $pass, $obligationsAnswered, $authorized)
        {
                // nothing to rework!
        }

        public function getQuestionType()
        {
                return "assNumeric";
        }

        public function getMaxChars()
        {
                return $this->maxchars;
        }

        public function setMaxChars($maxchars)
        {
                $this->maxchars = $maxchars;
        }

        function getAdditionalTableName()
        {
                return "qpl_qst_numeric";
        }

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

        public function setExportDetailsXLS($worksheet, $startrow, $active_id, $pass)
        {
                parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);

                $solutions = $this->getSolutionValues($active_id, $pass);

                $i = 1;
                $worksheet->setCell($startrow + $i, 0, $this->lng->txt("result"));
                $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
                
                $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
                if (strlen($solutions[0]["value1"]))
                {
                        $worksheet->setCell($startrow + $i, 1, $solutions[0]["value1"]);
                }
                $i++;

                return $startrow + $i + 1;
        }

        public function getOperators($expression)
        {
                require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
                return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
        }

        public function getExpressionTypes()
        {
                return array(
                        iQuestionCondition::PercentageResultExpression,
                        iQuestionCondition::NumericResultExpression,
                        iQuestionCondition::EmptyAnswerExpression,
                );
        }

        public function getUserQuestionResult($active_id, $pass)
        {
                global $ilDB;
                $result = new ilUserQuestionResult($this, $active_id, $pass);

                $maxStep = $this->lookupMaxStep($active_id, $pass);

                if( $maxStep !== null )
                {
                        $data = $ilDB->queryF(
                                "SELECT value1 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = %s",
                                array("integer", "integer", "integer","integer"),
                                array($active_id, $pass, $this->getId(), $maxStep)
                        );
                }
                else
                {
                        $data = $ilDB->queryF(
                                "SELECT value1 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s",
                                array("integer", "integer", "integer"),
                                array($active_id, $pass, $this->getId())
                        );
                }

                while($row = $ilDB->fetchAssoc($data))
                {
                        $result->addKeyValue(1, $row["value1"]);
                }

                $points = $this->calculateReachedPoints($active_id, $pass);
                $max_points = $this->getMaximumPoints();

                $result->setReachedPercentage(($points/$max_points) * 100);

                return $result;
        }

        public function getAvailableAnswerOptions($index = null)
        {
                return array(
                        "lower" => $this->getLowerLimit(),
                        "upper" => $this->getUpperLimit()
                );
        }
}