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

Inheritance diagram for SurveyMatrixQuestion:

Collaboration diagram for SurveyMatrixQuestion:

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

	getColumnCount ()

	removeColumn (int $index)

	removeColumns (array $array)

	removeColumnWithName (string $name)

	getColumns ()

	getColumn (int $index)

	getColumnForScale (int $scale)

	getColumnIndex (string $name)

	flushColumns ()

	getRowCount ()

	addRow (string $a_text, string $a_other, string $a_label)

	addRowAtPosition (string $a_text, string $a_other, int $a_position)

	flushRows ()

	getRow (int $a_index)

	moveRowUp (int $index)

	moveRowDown (int $index)

	removeRows (array $array)

	removeRow (int $index)

	getBipolarAdjective (int $a_index)
	Returns one of the bipolar adjectives. More...

	setBipolarAdjective (int $a_index, string $a_value)

	addPhrase (int $phrase_id)
	Adds a phrase to the question. More...

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

	loadFromDb (int $question_id)

	isComplete ()

	saveToDb (int $original_id=0)

	saveBipolarAdjectives (string $adjective1, string $adjective2)

	saveColumnToDb (string $columntext, int $neutral=0)

	saveColumnsToDb (int $original_id=0)

	saveRowsToDb (int $original_id=0)

	toXML (bool $a_include_header=true, bool $obligatory_state=false)
	Returns an xml representation of the question. More...

	insertXML (ilXmlWriter $a_xml_writer, bool $a_include_header=true)
	Adds the question XML to a given XMLWriter object. More...

	syncWithOriginal ()

	addStandardNumbers (int $lower_limit, int $upper_limit)
	Adds standard numbers as columns. More...

	savePhrase (string $title)
	Saves a set of columns to a default phrase (data currently comes from session) More...

	getQuestionType ()

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

	getWorkingDataFromUserInput (array $post_data)

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

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

	deleteAdditionalTableData (int $question_id)
	Delete question data from additional table. More...

	getSubtype ()
	Returns the subtype of the matrix question. More...

	setSubtype (int $a_subtype=0)
	Sets the subtype of the matrix question. More...

	setColumnSeparators (bool $enable=false)
	Enables/Disables separators for the matrix columns. More...

	getColumnSeparators ()

	setRowSeparators (bool $enable=false)
	Enables/Disables separators for the matrix rows. More...

	getRowSeparators ()

	setNeutralColumnSeparator (bool $enable=true)

	getNeutralColumnSeparator ()

	importAdditionalMetadata (array $a_meta)
	Import additional meta 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...

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

	usableForPrecondition ()
	Returns if the question is usable 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...

	saveLayout (float $percent_row, float $percent_columns, float $percent_bipolar_adjective1=0, float $percent_bipolar_adjective2=0, float $percent_neutral=0)
	Saves the layout of a matrix question. More...

	getLayout ()

	setLayout ($layout)

	hasBipolarAdjectives ()
	Returns TRUE if bipolar adjectives exist. More...

	hasNeutralColumn ()
	Returns TRUE if a neutral column exists. More...

	setColumnPlaceholders (bool $a_value=false)
	Set whether placeholders should be used for the column titles or not. More...

	getColumnPlaceholders ()

	setLegend (bool $a_value=false)
	Set whether the legend should be shown or not. More...

	getLegend ()

	setSingleLineRowCaption (bool $a_value=false)

	getSingleLineRowCaption ()

	setRepeatColumnHeader (bool $a_value=false)

	getRepeatColumnHeader ()

	getRows ()

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

Static Public Member Functions
static	getMaxSumScore (int $survey_id)

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

Data Fields
SurveyCategories	$columns

SurveyCategories	$rows

string	$bipolar_adjective1 = ""

string	$bipolar_adjective2 = ""

bool	$columnSeparators = false

bool	$rowSeparators = false

bool	$neutralColumnSeparator = false

array	$layout

bool	$columnPlaceholders = false

bool	$legend = false

bool	$singleLineRowCaption = false

bool	$repeatColumnHeader = false

int	$subtype
	Matrix question subtype 0 = Single choice 1 = Multiple choice 2 = Text 3 = Integer 4 = Double 5 = Date 6 = Time. More...

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
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 The SurveyMatrixQuestion class defines and encapsulates basic methods and attributes for matrix 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 24 of file class.SurveyMatrixQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

SurveyMatrixQuestion::__construct	(	string	$title = `""`,
		string	$description = `""`,
		string	$author = `""`,
		string	$questiontext = `""`,
		int	$owner = `-1`
	)

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

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

       {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->db = $DIC->database();
         parent::__construct($title, $description, $author, $questiontext, $owner);
 
         $this->subtype = 0;
         $this->columns = new SurveyCategories();
         $this->rows = new SurveyCategories();
         $this->bipolar_adjective1 = "";
         $this->bipolar_adjective2 = "";
         $this->rowSeparators = 0;
         $this->columnSeparators = 0;
         $this->neutralColumnSeparator = 1;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addPhrase()

SurveyMatrixQuestion::addPhrase ( int $phrase_id )

Adds a phrase to the question.

Definition at line 208 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, $ilDB, $ilUser, SurveyQuestion\$user, ILIAS\Repository\int(), and ILIAS\Repository\lng().

                                              : void
     {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         $result = $ilDB->queryF(
             "SELECT svy_category.* FROM svy_category, svy_phrase_cat WHERE svy_phrase_cat.category_fi = svy_category.category_id AND svy_phrase_cat.phrase_fi = %s AND (svy_category.owner_fi = %s OR svy_category.owner_fi = %s) ORDER BY svy_phrase_cat.sequence",
             array('integer', 'integer', 'integer'),
             array($phrase_id, 0, $ilUser->getId())
         );
         while ($row = $ilDB->fetchAssoc($result)) {
             $neutral = $row["neutral"];
             if ((int) $row["defaultvalue"] === 1 && (int) $row["owner_fi"] === 0) {
                 $this->columns->addCategory($this->lng->txt($row["title"]), 0, $neutral);
             } else {
                 $this->columns->addCategory($row["title"], 0, $neutral);
             }
         }
     }

Here is the call graph for this function:

◆ addRow()

SurveyMatrixQuestion::addRow	(	string	$a_text,
		string	$a_other,
		string	$a_label
	)

Definition at line 133 of file class.SurveyMatrixQuestion.php.

Referenced by importMatrix(), and loadFromDb().

      : void {
         $this->rows->addCategory($a_text, (int) $a_other, 0, $a_label);
     }

Here is the caller graph for this function:

◆ addRowAtPosition()

SurveyMatrixQuestion::addRowAtPosition	(	string	$a_text,
		string	$a_other,
		int	$a_position
	)

Definition at line 141 of file class.SurveyMatrixQuestion.php.

      : void {
         $this->rows->addCategoryAtPosition($a_text, $a_position, $a_other);
     }

◆ addStandardNumbers()

SurveyMatrixQuestion::addStandardNumbers	(	int	$lower_limit,
		int	$upper_limit
	)

Adds standard numbers as columns.

Definition at line 628 of file class.SurveyMatrixQuestion.php.

References $i.

      : void {
         for ($i = $lower_limit; $i <= $upper_limit; $i++) {
             $this->columns->addCategory($i);
         }
     }

◆ checkUserInput()

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

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

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

Definition at line 723 of file class.SurveyMatrixQuestion.php.

References ILIAS\LTI\ToolProvider\$key, SurveyQuestion\getId(), SurveyQuestion\getObligatory(), getRowCount(), getSubtype(), and ILIAS\Repository\lng().

      : string {
         if (!$this->getObligatory()) {
             return "";
         }
         switch ($this->getSubtype()) {
             case 0:
                 $counter = 0;
                 foreach ($post_data as $key => $value) {
                     if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                         if (array_key_exists('matrix_other_' . $this->getId() . "_" . $matches[1], $post_data) && strlen($post_data['matrix_other_' . $this->getId() . "_" . $matches[1]]) == 0) {
                             return $this->lng->txt("question_mr_no_other_answer");
                         }
                         $counter++;
                     }
                 }
                 if ($counter !== $this->getRowCount()) {
                     return $this->lng->txt("matrix_question_radio_button_not_checked");
                 }
                 break;
             case 1:
                 $counter = 0;
                 foreach ($post_data as $key => $value) {
                     if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                         if (array_key_exists('matrix_other_' . $this->getId() . "_" . $matches[1], $post_data) && strlen($post_data['matrix_other_' . $this->getId() . "_" . $matches[1]]) == 0) {
                             return $this->lng->txt("question_mr_no_other_answer");
                         }
                         $counter++;
                         if ((!is_array($value)) || (count($value) < 1)) {
                             return $this->lng->txt("matrix_question_checkbox_not_checked");
                         }
                     }
                 }
                 if ($counter !== $this->getRowCount()) {
                     return $this->lng->txt("matrix_question_checkbox_not_checked");
                 }
                 break;
         }
         return "";
     }

Here is the call graph for this function:

◆ deleteAdditionalTableData()

SurveyMatrixQuestion::deleteAdditionalTableData ( int $question_id )

Delete question data from additional table.

Definition at line 836 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, and $ilDB.

      : void {
         parent::deleteAdditionalTableData($question_id);
 
         $ilDB = $this->db;
         $ilDB->manipulateF(
             "DELETE FROM svy_qst_matrixrows WHERE question_fi = %s",
             array('integer'),
             array($question_id)
         );
     }

◆ flushColumns()

SurveyMatrixQuestion::flushColumns ( )

Definition at line 123 of file class.SurveyMatrixQuestion.php.

Referenced by loadFromDb().

                                   : void
     {
         $this->columns->flushCategories();
     }

Here is the caller graph for this function:

◆ flushRows()

SurveyMatrixQuestion::flushRows ( )

Definition at line 149 of file class.SurveyMatrixQuestion.php.

                                : void
     {
         $this->rows = new SurveyCategories();
     }

◆ getAdditionalTableName()

SurveyMatrixQuestion::getAdditionalTableName ( )

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

Definition at line 683 of file class.SurveyMatrixQuestion.php.

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

                                             : string
     {
         return "svy_qst_matrix";
     }

Here is the caller graph for this function:

◆ getBipolarAdjective()

SurveyMatrixQuestion::getBipolarAdjective ( int $a_index )

Returns one of the bipolar adjectives.

Parameters

int $a_index bipolar adjective (0 first, and 1 for the second)

Definition at line 186 of file class.SurveyMatrixQuestion.php.

References $bipolar_adjective1, and $bipolar_adjective2.

Referenced by hasBipolarAdjectives(), insertXML(), and saveToDb().

                                                      : string
     {
         if ($a_index === 1) {
             return $this->bipolar_adjective2;
         }
         return $this->bipolar_adjective1;
     }

Here is the caller graph for this function:

◆ getColumn()

SurveyMatrixQuestion::getColumn ( int $index )

Definition at line 108 of file class.SurveyMatrixQuestion.php.

Referenced by hasNeutralColumn(), insertXML(), and saveColumnsToDb().

                                          : ?ilSurveyCategory
     {
         return $this->columns->getCategory($index);
     }

Here is the caller graph for this function:

◆ getColumnCount()

SurveyMatrixQuestion::getColumnCount ( )

Definition at line 80 of file class.SurveyMatrixQuestion.php.

Referenced by hasNeutralColumn(), insertXML(), isComplete(), and saveColumnsToDb().

                                     : int
     {
         return $this->columns->getCategoryCount();
     }

Here is the caller graph for this function:

◆ getColumnForScale()

SurveyMatrixQuestion::getColumnForScale ( int $scale )

Definition at line 113 of file class.SurveyMatrixQuestion.php.

                                                  : ?ilSurveyCategory
     {
         return $this->columns->getCategoryForScale($scale);
     }

◆ getColumnIndex()

SurveyMatrixQuestion::getColumnIndex ( string $name )

Definition at line 118 of file class.SurveyMatrixQuestion.php.

                                                 : int
     {
         return $this->columns->getCategoryIndex($name);
     }

◆ getColumnPlaceholders()

SurveyMatrixQuestion::getColumnPlaceholders ( )

Definition at line 1123 of file class.SurveyMatrixQuestion.php.

References $columnPlaceholders.

Referenced by saveToDb().

                                            : bool
     {
         return $this->columnPlaceholders;
     }

Here is the caller graph for this function:

◆ getColumns()

SurveyMatrixQuestion::getColumns ( )

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

References $columns.

                                 : SurveyCategories
     {
         return $this->columns;
     }

◆ getColumnSeparators()

SurveyMatrixQuestion::getColumnSeparators ( )

Definition at line 886 of file class.SurveyMatrixQuestion.php.

References $columnSeparators.

Referenced by insertXML(), and saveToDb().

                                          : bool
     {
         return $this->columnSeparators;
     }

Here is the caller graph for this function:

◆ getLayout()

SurveyMatrixQuestion::getLayout ( )

Definition at line 1041 of file class.SurveyMatrixQuestion.php.

References $layout, hasBipolarAdjectives(), and hasNeutralColumn().

Referenced by insertXML(), and saveToDb().

                                : array
     {
         if (count($this->layout) === 0) {
             if ($this->hasBipolarAdjectives() && $this->hasNeutralColumn()) {
                 $this->layout = array(
                     "percent_row" => 30,
                     "percent_columns" => 40,
                     "percent_bipolar_adjective1" => 10,
                     "percent_bipolar_adjective2" => 10,
                     "percent_neutral" => 10
                 );
             } elseif ($this->hasBipolarAdjectives()) {
                 $this->layout = array(
                     "percent_row" => 30,
                     "percent_columns" => 50,
                     "percent_bipolar_adjective1" => 10,
                     "percent_bipolar_adjective2" => 10,
                     "percent_neutral" => 0
                 );
             } elseif ($this->hasNeutralColumn()) {
                 $this->layout = array(
                     "percent_row" => 30,
                     "percent_columns" => 50,
                     "percent_bipolar_adjective1" => 0,
                     "percent_bipolar_adjective2" => 0,
                     "percent_neutral" => 20
                 );
             } else {
                 $this->layout = array(
                     "percent_row" => 30,
                     "percent_columns" => 70,
                     "percent_bipolar_adjective1" => 0,
                     "percent_bipolar_adjective2" => 0,
                     "percent_neutral" => 0
                 );
             }
         }
         return $this->layout;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegend()

SurveyMatrixQuestion::getLegend ( )

Definition at line 1136 of file class.SurveyMatrixQuestion.php.

References $legend.

Referenced by saveToDb().

                                : bool
     {
         return $this->legend;
     }

Here is the caller graph for this function:

◆ getMaxSumScore()

static SurveyMatrixQuestion::getMaxSumScore ( int $survey_id )

static

Definition at line 1167 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, $DIC, ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

                                                          : int
     {
         global $DIC;
 
         // we need max scale values of matrix rows * number of rows (type 5)
         $db = $DIC->database();
 
         $set = $db->queryF(
             "SELECT MAX(scale) max_sum_score, q.question_id FROM svy_svy_qst sq " .
             "JOIN svy_question q ON (sq.question_fi = q.question_id) " .
             "JOIN svy_variable v ON (v.question_fi = q.question_id) " .
             "WHERE sq.survey_fi  = %s AND q.questiontype_fi = %s " .
             "GROUP BY (q.question_id)",
             ["integer", "integer"],
             [$survey_id, 5]
         );
         $max_score = [];
         while ($rec = $db->fetchAssoc($set)) {
             $max_score[$rec["question_id"]] = $rec["max_sum_score"];
         }
 
         $set = $db->queryF(
             "SELECT COUNT(mr.id_svy_qst_matrixrows) cnt_rows, q.question_id FROM svy_svy_qst sq " .
             "JOIN svy_question q ON (sq.question_fi = q.question_id) " .
             "JOIN svy_qst_matrixrows mr ON (mr.question_fi = q.question_id) " .
             "WHERE sq.survey_fi  = %s AND q.questiontype_fi = %s " .
             "GROUP BY (q.question_id)",
             ["integer", "integer"],
             [$survey_id, 5]
         );
         $cnt_rows = [];
         while ($rec = $db->fetchAssoc($set)) {
             $cnt_rows[$rec["question_id"]] = $rec["cnt_rows"];
         }
 
         $sum_sum_score = 0;
         foreach ($max_score as $qid => $s) {
             $sum_sum_score += $s * $cnt_rows[$qid];
         }
 
         return $sum_sum_score;
     }

Here is the call graph for this function:

◆ getNeutralColumnSeparator()

SurveyMatrixQuestion::getNeutralColumnSeparator ( )

Definition at line 909 of file class.SurveyMatrixQuestion.php.

References $neutralColumnSeparator.

Referenced by insertXML(), and saveToDb().

                                                : bool
     {
         return $this->neutralColumnSeparator;
     }

Here is the caller graph for this function:

◆ getPreconditionSelectValue()

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

Creates a form property for the precondition value.

Definition at line 997 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\getPreconditionOptions().

      : ?ilFormPropertyGUI {
         $step3 = new ilSelectInputGUI($title, $variable);
         $options = $this->getPreconditionOptions();
         $step3->setOptions($options);
         $step3->setValue($default);
         return $step3;
     }

Here is the call graph for this function:

◆ getPreconditionValueOutput()

SurveyMatrixQuestion::getPreconditionValueOutput ( string $value )

Returns the output for a precondition value.

Definition at line 989 of file class.SurveyMatrixQuestion.php.

                                                              : string
     {
         return $value;
     }

◆ getQuestionDataArray()

SurveyMatrixQuestion::getQuestionDataArray ( int $id )

Returns the question data fields from the database.

Definition at line 231 of file class.SurveyMatrixQuestion.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);
         }
 
         return array();
     }

Here is the call graph for this function:

◆ getQuestionType()

SurveyMatrixQuestion::getQuestionType ( )

Definition at line 675 of file class.SurveyMatrixQuestion.php.

Referenced by insertXML().

                                      : string
     {
         return "SurveyMatrixQuestion";
     }

Here is the caller graph for this function:

◆ getRepeatColumnHeader()

SurveyMatrixQuestion::getRepeatColumnHeader ( )

Definition at line 1156 of file class.SurveyMatrixQuestion.php.

References $repeatColumnHeader.

Referenced by saveToDb().

                                            : bool
     {
         return $this->repeatColumnHeader;
     }

Here is the caller graph for this function:

◆ getRow()

SurveyMatrixQuestion::getRow ( int $a_index )

Definition at line 154 of file class.SurveyMatrixQuestion.php.

Referenced by insertXML(), and saveRowsToDb().

                                         : ?ilSurveyCategory
     {
         return $this->rows->getCategory($a_index);
     }

Here is the caller graph for this function:

◆ getRowCount()

SurveyMatrixQuestion::getRowCount ( )

Definition at line 128 of file class.SurveyMatrixQuestion.php.

Referenced by checkUserInput(), insertXML(), isComplete(), and saveRowsToDb().

                                  : int
     {
         return $this->rows->getCategoryCount();
     }

Here is the caller graph for this function:

◆ getRows()

SurveyMatrixQuestion::getRows ( )

Definition at line 1162 of file class.SurveyMatrixQuestion.php.

References $rows.

                              : SurveyCategories
     {
         return $this->rows;
     }

◆ getRowSeparators()

SurveyMatrixQuestion::getRowSeparators ( )

Definition at line 899 of file class.SurveyMatrixQuestion.php.

References $rowSeparators.

Referenced by insertXML(), and saveToDb().

                                       : bool
     {
         return $this->rowSeparators;
     }

Here is the caller graph for this function:

◆ getSingleLineRowCaption()

SurveyMatrixQuestion::getSingleLineRowCaption ( )

Definition at line 1146 of file class.SurveyMatrixQuestion.php.

References $singleLineRowCaption.

Referenced by saveToDb().

                                              : bool
     {
         return $this->singleLineRowCaption;
     }

Here is the caller graph for this function:

◆ getSubtype()

SurveyMatrixQuestion::getSubtype ( )

Returns the subtype of the matrix question.

Definition at line 852 of file class.SurveyMatrixQuestion.php.

References $subtype.

Referenced by checkUserInput(), getWorkingDataFromUserInput(), insertXML(), saveToDb(), and saveUserInput().

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

Here is the caller graph for this function:

◆ getWorkingDataFromUserInput()

SurveyMatrixQuestion::getWorkingDataFromUserInput ( array $post_data )

Definition at line 688 of file class.SurveyMatrixQuestion.php.

References $data, ILIAS\LTI\ToolProvider\$key, SurveyQuestion\getId(), and getSubtype().

                                                                  : array
     {
         $data = array();
         foreach ($post_data as $key => $value) {
             switch ($this->getSubtype()) {
                 case 1:
                 case 0:
                     if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                         if (is_array($value)) {
                             foreach ($value as $val) {
                                 $data[] = array("value" => $val,
                                                 "rowvalue" => $matches[1],
                                                 "textanswer" => $post_data['matrix_other_' . $this->getId(
                                                 ) . '_' . $matches[1]] ?? ""
                                 );
                             }
                         } else {
                             $data[] = array("value" => $value,
                                             "rowvalue" => $matches[1],
                                             "textanswer" => $post_data['matrix_other_' . $this->getId(
                                             ) . '_' . $matches[1]] ?? ""
                             );
                         }
                     }
                     break;
             }
         }
         return $data;
     }

Here is the call graph for this function:

◆ hasBipolarAdjectives()

SurveyMatrixQuestion::hasBipolarAdjectives ( )

Returns TRUE if bipolar adjectives exist.

Definition at line 1096 of file class.SurveyMatrixQuestion.php.

References getBipolarAdjective().

Referenced by getLayout().

                                           : bool
     {
         return $this->getBipolarAdjective(0) !== '' && $this->getBipolarAdjective(1) !== '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasNeutralColumn()

SurveyMatrixQuestion::hasNeutralColumn ( )

Returns TRUE if a neutral column exists.

Definition at line 1104 of file class.SurveyMatrixQuestion.php.

References $i, getColumn(), and getColumnCount().

Referenced by getLayout().

                                       : bool
     {
         for ($i = 0; $i < $this->getColumnCount(); $i++) {
             $column = $this->getColumn($i);
             if ($column->neutral && strlen($column->title)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importAdditionalMetadata()

SurveyMatrixQuestion::importAdditionalMetadata ( array $a_meta )

Import additional meta data from the question import file.

Definition at line 917 of file class.SurveyMatrixQuestion.php.

References ILIAS\LTI\ToolProvider\$key, setColumnSeparators(), setLayout(), setNeutralColumnSeparator(), and setRowSeparators().

                                                            : void
     {
         foreach ($a_meta as $key => $value) {
             switch ($value["label"]) {
                 case "column_separators":
                     $this->setColumnSeparators($value["entry"]);
                     break;
                 case "row_separators":
                     $this->setRowSeparators($value["entry"]);
                     break;
                 case "layout":
                     $this->setLayout($value["entry"]);
                     break;
                 case "neutral_column_separator":
                     $this->setNeutralColumnSeparator($value["entry"]);
                     break;
             }
         }
     }

Here is the call graph for this function:

◆ importAdjectives()

SurveyMatrixQuestion::importAdjectives ( array $a_data )

Import bipolar adjectives from the question import file.

Definition at line 940 of file class.SurveyMatrixQuestion.php.

References $i, and setBipolarAdjective().

                                                    : void
     {
         $i = 0;
         foreach ($a_data as $adjective) {
             if (is_numeric($adjective["label"])) {
                 $this->setBipolarAdjective($adjective["label"], $adjective["text"]);
             } else {
                 $this->setBipolarAdjective($i, $adjective["text"]);
             }
             $i++;
         }
     }

Here is the call graph for this function:

◆ importMatrix()

SurveyMatrixQuestion::importMatrix ( array $a_data )

Import matrix rows from the question import file.

Definition at line 956 of file class.SurveyMatrixQuestion.php.

References addRow().

      : void {
         foreach ($a_data as $row) {
             $this->addRow($row['title'], $row['other'], $row['label']);
         }
     }

Here is the call graph for this function:

◆ importResponses()

SurveyMatrixQuestion::importResponses ( array $a_data )

Import response data from the question import file.

Definition at line 967 of file class.SurveyMatrixQuestion.php.

References $data, SurveyQuestion\$id, and SurveyQuestion\$material.

                                                   : void
     {
         foreach ($a_data as $id => $data) {
             $column = "";
             foreach ($data["material"] as $material) {
                 $column .= $material["text"];
             }
             $this->columns->addCategory($column, 0, strcmp($data["label"], "neutral") == 0);
         }
     }

◆ insertXML()

SurveyMatrixQuestion::insertXML	(	ilXmlWriter	$a_xml_writer,
		bool	$a_include_header = `true`
	)

Adds the question XML to a given XMLWriter object.

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

References $i, SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), getBipolarAdjective(), getColumn(), getColumnCount(), getColumnSeparators(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), getLayout(), getNeutralColumnSeparator(), SurveyQuestion\getObligatory(), SurveyQuestion\getQuestiontext(), getQuestionType(), getRow(), getRowCount(), getRowSeparators(), 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("matrix");
         $a_xml_writer->xmlStartTag("matrixrows");
         for ($i = 0; $i < $this->getRowCount(); $i++) {
             $attrs = array(
                 "id" => $i
             );
             if (strlen($this->getRow($i)->label)) {
                 $attrs['label'] = $this->getRow($i)->label;
             }
             if ($this->getRow($i)->other) {
                 $attrs['other'] = 1;
             }
             $a_xml_writer->xmlStartTag("matrixrow", $attrs);
             $this->addMaterialTag($a_xml_writer, $this->getRow($i)->title);
             $a_xml_writer->xmlEndTag("matrixrow");
         }
         $a_xml_writer->xmlEndTag("matrixrows");
 
         $a_xml_writer->xmlStartTag("responses");
         if ($this->getBipolarAdjective(0) !== '' && ($this->getBipolarAdjective(1) !== '')) {
             $a_xml_writer->xmlStartTag("bipolar_adjectives");
             $attribs = array(
                 "label" => "0"
             );
             $a_xml_writer->xmlElement("adjective", $attribs, $this->getBipolarAdjective(0));
             $attribs = array(
                 "label" => "1"
             );
             $a_xml_writer->xmlElement("adjective", $attribs, $this->getBipolarAdjective(1));
             $a_xml_writer->xmlEndTag("bipolar_adjectives");
         }
         for ($i = 0; $i < $this->getColumnCount(); $i++) {
             $attrs = array(
                 "id" => $i
             );
             if ($this->getColumn($i)->neutral) {
                 $attrs['label'] = 'neutral';
             }
             switch ($this->getSubtype()) {
                 case 0:
                     $a_xml_writer->xmlStartTag("response_single", $attrs);
                     break;
                 case 1:
                     $a_xml_writer->xmlStartTag("response_multiple", $attrs);
                     break;
             }
             $this->addMaterialTag($a_xml_writer, $this->getColumn($i)->title);
             switch ($this->getSubtype()) {
                 case 0:
                     $a_xml_writer->xmlEndTag("response_single");
                     break;
                 case 1:
                     $a_xml_writer->xmlEndTag("response_multiple");
                     break;
             }
         }
 
         $a_xml_writer->xmlEndTag("responses");
         $a_xml_writer->xmlEndTag("matrix");
 
         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->xmlStartTag("metadata");
         $a_xml_writer->xmlStartTag("metadatafield");
         $a_xml_writer->xmlElement("fieldlabel", null, "column_separators");
         $a_xml_writer->xmlElement("fieldentry", null, $this->getColumnSeparators());
         $a_xml_writer->xmlEndTag("metadatafield");
 
         $a_xml_writer->xmlStartTag("metadatafield");
         $a_xml_writer->xmlElement("fieldlabel", null, "row_separators");
         $a_xml_writer->xmlElement("fieldentry", null, $this->getRowSeparators());
         $a_xml_writer->xmlEndTag("metadatafield");
 
         $a_xml_writer->xmlStartTag("metadatafield");
         $a_xml_writer->xmlElement("fieldlabel", null, "neutral_column_separator");
         $a_xml_writer->xmlElement("fieldentry", null, $this->getNeutralColumnSeparator());
         $a_xml_writer->xmlEndTag("metadatafield");
 
         $a_xml_writer->xmlStartTag("metadatafield");
         $a_xml_writer->xmlElement("fieldlabel", null, "layout");
         $a_xml_writer->xmlElement("fieldentry", null, serialize($this->getLayout()));
         $a_xml_writer->xmlEndTag("metadatafield");
 
         $a_xml_writer->xmlEndTag("metadata");
 
         $a_xml_writer->xmlEndTag("question");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isComplete()

SurveyMatrixQuestion::isComplete ( )

Definition at line 304 of file class.SurveyMatrixQuestion.php.

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

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

Here is the call graph for this function:

◆ loadFromDb()

SurveyMatrixQuestion::loadFromDb ( int $question_id )

Definition at line 247 of file class.SurveyMatrixQuestion.php.

                                                 : 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->label = (string) $data['label'];
             $this->setDescription((string) $data["description"]);
             $this->setObjId((int) $data["obj_fi"]);
             $this->setAuthor((string) $data["author"]);
             $this->setOwner((int) $data["owner_fi"]);
             $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"]);
             $this->setRowSeparators((bool) $data["row_separators"]);
             $this->setNeutralColumnSeparator((bool) $data["neutral_column_separator"]);
             $this->setColumnSeparators((bool) $data["column_separators"]);
             $this->setColumnPlaceholders((bool) $data["column_placeholders"]);
             $this->setLegend((bool) $data["legend"]);
             $this->setSingleLineRowCaption((string) $data["singleline_row_caption"]);
             $this->setRepeatColumnHeader((bool) $data["repeat_column_header"]);
             $this->setBipolarAdjective(0, (string) $data["bipolar_adjective1"]);
             $this->setBipolarAdjective(1, (string) $data["bipolar_adjective2"]);
             $this->setLayout($data["layout"]);
             $this->flushColumns();
 
             $result = $ilDB->queryF(
                 "SELECT svy_variable.*, svy_category.title, svy_category.neutral FROM svy_variable, svy_category WHERE svy_variable.question_fi = %s AND svy_variable.category_fi = svy_category.category_id ORDER BY sequence ASC",
                 array('integer'),
                 array($question_id)
             );
             if ($result->numRows() > 0) {
                 while ($data = $ilDB->fetchAssoc($result)) {
                     $this->columns->addCategory((string) $data["title"], (int) $data["other"], (int) $data["neutral"], null, ($data['scale']) ?: ($data['sequence'] + 1));
                 }
             }
 
             $result = $ilDB->queryF(
                 "SELECT * FROM svy_qst_matrixrows WHERE question_fi = %s ORDER BY sequence",
                 array('integer'),
                 array($question_id)
             );
             while ($row = $ilDB->fetchAssoc($result)) {
                 $this->addRow((string) $row["title"], (string) $row['other'], (string) ($row['label'] ?? ""));
             }
         }
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ moveRowDown()

SurveyMatrixQuestion::moveRowDown ( int $index )

Definition at line 164 of file class.SurveyMatrixQuestion.php.

                                            : void
     {
         $this->rows->moveCategoryDown($index);
     }

◆ moveRowUp()

SurveyMatrixQuestion::moveRowUp ( int $index )

Definition at line 159 of file class.SurveyMatrixQuestion.php.

                                          : void
     {
         $this->rows->moveCategoryUp($index);
     }

◆ removeColumn()

SurveyMatrixQuestion::removeColumn ( int $index )

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

                                             : void
     {
         $this->columns->removeCategory($index);
     }

◆ removeColumns()

SurveyMatrixQuestion::removeColumns ( array $array )

Parameters

int[] $array index positions

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

                                                : void
     {
         $this->columns->removeCategories($array);
     }

◆ removeColumnWithName()

SurveyMatrixQuestion::removeColumnWithName ( string $name )

Definition at line 98 of file class.SurveyMatrixQuestion.php.

                                                       : void
     {
         $this->columns->removeCategoryWithName($name);
     }

◆ removeRow()

SurveyMatrixQuestion::removeRow ( int $index )

Definition at line 177 of file class.SurveyMatrixQuestion.php.

                                          : void
     {
         $this->rows->removeCategory($index);
     }

◆ removeRows()

SurveyMatrixQuestion::removeRows ( array $array )

Parameters

int[] $array index positions

Definition at line 172 of file class.SurveyMatrixQuestion.php.

                                             : void
     {
         $this->rows->removeCategories($array);
     }

◆ saveBipolarAdjectives()

SurveyMatrixQuestion::saveBipolarAdjectives	(	string	$adjective1,
		string	$adjective2
	)

Definition at line 363 of file class.SurveyMatrixQuestion.php.

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

      : void {
         $ilDB = $this->db;
 
         $ilDB->manipulateF(
             "UPDATE " . $this->getAdditionalTableName() . " SET bipolar_adjective1 = %s, bipolar_adjective2 = %s WHERE question_fi = %s",
             array('text', 'text', 'integer'),
             array(($adjective1 !== '') ? $adjective1 : null, ($adjective2 !== '') ? $adjective2 : null, $this->getId())
         );
     }

Here is the call graph for this function:

◆ saveColumnsToDb()

SurveyMatrixQuestion::saveColumnsToDb ( int $original_id = 0 )

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

References SurveyQuestion\$db, $i, $ilDB, SurveyQuestion\$original_id, getColumn(), getColumnCount(), SurveyQuestion\getId(), saveColumnToDb(), and SurveyQuestion\saveCompletionStatus().

Referenced by saveToDb(), and syncWithOriginal().

      : void {
         $ilDB = $this->db;
 
         // save columns
         $question_id = $this->getId();
         if ($original_id > 0) {
             $question_id = $original_id;
         }
 
         // delete existing column relations
         $affectedRows = $ilDB->manipulateF(
             "DELETE FROM svy_variable WHERE question_fi = %s",
             array('integer'),
             array($question_id)
         );
         // create new column relations
         for ($i = 0; $i < $this->getColumnCount(); $i++) {
             $cat = $this->getColumn($i);
             $column_id = $this->saveColumnToDb($cat->title, $cat->neutral);
             $next_id = $ilDB->nextId('svy_variable');
             $affectedRows = $ilDB->manipulateF(
                 "INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, other, sequence, scale, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
                 array('integer','integer','integer','float','integer','integer', 'integer','integer'),
                 array($next_id, $column_id, $question_id, ($i + 1), $cat->other, $i, ($cat->scale > 0) ? $cat->scale : null, time())
             );
         }
         $this->saveCompletionStatus($original_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveColumnToDb()

SurveyMatrixQuestion::saveColumnToDb	(	string	$columntext,
		int	$neutral = `0`
	)

Definition at line 376 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, $ilDB, $ilUser, and SurveyQuestion\$user.

Referenced by saveColumnsToDb().

      : int {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         $result = $ilDB->queryF(
             "SELECT title, category_id FROM svy_category WHERE title = %s AND neutral = %s AND owner_fi = %s",
             array('text', 'text', 'integer'),
             array($columntext, $neutral, $ilUser->getId())
         );
         $insert = false;
         $returnvalue = "";
         $insert = true;
         if ($result->numRows()) {
             while ($row = $ilDB->fetchAssoc($result)) {
                 if (strcmp($row["title"] ?? '', $columntext) === 0) {
                     $returnvalue = $row["category_id"];
                     $insert = false;
                 }
             }
         }
         if ($insert) {
             $next_id = $ilDB->nextId('svy_category');
             $affectedRows = $ilDB->manipulateF(
                 "INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, neutral, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                 array('integer', 'text', 'text', 'integer', 'text', 'integer'),
                 array($next_id, $columntext, 0, $ilUser->getId(), $neutral, time())
             );
             $returnvalue = $next_id;
         }
         return $returnvalue;
     }

Here is the caller graph for this function:

◆ saveLayout()

SurveyMatrixQuestion::saveLayout	(	float	$percent_row,
		float	$percent_columns,
		float	$percent_bipolar_adjective1 = `0`,
		float	$percent_bipolar_adjective2 = `0`,
		float	$percent_neutral = `0`
	)

Saves the layout of a matrix question.

Deprecated:: ?

Parameters

float	$percent_row	width in percent for the matrix rows
float	$percent_columns	width in percent for the matrix columns
float \| int	$percent_bipolar_adjective1	width in percent for the first bipolar adjective
float \| int	$percent_bipolar_adjective2	width in percent for the second bipolar adjective
float \| int	$percent_neutral

Definition at line 1018 of file class.SurveyMatrixQuestion.php.

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

      : void {
         $ilDB = $this->db;
 
         $layout = array(
             "percent_row" => $percent_row,
             "percent_columns" => $percent_columns,
             "percent_bipolar_adjective1" => $percent_bipolar_adjective1,
             "percent_bipolar_adjective2" => $percent_bipolar_adjective2,
             "percent_neutral" => $percent_neutral
         );
         $affectedRows = $ilDB->manipulateF(
             "UPDATE " . $this->getAdditionalTableName() . " SET layout = %s WHERE question_fi = %s",
             array('text', 'integer'),
             array(serialize($layout), $this->getId())
         );
     }

Here is the call graph for this function:

◆ savePhrase()

SurveyMatrixQuestion::savePhrase ( string $title )

Saves a set of columns to a default phrase (data currently comes from session)

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

References $data, SurveyQuestion\$db, $ilDB, $ilUser, and SurveyQuestion\$user.

      : void {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         $next_id = $ilDB->nextId('svy_phrase');
         $ilDB->manipulateF(
             "INSERT INTO svy_phrase (phrase_id, title, defaultvalue, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
             array('integer','text','text','integer','integer'),
             array($next_id, $title, 1, $ilUser->getId(), time())
         );
         $phrase_id = $next_id;
 
         $counter = 1;
         $phrase_data = $this->edit_manager->getPhraseData();
         foreach ($phrase_data as $data) {
             $next_id = $ilDB->nextId('svy_category');
             $affectedRows = $ilDB->manipulateF(
                 "INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, tstamp, neutral) VALUES (%s, %s, %s, %s, %s, %s)",
                 array('integer','text','text','integer','integer','text'),
                 array($next_id, $data['answer'], 1, $ilUser->getId(), time(), $data['neutral'])
             );
             $category_id = $next_id;
             $next_id = $ilDB->nextId('svy_phrase_cat');
             $affectedRows = $ilDB->manipulateF(
                 "INSERT INTO svy_phrase_cat (phrase_category_id, phrase_fi, category_fi, sequence, other, scale) VALUES (%s, %s, %s, %s, %s, %s)",
                 array('integer', 'integer', 'integer','integer', 'integer', 'integer'),
                 array($next_id, $phrase_id, $category_id, $counter, ($data['other']) ? 1 : 0, $data['scale'])
             );
             $counter++;
         }
     }

◆ saveRowsToDb()

SurveyMatrixQuestion::saveRowsToDb ( int $original_id = 0 )

Definition at line 442 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, $i, $ilDB, SurveyQuestion\$original_id, SurveyQuestion\getId(), getRow(), getRowCount(), and SurveyQuestion\saveCompletionStatus().

Referenced by saveToDb(), and syncWithOriginal().

      : void {
         $ilDB = $this->db;
 
         // save rows
         $question_id = $this->getId();
         if ($original_id > 0) {
             $question_id = $original_id;
         }
 
         // delete existing rows
         $affectedRows = $ilDB->manipulateF(
             "DELETE FROM svy_qst_matrixrows WHERE question_fi = %s",
             array('integer'),
             array($question_id)
         );
         // create new rows
         for ($i = 0; $i < $this->getRowCount(); $i++) {
             $row = $this->getRow($i);
             $next_id = $ilDB->nextId('svy_qst_matrixrows');
             $affectedRows = $ilDB->manipulateF(
                 "INSERT INTO svy_qst_matrixrows (id_svy_qst_matrixrows, title, label, other, sequence, question_fi) VALUES (%s, %s, %s, %s, %s, %s)",
                 array('integer','text','text','integer','integer','integer'),
                 array($next_id, $row->title, $row->label, ($row->other) ? 1 : 0, $i, $question_id)
             );
         }
         $this->saveCompletionStatus($original_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

SurveyMatrixQuestion::saveToDb ( int $original_id = 0 )

Definition at line 315 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, $ilDB, SurveyQuestion\$original_id, getAdditionalTableName(), getBipolarAdjective(), getColumnPlaceholders(), getColumnSeparators(), SurveyQuestion\getId(), getLayout(), getLegend(), getNeutralColumnSeparator(), getRepeatColumnHeader(), getRowSeparators(), getSingleLineRowCaption(), getSubtype(), saveColumnsToDb(), SurveyQuestion\saveMaterial(), and saveRowsToDb().

                                                   : 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, column_separators, row_separators, neutral_column_separator,column_placeholders,
                                 legend, singleline_row_caption, repeat_column_header,
                                 bipolar_adjective1, bipolar_adjective2, layout, tstamp)
                                 VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                 array(
                     'integer', 'integer', 'text', 'text', 'text', 'integer', 'text', 'text', 'text',
                     'text', 'text', 'text', 'integer'
                 ),
                 array(
                     $this->getId(),
                     $this->getSubtype(),
                     $this->getColumnSeparators(),
                     $this->getRowSeparators(),
                     $this->getNeutralColumnSeparator(),
                     $this->getColumnPlaceholders(),
                     $this->getLegend(),
                     $this->getSingleLineRowCaption(),
                     $this->getRepeatColumnHeader(),
                     $this->getBipolarAdjective(0),
                     $this->getBipolarAdjective(1),
                     serialize($this->getLayout()),
                     time()
                 )
             );
 
             // saving material uris in the database
             $this->saveMaterial();
 
             $this->saveColumnsToDb();
             $this->saveRowsToDb();
         }
         return $affectedRows;
     }

Here is the call graph for this function:

◆ saveUserInput()

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

Definition at line 766 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\$db, $ilDB, ILIAS\LTI\ToolProvider\$key, SurveyQuestion\getId(), getSubtype(), and SurveyQuestion\stripSlashesAddSpaceFallback().

      : ?array {
         $ilDB = $this->db;
 
         $answer_data = array();
 
         // gather data
         switch ($this->getSubtype()) {
             case 0:
                 foreach ($post_data as $key => $value) {
                     if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                         if (strlen($value)) {
                             $other_value = (array_key_exists('matrix_other_' . $this->getId() . '_' . $matches[1], $post_data))
                                 ? $this->stripSlashesAddSpaceFallback($post_data['matrix_other_' . $this->getId() . '_' . $matches[1]])
                                 : null;
                             $answer_data[] = array("value" => $value,
                                 "textanswer" => $other_value,
                                 "rowvalue" => $matches[1]);
                         }
                     }
                 }
                 break;
 
             case 1:
                 foreach ($post_data as $key => $value) {
                     if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                         $other_value = (array_key_exists('matrix_other_' . $this->getId() . '_' . $matches[1], $post_data))
                             ? $this->stripSlashesAddSpaceFallback($post_data['matrix_other_' . $this->getId() . '_' . $matches[1]])
                             : null;
                         foreach ($value as $checked) {
                             $answer_data[] = array("value" => $checked,
                                 "textanswer" => $other_value,
                                 "rowvalue" => $matches[1]);
                         }
                     }
                 }
                 break;
         }
 
         if ($a_return) {
             return $answer_data;
         }
 
         // #16387 - only if any input
         if (count($answer_data)) {
             // save data
             foreach ($answer_data as $item) {
                 $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", $item['value']);
                 $fields['textanswer'] = array("clob", $item['textanswer']);
                 $fields['rowvalue'] = array("integer", $item['rowvalue']);
                 $fields['tstamp'] = array("integer", time());
 
                 $affectedRows = $ilDB->insert("svy_answer", $fields);
             }
         }
         return null;
     }

Here is the call graph for this function:

◆ setBipolarAdjective()

SurveyMatrixQuestion::setBipolarAdjective	(	int	$a_index,
		string	$a_value
	)

Definition at line 194 of file class.SurveyMatrixQuestion.php.

Referenced by importAdjectives(), and loadFromDb().

      : void {
         if ($a_index === 1) {
             $this->bipolar_adjective2 = $a_value;
         } else {
             $this->bipolar_adjective1 = $a_value;
         }
     }

Here is the caller graph for this function:

◆ setColumnPlaceholders()

SurveyMatrixQuestion::setColumnPlaceholders ( bool $a_value = false )

Set whether placeholders should be used for the column titles or not.

Definition at line 1118 of file class.SurveyMatrixQuestion.php.

Referenced by loadFromDb().

                                                                 : void
     {
         $this->columnPlaceholders = $a_value;
     }

Here is the caller graph for this function:

◆ setColumnSeparators()

SurveyMatrixQuestion::setColumnSeparators ( bool $enable = false )

Enables/Disables separators for the matrix columns.

Definition at line 881 of file class.SurveyMatrixQuestion.php.

Referenced by importAdditionalMetadata(), and loadFromDb().

                                                              : void
     {
         $this->columnSeparators = $enable;
     }

Here is the caller graph for this function:

◆ setLayout()

SurveyMatrixQuestion::setLayout ( $layout )

Parameters

array | string $layout

Definition at line 1084 of file class.SurveyMatrixQuestion.php.

References $layout.

Referenced by importAdditionalMetadata(), and loadFromDb().

                                       : void
     {
         if (is_array($layout)) {
             $this->layout = $layout;
         } else {
             $this->layout = unserialize($layout, ['allowed_classes' => false]) ?: [];
         }
     }

Here is the caller graph for this function:

◆ setLegend()

SurveyMatrixQuestion::setLegend ( bool $a_value = false )

Set whether the legend should be shown or not.

Definition at line 1131 of file class.SurveyMatrixQuestion.php.

Referenced by loadFromDb().

                                                     : void
     {
         $this->legend = $a_value;
     }

Here is the caller graph for this function:

◆ setNeutralColumnSeparator()

SurveyMatrixQuestion::setNeutralColumnSeparator ( bool $enable = true )

Definition at line 904 of file class.SurveyMatrixQuestion.php.

Referenced by importAdditionalMetadata(), and loadFromDb().

                                                                   : void
     {
         $this->neutralColumnSeparator = $enable;
     }

Here is the caller graph for this function:

◆ setRepeatColumnHeader()

SurveyMatrixQuestion::setRepeatColumnHeader ( bool $a_value = false )

Definition at line 1151 of file class.SurveyMatrixQuestion.php.

Referenced by loadFromDb().

                                                                 : void
     {
         $this->repeatColumnHeader = $a_value;
     }

Here is the caller graph for this function:

◆ setRowSeparators()

SurveyMatrixQuestion::setRowSeparators ( bool $enable = false )

Enables/Disables separators for the matrix rows.

Definition at line 894 of file class.SurveyMatrixQuestion.php.

Referenced by importAdditionalMetadata(), and loadFromDb().

                                                           : void
     {
         $this->rowSeparators = $enable;
     }

Here is the caller graph for this function:

◆ setSingleLineRowCaption()

SurveyMatrixQuestion::setSingleLineRowCaption ( bool $a_value = false )

Definition at line 1141 of file class.SurveyMatrixQuestion.php.

Referenced by loadFromDb().

                                                                   : void
     {
         $this->singleLineRowCaption = $a_value;
     }

Here is the caller graph for this function:

◆ setSubtype()

SurveyMatrixQuestion::setSubtype ( int $a_subtype = 0 )

Sets the subtype of the matrix question.

Definition at line 860 of file class.SurveyMatrixQuestion.php.

Referenced by loadFromDb().

                                                   : void
     {
         switch ($a_subtype) {
             case 1:
             case 2:
             case 3:
             case 4:
             case 5:
             case 6:
                 $this->subtype = $a_subtype;
                 break;
             case 0:
             default:
                 $this->subtype = 0;
                 break;
         }
     }

Here is the caller graph for this function:

◆ syncWithOriginal()

SurveyMatrixQuestion::syncWithOriginal ( )

Definition at line 616 of file class.SurveyMatrixQuestion.php.

References SurveyQuestion\getOriginalId(), saveColumnsToDb(), and saveRowsToDb().

                                       : void
     {
         if ($this->getOriginalId()) {
             parent::syncWithOriginal();
             $this->saveColumnsToDb($this->getOriginalId());
             $this->saveRowsToDb($this->getOriginalId());
         }
     }

Here is the call graph for this function:

◆ toXML()

SurveyMatrixQuestion::toXML	(	bool	$a_include_header = `true`,
		bool	$obligatory_state = `false`
	)

Returns an xml representation of the question.

Returns: string The xml representation of the question public

Definition at line 478 of file class.SurveyMatrixQuestion.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()

SurveyMatrixQuestion::usableForPrecondition ( )

Returns if the question is usable for preconditions.

Definition at line 981 of file class.SurveyMatrixQuestion.php.

                                            : bool
     {
         return false;
     }

Field Documentation

◆ $bipolar_adjective1

string SurveyMatrixQuestion::$bipolar_adjective1 = ""

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

Referenced by getBipolarAdjective().

◆ $bipolar_adjective2

string SurveyMatrixQuestion::$bipolar_adjective2 = ""

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

Referenced by getBipolarAdjective().

◆ $columnPlaceholders

bool SurveyMatrixQuestion::$columnPlaceholders = false

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

Referenced by getColumnPlaceholders().

◆ $columns

SurveyCategories SurveyMatrixQuestion::$columns

Definition at line 26 of file class.SurveyMatrixQuestion.php.

Referenced by getColumns().

◆ $columnSeparators

bool SurveyMatrixQuestion::$columnSeparators = false

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

Referenced by getColumnSeparators().

◆ $layout

array SurveyMatrixQuestion::$layout

Definition at line 38 of file class.SurveyMatrixQuestion.php.

Referenced by getLayout(), and setLayout().

◆ $legend

bool SurveyMatrixQuestion::$legend = false

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

Referenced by getLegend().

◆ $neutralColumnSeparator

bool SurveyMatrixQuestion::$neutralColumnSeparator = false

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

Referenced by getNeutralColumnSeparator().

◆ $repeatColumnHeader

bool SurveyMatrixQuestion::$repeatColumnHeader = false

Definition at line 43 of file class.SurveyMatrixQuestion.php.

Referenced by getRepeatColumnHeader().

◆ $rows

SurveyCategories SurveyMatrixQuestion::$rows

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

Referenced by getRows().

◆ $rowSeparators

bool SurveyMatrixQuestion::$rowSeparators = false

Definition at line 35 of file class.SurveyMatrixQuestion.php.

Referenced by getRowSeparators().

◆ $singleLineRowCaption

bool SurveyMatrixQuestion::$singleLineRowCaption = false

Definition at line 42 of file class.SurveyMatrixQuestion.php.

Referenced by getSingleLineRowCaption().

◆ $subtype

int SurveyMatrixQuestion::$subtype

Matrix question subtype 0 = Single choice 1 = Multiple choice 2 = Text 3 = Integer 4 = Double 5 = Date 6 = Time.

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

Referenced by getSubtype().

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

Modules/SurveyQuestionPool/Questions/class.SurveyMatrixQuestion.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPhrase()

◆ addRow()

◆ addRowAtPosition()

◆ addStandardNumbers()

◆ checkUserInput()

◆ deleteAdditionalTableData()

◆ flushColumns()

◆ flushRows()

◆ getAdditionalTableName()

◆ getBipolarAdjective()

◆ getColumn()

◆ getColumnCount()

◆ getColumnForScale()

◆ getColumnIndex()

◆ getColumnPlaceholders()

◆ getColumns()

◆ getColumnSeparators()

◆ getLayout()

◆ getLegend()

◆ getMaxSumScore()

◆ getNeutralColumnSeparator()

◆ getPreconditionSelectValue()

◆ getPreconditionValueOutput()

◆ getQuestionDataArray()

◆ getQuestionType()

◆ getRepeatColumnHeader()

◆ getRow()

◆ getRowCount()

◆ getRows()

◆ getRowSeparators()

◆ getSingleLineRowCaption()

◆ getSubtype()

◆ getWorkingDataFromUserInput()

◆ hasBipolarAdjectives()

◆ hasNeutralColumn()

◆ importAdditionalMetadata()

◆ importAdjectives()

◆ importMatrix()

◆ importResponses()

◆ insertXML()

◆ isComplete()

◆ loadFromDb()

◆ moveRowDown()

◆ moveRowUp()

◆ removeColumn()

◆ removeColumns()

◆ removeColumnWithName()

◆ removeRow()

◆ removeRows()

◆ saveBipolarAdjectives()

◆ saveColumnsToDb()

◆ saveColumnToDb()

◆ saveLayout()

◆ savePhrase()

◆ saveRowsToDb()

◆ saveToDb()

◆ saveUserInput()

◆ setBipolarAdjective()

◆ setColumnPlaceholders()

◆ setColumnSeparators()

◆ setLayout()

◆ setLegend()

◆ setNeutralColumnSeparator()

◆ setRepeatColumnHeader()

◆ setRowSeparators()

◆ setSingleLineRowCaption()

◆ setSubtype()

◆ syncWithOriginal()

◆ toXML()

◆ usableForPrecondition()

Field Documentation

◆ $bipolar_adjective1