class.assOrderingHorizontal.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.iQuestionCondition.php';
require_once './Modules/TestQuestionPool/classes/class.ilUserQuestionResult.php';

class assOrderingHorizontal extends assQuestion implements ilObjQuestionScoringAdjustable, iQuestionCondition
{
        protected $ordertext;
        protected $textsize;
        protected $separator = "::";
        protected $answer_separator = '{::}';
        
        function __construct(
                $title = "",
                $comment = "",
                $author = "",
                $owner = -1,
                $question = ""
        )
        {
                parent::__construct($title, $comment, $author, $owner, $question);
                $this->ordertext = "";
        }
        
        public function isComplete()
        {
                if (strlen($this->title) and ($this->author) and ($this->question) and ($this->getMaximumPoints() > 0))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

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

        public function getAnswerSeparator()
        {
                return $this->answer_separator;
        }

        
        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->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->setOrderText($data["ordertext"]);
                        $this->setTextSize($data["textsize"]);
                        $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)
                        {
                        }
                }

                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;
                include_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 getMaximumPoints()
        {
                return $this->getPoints();
        }

        public function calculateReachedPoints($active_id, $pass = NULL, $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);
                $points = 0;
                $data = $ilDB->fetchAssoc($result);

                $points = $this->calculateReachedPointsForSolution($data['value1']);
                
                return $points;
        }
        
        public function splitAndTrimOrderElementText($in_string, $separator)
        {
                $result = array();
                include_once "./Services/Utilities/classes/class.ilStr.php";
                
                if (ilStr::strPos($in_string, $separator) === false)
                {
                        $result = preg_split("/\\s+/", $in_string);
                }
                else
                {
                        $result = split($separator, $in_string);
                }
                
                foreach ($result as $key => $value)
                {
                        $result[$key] = trim($value);
                }
                
                return $result;
        }
        
        public function getSolutionSubmit()
        {
                return $_POST["orderresult"];
        }
        
        public 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);
                }

                $this->getProcessLocker()->requestUserSolutionUpdateLock();

                $affectedRows = $this->removeCurrentSolution($active_id, $pass);
                
                $solutionSubmit = $this->getSolutionSubmit();
                
                $entered_values = false;
                if (strlen($solutionSubmit))
                {
                        $affectedRows = $this->saveCurrentSolution($active_id, $pass, $_POST['orderresult'], null);
                        $entered_values = true;
                }

                $this->getProcessLocker()->releaseUserSolutionUpdateLock();
                
                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());
                        }
                }

                return true;
        }

        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, ordertext, textsize) VALUES (%s, %s, %s)",
                                                        array( "integer", "text", "float" ),
                                                        array(
                                                                $this->getId(),
                                                                $this->getOrderText(),
                                                                ($this->getTextSize() < 10) ? NULL : $this->getTextSize()
                                                        )
                );
        }

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

        public function getQuestionType()
        {
                return "assOrderingHorizontal";
        }
        
        public function getAdditionalTableName()
        {
                return "qpl_qst_horder";
        }
        
        public function getAnswerTableName()
        {
                return "";
        }
        
        public function deleteAnswers($question_id)
        {
        }

        public function getRTETextWithMediaObjects()
        {
                $text = parent::getRTETextWithMediaObjects();
                return $text;
        }

        public function setExportDetailsXLS(&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
                $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);

                $solutionvalue = "";
                $solutions =& $this->getSolutionValues($active_id, $pass);
                $solutionvalue = str_replace("{::}", " ", $solutions[0]["value1"]);
                $i = 1;
                $worksheet->writeString($startrow+$i, 0, ilExcelUtils::_convert_text($solutionvalue));
                $i++;
                return $startrow + $i + 1;
        }
        
        public function fromXML(&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
        {
                include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assOrderingHorizontalImport.php";
                $import = new assOrderingHorizontalImport($this);
                $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
        }
        
        public function toXML($a_include_header = true, $a_include_binary = true, $a_shuffle = false, $test_output = false, $force_image_references = false)
        {
                include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assOrderingHorizontalExport.php";
                $export = new assOrderingHorizontalExport($this);
                return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
        }

        public function getBestSolution($active_id, $pass)
        {
                $user_solution = array();
                return $user_solution;
        }
        
        public function getOrderingElements()
        {
                return $this->splitAndTrimOrderElementText($this->getOrderText(), $this->separator);
        }
        
        public function getRandomOrderingElements()
        {
                $elements = $this->getOrderingElements();
                shuffle($elements);
                return $elements;
        }
        
        public function getOrderText()
        {
                return $this->ordertext;
        }
        
        public function setOrderText($a_value)
        {
                $this->ordertext = $a_value;
        }
        
        public function getTextSize()
        {
                return $this->textsize;
        }
        
        public function setTextSize($a_value)
        {
                if ($a_value >= 10)
                {
                        $this->textsize = $a_value;
                }
        }
        
        public function getSeparator()
        {
                return $this->separator;
        }
        
        public function setSeparator($a_value)
        {
                $this->separator = $a_value;
        }
        
        public function __get($value)
        {
                switch ($value)
                {
                        case "ordertext":
                                return $this->getOrderText();
                                break;
                        case "textsize":
                                return $this->getTextSize();
                                break;
                        case "separator":
                                return $this->getSeparator();
                                break;
                        default:
                                return parent::__get($value);
                                break;
                }
        }

        public function __set($key, $value)
        {
                switch ($key)
                {
                        case "ordertext":
                                $this->setOrderText($value);
                                break;
                        case "textsize":
                                $this->setTextSize($value);
                                break;
                        case "separator":
                                $this->setSeparator($value);
                                break;
                        default:
                                parent::__set($key, $value);
                                break;
                }
        }
        
        public function supportsJavascriptOutput()
        {
                return true;
        }

        public function supportsNonJsOutput()
        {
                return false;
        }

        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'] =  $this->formatSAQuestion($this->getQuestion());
                $result['nr_of_tries'] = (int) $this->getNrOfTries();
                $result['shuffle'] = (bool) true;
                $result['points'] = (bool) $this->getPoints();
                $result['textsize'] = ((int)$this->getTextSize()) // #10923
                        ? (int)$this->getTextSize()
                        : 100;
                $result['feedback'] = array(
                        'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                        'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
                );
                
                $arr = array();
                foreach ($this->getOrderingElements() as $order => $answer)
                {
                        array_push($arr, array(
                                "answertext" => (string) $answer,
                                "order" => (int) $order+1
                        ));
                }
                $result['answers'] = $arr;

                $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
                $result['mobs'] = $mobs;
        
                return json_encode($result);
        }

        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::OrderingResultExpression,
                        iQuestionCondition::StringResultExpression,
                );
        }

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

                $data = $ilDB->queryF(
                        "SELECT value1 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = (
                                SELECT MAX(step) FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s
                        )",
                        array("integer", "integer", "integer","integer", "integer", "integer"),
                        array($active_id, $pass, $this->getId(), $active_id, $pass, $this->getId())
                );
                $row = $ilDB->fetchAssoc($data);

                $answer_elements = $this->splitAndTrimOrderElementText($row["value1"], $this->answer_separator);
                $elements = $this->getOrderingElements();
                $solutions = array();

                foreach($answer_elements as $answer)
                {
                        foreach($elements as $key => $element)
                        {
                                if($element == $answer)
                                {
                                        $result->addKeyValue($key+1, $answer);
                                }
                        }
                }

                $glue = " ";
                if($this->answer_separator = '{::}')
                {
                        $glue = "";
                }
                $result->addKeyValue(null, join($glue, $answer_elements));

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

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

                return $result;
        }

        public function getAvailableAnswerOptions($index = null)
        {
                $elements = $this->getOrderingElements();
                if($index !== null)
                {
                        if(array_key_exists($index, $elements))
                        {
                                return $elements[$index];
                        }
                        return null;
                }
                else
                {
                        return $elements;
                }
        }

        protected function calculateReachedPointsForSolution($value)
        {
                $value = $this->splitAndTrimOrderElementText($value, $this->answer_separator);
                $value = join($value, $this->answer_separator);
                if(strcmp($value, join($this->getOrderingElements(), $this->answer_separator)) == 0)
                {
                        $points = $this->getPoints();
                        return $points;
                }
                return 0;
        }
}