This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for SurveyMetricQuestion:

Collaboration diagram for SurveyMetricQuestion:

Public Member Functions
	__construct (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1, int $subtype=self::SUBTYPE_NON_RATIO)

	setSubtype (int $a_subtype=self::SUBTYPE_NON_RATIO)

	setMinimum (?float $minimum=null)

	setMaximum (?float $maximum=null)

	getSubtype ()

	getMinimum ()

	getMaximum ()

	getQuestionDataArray (int $id)

	loadFromDb (int $question_id)

	isComplete ()

	saveToDb (int $original_id=0)

	toXML (bool $a_include_header=true)

	insertXML (ilXmlWriter $a_xml_writer, bool $a_include_header=true)

	getQuestionTypeID ()

	getQuestionType ()

	getAdditionalTableName ()

	getWorkingDataFromUserInput (array $post_data)

	checkUserInput (array $post_data, int $survey_id)

	saveUserInput (array $post_data, int $active_id, bool $a_return=false)

	importResponses (array $a_data)

	usableForPrecondition ()

	getAvailableRelations ()

	outPreconditionSelectValue (ilTemplate $template)

	getPreconditionSelectValue (string $default, string $title, string $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 (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1)

	setComplete (bool $a_complete)

	isComplete ()

	questionTitleExists (string $title, int $questionpool_object=0)

	setTitle (string $title="")

	setObligatory (bool $obligatory=true)

	setOrientation (int $orientation=0)

	setId (int $id=-1)

	setSurveyId (int $id=-1)

	setDescription (string $description="")

	addMaterials (string $materials_file, string $materials_name="")

	setMaterialsfile (string $materials_filename, string $materials_tempfilename="", string $materials_name="")
	Uploads and adds a material. More...

	deleteMaterial (string $materials_name="")

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

	setAuthor (string $author="")

	setQuestiontext (string $questiontext="")

	setOwner (int $owner=0)

	getTitle ()

	getLabel ()

	getId ()

	getObligatory ()

	getSurveyId ()

	getOrientation ()

	getDescription ()

	getAuthor ()

	getOwner ()

	getQuestiontext ()

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

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

	duplicate (bool $for_survey=true, string $title="", string $author="", int $owner=0, int $a_survey_id=0)

	copyObject (int $target_questionpool, string $title="")

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	Copy media object usages from other question. More...

	loadFromDb (int $question_id)
	load question data into object note: this base implementation only loads the material data More...

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

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

	saveMaterial ()

	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...

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

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

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

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

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

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

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

	syncWithOriginal ()

	getPhrase (int $phrase_id)
	Returns a phrase title for phrase id. More...

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

	deleteMaterials (array $a_array)

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

	addMaterial (ilSurveyMaterial $obj_material)

	getQuestionTypeID ()

	getQuestionType ()

	isHTML (string $a_text)

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

	addMaterialTag (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true, ?array $a_attrs=null)
	Creates an XML material tag from a plain text or xhtml text. More...

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

	getQuestionDataArray (int $id)
	Returns the question data. More...

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

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

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

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

	importMatrix (array $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 (string $value)
	Returns the output for a precondition value. More...

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

	setOriginalId (?int $original_id)

	getOriginalId ()

	getMaterial ()

	setSubtype (int $a_subtype)

	getSubtype ()

	__get (string $value)

	__set (string $key, string $value)

	getCopyIds (bool $a_group_by_survey=false)

	hasCopies ()

	stripSlashesAddSpaceFallback (string $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

int	$subtype

float	$minimum

float	$maximum

Data Fields inherited from SurveyQuestion
int	$id

string	$title

string	$description

int	$owner

string	$author

array	$materials

int	$survey_id

int	$obj_id

string	$questiontext

bool	$obligatory

ilLanguage	$lng

int	$orientation

array	$material

bool	$complete

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

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

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

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

static	_questionExists (int $question_id)

static	_resolveInternalLink (string $internal_link)

static	_resolveIntLinks (int $question_id)

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

static	_isWriteable (int $question_id, int $user_id)
	is question writeable by a certain user More...

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

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

static	_instanciateQuestion (int $question_id)
	Get question object. More...

static	_instanciateQuestionGUI (int $question_id)
	Get question gui object. More...

static	_instanciateQuestionEvaluation (int $question_id, array $a_finished_ids=null)

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

static	_lookupSurveyObjId (int $a_question_id)

static	lookupObjFi (int $a_qid)

static	getMaxSumScore (int $survey_id)
	Get max sum score for specific survey (and this question type) More...

Protected Attributes inherited from SurveyQuestion
int	$original_id

ILIAS SurveyQuestionPool Editing EditSessionRepository	$edit_manager

ilObjUser	$user

ilDBInterface	$db

array	$cumulated

ilLogger	$log

ILIAS SurveyQuestionPool Export ImportSessionRepository	$import_manager

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References SurveyQuestion\$author, SurveyQuestion\$description, $DIC, SurveyQuestion\$owner, SurveyQuestion\$questiontext, $subtype, SurveyQuestion\$title, and ILIAS\GlobalScreen\Provider\__construct().

       {
         global $DIC;
 
         $this->db = $DIC->database();
         parent::__construct($title, $description, $author, $questiontext, $owner);
 
         $this->subtype = $subtype;
         $this->minimum = null;
         $this->maximum = null;
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkUserInput()

SurveyMetricQuestion::checkUserInput	(	array	$post_data,
		int	$survey_id
	)

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

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

References SurveyQuestion\getId(), getMaximum(), getMinimum(), SurveyQuestion\getObligatory(), getSubtype(), and ILIAS\Repository\lng().

      : string {
         $entered_value = $post_data[$this->getId() . "_metric_question"];
         // replace german notation with international notation
         $entered_value = str_replace(",", ".", $entered_value);
 
         if ((!$this->getObligatory()) && (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
             } elseif ($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 && ((int) $entered_value != (float) $entered_value)) {
             return $this->lng->txt("metric_question_floating_point");
         }
         return "";
     }

Here is the call graph for this function:

◆ getAdditionalTableName()

SurveyMetricQuestion::getAdditionalTableName ( )

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

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

                                             : string
     {
         return "svy_qst_metric";
     }

Here is the caller graph for this function:

◆ getAvailableRelations()

SurveyMetricQuestion::getAvailableRelations ( )

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

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

◆ getMaximum()

SurveyMetricQuestion::getMaximum ( )

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

References $maximum.

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

                                 : ?float
     {
         return $this->maximum;
     }

Here is the caller graph for this function:

◆ getMinimum()

SurveyMetricQuestion::getMinimum ( )

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

References $minimum, and getSubtype().

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

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

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.

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

References getMaximum(), getMinimum(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getPreconditionSelectValue()

SurveyMetricQuestion::getPreconditionSelectValue	(	string	$default,
		string	$title,
		string	$variable
	)

Creates a form property for the precondition value.

Returns: ilFormPropertyGUI|null ILIAS form element public

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

      : ?ilFormPropertyGUI {
         $step3 = new ilNumberInputGUI($title, $variable);
         $step3->setValue($default);
         return $step3;
     }

◆ getQuestionDataArray()

SurveyMetricQuestion::getQuestionDataArray ( int $id )

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

References SurveyQuestion\$db, $ilDB, and getAdditionalTableName().

                                                  : array
     {
         $ilDB = $this->db;
 
         $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 ( )

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

Referenced by getQuestionTypeID(), and insertXML().

                                      : string
     {
         return "SurveyMetricQuestion";
     }

Here is the caller graph for this function:

◆ getQuestionTypeID()

SurveyMetricQuestion::getQuestionTypeID ( )

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

References SurveyQuestion\$db, $ilDB, and getQuestionType().

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

Here is the call graph for this function:

◆ getSubtype()

SurveyMetricQuestion::getSubtype ( )

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

References $subtype.

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

                                 : ?int
     {
         return $this->subtype;
     }

Here is the caller graph for this function:

◆ getWorkingDataFromUserInput()

SurveyMetricQuestion::getWorkingDataFromUserInput ( array $post_data )

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

References $data, and SurveyQuestion\getId().

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

Here is the call graph for this function:

◆ importResponses()

SurveyMetricQuestion::importResponses ( array $a_data )

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

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

                                                   : void
     {
         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	(	ilXmlWriter	$a_xml_writer,
		bool	$a_include_header = `true`
	)

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

References SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), getMaximum(), getMinimum(), SurveyQuestion\getObligatory(), SurveyQuestion\getQuestiontext(), getQuestionType(), getSubtype(), SurveyQuestion\getTitle(), IL_INST_ID, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by toXML().

      : void {
         $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 4:
             case 3:
                 $attrs = array(
                     "id" => "0",
                     "format" => "double"
                 );
                 if ((string) $this->getMinimum() !== '') {
                     $attrs["min"] = $this->getMinimum();
                 }
                 if ((string) $this->getMaximum() !== '') {
                     $attrs["max"] = $this->getMaximum();
                 }
                 break;
             case 5:
                 $attrs = array(
                     "id" => "0",
                     "format" => "integer"
                 );
                 if ((string) $this->getMinimum() !== '') {
                     $attrs["min"] = $this->getMinimum();
                 }
                 if ((string) $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) && 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 ( )

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

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

                                 : bool
     {
         return (
             $this->getTitle() !== '' &&
             $this->getAuthor() !== '' &&
             $this->getQuestiontext() !== ''
         );
     }

Here is the call graph for this function:

◆ loadFromDb()

SurveyMetricQuestion::loadFromDb ( int $question_id )

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

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

                                                 : void
     {
         $ilDB = $this->db;
 
         $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($question_id)
         );
         if ($result->numRows() === 1) {
             $data = $ilDB->fetchAssoc($result);
             $this->setId((int) $data["question_id"]);
             $this->setTitle((string) $data["title"]);
             $this->setDescription((string) $data["description"]);
             $this->setObjId((int) $data["obj_fi"]);
             $this->setAuthor((string) $data["author"]);
             $this->setOwner((int) $data["owner_fi"]);
             $this->label = (string) $data['label'];
             $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc((string) $data["questiontext"], 1));
             $this->setObligatory((bool) $data["obligatory"]);
             $this->setComplete((bool) $data["complete"]);
             $this->setOriginalId((int) $data["original_id"]);
             $this->setSubtype((int) $data["subtype"]);
 
             $result = $ilDB->queryF(
                 "SELECT svy_variable.* FROM svy_variable WHERE svy_variable.question_fi = %s",
                 array('integer'),
                 array($question_id)
             );
             if ($result->numRows() > 0) {
                 if ($data = $ilDB->fetchAssoc($result)) {
                     $this->minimum = is_null($data["value1"]) ? null : (float) $data["value1"];
                     if (($data["value2"] < 0) or (strcmp($data["value2"], "") == 0)) {
                         $this->maximum = null;
                     } else {
                         $this->maximum = is_null($data["value2"]) ? null : (float) $data["value2"];
                     }
                 }
             }
         }
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ outPreconditionSelectValue()

SurveyMetricQuestion::outPreconditionSelectValue ( ilTemplate $template )

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

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

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

Here is the call graph for this function:

◆ saveToDb()

SurveyMetricQuestion::saveToDb ( int $original_id = 0 )

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

References SurveyQuestion\$db, $ilDB, SurveyQuestion\$original_id, getAdditionalTableName(), SurveyQuestion\getId(), getMaximum(), getMinimum(), getSubtype(), and SurveyQuestion\saveMaterial().

                                                   : int
     {
         $ilDB = $this->db;
 
         $affectedRows = parent::saveToDb($original_id);
         if ($affectedRows === 1) {
             $ilDB->manipulateF(
                 "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                 array('integer'),
                 array($this->getId())
             );
             $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
             $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');
             $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())
             );
         }
         return $affectedRows;
     }

Here is the call graph for this function:

◆ saveUserInput()

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

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

References SurveyQuestion\$db, $ilDB, and SurveyQuestion\getId().

      : ?array {
         $ilDB = $this->db;
 
         $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 ($entered_value === '') {
             return null;
         }
 
         $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", $entered_value);
         $fields['textanswer'] = array("clob", null);
         $fields['tstamp'] = array("integer", time());
 
         $ilDB->insert("svy_answer", $fields);
 
         return null;
     }

Here is the call graph for this function:

◆ setMaximum()

SurveyMetricQuestion::setMaximum ( ?float $maximum = null )

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

References $maximum.

Referenced by importResponses().

                                                       : void
     {
         $this->maximum = $maximum;
     }

Here is the caller graph for this function:

◆ setMinimum()

SurveyMetricQuestion::setMinimum ( ?float $minimum = null )

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

References $minimum.

Referenced by importResponses().

                                                       : void
     {
         $this->minimum = $minimum;
     }

Here is the caller graph for this function:

◆ setSubtype()

SurveyMetricQuestion::setSubtype ( int $a_subtype = self::SUBTYPE_NON_RATIO )

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

Referenced by loadFromDb().

                                                                       : void
     {
         $this->subtype = $a_subtype;
     }

Here is the caller graph for this function:

◆ toXML()

SurveyMetricQuestion::toXML ( bool $a_include_header = true )

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

References $xml, and insertXML().

      : string {
         $a_xml_writer = new ilXmlWriter();
         $a_xml_writer->xmlHeader();
         $this->insertXML($a_xml_writer, $a_include_header);
         $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 ( )

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

                                            : bool
     {
         return true;
     }

Field Documentation

◆ $maximum

float SurveyMetricQuestion::$maximum

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

Referenced by getMaximum(), and setMaximum().

◆ $minimum

float SurveyMetricQuestion::$minimum

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

Referenced by getMinimum(), and setMinimum().

◆ $subtype

int SurveyMetricQuestion::$subtype

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

Referenced by __construct(), and getSubtype().

◆ SUBTYPE_NON_RATIO

const SurveyMetricQuestion::SUBTYPE_NON_RATIO = 3

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

Referenced by SurveyMetricQuestionGUI\addFieldsToEditForm().

◆ SUBTYPE_RATIO_ABSOLUTE

const SurveyMetricQuestion::SUBTYPE_RATIO_ABSOLUTE = 5

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

Referenced by SurveyMetricQuestionGUI\addFieldsToEditForm().

◆ SUBTYPE_RATIO_NON_ABSOLUTE

const SurveyMetricQuestion::SUBTYPE_RATIO_NON_ABSOLUTE = 4

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

Referenced by SurveyMetricQuestionGUI\addFieldsToEditForm().

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

Modules/SurveyQuestionPool/Questions/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