class.SurveyMatrixQuestion.php

Go to the documentation of this file.

<?php
 /*
   +----------------------------------------------------------------------------+
   | ILIAS open source                                                          |
   +----------------------------------------------------------------------------+
   | Copyright (c) 1998-2001 ILIAS open source, University of Cologne           |
   |                                                                            |
   | This program is free software; you can redistribute it and/or              |
   | modify it under the terms of the GNU General Public License                |
   | as published by the Free Software Foundation; either version 2             |
   | of the License, or (at your option) any later version.                     |
   |                                                                            |
   | This program is distributed in the hope that it will be useful,            |
   | but WITHOUT ANY WARRANTY; without even the implied warranty of             |
   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              |
   | GNU General Public License for more details.                               |
   |                                                                            |
   | You should have received a copy of the GNU General Public License          |
   | along with this program; if not, write to the Free Software                |
   | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
   +----------------------------------------------------------------------------+
*/

include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php";

class SurveyMatrixQuestion extends SurveyQuestion 
{
  var $columns;
        
        var $rows;

        var $bipolar_adjective1;
        
        var $bipolar_adjective2;
        
        var $columnSeparators;
        
        var $rowSeparators;

        var $neutralColumnSeparator;
        
        /*
         * Layout of the matrix question
         * 
         * @var array
         */
        var $layout;
        
        /*
         * Use placeholders for the column titles
         * 
         * @var boolean
         */
        var $columnPlaceholders;
        
        /*
         * Show a legend
         * 
         * @var boolean
         */
        var $legend;
        
        var $singleLineRowCaption;
        
        var $repeatColumnHeader;
        
        var $columnHeaderPosition;
        
        /*
         * Use random order for rows
         * 
         * @var boolean
         */
        var $randomRows;
        
        var $columnOrder;
        
        var $columnImages;
        
        var $rowImages;
        
        var $openRows;
        
        
  var $subtype;

        function __construct($title = "", $description = "", $author = "", $questiontext = "", $owner = -1)
        {
                parent::__construct($title, $description, $author, $questiontext, $owner);
                
                $this->subtype = 0;
                include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
                $this->columns = new SurveyCategories();
                $this->rows = new SurveyCategories();
                $this->bipolar_adjective1 = "";
                $this->bipolar_adjective2 = "";
                $this->rowSeparators = 0;
                $this->columnSeparators = 0;
                $this->neutralColumnSeparator = 1;
        }
        
        function getColumnCount() 
        {
                return $this->columns->getCategoryCount();
        }
        
        function removeColumn($index)
        {
                $this->columns->removeCategory($index);
        }

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

        function removeColumnWithName($name)
        {
                $this->columns->removeCategoryWithName($name);
        }
        
        public function getColumns()
        {
                return $this->columns;
        }
        
        function getColumn($index)
        {
                return $this->columns->getCategory($index);
        }
        
        function getColumnForScale($scale)
        {
                return $this->columns->getCategoryForScale($scale);
        }

        function getColumnIndex($name)
        {
                return $this->columns->getCategoryIndex($name);
        }
        
        
        function flushColumns() 
        {
                $this->columns->flushCategories();
        }
        
        function getRowCount()
        {
                return $this->rows->getCategoryCount();
        }

        function addRow($a_text, $a_other, $a_label)
        {
                $this->rows->addCategory($a_text, $a_other, 0, $a_label);
        }
        
        function addRowAtPosition($a_text, $a_other, $a_position)
        {
                $this->rows->addCategoryAtPosition($a_text, $a_position, $a_other);
        }

        function flushRows() 
        {
                $this->rows = new SurveyCategories();
        }
        
        function getRow($a_index)
        {
                return $this->rows->getCategory($a_index);
        }

        function moveRowUp($index)
        {
                $this->rows->moveCategoryUp($index);
        }
        
        function moveRowDown($index)
        {
                $this->rows->moveCategoryDown($index);
        }
        
        function removeRows($array)
        {
                $this->rows->removeCategories($array);
        }

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

        function getBipolarAdjective($a_index)
        {
                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;
        }

        function setBipolarAdjective($a_index, $a_value)
        {
                switch ($a_index)
                {
                        case 1:
                                $this->bipolar_adjective2 = $a_value;
                                break;
                        case 0:
                        default:
                                $this->bipolar_adjective1 = $a_value;
                                break;
                }
        }
        
        function addPhrase($phrase_id)
        {
                global $ilUser;
                global $ilDB;

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

        function isComplete()
        {
                if (
                        strlen($this->getTitle()) && 
                        strlen($this->getAuthor()) && 
                        strlen($this->getQuestiontext()) && 
                        $this->getColumnCount() &&
                        $this->getRowCount()
                )
                {
                        return 1;
                }
                else
                {
                        return 0;
                }
        }
        
        function saveToDb($original_id = NULL, $withanswers = true)
        {
                global $ilDB;

                $affectedRows = parent::saveToDb($original_id);

                if ($affectedRows == 1) 
                {
                        $affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                                array('integer'),
                                array($this->getId())
                        );
                        $affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (
                                question_fi, subtype, 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();
                }
        }
                
        function saveBipolarAdjectives($adjective1, $adjective2)
        {
                global $ilDB;
                
                $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())
                );
        }

        function saveColumnToDb($columntext, $neutral = 0)
        {
                global $ilUser, $ilDB;
                
                $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;
        }

        function saveColumnsToDb($original_id = "")
        {
                global $ilDB;
                
                // 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);
        }

        function saveRowsToDb($original_id = "")
        {
                global $ilDB;
                
                // 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);
        }

        function toXML($a_include_header = TRUE, $obligatory_state = "")
        {
                include_once("./Services/Xml/classes/class.ilXmlWriter.php");
                $a_xml_writer = new ilXmlWriter;
                $a_xml_writer->xmlHeader();
                $this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
                $xml = $a_xml_writer->xmlDumpMem(FALSE);
                if (!$a_include_header)
                {
                        $pos = strpos($xml, "?>");
                        $xml = substr($xml, $pos + 2);
                }
                return $xml;
        }
        
        function insertXML(&$a_xml_writer, $a_include_header = TRUE)
        {
                $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");
        }

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


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

        function savePhrase($title)
        {
                global $ilUser;
                global $ilDB;

                $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++;
                }
        }
        
        function getQuestionType()
        {
                return "SurveyMatrixQuestion";
        }

        function getAdditionalTableName()
        {
                return "svy_qst_matrix";
        }
        
        function &getWorkingDataFromUserInput($post_data)
        {
                $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;
        }
        
        function checkUserInput($post_data, $survey_id)
        {
                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 "";
        }

        function saveUserInput($post_data, $active_id, $a_return = false)
        {
                global $ilDB;
                
                $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)) 
                                                                ? ($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)) 
                                                        ? ($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);   

                        }                       
                }               
        }

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

        function getSubtype()
        {
                return $this->subtype;
        }

        function setSubtype($a_subtype = 0)
        {
                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;
                }
        }
        
        function setColumnSeparators($enable = 0)
        {
                switch ($enable)
                {
                        case 1:
                                $this->columnSeparators = 1;
                                break;
                        case 0:
                        default:
                                $this->columnSeparators = 0;
                                break;
                }
        }
        
        function getColumnSeparators()
        {
                return ($this->columnSeparators) ? 1 : 0;
        }
        
        function setRowSeparators($enable = 0)
        {
                switch ($enable)
                {
                        case 1:
                                $this->rowSeparators = 1;
                                break;
                        case 0:
                        default:
                                $this->rowSeparators = 0;
                                break;
                }
        }
        
        function getRowSeparators()
        {
                return ($this->rowSeparators) ? 1 : 0;
        }

        function setNeutralColumnSeparator($enable = 0)
        {
                switch ($enable)
                {
                        case 1:
                                $this->neutralColumnSeparator = 1;
                                break;
                        case 0:
                        default:
                                $this->neutralColumnSeparator = 0;
                                break;
                }
        }
        
        function getNeutralColumnSeparator()
        {
                return ($this->neutralColumnSeparator) ? 1 : 0;
        }

        function importAdditionalMetadata($a_meta)
        {
                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;
                        }
                }
        }

        function importAdjectives($a_data)
        {
                $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++;
                }
        }

        function importMatrix($a_data)
        {
                foreach ($a_data as $row)
                {
                        $this->addRow($row['title'], $row['other'], $row['label']);
                }
        }
        
        function importResponses($a_data)
        {
                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);
                }
        }

        function usableForPrecondition()
        {
                return FALSE;
        }

        function getPreconditionValueOutput($value)
        {
                return $value;
        }

        public function getPreconditionSelectValue($default = "", $title, $variable)
        {
                include_once "./Services/Form/classes/class.ilSelectInputGUI.php";
                $step3 = new ilSelectInputGUI($title, $variable);
                $options = $this->getPreconditionOptions();
                $step3->setOptions($options);
                $step3->setValue($default);
                return $step3;
        }
        
        function saveLayout($percent_row, $percent_columns, $percent_bipolar_adjective1 = "", $percent_bipolar_adjective2 = "", $percent_neutral)
        {
                global $ilDB;
                
                $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())
                );
        }

        function getLayout()
        {
                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;
        }
        
        function setLayout($layout)
        {
                if (is_array($layout))
                {
                        $this->layout = $layout;
                }
                else
                {
                        $this->layout = unserialize($layout);
                }
        }
        
        function hasBipolarAdjectives()
        {
                if ((strlen($this->getBipolarAdjective(0))) && (strlen($this->getBipolarAdjective(1))))
                {
                        return TRUE;
                }
                else
                {
                        return FALSE;
                }
        }
        
        function hasNeutralColumn()
        {
                for ($i = 0; $i < $this->getColumnCount(); $i++)
                {
                        $column = $this->getColumn($i);
                        if ($column->neutral && strlen($column->title)) return true;
                }
                return FALSE;
        }
        
        function setColumnPlaceholders($a_value = 0)
        {
                $this->columnPlaceholders = ($a_value) ? 1 : 0;
        }
        
        function getColumnPlaceholders()
        {
                return ($this->columnPlaceholders) ? 1 : 0;
        }

        function setLegend($a_value = 0)
        {
                $this->legend = ($a_value) ? 1 : 0;
        }
        
        function getLegend()
        {
                return ($this->legend) ? 1 : 0;
        }
        
        function setSingleLineRowCaption($a_value = 0)
        {
                $this->singleLineRowCaption = ($a_value) ? 1 : 0;
        }
        
        function getSingleLineRowCaption()
        {
                return ($this->singleLineRowCaption) ? 1 : 0;
        }
        
        function setRepeatColumnHeader($a_value = 0)
        {
                $this->repeatColumnHeader = ($a_value) ? 1 : 0;
        }
        
        function getRepeatColumnHeader()
        {
                return ($this->repeatColumnHeader) ? 1 : 0;
        }
        
        function setColumnHeaderPosition($a_value)
        {
                $this->columnHeaderPosition = $a_value;
        }
        
        function getColumnHeaderPosition()
        {
                return ($this->columnHeaderPosition) ? $this->columnHeaderPosition : 0;
        }
        
        function setRandomRows($a_value = 0)
        {
                $this->randomRows = ($a_value) ? 1 : 0;
        }
        
        function getRandomRows()
        {
                return ($this->randomRows) ? 1 : 0;
        }
        
        function setColumnOrder($a_value)
        {
                $this->columnOrder = $a_value;
        }
        
        function getColumnOrder()
        {
                return ($this->columnOrder) ? $this->columnOrder : 0;
        }
        
        function setColumnImages($a_value = 0)
        {
                $this->columnImages = ($a_value) ? 1 : 0;
        }
        
        function getColumnImages()
        {
                return ($this->columnImages) ? 1 : 0;
        }
        
        function setRowImages($a_value = 0)
        {
                $this->rowImages = ($a_value) ? 1 : 0;
        }
        
        function getRowImages()
        {
                return ($this->rowImages) ? 1 : 0;
        }

        public function getRows()
        {
                return $this->rows;
        }
}

?>