Public Member Functions | Data Fields

assNumeric Class Reference
[Modules/TestQuestionPool]

Class for numeric questions. More...

Inheritance diagram for assNumeric:
Collaboration diagram for assNumeric:

Public Member Functions

 assNumeric ($title="", $comment="", $author="", $owner=-1, $question="")
 assNumeric constructor
 isComplete ()
 Returns true, if a numeric question is complete for use.
 saveToDb ($original_id="")
 Saves a assNumeric object to a database.
 loadFromDb ($question_id)
 Loads a assNumeric object from a database.
 addRange ($lowerlimit=0.0, $upperlimit=0.0, $points=0.0, $order=0)
 Adds a range to the numeric question.
 duplicate ($for_test=true, $title="", $author="", $owner="")
 Duplicates an assNumericQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assNumeric object.
 getRangeCount ()
 Returns the number of ranges.
 getRange ($index=0)
 Returns a range.
 deleteRange ($index=0)
 Deletes a range.
 flushRanges ()
 Deletes all ranges.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 getBestRange ()
 Returns the range with the maximum points, a learner can reach answering the question.
 calculateReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 getQuestionType ()
 Returns the question type of the question.
 getMaxChars ()
 Returns the maximum number of characters for the numeric input field.
 setMaxChars ($maxchars)
 Sets the maximum number of characters for the numeric input field.
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database.
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor.
getRanges ()
 Returns the ranges array.

Data Fields

 $ranges
 $maxchars

Detailed Description

Class for numeric questions.

assNumeric is a class for numeric questions. To solve a numeric question, a learner has to enter a numerical value in a defined range

Author:
Helmut Schottmüller <helmut.schottmueller@mac.com>
Nina Gharib <nina@wgserve.de>
Version:
Id:
class.assNumeric.php 18645 2009-01-20 18:35:38Z hschottm

Definition at line 37 of file class.assNumeric.php.


Member Function Documentation

assNumeric::addRange ( lowerlimit = 0.0,
upperlimit = 0.0,
points = 0.0,
order = 0 
)

Adds a range to the numeric question.

Adds a range to the numeric question. An assNumericRange object will be created and assigned to the array $this->ranges

Parameters:
double $lowerlimit The lower limit of the range
double $upperlimit The upper limit of the range
double $points The points for entering a number in the correct range
integer $order The display order of the range public
See also:
$ranges
assNumericalRange

Definition at line 290 of file class.assNumeric.php.

References assQuestion::$points.

        {
                $found = -1;
                foreach ($this->ranges as $key => $range)
                {
                        if ($range->getOrder() == $order)
                        {
                                $found = $order;
                        }
                }
                include_once "./Modules/TestQuestionPool/classes/class.assNumericRange.php";
                if ($found >= 0)
                {
                        // insert range
                        $range = new assNumericRange($lowerlimit, $upperlimit, $points, $found);
                        array_push($this->ranges, $range);
                        for ($i = $found + 1; $i < count($this->ranges); $i++)
                        {
                                $this->ranges[$i] = $this->ranges[$i-1];
                        }
                        $this->ranges[$found] = $range;
                }
                else
                {
                        // append range
                        $range = new assNumericRange($lowerlimit, $upperlimit, $points, count($this->ranges));
                        array_push($this->ranges, $range);
                }
        }

assNumeric::assNumeric ( title = "",
comment = "",
author = "",
owner = -1,
question = "" 
)

assNumeric constructor

The constructor takes possible arguments an creates an instance of the assNumeric object.

Parameters:
string $title A title string to describe the question
string $comment A comment string to describe the question
string $author A string containing the name of the questions author
integer $owner A numerical ID to identify the owner/creator
string $question The question string of the numeric question public
See also:
assQuestion:assQuestion()

Definition at line 70 of file class.assNumeric.php.

References assQuestion::$author, assQuestion::$comment, assQuestion::$owner, assQuestion::$question, assQuestion::$title, and assQuestion::assQuestion().

        {
                $this->assQuestion($title, $comment, $author, $owner, $question);
                $this->ranges = array();
                $this->maxchars = 6;
        }

Here is the call graph for this function:

assNumeric::calculateReachedPoints ( active_id,
pass = NULL 
)

Returns the points, a learner has reached answering the question.

Returns the points, a learner has reached answering the question The points are calculated from the given answers including checks for all special scoring options in the test container.

Parameters:
integer $user_id The database ID of the learner
integer $test_id The database Id of the test containing the question public

Definition at line 543 of file class.assNumeric.php.

References $data, assQuestion::$points, assQuestion::getId(), and assQuestion::getSolutionMaxPass().

        {
                global $ilDB;
                
                $found_values = array();
                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);
                $data = $result->fetchRow(DB_FETCHMODE_ASSOC);
                
                $enteredvalue = $data["value1"];
                //if (!is_numeric($enteredvalue)) return 0;
                $points = 0;
                foreach ($this->ranges as $key => $range)
                {
                        if ($points == 0)
                        {
                                if ($range->contains($enteredvalue))
                                {
                                        $points = $range->getPoints();
                                }
                        }
                }

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

Here is the call graph for this function:

assNumeric::copyObject ( target_questionpool,
title = "" 
)

Copies an assNumeric object.

Copies an assNumeric object

public

Definition at line 385 of file class.assNumeric.php.

References assQuestion::$title, assQuestion::_getOriginalId(), and assQuestion::getObjId().

        {
                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;
        }

Here is the call graph for this function:

assNumeric::deleteRange ( index = 0  ) 

Deletes a range.

Deletes a range with a given index. The index of the first range is 0, the index of the second range is 1 and so on.

Parameters:
integer $index A nonnegative index of the n-th range public
See also:
$ranges

Definition at line 459 of file class.assNumeric.php.

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

assNumeric::duplicate ( for_test = true,
title = "",
author = "",
owner = "" 
)

Duplicates an assNumericQuestion.

Duplicates an assNumericQuestion

public

Definition at line 332 of file class.assNumeric.php.

References assQuestion::$author, assQuestion::$owner, assQuestion::$title, assQuestion::_getOriginalId(), and assQuestion::getId().

        {
                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;
        }

Here is the call graph for this function:

assNumeric::flushRanges (  ) 

Deletes all ranges.

Deletes all ranges

public

See also:
$ranges

Definition at line 483 of file class.assNumeric.php.

        {
                $this->ranges = array();
        }

assNumeric::getAdditionalTableName (  ) 

Returns the name of the additional question data table in the database.

Returns the name of the additional question data table in the database

Returns:
string The additional table name public

Reimplemented from assQuestion.

Definition at line 720 of file class.assNumeric.php.

        {
                return "qpl_question_numeric";
        }

assNumeric::getBestRange (  ) 

Returns the range with the maximum points, a learner can reach answering the question.

Returns the range with the maximum points, a learner can reach answering the question

public

See also:
$points

Definition at line 517 of file class.assNumeric.php.

        {
                $max = 0;
                $bestrange = NULL;
                foreach ($this->ranges as $key => $range) 
                {
                        if ($range->getPoints() > $max)
                        {
                                $max = $range->getPoints();
                                $bestrange = $range;
                        }
                }
                return $bestrange;
        }

assNumeric::getMaxChars (  ) 

Returns the maximum number of characters for the numeric input field.

Returns the maximum number of characters for the numeric input field

Returns:
integer The maximum number of characters public

Definition at line 694 of file class.assNumeric.php.

Referenced by saveToDb().

        {
                return $this->maxchars;
        }

Here is the caller graph for this function:

assNumeric::getMaximumPoints (  ) 

Returns the maximum points, a learner can reach answering the question.

Returns the maximum points, a learner can reach answering the question

public

See also:
$points

Reimplemented from assQuestion.

Definition at line 496 of file class.assNumeric.php.

Referenced by isComplete(), and saveToDb().

        {
                $max = 0;
                foreach ($this->ranges as $key => $range) 
                {
                        if ($range->getPoints() > $max)
                        {
                                $max = $range->getPoints();
                        }
                }
                return $max;
        }

Here is the caller graph for this function:

assNumeric::getQuestionType (  ) 

Returns the question type of the question.

Returns the question type of the question

Returns:
integer The question type of the question public

Reimplemented from assQuestion.

Definition at line 681 of file class.assNumeric.php.

        {
                return "assNumeric";
        }

assNumeric::getRange ( index = 0  ) 

Returns a range.

Returns a range with a given index. The index of the first range is 0, the index of the second range is 1 and so on.

Parameters:
integer $index A nonnegative index of the n-th range
Returns:
object assNumericelRange-Object containing the range public
See also:
$ranges

Definition at line 440 of file class.assNumeric.php.

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

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

assNumeric::getRangeCount (  ) 

Returns the number of ranges.

Returns the number of ranges

Returns:
integer The number of ranges of the numeric question public
See also:
$ranges

Definition at line 424 of file class.assNumeric.php.

        {
                return count($this->ranges);
        }

& assNumeric::getRanges (  ) 

Returns the ranges array.

Definition at line 737 of file class.assNumeric.php.

        {
                return $this->ranges;
        }

assNumeric::getRTETextWithMediaObjects (  ) 

Collects all text in the question which could contain media objects which were created with the Rich Text Editor.

Reimplemented from assQuestion.

Definition at line 729 of file class.assNumeric.php.

assNumeric::isComplete (  ) 

Returns true, if a numeric question is complete for use.

Returns true, if a numeric question is complete for use

Returns:
boolean True, if the numeric question is complete for use, otherwise false public

Reimplemented from assQuestion.

Definition at line 91 of file class.assNumeric.php.

References getMaximumPoints().

Referenced by saveToDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

assNumeric::loadFromDb ( question_id  ) 

Loads a assNumeric object from a database.

Loads a assNumeric object from a database (experimental)

Parameters:
object $db A pear DB object
integer $question_id A unique key which defines the multiple choice test in the database public

Reimplemented from assQuestion.

Definition at line 230 of file class.assNumeric.php.

References $data, ilRTE::_replaceMediaObjectImageSrc(), and assQuestion::setEstimatedWorkingTime().

        {
                global $ilDB;
                
    $query = sprintf("SELECT qpl_questions.*, qpl_question_numeric.* FROM qpl_questions, qpl_question_numeric WHERE question_id = %s AND qpl_questions.question_id = qpl_question_numeric.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->maxchars = $data->maxNumOfChars;
                                $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_numeric_range WHERE question_fi = %s ORDER BY aorder ASC",
                                $ilDB->quote($question_id)
                        );

                        $result = $ilDB->query($query);

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

Here is the call graph for this function:

assNumeric::saveToDb ( original_id = ""  ) 

Saves a assNumeric object to a database.

Saves a assNumeric object to a database (experimental)

Parameters:
object $db A pear DB object public

Reimplemented from assQuestion.

Definition at line 111 of file class.assNumeric.php.

References ilRTE::_replaceMediaObjectImageSrc(), assQuestion::createPageObject(), assQuestion::getEstimatedWorkingTime(), getMaxChars(), getMaximumPoints(), assQuestion::getQuestionTypeID(), assQuestion::getTestId(), assQuestion::insertIntoTest(), and isComplete().

        {
                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_numeric (question_fi, maxNumOfChars) VALUES (%s, %s)",
                                        $ilDB->quote($this->id . ""),
                                        $ilDB->quote($this->getMaxChars() . "")
                                );
                                $ilDB->query($query);

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

                                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_numeric SET maxNumOfChars = %s WHERE question_fi = %s",
                                $ilDB->quote($this->getMaxChars() . ""),
                                $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_numeric_range WHERE question_fi = %s",
                                $ilDB->quote($this->id)
                        );
                        $result = $ilDB->query($query);

                        // 2. write ranges
                        foreach ($this->ranges as $key => $range)
                        {
                                $query = sprintf("INSERT INTO qpl_numeric_range (range_id, question_fi, lowerlimit, upperlimit, points, aorder, lastchange) VALUES (NULL, %s, %s, %s, %s, %s, NULL)",
                                $ilDB->quote($this->id),
                                $ilDB->quote($range->getLowerLimit()),
                                $ilDB->quote($range->getUpperLimit() . ""),
                                $ilDB->quote($range->getPoints() . ""),
                                $ilDB->quote($range->getOrder() . "")
                                );
                                $answer_result = $ilDB->query($query);
                        }
                }
                parent::saveToDb($original_id);
        }

Here is the call graph for this function:

assNumeric::saveWorkingData ( active_id,
pass = NULL 
)

Saves the learners input of the question to the database.

Saves the learners input of the question to the database

Parameters:
integer $test_id The database id of the test containing this question
Returns:
boolean Indicates the save status (true if saved successful, false otherwise) public
See also:
$ranges

Reimplemented from assQuestion.

Definition at line 588 of file class.assNumeric.php.

References ilObjAssessmentFolder::_enabledAssessmentLogging(), ilObjAssessmentFolder::_getLogLanguage(), ilObjTest::_getPass(), assQuestion::getId(), assQuestion::logAction(), and ilUtil::sendInfo().

        {
                global $ilDB;
                global $ilUser;

                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }
                $entered_values = 0;
                $numeric_result = str_replace(",",".",$_POST["numeric_result"]);

                include_once "./Services/Math/classes/class.EvalMath.php";
                $math = new EvalMath();
                $math->suppress_errors = TRUE;
                $result = $math->evaluate($numeric_result);
                $returnvalue = true;
                if (($result === FALSE) || ($result === TRUE))
                {
                        ilUtil::sendInfo($this->lng->txt("err_no_numeric_value"), true);
                        $returnvalue = false;
                }
                $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);
                $row = $result->fetchRow(DB_FETCHMODE_OBJECT);
                $update = $row->solution_id;
                if ($update)
                {
                        if (strlen($numeric_result))
                        {
                                $query = sprintf("UPDATE tst_solutions SET value1 = %s WHERE solution_id = %s",
                                        $ilDB->quote(trim($numeric_result)),
                                        $ilDB->quote($update)
                                );
                                $result = $ilDB->query($query);
                                $entered_values++;
                        }
                        else
                        {
                                $query = sprintf("DELETE FROM tst_solutions WHERE solution_id = %s",
                                        $ilDB->quote($update)
                                );
                                $result = $ilDB->query($query);
                        }
                }
                else
                {
                        if (strlen($numeric_result))
                        {
                                $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($numeric_result)),
                                        $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 $returnvalue;
        }

Here is the call graph for this function:

assNumeric::setMaxChars ( maxchars  ) 

Sets the maximum number of characters for the numeric input field.

Sets the maximum number of characters for the numeric input field

Parameters:
integer $maxchars The maximum number of characters public

Definition at line 707 of file class.assNumeric.php.

References $maxchars.

        {
                $this->maxchars = $maxchars;
        }


Field Documentation

assNumeric::$maxchars

Definition at line 55 of file class.assNumeric.php.

Referenced by setMaxChars().

assNumeric::$ranges

Definition at line 46 of file class.assNumeric.php.


The documentation for this class was generated from the following file: