The SurveyMatrixQuestion class defines and encapsulates basic methods and attributes for matrix question types. More...

Inheritance diagram for SurveyMatrixQuestion:

Collaboration diagram for SurveyMatrixQuestion:

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

	getColumnCount ()
	Returns the number of columns. More...

	removeColumn ($index)
	Removes a column from the list of columns. More...

	removeColumns ($array)
	Removes many columns from the list of columns. More...

	removeColumnWithName ($name)
	Removes a column from the list of columns. More...

	getColumns ()
	Return the columns. More...

	getColumn ($index)
	Returns the name of a column for a given index. More...

	getColumnForScale ($scale)

	getColumnIndex ($name)
	Returns the index of a column with a given name. More...

	flushColumns ()
	Empties the columns list. More...

	getRowCount ()
	Returns the number of rows in the question. More...

	addRow ($a_text, $a_other, $a_label)
	Adds a row to the question. More...

	addRowAtPosition ($a_text, $a_other, $a_position)
	Adds a row at a given position. More...

	flushRows ()
	Empties the row list. More...

	getRow ($a_index)
	Returns a specific row. More...

	moveRowUp ($index)

	moveRowDown ($index)

	removeRows ($array)
	Removes rows from the question. More...

	removeRow ($index)
	Removes a row. More...

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

	setBipolarAdjective ($a_index, $a_value)
	Sets one of the bipolar adjectives. More...

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

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

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

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

	saveToDb ($original_id=null, $withanswers=true)
	Saves a SurveyMatrixQuestion object to a database. More...

	saveBipolarAdjectives ($adjective1, $adjective2)

	saveColumnToDb ($columntext, $neutral=0)
	Saves a column to the database. More...

	saveColumnsToDb ($original_id="")

	saveRowsToDb ($original_id="")

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

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

	syncWithOriginal ()

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

	savePhrase ($title)
	Saves a set of columns to a default phrase. More...

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

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

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

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

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

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

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

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

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

	getColumnSeparators ()
	Gets the separators enable state for the matrix columns. More...

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

	getRowSeparators ()
	Gets the separators enable state for the matrix rows. More...

	setNeutralColumnSeparator ($enable=0)
	Enables/Disables a separator for the neutral column. More...

	getNeutralColumnSeparator ()
	Gets the separator enable state for the neutral column. More...

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

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

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

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

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

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

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

	saveLayout ($percent_row, $percent_columns, $percent_bipolar_adjective1="", $percent_bipolar_adjective2="", $percent_neutral)
	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 ($a_value=0)
	Set whether placeholders should be used for the column titles or not. More...

	getColumnPlaceholders ()
	Get whether placeholders should be used for the column titles or not. More...

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

	getLegend ()
	Get whether the legend should be shown or not. More...

	setSingleLineRowCaption ($a_value=0)

	getSingleLineRowCaption ()

	setRepeatColumnHeader ($a_value=0)

	getRepeatColumnHeader ()

	setColumnHeaderPosition ($a_value)

	getColumnHeaderPosition ()

	setRandomRows ($a_value=0)

	getRandomRows ()

	setColumnOrder ($a_value)

	getColumnOrder ()

	setColumnImages ($a_value=0)

	getColumnImages ()

	setRowImages ($a_value=0)

	getRowImages ()

	getRows ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	getLabel ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	saveMaterial ()
	save material to db More...

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

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

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

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

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

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

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

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

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

	syncWithOriginal ()

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

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

	addInternalLink ($material_id, $title="")

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

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

	addMaterial ($obj_material)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	setOriginalId ($original_id)

	getOriginalId ()

	getMaterial ()

	setSubtype ($a_subtype)

	getSubtype ()

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

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

	getCopyIds ($a_group_by_survey=false)

	hasCopies ()

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

Data Fields
	$columns

	$rows

	$bipolar_adjective1

	$bipolar_adjective2

	$columnSeparators

	$rowSeparators

	$neutralColumnSeparator

	$layout

	$columnPlaceholders

	$legend

	$singleLineRowCaption

	$repeatColumnHeader

	$columnHeaderPosition

	$randomRows

	$columnOrder

	$columnImages

	$rowImages

	$openRows

	$subtype

Data Fields inherited from SurveyQuestion
	$id

	$title

	$description

	$owner

	$author

	$materials

	$survey_id

	$obj_id

	$questiontext

	$obligatory

	$lng

	$orientation

	$material

	$complete

Protected Attributes
	$user

	$db

Protected Attributes inherited from SurveyQuestion
	$user

	$db

	$cumulated
	An array containing the cumulated results of the question for a given survey. More...

	$log

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

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

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

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

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

static	_resolveInternalLink ($internal_link)

static	_resolveIntLinks ($question_id)

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

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

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

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

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

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

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

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

static	_lookupSurveyObjId ($a_question_id)

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

Detailed Description

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 11 of file class.SurveyMatrixQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

Parameters

string	$title	A title string to describe the question
string	$description	A description string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator public

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

References SurveyQuestion\$author, SurveyQuestion\$description, $DIC, SurveyQuestion\$owner, SurveyQuestion\$questiontext, SurveyQuestion\$title, ILIAS\GlobalScreen\Provider\__construct(), and 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 ( $phrase_id )

Adds a phrase to the question.

Parameters

integer $phrase_id The database id of the given phrase public

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

References $db, $ilDB, $ilUser, $result, and $user.

     {
         $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 (($row["defaultvalue"] == 1) && ($row["owner_fi"] == 0)) {
                 $this->columns->addCategory($this->lng->txt($row["title"]), 0, $neutral);
             } else {
                 $this->columns->addCategory($row["title"], 0, $neutral);
             }
         }
     }

◆ addRow()

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

Adds a row to the question.

Parameters

string $a_text The text of the row

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

Referenced by importMatrix(), and loadFromDb().

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

Here is the caller graph for this function:

◆ addRowAtPosition()

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

Adds a row at a given position.

Parameters

string	$a_text	The text of the row
integer	$a_position	The row position

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

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

◆ addStandardNumbers()

SurveyMatrixQuestion::addStandardNumbers	(	$lower_limit,
		$upper_limit
	)

Adds standard numbers as columns.

Parameters

integer	$lower_limit	The lower limit
integer	$upper_limit	The upper limit public

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

References $i.

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

◆ checkUserInput()

SurveyMatrixQuestion::checkUserInput	(	$post_data,
		$survey_id
	)

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

Parameters

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

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

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

References SurveyQuestion\$survey_id, SurveyQuestion\getId(), SurveyQuestion\getObligatory(), getRowCount(), and getSubtype().

     {
         if (!$this->getObligatory($survey_id)) {
             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 ( $question_id )

Deletes datasets from the additional question table in the database.

Parameters

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

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

References $db, and $ilDB.

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

◆ flushColumns()

SurveyMatrixQuestion::flushColumns ( )

Empties the columns list.

public

See also: $columns

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

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ flushRows()

SurveyMatrixQuestion::flushRows ( )

Empties the row list.

public

See also: $rows

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

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

◆ getAdditionalTableName()

SurveyMatrixQuestion::getAdditionalTableName ( )

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

Returns: string The additional table name public

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

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

     {
         return "svy_qst_matrix";
     }

Here is the caller graph for this function:

◆ getBipolarAdjective()

SurveyMatrixQuestion::getBipolarAdjective ( $a_index )

Returns one of the bipolar adjectives.

Parameters

integer $a_index The number of the bipolar adjective (0 for the first and 1 for the second adjective)

Returns: string The text of the bipolar adjective public

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

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

     {
         switch ($a_index) {
             case 1:
                 return (strlen($this->bipolar_adjective2)) ? $this->bipolar_adjective2 : null;
                 break;
             case 0:
             default:
                 return (strlen($this->bipolar_adjective1)) ? $this->bipolar_adjective1 : null;
                 break;
         }
         return null;
     }

Here is the caller graph for this function:

◆ getColumn()

SurveyMatrixQuestion::getColumn ( $index )

Returns the name of a column for a given index.

Parameters

integer $index The index of the column

Returns: array column public

See also: $columns

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

References $index.

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

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

Here is the caller graph for this function:

◆ getColumnCount()

SurveyMatrixQuestion::getColumnCount ( )

Returns the number of columns.

Returns: integer The number of contained columns public

See also: $columns

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

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

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

Here is the caller graph for this function:

◆ getColumnForScale()

SurveyMatrixQuestion::getColumnForScale ( $scale )

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

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

◆ getColumnHeaderPosition()

SurveyMatrixQuestion::getColumnHeaderPosition ( )

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

Referenced by saveToDb().

     {
         return ($this->columnHeaderPosition) ? $this->columnHeaderPosition : 0;
     }

Here is the caller graph for this function:

◆ getColumnImages()

SurveyMatrixQuestion::getColumnImages ( )

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

Referenced by saveToDb().

     {
         return ($this->columnImages) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getColumnIndex()

SurveyMatrixQuestion::getColumnIndex ( $name )

Returns the index of a column with a given name.

Parameters

string $name The name of the column public

See also: $columns

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

References $name.

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

◆ getColumnOrder()

SurveyMatrixQuestion::getColumnOrder ( )

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

Referenced by saveToDb().

     {
         return ($this->columnOrder) ? $this->columnOrder : 0;
     }

Here is the caller graph for this function:

◆ getColumnPlaceholders()

SurveyMatrixQuestion::getColumnPlaceholders ( )

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

Returns: integer 1 for placeholders, 0 otherwise

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

Referenced by saveToDb().

     {
         return ($this->columnPlaceholders) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getColumns()

SurveyMatrixQuestion::getColumns ( )

Return the columns.

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

References $columns.

     {
         return $this->columns;
     }

◆ getColumnSeparators()

SurveyMatrixQuestion::getColumnSeparators ( )

Gets the separators enable state for the matrix columns.

Returns: integer 1 if the separators are enabled, 0 otherwise public

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

Referenced by insertXML(), and saveToDb().

     {
         return ($this->columnSeparators) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getLayout()

SurveyMatrixQuestion::getLayout ( )

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

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

Referenced by insertXML(), and saveToDb().

     {
         if (!is_array($this->layout) || 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 ( )

Get whether the legend should be shown or not.

Returns: integer Show legend

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

Referenced by saveToDb().

     {
         return ($this->legend) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getNeutralColumnSeparator()

SurveyMatrixQuestion::getNeutralColumnSeparator ( )

Gets the separator enable state for the neutral column.

Returns: integer 1 if the separator is enabled, 0 otherwise public

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

Referenced by insertXML(), and saveToDb().

     {
         return ($this->neutralColumnSeparator) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getPreconditionSelectValue()

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

Creates a form property for the precondition value.

Returns: The ILIAS form element public

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

References SurveyQuestion\$title, and SurveyQuestion\getPreconditionOptions().

     {
         $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 ( $value )

Returns the output for a precondition value.

Parameters

string $value The precondition value

Returns: string The output of the precondition value public

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

     {
         return $value;
     }

◆ getQuestionDataArray()

SurveyMatrixQuestion::getQuestionDataArray ( $id )

Returns the question data fields from the database.

Parameters

integer $id The question ID from the database

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

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

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

     {
         $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()

SurveyMatrixQuestion::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question public

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

     {
         return "SurveyMatrixQuestion";
     }

◆ getRandomRows()

SurveyMatrixQuestion::getRandomRows ( )

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

Referenced by saveToDb().

     {
         return ($this->randomRows) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getRepeatColumnHeader()

SurveyMatrixQuestion::getRepeatColumnHeader ( )

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

Referenced by saveToDb().

     {
         return ($this->repeatColumnHeader) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getRow()

SurveyMatrixQuestion::getRow ( $a_index )

Returns a specific row.

Parameters

integer $a_index The index position of the row public

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

Referenced by insertXML(), and saveRowsToDb().

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

Here is the caller graph for this function:

◆ getRowCount()

SurveyMatrixQuestion::getRowCount ( )

Returns the number of rows in the question.

Returns: integer The number of rows public

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

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

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

Here is the caller graph for this function:

◆ getRowImages()

SurveyMatrixQuestion::getRowImages ( )

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

Referenced by saveToDb().

     {
         return ($this->rowImages) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getRows()

SurveyMatrixQuestion::getRows ( )

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

References $rows.

     {
         return $this->rows;
     }

◆ getRowSeparators()

SurveyMatrixQuestion::getRowSeparators ( )

Gets the separators enable state for the matrix rows.

Returns: integer 1 if the separators are enabled, 0 otherwise public

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

Referenced by insertXML(), and saveToDb().

     {
         return ($this->rowSeparators) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getSingleLineRowCaption()

SurveyMatrixQuestion::getSingleLineRowCaption ( )

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

Referenced by saveToDb().

     {
         return ($this->singleLineRowCaption) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getSubtype()

SurveyMatrixQuestion::getSubtype ( )

Returns the subtype of the matrix question.

Returns: integer The subtype of the matrix question public

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

References $subtype.

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

     {
         return $this->subtype;
     }

Here is the caller graph for this function:

◆ getWorkingDataFromUserInput()

& SurveyMatrixQuestion::getWorkingDataFromUserInput ( $post_data )

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

Returns: array User data according to the svy_answer table public

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

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

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

Returns: boolean TRUE if bipolar adjectives exist, FALSE otherwise

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

References getBipolarAdjective().

Referenced by getLayout().

     {
         if ((strlen($this->getBipolarAdjective(0))) && (strlen($this->getBipolarAdjective(1)))) {
             return true;
         } else {
             return false;
         }
     }

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.

Returns: boolean TRUE if a neutral column exists, FALSE otherwise

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

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

Referenced by getLayout().

     {
         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 ( $a_meta )

Import additional meta data from the question import file.

Usually the meta data section is used to store question elements which are not part of the standard XML schema.

Returns: array $a_meta Array containing the additional meta data public

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

References setColumnSeparators(), setLayout(), setNeutralColumnSeparator(), and setRowSeparators().

     {
         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 ( $a_data )

Import bipolar adjectives from the question import file.

Returns: array $a_data Array containing the adjectives public

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

References $i, and setBipolarAdjective().

     {
         $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 ( $a_data )

Import matrix rows from the question import file.

Returns: array $a_data Array containing the matrix rows public

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

References addRow().

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

Here is the call graph for this function:

◆ importResponses()

SurveyMatrixQuestion::importResponses ( $a_data )

Import response data from the question import file.

Returns: array $a_data Array containing the response data public

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

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

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

◆ insertXML()

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

Adds the question XML to a given XMLWriter object.

Parameters

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

Definition at line 721 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(), getRow(), getRowCount(), getRowSeparators(), getSubtype(), and SurveyQuestion\getTitle().

Referenced by toXML().

     {
         $attrs = array(
             "id" => $this->getId(),
             "title" => $this->getTitle(),
             "type" => $this->getQuestiontype(),
             "subtype" => $this->getSubtype(),
             "obligatory" => $this->getObligatory()
         );
         $a_xml_writer->xmlStartTag("question", $attrs);
         
         $a_xml_writer->xmlElement("description", null, $this->getDescription());
         $a_xml_writer->xmlElement("author", null, $this->getAuthor());
         $a_xml_writer->xmlStartTag("questiontext");
         $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
         $a_xml_writer->xmlEndTag("questiontext");
 
         $a_xml_writer->xmlStartTag("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 (strlen($this->getBipolarAdjective(0)) && (strlen($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 ( )

Returns 1 if the question is complete for use.

Returns: integer 1 if the question is complete for use, otherwise 0 public

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

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

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

Here is the call graph for this function:

◆ loadFromDb()

SurveyMatrixQuestion::loadFromDb ( $id )

Loads a SurveyMatrixQuestion object from the database.

Parameters

integer $id The database id of the matrix question public

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

     {
         $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($id)
         );
         if ($result->numRows() == 1) {
             $data = $ilDB->fetchAssoc($result);
             $this->setId($data["question_id"]);
             $this->setTitle($data["title"]);
             $this->label = $data['label'];
             $this->setDescription($data["description"]);
             $this->setObjId($data["obj_fi"]);
             $this->setAuthor($data["author"]);
             $this->setOwner($data["owner_fi"]);
             $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc($data["questiontext"], 1));
             $this->setObligatory($data["obligatory"]);
             $this->setComplete($data["complete"]);
             $this->setOriginalId($data["original_id"]);
             $this->setSubtype($data["subtype"]);
             $this->setRowSeparators($data["row_separators"]);
             $this->setNeutralColumnSeparator($data["neutral_column_separator"]);
             $this->setColumnSeparators($data["column_separators"]);
             $this->setColumnPlaceholders($data["column_placeholders"]);
             $this->setLegend($data["legend"]);
             $this->setSingleLineRowCaption($data["singleline_row_caption"]);
             $this->setRepeatColumnHeader($data["repeat_column_header"]);
             $this->setColumnHeaderPosition($data["column_header_position"]);
             $this->setRandomRows($data["random_rows"]);
             $this->setColumnOrder($data["column_order"]);
             $this->setColumnImages($data["column_images"]);
             $this->setRowImages($data["row_images"]);
             $this->setBipolarAdjective(0, $data["bipolar_adjective1"]);
             $this->setBipolarAdjective(1, $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($id)
             );
             if ($result->numRows() > 0) {
                 while ($data = $ilDB->fetchAssoc($result)) {
                     $this->columns->addCategory($data["title"], $data["other"], $data["neutral"], null, ($data['scale']) ? $data['scale'] : ($data['sequence'] + 1));
                 }
             }
             
             $result = $ilDB->queryF(
                 "SELECT * FROM svy_qst_matrixrows WHERE question_fi = %s ORDER BY sequence",
                 array('integer'),
                 array($id)
             );
             while ($row = $ilDB->fetchAssoc($result)) {
                 $this->addRow($row["title"], $row['other'], $row['label']);
             }
         }
         parent::loadFromDb($id);
     }

Here is the call graph for this function:

◆ moveRowDown()

SurveyMatrixQuestion::moveRowDown ( $index )

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

References $index.

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

◆ moveRowUp()

SurveyMatrixQuestion::moveRowUp ( $index )

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

References $index.

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

◆ removeColumn()

SurveyMatrixQuestion::removeColumn ( $index )

Removes a column from the list of columns.

Parameters

integer $index The index of the column to be removed public

See also: $columns

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

References $index.

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

◆ removeColumns()

SurveyMatrixQuestion::removeColumns ( $array )

Removes many columns from the list of columns.

Parameters

array $array An array containing the index positions of the columns to be removed public

See also: $columns

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

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

◆ removeColumnWithName()

SurveyMatrixQuestion::removeColumnWithName ( $name )

Removes a column from the list of columns.

Parameters

string $name The name of the column to be removed public

See also: $columns

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

References $name.

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

◆ removeRow()

SurveyMatrixQuestion::removeRow ( $index )

Removes a row.

Parameters

integer $index The index of the row to be removed

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

References $index.

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

◆ removeRows()

SurveyMatrixQuestion::removeRows ( $array )

Removes rows from the question.

Parameters

array $array An array containing the index positions of the rows to be removed public

See also: $rows

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

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

◆ saveBipolarAdjectives()

SurveyMatrixQuestion::saveBipolarAdjectives	(	$adjective1,
		$adjective2
	)

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

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

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

Here is the call graph for this function:

◆ saveColumnsToDb()

SurveyMatrixQuestion::saveColumnsToDb ( $original_id = "" )

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

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

Referenced by saveToDb(), and syncWithOriginal().

     {
         $ilDB = $this->db;
         
         // save columns
         $question_id = $this->getId();
         if (strlen($original_id)) {
             $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	(	$columntext,
		$neutral = `0`
	)

Saves a column to the database.

Parameters

string $columntext The text of the column

Returns: integer The database ID of the column public

See also: $columns

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

References $db, $ilDB, $ilUser, $result, and $user.

Referenced by saveColumnsToDb().

     {
         $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 = "";
         if ($result->numRows()) {
             $insert = true;
             while ($row = $ilDB->fetchAssoc($result)) {
                 if (strcmp($row["title"], $columntext) == 0) {
                     $returnvalue = $row["category_id"];
                     $insert = false;
                 }
             }
         } else {
             $insert = true;
         }
         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	(	$percent_row,
		$percent_columns,
		$percent_bipolar_adjective1 = `""`,
		$percent_bipolar_adjective2 = `""`,
		$percent_neutral
	)

Saves the layout of a matrix question.

Parameters

double	$percent_row	The width in percent for the matrix rows
double	$percent_columns	The width in percent for the matrix columns
double	$percent_bipolar_adjective1	The width in percent for the first bipolar adjective
double	$percent_bipolar_adjective2	The width in percent for the second bipolar adjective

Returns: void

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

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

     {
         $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 ( $title )

Saves a set of columns to a default phrase.

Parameters

array	$phrases	The database ids of the seleted phrases
string	$title	The title of the default phrase public

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

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

     {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         $next_id = $ilDB->nextId('svy_phrase');
         $affectedRows = $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;
         foreach ($_SESSION['save_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 ( $original_id = "" )

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

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

Referenced by saveToDb(), and syncWithOriginal().

     {
         $ilDB = $this->db;
         
         // save rows
         $question_id = $this->getId();
         if (strlen($original_id)) {
             $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	(	$original_id = `null`,
		$withanswers = `true`
	)

Saves a SurveyMatrixQuestion object to a database.

public

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

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

     {
         $ilDB = $this->db;
 
         $affectedRows = parent::saveToDb($original_id);
 
         if ($affectedRows == 1) {
             $affectedRows = $ilDB->manipulateF(
                 "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                 array('integer'),
                 array($this->getId())
             );
             $affectedRows = $ilDB->manipulateF(
                 "INSERT INTO " . $this->getAdditionalTableName() . " (
                                 question_fi, subtype, column_separators, row_separators, neutral_column_separator,column_placeholders,
                                 legend, singleline_row_caption, repeat_column_header, column_header_position, random_rows,
                                 column_order, column_images, row_images, bipolar_adjective1, bipolar_adjective2, layout, tstamp)
                                 VALUES (%s, %s, %s, %s, %s, %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', '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->getColumnHeaderPosition(),
                     $this->getRandomRows(),
                     $this->getColumnOrder(),
                     $this->getColumnImages(),
                     $this->getRowImages(),
                     $this->getBipolarAdjective(0),
                     $this->getBipolarAdjective(1),
                     serialize($this->getLayout()),
                     time()
                 )
             );
 
             // saving material uris in the database
             $this->saveMaterial();
 
             $this->saveColumnsToDb();
             $this->saveRowsToDb();
         }
     }

Here is the call graph for this function:

◆ saveUserInput()

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

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

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

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

Here is the call graph for this function:

◆ setBipolarAdjective()

SurveyMatrixQuestion::setBipolarAdjective	(	$a_index,
		$a_value
	)

Sets one of the bipolar adjectives.

Parameters

integer	$a_index	The number of the bipolar adjective (0 for the first and 1 for the second adjective)
string	$a_value	The text of the bipolar adjective public

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

Referenced by importAdjectives(), and loadFromDb().

     {
         switch ($a_index) {
             case 1:
                 $this->bipolar_adjective2 = $a_value;
                 break;
             case 0:
             default:
                 $this->bipolar_adjective1 = $a_value;
                 break;
         }
     }

Here is the caller graph for this function:

◆ setColumnHeaderPosition()

SurveyMatrixQuestion::setColumnHeaderPosition ( $a_value )

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

Referenced by loadFromDb().

     {
         $this->columnHeaderPosition = $a_value;
     }

Here is the caller graph for this function:

◆ setColumnImages()

SurveyMatrixQuestion::setColumnImages ( $a_value = 0 )

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

Referenced by loadFromDb().

     {
         $this->columnImages = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setColumnOrder()

SurveyMatrixQuestion::setColumnOrder ( $a_value )

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

Referenced by loadFromDb().

     {
         $this->columnOrder = $a_value;
     }

Here is the caller graph for this function:

◆ setColumnPlaceholders()

SurveyMatrixQuestion::setColumnPlaceholders ( $a_value = 0 )

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

Parameters

integer $a_value 1 for placeholders, 0 otherwise

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

Referenced by loadFromDb().

     {
         $this->columnPlaceholders = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setColumnSeparators()

SurveyMatrixQuestion::setColumnSeparators ( $enable = 0 )

Enables/Disables separators for the matrix columns.

Parameters

integer $enable 1 if the separators should be enabled, 0 otherwise public

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

Referenced by importAdditionalMetadata(), and loadFromDb().

     {
         switch ($enable) {
             case 1:
                 $this->columnSeparators = 1;
                 break;
             case 0:
             default:
                 $this->columnSeparators = 0;
                 break;
         }
     }

Here is the caller graph for this function:

◆ setLayout()

SurveyMatrixQuestion::setLayout ( $layout )

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

References $layout.

Referenced by importAdditionalMetadata(), and loadFromDb().

     {
         if (is_array($layout)) {
             $this->layout = $layout;
         } else {
             $this->layout = unserialize($layout);
         }
     }

Here is the caller graph for this function:

◆ setLegend()

SurveyMatrixQuestion::setLegend ( $a_value = 0 )

Set whether the legend should be shown or not.

Parameters

integer $a_value Show legend

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

Referenced by loadFromDb().

     {
         $this->legend = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setNeutralColumnSeparator()

SurveyMatrixQuestion::setNeutralColumnSeparator ( $enable = 0 )

Enables/Disables a separator for the neutral column.

Parameters

integer $enable 1 if the separator should be enabled, 0 otherwise public

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

Referenced by importAdditionalMetadata(), and loadFromDb().

     {
         switch ($enable) {
             case 1:
                 $this->neutralColumnSeparator = 1;
                 break;
             case 0:
             default:
                 $this->neutralColumnSeparator = 0;
                 break;
         }
     }

Here is the caller graph for this function:

◆ setRandomRows()

SurveyMatrixQuestion::setRandomRows ( $a_value = 0 )

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

Referenced by loadFromDb().

     {
         $this->randomRows = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setRepeatColumnHeader()

SurveyMatrixQuestion::setRepeatColumnHeader ( $a_value = 0 )

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

Referenced by loadFromDb().

     {
         $this->repeatColumnHeader = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setRowImages()

SurveyMatrixQuestion::setRowImages ( $a_value = 0 )

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

Referenced by loadFromDb().

     {
         $this->rowImages = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setRowSeparators()

SurveyMatrixQuestion::setRowSeparators ( $enable = 0 )

Enables/Disables separators for the matrix rows.

Parameters

integer $enable 1 if the separators should be enabled, 0 otherwise public

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

Referenced by importAdditionalMetadata(), and loadFromDb().

     {
         switch ($enable) {
             case 1:
                 $this->rowSeparators = 1;
                 break;
             case 0:
             default:
                 $this->rowSeparators = 0;
                 break;
         }
     }

Here is the caller graph for this function:

◆ setSingleLineRowCaption()

SurveyMatrixQuestion::setSingleLineRowCaption ( $a_value = 0 )

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

Referenced by loadFromDb().

     {
         $this->singleLineRowCaption = ($a_value) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setSubtype()

SurveyMatrixQuestion::setSubtype ( $a_subtype = 0 )

Sets the subtype of the matrix question.

Returns: integer $a_subtype The subtype of the matrix question public

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

Referenced by loadFromDb().

     {
         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 839 of file class.SurveyMatrixQuestion.php.

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

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

Here is the call graph for this function:

◆ toXML()

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

Returns an xml representation of the question.

Returns: string The xml representation of the question public

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

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

     {
         $a_xml_writer = new ilXmlWriter;
         $a_xml_writer->xmlHeader();
         $this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
         $xml = $a_xml_writer->xmlDumpMem(false);
         if (!$a_include_header) {
             $pos = strpos($xml, "?>");
             $xml = substr($xml, $pos + 2);
         }
         return $xml;
     }