Class for horizontal ordering questions. More...

Inheritance diagram for assOrderingHorizontal:

Collaboration diagram for assOrderingHorizontal:

Public Member Functions
	__construct ($title="", $comment="", $author="", $owner=-1, $question="")
	assOrderingHorizontal constructor
	isComplete ()
	Returns true, if a single choice question is complete for use.
	saveToDb ($original_id="")
	Saves a assOrderingHorizontal object to a database.
	loadFromDb ($question_id)
	Loads a assOrderingHorizontal object from a database.
	duplicate ($for_test=true, $title="", $author="", $owner="")
	Duplicates an assOrderingHorizontal.
	copyObject ($target_questionpool, $title="")
	Copies an assOrderingHorizontal object.
	getMaximumPoints ()
	Returns 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 The points are calculated from the given answers including checks for all special scoring options in the test container.
	saveWorkingData ($active_id, $pass=NULL)
	Saves the learners input of the question to the database.
	moveRight ($position, $active_id, $pass=null)
	getQuestionType ()
	Returns the question type of the question.
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database.
	getAnswerTableName ()
	Returns the name of the answer table in the database.
	deleteAnswers ($question_id)
	Deletes datasets from answers tables.
	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor.
	setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question.
	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Creates a question from a QTI file.
	toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
	Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.
	getBestSolution ($active_id, $pass)
	Returns the best solution for a given pass of a participant.
	getOrderingElements ()
	Get ordering elements from order text.
	getRandomOrderingElements ()
	Get ordering elements from order text in random sequence.
	getOrderText ()
	Get order text.
	setOrderText ($a_value)
	Set order text.
	getTextSize ()
	Get text size.
	setTextSize ($a_value)
	Set text size.
	getSeparator ()
	Get order text separator.
	setSeparator ($a_value)
	Set order text separator.
	__get ($value)
	Object getter.
	__set ($key, $value)
	Object setter.
Public Member Functions inherited from assQuestion
	questionTitleExists ($questionpool_id, $title)
	Returns TRUE if the question title exists in the database.
	setTitle ($title="")
	Sets the title string of the assQuestion object.
	setId ($id=-1)
	Sets the id of the assQuestion object.
	setTestId ($id=-1)
	Sets the test id of the assQuestion object.
	setComment ($comment="")
	Sets the comment string of the assQuestion object.
	setOutputType ($outputType=OUTPUT_HTML)
	Sets the output type.
	setShuffle ($shuffle=true)
	Sets the shuffle flag.
	setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
	Sets the estimated working time of a question.
	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array
	setAuthor ($author="")
	Sets the authors name of the assQuestion object.
	setOwner ($owner="")
	Sets the creator/owner ID of the assQuestion object.
	getTitle ()
	Gets the title string of the assQuestion object.
	getId ()
	Gets the id of the assQuestion object.
	getShuffle ()
	Gets the shuffle flag.
	getTestId ()
	Gets the test id of the assQuestion object.
	getComment ()
	Gets the comment string of the assQuestion object.
	getOutputType ()
	Gets the output type.
	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output.
	getEstimatedWorkingTime ()
	Gets the estimated working time of a question.
	getAuthor ()
	Gets the authors name of the assQuestion object.
	getOwner ()
	Gets the creator/owner ID of the assQuestion object.
	getObjId ()
	Get the object id of the container object.
	setObjId ($obj_id=0)
	Set the object id of the container object.
	_getMaximumPoints ($question_id)
	Returns the maximum points, a learner can reach answering the question.
&	_getQuestionInfo ($question_id)
	Returns question information from the database.
	getSuggestedSolutionOutput ()
&	_getSuggestedSolution ($question_id, $subquestion_index=0)
	Returns a suggested solution for a given subquestion index.
	getSuggestedSolutions ()
	Return the suggested solutions.
	_getReachedPoints ($active_id, $question_id, $pass=NULL)
	Returns the points, a learner has reached answering the question.
	getReachedPoints ($active_id, $pass=NULL)
	Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database.
	calculateResultsFromSolution ($active_id, $pass=NULL)
	Calculates the question results from a previously saved question solution.
	_updateTestResultCache ($active_id)
	_updateTestPassResults ($active_id, $pass)
	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log.
	_logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log.
	moveUploadedMediaFile ($file, $name)
	Move an uploaded media file to an public accessible temp dir to present it.
	getSuggestedSolutionPath ()
	Returns the path for a suggested solution.
	getJavaPath ()
	Returns the image path for web accessable images of a question.
	getImagePath ()
	Returns the image path for web accessable images of a question.
	getFlashPath ()
	Returns the image path for web accessable flash files of a question.
	getJavaPathWeb ()
	Returns the web image path for web accessable java applets of a question.
	getSuggestedSolutionPathWeb ()
	Returns the web path for a suggested solution.
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question.
	getFlashPathWeb ()
	Returns the web image path for web accessable flash applications of a question.
&	getSolutionValues ($active_id, $pass=NULL)
	Loads solutions of a given user from the database an returns it.
	isInUse ($question_id="")
	Checks whether the question is in use or not.
	isClone ($question_id="")
	Checks whether the question is a clone of another question or not.
	pcArrayShuffle ($array)
	Shuffles the values of a given array.
	getQuestionTypeFromDb ($question_id)
	get question type for question id
	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database.
	delete ($question_id)
	Deletes a question and all materials from the database.
	getTotalAnswers ()
	get total number of answers
	_getTotalAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method
	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method
	_getTitle ($a_q_id)
	Returns the title of a question.
	_getQuestionText ($a_q_id)
	Returns question text.
	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	create page object of question
	copyPageOfQuestion ($a_q_id)
	getPageOfQuestion ()
	_getQuestionType ($question_id)
	Returns the question type of a question with a given id.
	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id.
	setOriginalId ($original_id)
	getOriginalId ()
	createNewQuestion ()
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs.
	saveQuestionDataToDb ($original_id="")
	deleteSuggestedSolutions ()
	Deletes all suggestes solutions in the database.
	getSuggestedSolution ($subquestion_index=0)
	Returns a suggested solution for a given subquestion index.
	getSuggestedSolutionTitle ($subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index.
	setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
	Sets a suggested solution for the question.
	updateSuggestedSolutions ($original_id="")
	Update the suggested solutions of a question based on the suggested solution array attribute.
	saveSuggestedSolution ($type, $solution_id="", $subquestion_index=0, $value="")
	Saves a suggested solution for the question.
	_resolveInternalLink ($internal_link)
	_resolveIntLinks ($question_id)
	_getInternalLinkHref ($target="")
	_getOriginalId ($question_id)
	Returns the original id of a question.
	syncWithOriginal ()
	createRandomSolution ($test_id, $user_id)
	_questionExists ($question_id)
	Returns true if the question already exists in the database.
&	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id.
	getPoints ()
	Returns the maximum available points for the question.
	setPoints ($a_points)
	Sets the maximum available points for the question.
	getSolutionMaxPass ($active_id)
	Returns the maximum pass a users question solution.
	_getSolutionMaxPass ($question_id, $active_id)
	Returns the maximum pass a users question solution.
	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user.
	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not.
	calculateReachedPoints ($active_id, $pass=NULL, $points=0)
	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.
	isHTML ($a_text)
	Checks if a given string contains HTML or not.
	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
	Prepares a string for a text area output in tests.
	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string.
	addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
	Creates a QTI material tag from a plain text or xhtml text.
	createNewImageFileName ($image_filename)
	_setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass=NULL, $manualscoring=FALSE)
	Sets the points, a learner has reached answering the question Additionally objective results are updated.
	getQuestion ()
	Gets the question string of the question object.
	setQuestion ($question="")
	Sets the question string of the question object.
	getQuestionTypeID ()
	Returns the question type of the question.
	saveFeedbackGeneric ($correctness, $feedback)
	Saves generic feedback to the database.
	getFeedbackGeneric ($correctness)
	Returns the generic feedback for a given question state.
	duplicateFeedbackGeneric ($original_id)
	Duplicates the generic feedback of a question.
	syncFeedbackGeneric ()
	cleanupMediaObjectUsage ()
	synchronises appearances of media objects in the question with media object usage table
&	getInstances ()
	Gets all instances of the question.
	_needsManualScoring ($question_id)
	getActiveUserData ($active_id)
	Returns the user id and the test id for a given active id.
&	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id.
	getNrOfTries ()
	setNrOfTries ($a_nr_of_tries)

Protected Attributes
	$ordertext
	$textsize
	$separator = "::"
	$answer_separator = '{::}'
Protected Attributes inherited from assQuestion
	$id
	$title
	$comment
	$owner
	$author
	$question
	$points
	$est_working_time
	$shuffle
	$test_id
	$obj_id
	$ilias
	$tpl
	$lng
	$outputType
	$suggested_solutions
	$original_id
	$page

Private Member Functions
	splitAndTrimOrderElementText ($in_string, $separator)
	Splits the answer string either by space(s) or the separator (eg.

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question.
static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution.
static	_isWorkedThrough ($active_id, $question_id, $pass=NULL)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value.
static	_areAnswered ($a_user_id, $a_question_ids)
	Checks if an array of question ids is answered by an user or not.
static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type.
static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag.
Protected Member Functions inherited from assQuestion
	deletePageOfQuestion ($question_id)
	Deletes the page object of a question with a given ID.
	onDuplicate ($source_question_id)
	Will be called when a question is duplicated (inside a question pool or for insertion in a test)
	onCopy ($source_questionpool_id, $source_question_id)
	Will be called when a question is copied (into another question pool)
	duplicateSuggestedSolutionFiles ($question_id)
	Duplicates the files of a suggested solution if the question is duplicated.
	syncSuggestedSolutionFiles ($original_id)
	Syncs the files of a suggested solution if the question is synced.
	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)

Detailed Description

Class for horizontal ordering questions.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

Id:: class.assOrderingHorizontal.php 33611 2012-03-08 15:16:09Z mbecker

Definition at line 33 of file class.assOrderingHorizontal.php.

Constructor & Destructor Documentation

assOrderingHorizontal::__construct	(	$title = `""`,
		$comment = `""`,
		$author = `""`,
		$owner = `-1`,
		$question = `""`
	)

assOrderingHorizontal constructor

The constructor takes possible arguments an creates an instance of the assOrderingHorizontal 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 single choice question

See Also: assQuestion:__construct()

Reimplemented from assQuestion.

Definition at line 52 of file class.assOrderingHorizontal.php.

References assQuestion\$author, assQuestion\$comment, assQuestion\$owner, assQuestion\$question, and assQuestion\$title.

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

Member Function Documentation

assOrderingHorizontal::__get ( $value )

Object getter.

Reimplemented from assQuestion.

Definition at line 641 of file class.assOrderingHorizontal.php.

References getOrderText(), getSeparator(), and getTextSize().

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

Here is the call graph for this function:

assOrderingHorizontal::__set	(	$key,
		$value
	)

Object setter.

Reimplemented from assQuestion.

Definition at line 663 of file class.assOrderingHorizontal.php.

References setOrderText(), setSeparator(), and setTextSize().

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

Here is the call graph for this function:

assOrderingHorizontal::calculateReachedPoints	(	$active_id,
		$pass = `NULL`
	)

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

Definition at line 248 of file class.assOrderingHorizontal.php.

References $data, $ilDB, $pass, assQuestion\$points, $result, assQuestion\getId(), getOrderingElements(), assQuestion\getPoints(), assQuestion\getSolutionMaxPass(), and splitAndTrimOrderElementText().

Referenced by moveRight().

        {
                global $ilDB;
                
                $found_values = array();
                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)
                );
                $points = 0;
                $data = $ilDB->fetchAssoc($result);
                $data["value1"] = $this->splitAndTrimOrderElementText($data["value1"], $this->answer_separator);
                
                $data['value1'] = join($data['value1'], $this->answer_separator);
                
                if (strcmp($data["value1"], join($this->getOrderingElements(), $this->answer_separator)) == 0)
                {
                        $points = $this->getPoints();
                }
                $points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
                return $points;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assOrderingHorizontal::copyObject	(	$target_questionpool,
		$title = `""`
	)

Copies an assOrderingHorizontal object.

Definition at line 198 of file class.assOrderingHorizontal.php.

References assQuestion\$original_id, assQuestion\$title, assQuestion\_getOriginalId(), assQuestion\getId(), 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);
                $clone->onCopy($this->getObjId(), $this->getId());
                return $clone->id;
        }

Here is the call graph for this function:

assOrderingHorizontal::deleteAnswers ( $question_id )

Deletes datasets from answers tables.

Parameters

integer $question_id The question id which should be deleted in the answers table

Reimplemented from assQuestion.

Definition at line 470 of file class.assOrderingHorizontal.php.

{

}

assOrderingHorizontal::duplicate	(	$for_test = `true`,
		$title = `""`,
		$author = `""`,
		$owner = `""`
	)

Duplicates an assOrderingHorizontal.

Definition at line 148 of file class.assOrderingHorizontal.php.

References assQuestion\$author, assQuestion\$original_id, 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);
                $clone->onDuplicate($this_id);
                return $clone->id;
        }

Here is the call graph for this function:

assOrderingHorizontal::fromXML	(	&	$item,
		&	$questionpool_id,
		&	$tst_id,
		&	$tst_object,
		&	$question_counter,
		&	$import_mapping
	)

Creates a question from a QTI file.

Receives parameters from a QTI parser and creates a valid ILIAS question object

Parameters

object	$item	The QTI item object
integer	$questionpool_id	The id of the parent questionpool
integer	$tst_id	The id of the parent test if the question is part of a test
object	$tst_object	A reference to the parent test object
integer	$question_counter	A reference to a question counter to count the questions of an imported question pool
array	$import_mapping	An array containing references to included ILIAS objects

Reimplemented from assQuestion.

Definition at line 522 of file class.assOrderingHorizontal.php.

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

assOrderingHorizontal::getAdditionalTableName ( )

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

Returns: string The additional table name

Reimplemented from assQuestion.

Definition at line 450 of file class.assOrderingHorizontal.php.

Referenced by loadFromDb(), and saveToDb().

        {
                return "qpl_qst_horder";
        }

Here is the caller graph for this function:

assOrderingHorizontal::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name

Reimplemented from assQuestion.

Definition at line 460 of file class.assOrderingHorizontal.php.

        {
                return "";
        }

assOrderingHorizontal::getBestSolution	(	$active_id,
		$pass
	)

Returns the best solution for a given pass of a participant.

Returns: array An associated array containing the best solution

Definition at line 547 of file class.assOrderingHorizontal.php.

        {
                $user_solution = array();
                return $user_solution;
        }

assOrderingHorizontal::getMaximumPoints ( )

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

See Also: $points

Reimplemented from assQuestion.

Definition at line 235 of file class.assOrderingHorizontal.php.

References assQuestion\getPoints().

Referenced by isComplete().

        {
                return $this->getPoints();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assOrderingHorizontal::getOrderingElements ( )

Get ordering elements from order text.

Returns: array Ordering elements

Definition at line 558 of file class.assOrderingHorizontal.php.

References getOrderText(), and splitAndTrimOrderElementText().

Referenced by calculateReachedPoints(), and getRandomOrderingElements().

        {
                return $this->splitAndTrimOrderElementText($this->getOrderText(), $this->separator);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assOrderingHorizontal::getOrderText ( )

Get order text.

Returns: string Order text

Definition at line 580 of file class.assOrderingHorizontal.php.

References $ordertext.

Referenced by __get(), getOrderingElements(), and saveToDb().

        {
                return $this->ordertext;
        }

Here is the caller graph for this function:

assOrderingHorizontal::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

Reimplemented from assQuestion.

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

        {
                return "assOrderingHorizontal";
        }

assOrderingHorizontal::getRandomOrderingElements ( )

Get ordering elements from order text in random sequence.

Returns: array Ordering elements

Definition at line 568 of file class.assOrderingHorizontal.php.

References getOrderingElements().

        {
                $elements = $this->getOrderingElements();
                shuffle($elements);
                return $elements;
        }

Here is the call graph for this function:

assOrderingHorizontal::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 478 of file class.assOrderingHorizontal.php.

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

assOrderingHorizontal::getSeparator ( )

Get order text separator.

Returns: string Separator

Definition at line 623 of file class.assOrderingHorizontal.php.

References $separator.

Referenced by __get().

        {
                return $this->separator;
        }

Here is the caller graph for this function:

assOrderingHorizontal::getTextSize ( )

Get text size.

Returns: double Text size in percent

Definition at line 600 of file class.assOrderingHorizontal.php.

References $textsize.

Referenced by __get(), and saveToDb().

        {
                return $this->textsize;
        }

Here is the caller graph for this function:

assOrderingHorizontal::isComplete ( )

Returns true, if a single choice question is complete for use.

Returns: boolean True, if the single choice question is complete for use, otherwise false

Reimplemented from assQuestion.

Definition at line 69 of file class.assOrderingHorizontal.php.

References getMaximumPoints().

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

Here is the call graph for this function:

assOrderingHorizontal::loadFromDb ( $question_id )

Loads a assOrderingHorizontal object from a database.

Parameters

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

Reimplemented from assQuestion.

Definition at line 115 of file class.assOrderingHorizontal.php.

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), setOrderText(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setTextSize(), and assQuestion\setTitle().

        {
                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));
                }
                parent::loadFromDb($question_id);
        }

Here is the call graph for this function:

assOrderingHorizontal::moveRight	(	$position,
		$active_id,
		$pass = `null`
	)

Definition at line 368 of file class.assOrderingHorizontal.php.

References $_SESSION, $ilDB, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), calculateReachedPoints(), assQuestion\getId(), assQuestion\getSolutionValues(), and assQuestion\logAction().

        {
                global $ilDB;
                global $ilUser;
                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }
                $solutions =& $this->getSolutionValues($active_id, $pass);
                $elements = array();
                if (count($solutions) == 1)
                {
                        $elements = split("{::}", $solutions[0]["value1"]);
                }
                else
                {
                        $elements = $_SESSION['qst_ordering_horizontal_elements'];
                }
                if (count($elements))
                {
                        $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)
                        );
                        if ($position < count($elements)-1)
                        {
                                $temp = $elements[$position];
                                $elements[$position] = $elements[$position+1];
                                $elements[$position+1] = $temp;
                        }
                        $entered_values = false;
                        $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", join($elements, '{::}')),
                                "value2" => array("clob", null),
                                "pass" => array("integer", $pass),
                                "tstamp" => array("integer", time())
                        ));
                        $entered_values = true;
                        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());
                                }
                        }
                        $this->calculateReachedPoints($active_id, $pass);
                }
        }

Here is the call graph for this function:

assOrderingHorizontal::saveToDb ( $original_id = "" )

Saves a assOrderingHorizontal object to a database.

Reimplemented from assQuestion.

Definition at line 85 of file class.assOrderingHorizontal.php.

References $ilDB, assQuestion\$original_id, getAdditionalTableName(), assQuestion\getId(), getOrderText(), getTextSize(), and assQuestion\saveQuestionDataToDb().

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

Here is the call graph for this function:

assOrderingHorizontal::saveWorkingData	(	$active_id,
		$pass = `NULL`
	)

Saves the learners input of the question to the database.

  @param integer $test_id The database id of the test containing this question

Returns: boolean Indicates the save status (true if saved successful, false otherwise)

See Also: $answers

Reimplemented from assQuestion.

Definition at line 314 of file class.assOrderingHorizontal.php.

References $_POST, $ilDB, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getId(), and assQuestion\logAction().

        {
                global $ilDB;
                global $ilUser;
                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)
                );
                
                $entered_values = false;
                if (strlen($_POST["orderresult"]))
                {
                        $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", $_POST['orderresult']),
                                "value2" => array("clob", null),
                                "pass" => array("integer", $pass),
                                "tstamp" => array("integer", time())
                        ));
                        $entered_values = true;
                }
                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;
        }

Here is the call graph for this function:

assOrderingHorizontal::setExportDetailsXLS	(	&	$worksheet,
			$startrow,
			$active_id,
			$pass,
		&	$format_title,
		&	$format_bold
	)

Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass
object	$format_title	Excel title format
object	$format_bold	Excel bold format
array	$eval_data	Cumulated evaluation data

Reimplemented from assQuestion.

Definition at line 495 of file class.assOrderingHorizontal.php.

References $pass, ilExcelUtils\_convert_text(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

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

Here is the call graph for this function:

assOrderingHorizontal::setOrderText ( $a_value )

Set order text.

Parameters

string $a_value Order text

Definition at line 590 of file class.assOrderingHorizontal.php.

Referenced by __set(), and loadFromDb().

        {
                $this->ordertext = $a_value;
        }

Here is the caller graph for this function:

assOrderingHorizontal::setSeparator ( $a_value )

Set order text separator.

Parameters

string $a_value Separator

Definition at line 633 of file class.assOrderingHorizontal.php.

Referenced by __set().

        {
                $this->separator = $a_value;
        }

Here is the caller graph for this function:

assOrderingHorizontal::setTextSize ( $a_value )

Set text size.

Parameters

double $a_value Text size in percent

Definition at line 610 of file class.assOrderingHorizontal.php.

Referenced by __set(), and loadFromDb().

        {
                if ($a_value >= 10)
                {
                        $this->textsize = $a_value;
                }
        }

Here is the caller graph for this function:

assOrderingHorizontal::splitAndTrimOrderElementText	(	$in_string,
		$separator
	)

private

Splits the answer string either by space(s) or the separator (eg.

::) and trims the resulting array elements.

Parameters

string	$in_string	OrderElements
string	$separator	to be used for splitting.

Returns: array

Definition at line 285 of file class.assOrderingHorizontal.php.

References $result, $separator, and ilStr\strPos().

Referenced by calculateReachedPoints(), and getOrderingElements().

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

Here is the call graph for this function:

Here is the caller graph for this function:

assOrderingHorizontal::toXML	(	$a_include_header = `true`,
		$a_include_binary = `true`,
		$a_shuffle = `false`,
		$test_output = `false`,
		$force_image_references = `false`
	)

Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.

Returns: string The QTI xml representation of the question

Reimplemented from assQuestion.

Definition at line 535 of file class.assOrderingHorizontal.php.

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