Metric survey question. More...

Inheritance diagram for SurveyMetricQuestion:

Collaboration diagram for SurveyMetricQuestion:

Public Member Functions
	__construct ($title="", $description="", $author="", $questiontext="", $owner=-1, $subtype=self::SUBTYPE_NON_RATIO)
	SurveyMetricQuestion constructor. More...

	setSubtype ($subtype=self::SUBTYPE_NON_RATIO)
	Sets the question subtype. More...

	setMinimum ($minimum=0)
	Sets the minimum value. More...

	setMaximum ($maximum="")
	Sets the maximum value. More...

	getSubtype ()
	Gets the question subtype. More...

	getMinimum ()
	Returns the minimum value of the question. More...

	getMaximum ()
	Returns the maximum value of the question. More...

	getQuestionDataArray ($id)
	Returns the question data fields from the database. More...

	loadFromDb ($id)
	Loads a SurveyMetricQuestion object from the database. More...

	isComplete ()
	Returns true if the question is complete for use. More...

	saveToDb ($original_id="")
	Saves a SurveyMetricQuestion object to a database. More...

	toXML ($a_include_header=TRUE, $obligatory_state="")
	Returns an xml representation of the question. More...

	insertXML (&$a_xml_writer, $a_include_header=TRUE)
	Adds the question XML to a given XMLWriter object. More...

	getQuestionTypeID ()
	Returns the question type ID of the question. More...

	getQuestionType ()
	Returns the question type of the question. More...

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the svy_answer table from the POST data. More...

	checkUserInput ($post_data, $survey_id)
	Checks the input of the active user for obligatory status and entered values. More...

	saveUserInput ($post_data, $active_id, $a_return=false)

	importResponses ($a_data)
	Import response data from the question import file. More...

	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...

	getAvailableRelations ()
	Returns the available relations for the question. More...

	outPreconditionSelectValue (&$template)
	Creates a value selection for preconditions. More...

	getPreconditionSelectValue ($default="", $title, $variable)
	Creates a form property for the precondition value. More...

	getMinMaxText ()
	Creates a text for the input range of the metric question. More...

Public Member Functions inherited from SurveyQuestion
	__construct ($title="", $description="", $author="", $questiontext="", $owner=-1)
	SurveyQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyQuestion object. More...

	setComplete ($a_complete)
	Sets the complete state of the question. More...

	isComplete ()
	Returns 1, if a question is complete for use. More...

	questionTitleExists ($title, $questionpool_object="")
	Returns TRUE if the question title exists in the database. More...

	setTitle ($title="")
	Sets the title string of the SurveyQuestion object. More...

	setObligatory ($obligatory=1)
	Sets the obligatory state of the question. More...

	setOrientation ($orientation=0)
	Sets the orientation of the question output. More...

	setId ($id=-1)
	Sets the id of the SurveyQuestion object. More...

	setSurveyId ($id=-1)
	Sets the survey id of the SurveyQuestion object. More...

	setDescription ($description="")
	Sets the description string of the SurveyQuestion object. More...

	addMaterials ($materials_file, $materials_name="")
	Sets the materials uri. More...

	setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
	Sets and uploads the materials uri. More...

	deleteMaterial ($materials_name="")
	Deletes a materials uri with a given name. More...

	flushMaterials ()
	Deletes all materials uris. More...

	setAuthor ($author="")
	Sets the authors name of the SurveyQuestion object. More...

	setQuestiontext ($questiontext="")
	Sets the questiontext of the SurveyQuestion object. More...

	setOwner ($owner="")
	Sets the creator/owner ID of the SurveyQuestion object. More...

	getTitle ()
	Gets the title string of the SurveyQuestion object. More...

	getLabel ()

	getId ()
	Gets the id of the SurveyQuestion object. More...

	getObligatory ($survey_id="")
	Gets the obligatory state of the question. More...

	getSurveyId ()
	Gets the survey id of the SurveyQuestion object. More...

	getOrientation ()
	Gets the orientation of the question output. More...

	getDescription ()
	Gets the description string of the SurveyQuestion object. More...

	getAuthor ()
	Gets the authors name of the SurveyQuestion object. More...

	getOwner ()
	Gets the creator/owner ID of the SurveyQuestion object. More...

	getQuestiontext ()
	Gets the questiontext of the SurveyQuestion object. More...

	getObjId ()
	Get the reference id of the container object. More...

	setObjId ($obj_id=0)
	Set the reference id of the container object. More...

	duplicate ($for_survey=true, $title="", $author="", $owner="", $a_survey_id=0)
	Duplicates a survey question. More...

	copyObject ($target_questionpool, $title="")
	Copies an assOrderingQuestion object. More...

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	Increases the media object usage counter when a question is duplicated. More...

	loadFromDb ($question_id)
	Loads a SurveyQuestion object from the database. More...

	saveCompletionStatus ($original_id="")
	Saves the complete flag to the database. More...

	saveToDb ($original_id="")
	Saves a SurveyQuestion object to a database. More...

	saveMaterial ()
	save material to db More...

	createNewQuestion ()
	Creates a new question with a 0 timestamp when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

	saveWorkingData ($limit_to=LIMIT_NO_LIMIT)
	Saves the learners input of the question to the database. More...

	getImagePath ()
	Returns the image path for web accessable images of a question. More...

	getMaterialsPath ()
	Returns the materials path for web accessable materials of a question. More...

	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...

	getMaterialsPathWeb ()
	Returns the web image path for web accessable images of a question. More...

	saveCategoryToDb ($categorytext, $neutral=0)
	Saves a category to the database. More...

	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...

	delete ($question_id)
	Deletes a question and all materials from the database. More...

	syncWithOriginal ()

	getPhrase ($phrase_id)
	Returns a phrase for a given database id. More...

	phraseExists ($title)
	Returns true if the phrase title already exists for the current user. More...

	addInternalLink ($material_id, $title="")

	deleteMaterials ($a_array)
	Deletes materials. More...

	duplicateMaterials ($question_id)
	Duplicates the materials of a question. More...

	addMaterial ($obj_material)

	setMaterial ($material_id="", $is_import=false, $material_title="")
	Sets a material link for the question. More...

	getQuestionTypeID ()
	Returns the question type ID of the question. More...

	getQuestionType ()
	Returns the question type of the question. More...

	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...

	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string. More...

	addMaterialTag (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE, $a_attrs=null)
	Creates an XML material tag from a plain text or xhtml text. More...

	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
	Prepares a string for a text area output in surveys. More...

	getQuestionDataArray ($id)
	Returns the question data fields from the database. More...

&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the svy_answer table from the POST data. More...

	importAdditionalMetadata ($a_meta)
	Import additional meta data from the question import file. More...

	importResponses ($a_data)
	Import response data from the question import file. More...

	importAdjectives ($a_data)
	Import bipolar adjectives from the question import file. More...

	importMatrix ($a_data)
	Import matrix rows from the question import file. More...

	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...

	getAvailableRelations ()
	Returns the available relations for the question. More...

	getPreconditionOptions ()
	Returns the options for preconditions. More...

	getPreconditionValueOutput ($value)
	Returns the output for a precondition value. More...

	getPreconditionSelectValue ($default="", $title, $variable)
	Creates a form property for the precondition value. More...

	setOriginalId ($original_id)

	getOriginalId ()

	getMaterial ()

	setSubtype ($a_subtype)

	getSubtype ()

	__get ($value)
	Object getter. More...

	__set ($key, $value)
	Object setter. More...

	getCopyIds ($a_group_by_survey=false)

	hasCopies ()

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://mantis.ilias.de/view.php?id=19727 and https://mantis.ilias.de/view.php?id=24200. More...

Data Fields
const	SUBTYPE_NON_RATIO = 3

const	SUBTYPE_RATIO_NON_ABSOLUTE = 4

const	SUBTYPE_RATIO_ABSOLUTE = 5

	$subtype

	$minimum

	$maximum

Data Fields inherited from SurveyQuestion
	$id

	$title

	$description

	$owner

	$author

	$materials

	$survey_id

	$obj_id

	$questiontext

	$obligatory

	$ilias

	$tpl

	$lng

	$orientation

	$material

	$complete

Additional Inherited Members
Static Public Member Functions inherited from SurveyQuestion
static	_isComplete ($question_id)
	Checks whether the question is complete or not. More...

static	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...

static	_getTitle ($question_id)
	Returns the question title of a question with a given id. More...

static	_getOriginalId ($question_id, $a_return_question_id_if_no_original=true)
	Returns the original id of a question. More...

static	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...

static	_resolveInternalLink ($internal_link)

static	_resolveIntLinks ($question_id)

static	_getInternalLinkHref ($target="", $a_parent_ref_id=null)

static	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...

static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...

static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...

static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...

static	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question GUI with a given question id. More...

static	_instanciateQuestionEvaluation ($question_id, array $a_finished_ids=null)
	Creates an instance of a question evaluation with a given question id. More...

static	_changeOriginalId ($a_question_id, $a_original_id, $a_object_id)
	Change original id of existing question in db. More...

static	_lookupSurveyObjId ($a_question_id)

static	lookupObjFi ($a_qid)
	Lookip obj fi. More...

Protected Attributes inherited from SurveyQuestion
	$cumulated
	An array containing the cumulated results of the question for a given survey. More...

	$log

Detailed Description

Metric survey question.

The SurveyMetricQuestion class defines and encapsulates basic methods and attributes for metric survey question types.

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$

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

Constructor & Destructor Documentation

◆ __construct()

SurveyMetricQuestion::__construct	(	$title = `""`,
		$description = `""`,
		$author = `""`,
		$questiontext = `""`,
		$owner = `-1`,
		$subtype = `self::SUBTYPE_NON_RATIO`
	)

SurveyMetricQuestion constructor.

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

Parameters

string	$title	A title string to describe the question
string	$description	A description 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 public

Definition at line 77 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$author, SurveyQuestion\$description, SurveyQuestion\$owner, SurveyQuestion\$questiontext, $subtype, and SurveyQuestion\$title.

         {
                 parent::__construct($title, $description, $author, $questiontext, $owner);
                 
                 $this->subtype = $subtype;
                 $this->minimum = "";
                 $this->maximum = "";
         }

Member Function Documentation

◆ checkUserInput()

SurveyMetricQuestion::checkUserInput	(	$post_data,
		$survey_id
	)

Checks the input of the active user for obligatory status and entered values.

Parameters

array	$post_data	The contents of the $_POST array
integer	$survey_id	The database ID of the active survey

Returns: string Empty string if the input is ok, an error message otherwise public

Definition at line 507 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$survey_id, SurveyQuestion\getId(), getMaximum(), getMinimum(), and SurveyQuestion\getObligatory().

         {
                 $entered_value = $post_data[$this->getId() . "_metric_question"];
                 // replace german notation with international notation
                 $entered_value = str_replace(",", ".", $entered_value);
                 
                 if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
                 
                 if (strlen($entered_value) == 0) return $this->lng->txt("survey_question_obligatory");
                 
                 if (strlen($this->getMinimum()))
                 {
                         if ($entered_value < $this->getMinimum())
                         {
                                 return $this->lng->txt("metric_question_out_of_bounds");
                         }
                 }
 
                 if (strlen($this->getMaximum()))
                 {
                         if (($this->getMaximum() == 1) && ($this->getMaximum() < $this->getMinimum()))
                         {
                                 // old &infty; values as maximum
                         }
                         else
                         {
                                 if ($entered_value > $this->getMaximum())
                                 {
                                         return $this->lng->txt("metric_question_out_of_bounds");
                                 }
                         }
                 }
 
                 if (!is_numeric($entered_value))
                 {
                         return $this->lng->txt("metric_question_not_a_value");
                 }
 
                 if (($this->getSubType() == self::SUBTYPE_RATIO_ABSOLUTE) && (intval($entered_value) != doubleval($entered_value)))
                 {
                         return $this->lng->txt("metric_question_floating_point");
                 }
                 return "";
         }

Here is the call graph for this function:

◆ getAdditionalTableName()

SurveyMetricQuestion::getAdditionalTableName ( )

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

Returns: string The additional table name public

Definition at line 476 of file class.SurveyMetricQuestion.php.

Referenced by getQuestionDataArray(), loadFromDb(), and saveToDb().

         {
                 return "svy_qst_metric";
         }

Here is the caller graph for this function:

◆ getAvailableRelations()

SurveyMetricQuestion::getAvailableRelations ( )

Returns the available relations for the question.

Returns: array An array containing the available relations public

Definition at line 612 of file class.SurveyMetricQuestion.php.

References array.

         {
                 return array("<", "<=", "=", "<>", ">=", ">");
         }

◆ getMaximum()

SurveyMetricQuestion::getMaximum ( )

Returns the maximum value of the question.

Returns: double The maximum value of the question public

See also: $maximum

Definition at line 173 of file class.SurveyMetricQuestion.php.

Referenced by checkUserInput(), getMinMaxText(), insertXML(), and saveToDb().

         {
                 return (strlen($this->maximum)) ? $this->maximum : NULL;
         }

Here is the caller graph for this function:

◆ getMinimum()

SurveyMetricQuestion::getMinimum ( )

Returns the minimum value of the question.

Returns: double The minimum value of the question public

See also: $minimum

Definition at line 157 of file class.SurveyMetricQuestion.php.

References getSubtype().

Referenced by checkUserInput(), getMinMaxText(), insertXML(), and saveToDb().

         {
                 if ((strlen($this->minimum) == 0) && ($this->getSubtype() > 3))
                 {
                         $this->minimum = 0;
                 }
                 return (strlen($this->minimum)) ? $this->minimum : NULL;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMinMaxText()

SurveyMetricQuestion::getMinMaxText ( )

Creates a text for the input range of the metric question.

Returns: string Range text private

Definition at line 650 of file class.SurveyMetricQuestion.php.

References getMaximum(), and getMinimum().

         {
                 $min = $this->getMinimum();
                 $max = $this->getMaximum();
                 if (strlen($min) && strlen($max))
                 {
                         return "(" . $min . " " . strtolower($this->lng->txt("to")) . " " . $max . ")";
                 }
                 else if (strlen($min))
                 {
                         return "(&gt;= " . $min . ")";
                 }
                 else if (strlen($max))
                 {
                         return "(&lt;= " . $max . ")";
                 }
                 else
                 {
                         return "";
                 }
         }

Here is the call graph for this function:

◆ getPreconditionSelectValue()

SurveyMetricQuestion::getPreconditionSelectValue	(	$default = `""`,
		$title,
		$variable
	)

Creates a form property for the precondition value.

Returns: The ILIAS form element public

Definition at line 636 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$title.

         {
                 include_once "./Services/Form/classes/class.ilNumberInputGUI.php";
                 $step3 = new ilNumberInputGUI($title, $variable);
                 $step3->setValue($default);
                 return $step3;
         }

◆ getQuestionDataArray()

SurveyMetricQuestion::getQuestionDataArray ( $id )

Returns the question data fields from the database.

Parameters

integer $id The question ID from the database

Returns: array Array containing the question fields and data from the database public

Definition at line 185 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$id, $ilDB, $result, array, and getAdditionalTableName().

         {
                 global $ilDB;
                 
                 $result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question, " . $this->getAdditionalTableName() . " WHERE svy_question.question_id = %s AND svy_question.question_id = " . $this->getAdditionalTableName() . ".question_fi",
                         array('integer'),
                         array($id)
                 );
                 if ($result->numRows() == 1)
                 {
                         return $ilDB->fetchAssoc($result);
                 }
                 else
                 {
                         return array();
                 }
         }

Here is the call graph for this function:

◆ getQuestionType()

SurveyMetricQuestion::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question public

Definition at line 465 of file class.SurveyMetricQuestion.php.

Referenced by getQuestionTypeID().

         {
                 return "SurveyMetricQuestion";
         }

Here is the caller graph for this function:

◆ getQuestionTypeID()

SurveyMetricQuestion::getQuestionTypeID ( )

Returns the question type ID of the question.

Returns: integer The question type of the question public

Definition at line 448 of file class.SurveyMetricQuestion.php.

References $ilDB, $result, $row, array, and getQuestionType().

         {
                 global $ilDB;
                 $result = $ilDB->queryF("SELECT questiontype_id FROM svy_qtype WHERE type_tag = %s",
                         array('text'),
                         array($this->getQuestionType())
                 );
                 $row = $ilDB->fetchAssoc($result);
                 return $row["questiontype_id"];
         }

Here is the call graph for this function:

◆ getSubtype()

SurveyMetricQuestion::getSubtype ( )

Gets the question subtype.

Returns: integer The question subtype public

See also: $subtype

Definition at line 145 of file class.SurveyMetricQuestion.php.

References $subtype.

Referenced by getMinimum(), and insertXML().

         {
     return $this->subtype;
   }

Here is the caller graph for this function:

◆ getWorkingDataFromUserInput()

& SurveyMetricQuestion::getWorkingDataFromUserInput ( $post_data )

Creates the user data of the svy_answer table from the POST data.

Returns: array User data according to the svy_answer table public

Definition at line 487 of file class.SurveyMetricQuestion.php.

References $data, array, and SurveyQuestion\getId().

         {
                 $entered_value = $post_data[$this->getId() . "_metric_question"];
                 $data = array();
                 if (strlen($entered_value))
                 {
                         array_push($data, array("value" => $entered_value));
                 }
                 return $data;
         }

Here is the call graph for this function:

◆ importResponses()

SurveyMetricQuestion::importResponses ( $a_data )

Import response data from the question import file.

Returns: array $a_data Array containing the response data public

Definition at line 586 of file class.SurveyMetricQuestion.php.

References $data, SurveyQuestion\$id, setMaximum(), and setMinimum().

         {
                 foreach ($a_data as $id => $data)
                 {
                         $this->setMinimum($data["min"]);
                         $this->setMaximum($data["max"]);
                 }
         }

Here is the call graph for this function:

◆ insertXML()

SurveyMetricQuestion::insertXML	(	&	$a_xml_writer,
			$a_include_header = `TRUE`
	)

Adds the question XML to a given XMLWriter object.

Parameters

object	$a_xml_writer	The XMLWriter object
boolean	$a_include_header	Determines wheather or not the XML should be used public

Definition at line 353 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\addMaterialTag(), array, SurveyQuestion\getAuthor(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), getMaximum(), getMinimum(), SurveyQuestion\getObligatory(), SurveyQuestion\getQuestiontext(), getSubtype(), and SurveyQuestion\getTitle().

Referenced by toXML().

         {
                 $attrs = array(
                         "id" => $this->getId(),
                         "title" => $this->getTitle(),
                         "type" => $this->getQuestiontype(),
                         "subtype" => $this->getSubtype(),
                         "obligatory" => $this->getObligatory()
                 );
                 $a_xml_writer->xmlStartTag("question", $attrs);
                 
                 $a_xml_writer->xmlElement("description", NULL, $this->getDescription());
                 $a_xml_writer->xmlElement("author", NULL, $this->getAuthor());
                 $a_xml_writer->xmlStartTag("questiontext");
                 $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
                 $a_xml_writer->xmlEndTag("questiontext");
 
                 $a_xml_writer->xmlStartTag("responses");
                 switch ($this->getSubtype())
                 {
                         case 3:
                                 $attrs = array(
                                         "id" => "0",
                                         "format" => "double"
                                 );
                                 if (strlen($this->getMinimum()))
                                 {
                                         $attrs["min"] = $this->getMinimum();
                                 }
                                 if (strlen($this->getMaximum()))
                                 {
                                         $attrs["max"] = $this->getMaximum();
                                 }
                                 break;
                         case 4:
                                 $attrs = array(
                                         "id" => "0",
                                         "format" => "double"
                                 );
                                 if (strlen($this->getMinimum()))
                                 {
                                         $attrs["min"] = $this->getMinimum();
                                 }
                                 if (strlen($this->getMaximum()))
                                 {
                                         $attrs["max"] = $this->getMaximum();
                                 }
                                 break;
                         case 5:
                                 $attrs = array(
                                         "id" => "0",
                                         "format" => "integer"
                                 );
                                 if (strlen($this->getMinimum()))
                                 {
                                         $attrs["min"] = $this->getMinimum();
                                 }
                                 if (strlen($this->getMaximum()))
                                 {
                                         $attrs["max"] = $this->getMaximum();
                                 }
                                 break;
                 }
                 $a_xml_writer->xmlStartTag("response_num", $attrs);
                 $a_xml_writer->xmlEndTag("response_num");
 
                 $a_xml_writer->xmlEndTag("responses");
 
                 if (count($this->material))
                 {
                         if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches))
                         {
                                 $attrs = array(
                                         "label" => $this->material["title"]
                                 );
                                 $a_xml_writer->xmlStartTag("material", $attrs);
                                 $intlink = "il_" . IL_INST_ID . "_" . $matches[2] . "_" . $matches[3];
                                 if (strcmp($matches[1], "") != 0)
                                 {
                                         $intlink = $this->material["internal_link"];
                                 }
                                 $a_xml_writer->xmlElement("mattext", NULL, $intlink);
                                 $a_xml_writer->xmlEndTag("material");
                         }
                 }
                 
                 $a_xml_writer->xmlEndTag("question");
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isComplete()

SurveyMetricQuestion::isComplete ( )

Returns true if the question is complete for use.

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

Definition at line 263 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\getAuthor(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

         {
                 if (
                         strlen($this->getTitle()) &&
                         strlen($this->getAuthor()) &&
                         strlen($this->getQuestiontext())
                 )
                 {
                         return 1;
                 }
                 else
                 {
                         return 0;
                 }
         }

Here is the call graph for this function:

◆ loadFromDb()

SurveyMetricQuestion::loadFromDb ( $id )

Loads a SurveyMetricQuestion object from the database.

Parameters

integer $id The database id of the metric survey question public

Definition at line 209 of file class.SurveyMetricQuestion.php.

References $data, SurveyQuestion\$id, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), array, getAdditionalTableName(), SurveyQuestion\setAuthor(), SurveyQuestion\setComplete(), SurveyQuestion\setDescription(), SurveyQuestion\setId(), SurveyQuestion\setObjId(), SurveyQuestion\setObligatory(), SurveyQuestion\setOriginalId(), SurveyQuestion\setOwner(), SurveyQuestion\setQuestiontext(), setSubtype(), and SurveyQuestion\setTitle().

         {
                 global $ilDB;
 
                 $result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = svy_question.question_id WHERE svy_question.question_id = %s",
                         array('integer'),
                         array($id)
                 );
                 if ($result->numRows() == 1) 
                 {
                         $data = $ilDB->fetchAssoc($result);
                         $this->setId($data["question_id"]);
                         $this->setTitle($data["title"]);
                         $this->setDescription($data["description"]);
                         $this->setObjId($data["obj_fi"]);
                         $this->setAuthor($data["author"]);
                         $this->setOwner($data["owner_fi"]);
                         $this->label = $data['label'];
                         include_once("./Services/RTE/classes/class.ilRTE.php");
                         $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc($data["questiontext"], 1));
                         $this->setObligatory($data["obligatory"]);
                         $this->setComplete($data["complete"]);
                         $this->setOriginalId($data["original_id"]);
                         $this->setSubtype($data["subtype"]);
 
                         $result = $ilDB->queryF("SELECT svy_variable.* FROM svy_variable WHERE svy_variable.question_fi = %s",
                                 array('integer'),
                                 array($id)
                         );
                         if ($result->numRows() > 0) 
                         {
                                 if ($data = $ilDB->fetchAssoc($result)) 
                                 {
                                         $this->minimum = $data["value1"];
                                         if (($data["value2"] < 0) or (strcmp($data["value2"], "") == 0))
                                         {
                                                 $this->maximum = "";
                                         }
                                         else
                                         {
                                                 $this->maximum = $data["value2"];
                                         }
                                 }
                         }
                 }
                 parent::loadFromDb($id);
         }

Here is the call graph for this function:

◆ outPreconditionSelectValue()

SurveyMetricQuestion::outPreconditionSelectValue ( & $template )

Creates a value selection for preconditions.

Parameters

object $template The template for the value selection (usually tpl.svy_svy_add_constraint.html) public

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

         {
                 $template->setCurrentBlock("textfield");
                 $template->setVariable("TEXTFIELD_VALUE", "");
                 $template->parseCurrentBlock();
         }

◆ saveToDb()

SurveyMetricQuestion::saveToDb ( $original_id = "" )

Saves a SurveyMetricQuestion object to a database.

public

Definition at line 284 of file class.SurveyMetricQuestion.php.

References $ilDB, array, getAdditionalTableName(), SurveyQuestion\getId(), getMaximum(), getMinimum(), SurveyQuestion\saveMaterial(), and time.

   {
                 global $ilDB;
 
                 $affectedRows = parent::saveToDb($original_id);
                 if ($affectedRows == 1) 
                 {
                         $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, subtype) VALUES (%s, %s)",
                                 array('integer', 'text'),
                                 array($this->getId(), $this->getSubType())
                         );
 
                         // saving material uris in the database
                         $this->saveMaterial();
                         
                         // save categories
                         $affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
                                 array('integer'),
                                 array($this->getId())
                         );
 
                         if (preg_match("/[\D]/", $this->maximum) or (strcmp($this->maximum, "&infin;") == 0))
                         {
                                 $max = -1;
                         }
                         else
                         {
                                 $max = $this->getMaximum();
                         }
                         $next_id = $ilDB->nextId('svy_variable');
                         $affectedRows = $ilDB->manipulateF("INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, value2, sequence, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s)",
                                 array('integer','integer','integer','float','float','integer','integer'),
                                 array($next_id, 0, $this->getId(), $this->getMinimum(), $max, 0, time())
                         );
                 } 
   }

Here is the call graph for this function:

◆ saveUserInput()

SurveyMetricQuestion::saveUserInput	(	$post_data,
		$active_id,
		$a_return = `false`
	)

Definition at line 552 of file class.SurveyMetricQuestion.php.

References $ilDB, array, SurveyQuestion\getId(), and time.

         {
                 global $ilDB;
                 
                 $entered_value = $post_data[$this->getId() . "_metric_question"];
                 
                 // replace german notation with international notation
                 $entered_value = str_replace(",", ".", $entered_value);
                 
                 if($a_return)
                 {
                         return array(array("value"=>$entered_value, "textanswer"=>null));
                 }
                 if (strlen($entered_value) == 0) return;
                 
                 $next_id = $ilDB->nextId('svy_answer');
                 #20216
                 $fields = array();
                 $fields['answer_id'] = array("integer", $next_id);
                 $fields['question_fi'] = array("integer", $this->getId());
                 $fields['active_fi'] = array("integer", $active_id);
                 $fields['value'] = array("float", (strlen($entered_value)) ? $entered_value : NULL);
                 $fields['textanswer'] = array("clob", NULL);
                 $fields['tstamp'] = array("integer", time());
 
                 $affectedRows = $ilDB->insert("svy_answer", $fields);   
         }

Here is the call graph for this function:

◆ setMaximum()

SurveyMetricQuestion::setMaximum ( $maximum = "" )

Sets the maximum value.

Parameters

double $maximum The maximum value public

See also: $maximum

Definition at line 125 of file class.SurveyMetricQuestion.php.

References $maximum.

Referenced by importResponses().

         {
             if($maximum !== NULL)
           {
                   $maximum = (float)$maximum;
           }
            if(!$maximum)
                 {
                         $maximum = NULL;
                 }
     $this->maximum = $maximum;
   }

Here is the caller graph for this function:

◆ setMinimum()

SurveyMetricQuestion::setMinimum ( $minimum = 0 )

Sets the minimum value.

Parameters

double $minimum The minimum value public

See also: $minimum

Definition at line 105 of file class.SurveyMetricQuestion.php.

References $minimum.

Referenced by importResponses().

         {
            if($minimum !== NULL)
           {
                   $minimum = (float)$minimum;            
           }
            if(!$minimum)
                 {
                         $minimum = NULL;
                 }
     $this->minimum = $minimum;
   }

Here is the caller graph for this function:

◆ setSubtype()

SurveyMetricQuestion::setSubtype ( $subtype = self::SUBTYPE_NON_RATIO )

Sets the question subtype.

Parameters

integer $subtype The question subtype public

See also: $subtype

Definition at line 93 of file class.SurveyMetricQuestion.php.

References $subtype.

Referenced by loadFromDb().

         {
     $this->subtype = $subtype;
   }

Here is the caller graph for this function:

◆ toXML()

SurveyMetricQuestion::toXML	(	$a_include_header = `TRUE`,
		$obligatory_state = `""`
	)

Returns an xml representation of the question.

Returns: string The xml representation of the question public

Definition at line 331 of file class.SurveyMetricQuestion.php.

References insertXML(), and ilXmlWriter\xmlHeader().

         {
                 include_once("./Services/Xml/classes/class.ilXmlWriter.php");
                 $a_xml_writer = new ilXmlWriter;
                 $a_xml_writer->xmlHeader();
                 $this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
                 $xml = $a_xml_writer->xmlDumpMem(FALSE);
                 if (!$a_include_header)
                 {
                         $pos = strpos($xml, "?>");
                         $xml = substr($xml, $pos + 2);
                 }
                 return $xml;
         }

Here is the call graph for this function:

◆ usableForPrecondition()

SurveyMetricQuestion::usableForPrecondition ( )

Returns if the question is usable for preconditions.

Returns: boolean TRUE if the question is usable for a precondition, FALSE otherwise public

Definition at line 601 of file class.SurveyMetricQuestion.php.

         {
                 return TRUE;
         }

Field Documentation

◆ $maximum

SurveyMetricQuestion::$maximum

Definition at line 64 of file class.SurveyMetricQuestion.php.

Referenced by setMaximum().

◆ $minimum

SurveyMetricQuestion::$minimum

Definition at line 57 of file class.SurveyMetricQuestion.php.

Referenced by setMinimum().

◆ $subtype

SurveyMetricQuestion::$subtype

Definition at line 50 of file class.SurveyMetricQuestion.php.

Referenced by __construct(), getSubtype(), and setSubtype().

◆ SUBTYPE_NON_RATIO

const SurveyMetricQuestion::SUBTYPE_NON_RATIO = 3

Definition at line 39 of file class.SurveyMetricQuestion.php.

Referenced by SurveyMetricQuestionGUI\addFieldsToEditForm().

◆ SUBTYPE_RATIO_ABSOLUTE

const SurveyMetricQuestion::SUBTYPE_RATIO_ABSOLUTE = 5

Definition at line 41 of file class.SurveyMetricQuestion.php.

Referenced by SurveyMetricQuestionGUI\addFieldsToEditForm().

◆ SUBTYPE_RATIO_NON_ABSOLUTE

const SurveyMetricQuestion::SUBTYPE_RATIO_NON_ABSOLUTE = 4

Definition at line 40 of file class.SurveyMetricQuestion.php.

Referenced by SurveyMetricQuestionGUI\addFieldsToEditForm().

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

Modules/SurveyQuestionPool/classes/class.SurveyMetricQuestion.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkUserInput()

◆ getAdditionalTableName()

◆ getAvailableRelations()

◆ getMaximum()

◆ getMinimum()

◆ getMinMaxText()

◆ getPreconditionSelectValue()

◆ getQuestionDataArray()

◆ getQuestionType()

◆ getQuestionTypeID()

◆ getSubtype()

◆ getWorkingDataFromUserInput()

◆ importResponses()

◆ insertXML()

◆ isComplete()

◆ loadFromDb()

◆ outPreconditionSelectValue()

◆ saveToDb()

◆ saveUserInput()

◆ setMaximum()

◆ setMinimum()

◆ setSubtype()

◆ toXML()

◆ usableForPrecondition()

Field Documentation

◆ $maximum

◆ $minimum

◆ $subtype

◆ SUBTYPE_NON_RATIO

◆ SUBTYPE_RATIO_ABSOLUTE

◆ SUBTYPE_RATIO_NON_ABSOLUTE