SurveyMatrixQuestion Class Reference

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)
	getQuestionDataArray (int $id)
	Returns the question data fields from the database. More...
	loadFromDb (int $question_id)
	load question data into object note: this base implementation only loads the material data More...
	isComplete ()
	saveToDb (int $original_id=0)
	Saves a SurveyQuestion object to a database. More...
	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...
	getQuestionType ()
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getWorkingDataFromUserInput (array $post_data)
	Creates the user data of the svy_answer table from the POST data. More...
	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...
	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 ()
	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, mixed $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)
	Get max sum score for specific survey (and this question type) More...
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 26 of file class.SurveyMatrixQuestion.php.

Constructor & Destructor Documentation

__construct()

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

Reimplemented from SurveyQuestion.

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

      {
        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 = false;
        $this->columnSeparators = false;
        $this->neutralColumnSeparator = true;
    }

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

Here is the call graph for this function:

Member Function Documentation

addRow()

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

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

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

addRowAtPosition()

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

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

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

addStandardNumbers()

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

Adds standard numbers as columns.

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

     : void {
        for ($i = $lower_limit; $i <= $upper_limit; $i++) {
            $this->columns->addCategory((string) $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 669 of file class.SurveyMatrixQuestion.php.

     : string {
        if (!$this->getObligatory()) {
            return "";
        }
        switch ($this->getSubtype()) {
            case 0:
                $counter = 0;
                foreach ($post_data as $key => $value) {
                    $key = (string) $key;
                    if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                        if (array_key_exists('matrix_other_' . $this->getId() . "_" . $matches[1], $post_data) && strlen((string) ($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) {
                    $key = (string) $key;
                    if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                        if (array_key_exists('matrix_other_' . $this->getId() . "_" . $matches[1], $post_data) && strlen((string) ($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 "";
    }

deleteAdditionalTableData()

SurveyMatrixQuestion::deleteAdditionalTableData

(

int

$question_id

)

Delete question data from additional table.

Reimplemented from SurveyQuestion.

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

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

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

flushRows()

SurveyMatrixQuestion::flushRows

(

)

Definition at line 151 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 628 of file class.SurveyMatrixQuestion.php.

                                            : string
    {
        return "svy_qst_matrix";
    }

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

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

getColumn()

SurveyMatrixQuestion::getColumn

(

int

$index

)

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

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

getColumnCount()

SurveyMatrixQuestion::getColumnCount

(

)

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

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

getColumnForScale()

SurveyMatrixQuestion::getColumnForScale

(

int

$scale

)

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

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

getColumnIndex()

SurveyMatrixQuestion::getColumnIndex

(

string

$name

)

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

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

getColumnPlaceholders()

SurveyMatrixQuestion::getColumnPlaceholders

(

)

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

                                           : bool
    {
        return $this->columnPlaceholders;
    }

getColumns()

SurveyMatrixQuestion::getColumns

(

)

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

                                : SurveyCategories
    {
        return $this->columns;
    }

References $columns.

getColumnSeparators()

SurveyMatrixQuestion::getColumnSeparators

(

)

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

                                         : bool
    {
        return $this->columnSeparators;
    }

getLayout()

SurveyMatrixQuestion::getLayout

(

)

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

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

getLegend()

SurveyMatrixQuestion::getLegend

(

)

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

                               : bool
    {
        return $this->legend;
    }

getMaxSumScore()

static SurveyMatrixQuestion::getMaxSumScore ( int  $survey_id )

static

Get max sum score for specific survey (and this question type)

Reimplemented from SurveyQuestion.

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

                                                         : 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[(int) $rec["question_id"]] = (int) $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[(int) $rec["question_id"]] = (int) $rec["cnt_rows"];
        }
 
        $sum_sum_score = 0;
        foreach ($max_score as $qid => $s) {
            $sum_sum_score += $s * $cnt_rows[$qid];
        }
 
        return $sum_sum_score;
    }

References $DIC, and ILIAS\Repository\int().

Here is the call graph for this function:

getNeutralColumnSeparator()

SurveyMatrixQuestion::getNeutralColumnSeparator

(

)

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

                                               : bool
    {
        return $this->neutralColumnSeparator;
    }

getPreconditionSelectValue()

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

Creates a form property for the precondition value.

Reimplemented from SurveyQuestion.

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

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

getPreconditionValueOutput()

SurveyMatrixQuestion::getPreconditionValueOutput

(

string

$value

)

Returns the output for a precondition value.

Reimplemented from SurveyQuestion.

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

                                                             : string
    {
        return $value;
    }

getQuestionDataArray()

SurveyMatrixQuestion::getQuestionDataArray

(

int

$id

)

Returns the question data fields from the database.

Reimplemented from SurveyQuestion.

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

                                                 : 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();
    }

References $id, and $ilDB.

getQuestionType()

SurveyMatrixQuestion::getQuestionType

(

)

Reimplemented from SurveyQuestion.

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

                                     : string
    {
        return "SurveyMatrixQuestion";
    }

getRepeatColumnHeader()

SurveyMatrixQuestion::getRepeatColumnHeader

(

)

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

                                           : bool
    {
        return $this->repeatColumnHeader;
    }

getRow()

SurveyMatrixQuestion::getRow

(

int

$a_index

)

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

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

getRowCount()

SurveyMatrixQuestion::getRowCount

(

)

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

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

getRows()

SurveyMatrixQuestion::getRows

(

)

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

                             : SurveyCategories
    {
        return $this->rows;
    }

References ILIAS\Scripts\PHPStan\$rows.

getRowSeparators()

SurveyMatrixQuestion::getRowSeparators

(

)

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

                                      : bool
    {
        return $this->rowSeparators;
    }

getSingleLineRowCaption()

SurveyMatrixQuestion::getSingleLineRowCaption

(

)

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

                                             : bool
    {
        return $this->singleLineRowCaption;
    }

getSubtype()

SurveyMatrixQuestion::getSubtype

(

)

Returns the subtype of the matrix question.

Reimplemented from SurveyQuestion.

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

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

getWorkingDataFromUserInput()

SurveyMatrixQuestion::getWorkingDataFromUserInput

(

array

$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

Reimplemented from SurveyQuestion.

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

                                                                 : array
    {
        $data = array();
        foreach ($post_data as $key => $value) {
            $key = (string) $key;
            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" => (string) $val,
                                                "rowvalue" => (int) $matches[1],
                                                "textanswer" => (string) ($post_data['matrix_other_' . $this->getId(
                                                ) . '_' . $matches[1]] ?? "")
                                );
                            }
                        } else {
                            $data[] = array("value" => (string) $value,
                                            "rowvalue" => (int) $matches[1],
                                            "textanswer" => (string) ($post_data['matrix_other_' . $this->getId(
                                            ) . '_' . $matches[1]] ?? "")
                            );
                        }
                    }
                    break;
            }
        }
        return $data;
    }

References $data, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

hasBipolarAdjectives()

SurveyMatrixQuestion::hasBipolarAdjectives

(

)

Returns TRUE if bipolar adjectives exist.

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

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

hasNeutralColumn()

SurveyMatrixQuestion::hasNeutralColumn

(

)

Returns TRUE if a neutral column exists.

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

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

importAdditionalMetadata()

SurveyMatrixQuestion::importAdditionalMetadata

(

array

$a_meta

)

Import additional meta data from the question import file.

Reimplemented from SurveyQuestion.

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

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

importAdjectives()

SurveyMatrixQuestion::importAdjectives

(

array

$a_data

)

Import bipolar adjectives from the question import file.

Reimplemented from SurveyQuestion.

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

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

importMatrix()

SurveyMatrixQuestion::importMatrix

(

array

$a_data

)

Import matrix rows from the question import file.

Reimplemented from SurveyQuestion.

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

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

importResponses()

SurveyMatrixQuestion::importResponses

(

array

$a_data

)

Import response data from the question import file.

Reimplemented from SurveyQuestion.

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

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

References $data, and $id.

insertXML()

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

Adds the question XML to a given XMLWriter object.

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

     : 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, (string) $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, (string) $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+)/", (string) $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, (int) $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, (int) $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, (int) $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");
    }

isComplete()

SurveyMatrixQuestion::isComplete

(

)

Reimplemented from SurveyQuestion.

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

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

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

loadFromDb()

SurveyMatrixQuestion::loadFromDb

(

int

$question_id

)

load question data into object note: this base implementation only loads the material data

Reimplemented from SurveyQuestion.

Definition at line 226 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((bool) $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,
                        (int) (($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);
    }

References $data, $ilDB, and ilRTE\_replaceMediaObjectImageSrc().

Here is the call graph for this function:

moveRowDown()

SurveyMatrixQuestion::moveRowDown

(

int

$index

)

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

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

moveRowUp()

SurveyMatrixQuestion::moveRowUp

(

int

$index

)

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

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

removeColumn()

SurveyMatrixQuestion::removeColumn

(

int

$index

)

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

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

removeColumns()

SurveyMatrixQuestion::removeColumns

(

array

$array

)

Parameters

int[]

$array

index positions

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

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

removeColumnWithName()

SurveyMatrixQuestion::removeColumnWithName

(

string

$name

)

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

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

removeRow()

SurveyMatrixQuestion::removeRow

(

int

$index

)

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

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

removeRows()

SurveyMatrixQuestion::removeRows

(

array

$array

)

Parameters

int[]

$array

index positions

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

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

saveBipolarAdjectives()

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

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

     : 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())
        );
    }

saveColumnsToDb()

SurveyMatrixQuestion::saveColumnsToDb

(

int

$original_id = 0

)

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

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

saveColumnToDb()

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

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

     : 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 = 0;
        $insert = true;
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                if (strcmp((string) ($row["title"] ?? ''), $columntext) === 0) {
                    $returnvalue = (int) $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;
    }

References $ilDB, and ILIAS\Repository\int().

Here is the call 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 977 of file class.SurveyMatrixQuestion.php.

     : 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())
        );
    }

saveRowsToDb()

SurveyMatrixQuestion::saveRowsToDb

(

int

$original_id = 0

)

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

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

saveToDb()

SurveyMatrixQuestion::saveToDb

(

int

$original_id = 0

)

Saves a SurveyQuestion object to a database.

Reimplemented from SurveyQuestion.

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

                                                  : 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()
                )
            );
 
            $this->saveColumnsToDb();
            $this->saveRowsToDb();
        }
        return $affectedRows;
    }

References $ilDB, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

saveUserInput()

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

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

     : ?array {
        $ilDB = $this->db;
 
        $answer_data = array();
 
        // gather data
        switch ($this->getSubtype()) {
            case 0:
                foreach ($post_data as $key => $value) {
                    $key = (string) $key;
                    if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                        $value = (string) $value;
                        if ($value !== '') {
                            $other_value = (array_key_exists('matrix_other_' . $this->getId() . '_' . $matches[1], $post_data))
                                ? $this->stripSlashesAddSpaceFallback((string) $post_data['matrix_other_' . $this->getId() . '_' . $matches[1]])
                                : null;
                            $answer_data[] = array("value" => $value,
                                "textanswer" => $other_value,
                                "rowvalue" => (int) $matches[1]);
                        }
                    }
                }
                break;
 
            case 1:
                foreach ($post_data as $key => $value) {
                    $key = (string) $key;
                    if (preg_match("/matrix_" . $this->getId() . "_(\d+)/", $key, $matches)) {
                        $other_value = (array_key_exists('matrix_other_' . $this->getId() . '_' . $matches[1], $post_data))
                            ? $this->stripSlashesAddSpaceFallback((string) $post_data['matrix_other_' . $this->getId() . '_' . $matches[1]])
                            : null;
                        foreach ((array) $value as $checked) {
                            $answer_data[] = array("value" => (string) $checked,
                                "textanswer" => $other_value,
                                "rowvalue" => (int) $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;
    }

setBipolarAdjective()

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

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

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

setColumnPlaceholders()

SurveyMatrixQuestion::setColumnPlaceholders

(

bool

$a_value = false

)

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

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

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

setColumnSeparators()

SurveyMatrixQuestion::setColumnSeparators

(

bool

$enable = false

)

Enables/Disables separators for the matrix columns.

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

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

setLayout()

SurveyMatrixQuestion::setLayout

(

$layout

)

Parameters

array | string

$layout

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

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

setLegend()

SurveyMatrixQuestion::setLegend

(

bool

$a_value = false

)

Set whether the legend should be shown or not.

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

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

setNeutralColumnSeparator()

SurveyMatrixQuestion::setNeutralColumnSeparator

(

bool

$enable = true

)

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

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

setRepeatColumnHeader()

SurveyMatrixQuestion::setRepeatColumnHeader

(

bool

$a_value = false

)

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

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

setRowSeparators()

SurveyMatrixQuestion::setRowSeparators

(

bool

$enable = false

)

Enables/Disables separators for the matrix rows.

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

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

setSingleLineRowCaption()

SurveyMatrixQuestion::setSingleLineRowCaption

(

bool

$a_value = false

)

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

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

setSubtype()

SurveyMatrixQuestion::setSubtype

(

int

$a_subtype = 0

)

Sets the subtype of the matrix question.

Reimplemented from SurveyQuestion.

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

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

syncWithOriginal()

SurveyMatrixQuestion::syncWithOriginal

(

)

Reimplemented from SurveyQuestion.

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

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

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 @access public

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

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

usableForPrecondition()

SurveyMatrixQuestion::usableForPrecondition

(

)

Returns if the question is usable for preconditions.

Reimplemented from SurveyQuestion.

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

                                           : bool
    {
        return false;
    }

Field Documentation

$bipolar_adjective1

string SurveyMatrixQuestion::$bipolar_adjective1 = ""

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

$bipolar_adjective2

string SurveyMatrixQuestion::$bipolar_adjective2 = ""

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

$columnPlaceholders

bool SurveyMatrixQuestion::$columnPlaceholders = false

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

$columns

SurveyCategories SurveyMatrixQuestion::$columns

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

Referenced by getColumns().

$columnSeparators

bool SurveyMatrixQuestion::$columnSeparators = false

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

$layout

array SurveyMatrixQuestion::$layout

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

$legend

bool SurveyMatrixQuestion::$legend = false

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

$neutralColumnSeparator

bool SurveyMatrixQuestion::$neutralColumnSeparator = false

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

$repeatColumnHeader

bool SurveyMatrixQuestion::$repeatColumnHeader = false

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

$rows

SurveyCategories SurveyMatrixQuestion::$rows

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

$rowSeparators

bool SurveyMatrixQuestion::$rowSeparators = false

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

$singleLineRowCaption

bool SurveyMatrixQuestion::$singleLineRowCaption = false

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

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

---

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

• components/ILIAS/SurveyQuestionPool/Questions/class.SurveyMatrixQuestion.php