class.SurveyMultipleChoiceQuestion.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";
include_once "./Modules/Survey/classes/inc.SurveyConstants.php";

class SurveyMultipleChoiceQuestion extends SurveyQuestion 
{
        var $categories;

        function SurveyMultipleChoiceQuestion(
                $title = "",
                $description = "",
                $author = "",
                $questiontext = "",
                $owner = -1,
                $orientation = 0 
        )
        {
                $this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
                $this->orientation = $orientation;
                include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
                $this->categories = new SurveyCategories();
        }
        
        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->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->setOrientation($data["orientation"]);

                        $this->categories->flushCategories();
                        $result = $ilDB->queryF("SELECT svy_variable.*, svy_category.title 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->categories->addCategory($data["title"]);
                                }
                        }
                }
                parent::loadFromDb($id);
        }

        function isComplete()
        {
                if (strlen($this->title) && strlen($this->author) && strlen($this->questiontext) && $this->categories->getCategoryCount())
                {
                        return 1;
                }
                else
                {
                        return 0;
                }
        }

  function saveToDb($original_id = "")
  {
                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, orientation) VALUES (%s, %s)",
                                array('integer', 'text'),
                                array($this->getId(), $this->getOrientation())
                        );

                        // saving material uris in the database
                        $this->saveMaterial();
                        $this->saveCategoriesToDb();
                }
        }

        function saveCategoriesToDb()
        {
                global $ilDB;
                
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
                        array('integer'),
                        array($this->getId())
                );

                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $category_id = $this->saveCategoryToDb($this->categories->getCategory($i));
                        $next_id = $ilDB->nextId('svy_variable');
                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, sequence, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                                array('integer','integer','integer','float','integer','integer'),
                                array($next_id, $category_id, $this->getId(), ($i + 1), $i, time())
                        );
                }
                $this->saveCompletionStatus();
        }
        
        function toXML($a_include_header = TRUE, $obligatory_state = "")
        {
                include_once("./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, $obligatory_state = "")
        {
                $attrs = array(
                        "id" => $this->getId(),
                        "title" => $this->getTitle(),
                        "type" => $this->getQuestiontype(),
                        "obligatory" => $this->getObligatory()
                );
                $a_xml_writer->xmlStartTag("question", $attrs);
                
                $a_xml_writer->xmlElement("description", NULL, $this->getDescription());
                $a_xml_writer->xmlElement("author", NULL, $this->getAuthor());
                $a_xml_writer->xmlStartTag("questiontext");
                $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
                $a_xml_writer->xmlEndTag("questiontext");

                $a_xml_writer->xmlStartTag("responses");

                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $attrs = array(
                                "id" => $i
                        );
                        $a_xml_writer->xmlStartTag("response_multiple", $attrs);
                        $this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i));
                        $a_xml_writer->xmlEndTag("response_multiple");
                }

                $a_xml_writer->xmlEndTag("responses");

                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, "orientation");
                $a_xml_writer->xmlElement("fieldentry", NULL, $this->getOrientation());
                $a_xml_writer->xmlEndTag("metadatafield");
                $a_xml_writer->xmlEndTag("metadata");

                $a_xml_writer->xmlEndTag("question");
        }

        function getQuestionType()
        {
                return "SurveyMultipleChoiceQuestion";
        }

        function getAdditionalTableName()
        {
                return "svy_qst_mc";
        }

        function &getWorkingDataFromUserInput($post_data)
        {
                $entered_value = $post_data[$this->getId() . "_value"];
                $data = array();
                if (is_array($entered_value))
                {
                        foreach ($entered_value as $value)
                        {
                                array_push($data, array("value" => $value));
                        }
                }
                return $data;
        }

        function checkUserInput($post_data, $survey_id)
        {
                // multiple response questions are always non-obligatory
                $entered_value = $post_data[$this->getId() . "_value"];
                if (!$this->getObligatory($survey_id)) return "";

                if (!is_array($entered_value))
                {
                        return $this->lng->txt("question_mr_not_checked");
                }
                return "";
        }
        
        public function saveRandomData($active_id)
        {
                global $ilDB;
                // multiple responses
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        if (rand(0,1)) 
                        {
                                $next_id = $ilDB->nextId('svy_answer');
                                $affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                                        array('integer','integer','integer','float','text','integer'),
                                        array($next_id, $this->getId(), $active_id, $i, NULL, time())
                                );
                        }
                }
        }
        
        function saveUserInput($post_data, $active_id)
        {
                global $ilDB;

                if (is_array($post_data[$this->getId() . "_value"]))
                {
                        foreach ($post_data[$this->getId() . "_value"] as $value)
                        {
                                $entered_value = $value;
                                if (strlen($entered_value) > 0)
                                {
                                        $next_id = $ilDB->nextId('svy_answer');
                                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                                                array('integer','integer','integer','float','text','integer'),
                                                array($next_id, $this->getId(), $active_id, (strlen($entered_value)) ? $entered_value : NULL, NULL, time())
                                        );
                                }
                        }
                }
                else
                {
                        $entered_value = $post_data[$this->getId() . "_value"];
                        if (strlen($entered_value) == 0) return;
                        $next_id = $ilDB->nextId('svy_answer');
                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                                array('integer','integer','integer','float','text','integer'),
                                array($next_id, $this->getId(), $active_id, (strlen($entered_value)) ? $entered_value : NULL, NULL, time())
                        );
                }
        }

        function &getCumulatedResults($survey_id, $nr_of_users)
        {
                global $ilDB;
                
                $question_id = $this->getId();
                
                $result_array = array();
                $cumulated = array();

                $result = $ilDB->queryF("SELECT svy_answer.* FROM svy_answer, svy_finished WHERE svy_answer.question_fi = %s AND svy_finished.survey_fi = %s AND svy_finished.finished_id = svy_answer.active_fi",
                        array('integer', 'integer'),
                        array($question_id, $survey_id)
                );
                $numrows = $result->numRows();
                
                // count the answers for every answer value
                while ($row = $ilDB->fetchAssoc($result))
                {
                        $cumulated[$row["value"]]++;
                }
                asort($cumulated, SORT_NUMERIC);
                end($cumulated);
                
                $mcmr_result = $ilDB->queryF("SELECT svy_answer.answer_id, svy_answer.question_fi, svy_answer.active_fi FROM svy_answer, svy_finished WHERE svy_answer.question_fi = %s AND svy_finished.survey_fi = %s AND svy_finished.finished_id = svy_answer.active_fi",
                        array('integer', 'integer'),
                        array($question_id, $survey_id)
                );
                $found = array();
                while ($row = $ilDB->fetchAssoc($mcmr_result))
                {
                        $found[$row["question_fi"] . "_" . $row["active_fi"]] = 1;
                }
                $result_array["USERS_ANSWERED"] = count($found);
                $result_array["USERS_SKIPPED"] = $nr_of_users - count($found);
                $numrows = count($found);

                $result_array["MEDIAN"] = "";
                $result_array["ARITHMETIC_MEAN"] = "";
                $prefix = "";
                if (strcmp(key($cumulated), "") != 0)
                {
                        $prefix = (key($cumulated)+1) . " - ";
                }
                $result_array["MODE"] =  $prefix . $this->categories->getCategory(key($cumulated));
                $result_array["MODE_VALUE"] =  key($cumulated)+1;
                $result_array["MODE_NR_OF_SELECTIONS"] = $cumulated[key($cumulated)];
                $result_array["QUESTION_TYPE"] = "SurveyMultipleChoiceQuestion";
                $maxvalues = 0;
                for ($key = 0; $key < $this->categories->getCategoryCount(); $key++)
                {
                        $maxvalues += $cumulated[$key];
                }
                for ($key = 0; $key < $this->categories->getCategoryCount(); $key++)
                {
                        $percentage = 0;
                        if ($numrows > 0)
                        {
                                if ($maxvalues > 0)
                                {
                                        $percentage = ($result_array["USERS_ANSWERED"] > 0) ? (float)((int)$cumulated[$key]/$result_array["USERS_ANSWERED"]) : 0;
                                }
                        }
                        $result_array["variables"][$key] = array("title" => $this->categories->getCategory($key), "selected" => (int)$cumulated[$key], "percentage" => $percentage);
                }
                return $result_array;
        }

        function setExportDetailsXLS(&$workbook, &$format_title, &$format_bold, &$eval_data)
        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $worksheet =& $workbook->addWorksheet();
                $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
                $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
                $worksheet->writeString(1, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
                $worksheet->writeString(1, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
                $worksheet->writeString(2, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
                $worksheet->writeString(2, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
                $worksheet->writeString(3, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
                $worksheet->write(3, 1, $eval_data["USERS_ANSWERED"]);
                $worksheet->writeString(4, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
                $worksheet->write(4, 1, $eval_data["USERS_SKIPPED"]);
                $rowcounter = 5;

                $worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode")), $format_bold);
                $worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE_VALUE"]));
                $worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode_text")), $format_bold);
                $worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE"]));
                $worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode_nr_of_selections")), $format_bold);
                $worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE_NR_OF_SELECTIONS"]));
                $worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("categories")), $format_bold);
                $worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_title);
                $worksheet->write($rowcounter, 2, ilExcelUtils::_convert_text($this->lng->txt("value")), $format_title);
                $worksheet->write($rowcounter, 3, ilExcelUtils::_convert_text($this->lng->txt("category_nr_selected")), $format_title);
                $worksheet->write($rowcounter++, 4, ilExcelUtils::_convert_text($this->lng->txt("percentage_of_selections")), $format_title);
                foreach ($eval_data["variables"] as $key => $value)
                {
                        $worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($value["title"]));
                        $worksheet->write($rowcounter, 2, $key+1);
                        $worksheet->write($rowcounter, 3, ilExcelUtils::_convert_text($value["selected"]));
                        $worksheet->write($rowcounter++, 4, ilExcelUtils::_convert_text($value["percentage"]), $format_percent);
                }
        }

        function addUserSpecificResultsExportTitles(&$a_array)
        {
                parent::addUserSpecificResultsExportTitles($a_array);
                for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
                {
                        $category = $this->categories->getCategory($index);
                        array_push($a_array, ($index+1) . " - $category");
                }
        }
        
        function addUserSpecificResultsData(&$a_array, &$resultset)
        {
                if (count($resultset["answers"][$this->getId()]))
                {
                        array_push($a_array, "");
                        for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
                        {
                                $category = $this->categories->getCategory($index);
                                $found = 0;
                                foreach ($resultset["answers"][$this->getId()] as $answerdata)
                                {
                                        if (strcmp($index, $answerdata["value"]) == 0)
                                        {
                                                $found = 1;
                                        }
                                }
                                if ($found)
                                {
                                        array_push($a_array, "1");
                                }
                                else
                                {
                                        array_push($a_array, "0");
                                }
                        }
                }
                else
                {
                        array_push($a_array, $this->lng->txt("skipped"));
                        for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
                        {
                                array_push($a_array, "");
                        }
                }
        }

        function &getUserAnswers($survey_id)
        {
                global $ilDB;
                
                $answers = array();

                $result = $ilDB->queryF("SELECT svy_answer.* FROM svy_answer, svy_finished WHERE svy_finished.survey_fi = %s AND svy_answer.question_fi = %s AND svy_finished.finished_id = svy_answer.active_fi",
                        array('integer', 'integer'),
                        array($survey_id, $this->getId())
                );
                while ($row = $ilDB->fetchAssoc($result))
                {
                        $category = $this->categories->getCategory($row["value"]);
                        if (!is_array($answers[$row["active_fi"]]))
                        {
                                $answers[$row["active_fi"]] = array();
                        }
                        array_push($answers[$row["active_fi"]], $row["value"] + 1 . " - " . $category);
                }
                return $answers;
        }

        function importAdditionalMetadata($a_meta)
        {
                foreach ($a_meta as $key => $value)
                {
                        switch ($value["label"])
                        {
                                case "orientation":
                                        $this->setOrientation($value["entry"]);
                                        break;
                        }
                }
        }

        function importResponses($a_data)
        {
                foreach ($a_data as $id => $data)
                {
                        $categorytext = "";
                        foreach ($data["material"] as $material)
                        {
                                $categorytext .= $material["text"];
                        }
                        $this->categories->addCategory($categorytext);
                }
        }

        function usableForPrecondition()
        {
                return TRUE;
        }

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

        function getPreconditionSelectValue($default = "")
        {
                global $lng;
                
                include_once "./classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_svy_svy_precondition_select_value_combobox.html", TRUE, TRUE, "Modules/Survey");
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $template->setCurrentBlock("option_v");
                        $template->setVariable("OPTION_VALUE", $i);
                        $template->setVariable("OPTION_TEXT", ($i+1) . " - " . $this->categories->getCategory($i));
                        if ($i == $default)
                        {
                                $template->setVariable("OPTION_CHECKED", " selected=\"selected\"");
                        }
                        $template->parseCurrentBlock();
                }
                $template->setVariable("SELECT_VALUE", $lng->txt("step") . " 3: " . $lng->txt("select_value"));
                return $template->get();
        }

        function getPreconditionValueOutput($value)
        {
                return ($value + 1) . " - " . $this->categories->getCategory($value);
        }


        function outChart($survey_id, $type = "")
        {
                if (count($this->cumulated) == 0)
                {
                        include_once "./Modules/Survey/classes/class.ilObjSurvey.php";
                        $nr_of_users = ilObjSurvey::_getNrOfParticipants($survey_id);
                        $this->cumulated =& $this->getCumulatedResults($survey_id, $nr_of_users);
                }
                
                foreach ($this->cumulated["variables"] as $key => $value)
                {
                        foreach ($value as $key2 => $value2)
                        {
                                $this->cumulated["variables"][$key][$key2] = utf8_decode($value2);
                        }
                }
                include_once "./Modules/SurveyQuestionPool/classes/class.SurveyChart.php";
                $b1 = new SurveyChart("bars",400,250,utf8_decode($this->getTitle()),utf8_decode($this->lng->txt("answers")),utf8_decode($this->lng->txt("users_answered")),$this->cumulated["variables"]);
        }
        
        public function getCategories()
        {
                return $this->categories;
        }
}
?>