class.SurveySingleChoiceQuestion.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 SurveySingleChoiceQuestion extends SurveyQuestion 
{
        var $categories;

        function __construct($title = "", $description = "", $author = "", $questiontext = "", $owner = -1, $orientation = 1)
        {
                parent::__construct($title, $description, $author, $questiontext, $owner);
                
                include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
                $this->orientation = $orientation;
                $this->categories = new SurveyCategories();
        }
        
        function &getCategoriesForPhrase($phrase_id)
        {
                global $ilDB;
                $categories = array();
                $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 ORDER BY svy_phrase_cat.sequence",
                        array('integer'),
                        array($phrase_id)
                );
                while ($row = $ilDB->fetchAssoc($result))
                {
                        if (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0))
                        {
                                $categories[$row["category_id"]] = $this->lng->txt($row["title"]);
                        }
                        else
                        {
                                $categories[$row["category_id"]] = $row["title"];
                        }
                }
                return $categories;
        }
        
        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 = 0 OR svy_category.owner_fi = %s) ORDER BY svy_phrase_cat.sequence",
                        array('integer', 'integer'),
                        array($phrase_id, $ilUser->getId())
                );
                while ($row = $ilDB->fetchAssoc($result))
                {
                        $neutral = $row["neutral"];                     
                        if (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0))
                        {
                                $this->categories->addCategory($this->lng->txt($row["title"]), 0, $neutral);
                        }
                        else
                        {
                                $this->categories->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->setOrientation($data["orientation"]);

                        $this->categories->flushCategories();
                        $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->categories->addCategory($data["title"], $data["other"], $data["neutral"], null, ($data['scale']) ? $data['scale'] : ($data['sequence'] + 1));
                                }
                        }
                }
                parent::loadFromDb($id);
        }

        function isComplete()
        {
                if (
                        strlen($this->getTitle()) &&
                        strlen($this->getAuthor()) &&
                        strlen($this->getQuestiontext()) &&
                        $this->categories->getCategoryCount()
                )
                {
                        return 1;
                }
                else
                {
                        return 0;
                }
        }
        
        function saveToDb($original_id = "")
        {
                global $ilDB;

                $affectedRows = parent::saveToDb($original_id);
                if ($affectedRows == 1) 
                {
                        $this->log->debug("Before save Category-> DELETE from svy_qst_sc WHERE question_fi = ".$this->getId()." AND INSERT again the same id and orientation in svy_qst_sc");
                        $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()
                                )
                        );

                        $this->saveMaterial();
                        $this->saveCategoriesToDb();
                }
        }

        function saveCategoriesToDb()
        {
                global $ilDB;

                $this->log->debug("DELETE from svy_variable before the INSERT into svy_variable. if scale > 0  we get scale value else we get null");

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

                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $cat = $this->categories->getCategory($i);
                        $category_id = $this->saveCategoryToDb($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, $category_id, $this->getId(), ($i + 1), $cat->other, $i, ($cat->scale > 0) ? $cat->scale : null, time())
                        );

                        $debug_scale = ($cat->scale > 0) ? $cat->scale : null;
                        $this->log->debug("INSERT INTO svy_variable category_fi= ".$category_id." question_fi= ".$this->getId()." value1= ".($i + 1)." other= ".$cat->other." sequence= ".$i." scale =".$debug_scale);
                }
                $this->saveCompletionStatus();
        }

        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(),
                        "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());
                if (strlen($this->label))
                {
                        $attrs = array(
                                "label" => $this->label,
                        );
                }
                else
                {
                        $attrs = array();
                }
                $a_xml_writer->xmlStartTag("questiontext", $attrs);
                $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
                        );
                        if (strlen($this->categories->getCategory($i)->other)) $attrs['other'] = $this->categories->getCategory($i)->other;
                        if (strlen($this->categories->getCategory($i)->neutral)) $attrs['neutral'] = $this->categories->getCategory($i)->neutral;
                        if (strlen($this->categories->getCategory($i)->label)) $attrs['label'] = $this->categories->getCategory($i)->label;
                        if (strlen($this->categories->getCategory($i)->scale)) $attrs['scale'] = $this->categories->getCategory($i)->scale;
                        $a_xml_writer->xmlStartTag("response_single", $attrs);
                        $this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i)->title);
                        $a_xml_writer->xmlEndTag("response_single");
                }

                $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 importAdditionalMetadata($a_meta)
        {
                foreach ($a_meta as $key => $value)
                {
                        switch ($value["label"])
                        {
                                case "orientation":
                                        $this->setOrientation($value["entry"]);
                                        break;
                        }
                }
        }

        function addStandardNumbers($lower_limit, $upper_limit)
        {
                for ($i = $lower_limit; $i <= $upper_limit; $i++)
                {
                        $this->categories->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 "SurveySingleChoiceQuestion";
        }

        function getAdditionalTableName()
        {
                return "svy_qst_sc";
        }
        
        function &getWorkingDataFromUserInput($post_data)
        {
                $entered_value = $post_data[$this->getId() . "_value"];
                $data = array();
                if (strlen($entered_value))
                {
                        array_push($data, array("value" => $entered_value, "textanswer" => $post_data[$this->getId() . '_' . $entered_value . '_other']));
                }
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $cat = $this->categories->getCategory($i);
                        if ($cat->other)
                        {
                                if ($i != $entered_value)
                                {
                                        if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
                                        {
                                                array_push($data, array("value" => $i, "textanswer" => $post_data[$this->getId() . '_' . $i . '_other'], "uncheck" => true));
                                        }
                                }
                        }
                }
                return $data;
        }

        function checkUserInput($post_data, $survey_id)
        {
                $entered_value = $post_data[$this->getId() . "_value"];

                $this->log->debug("Entered value = ".$entered_value);
                
                if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
                
                if (strlen($entered_value) == 0) return $this->lng->txt("question_not_checked");

                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $cat = $this->categories->getCategory($i);
                        if ($cat->other)
                        {
                                if ($i == $entered_value)
                                {
                                        if (array_key_exists($this->getId() . "_" . $entered_value . "_other", $post_data) && !strlen($post_data[$this->getId() . "_" . $entered_value . "_other"]))
                                        {
                                                return $this->lng->txt("question_mr_no_other_answer");
                                        }
                                }
                                else
                                {
                                        if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
                                        {
                                                return $this->lng->txt("question_sr_no_other_answer_checked");
                                        }
                                }
                        }
                }

                return "";
        }

        function saveUserInput($post_data, $active_id, $a_return = false)
        {
                global $ilDB;

                $entered_value = $post_data[$this->getId() . "_value"];
                
                if($a_return)
                {
                        return array(array("value"=>$entered_value,
                                "textanswer"=>$post_data[$this->getId() . "_" . $entered_value . "_other"]));
                }
                if (strlen($entered_value) == 0) return;
                
                $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", (strlen($entered_value)) ? $entered_value : NULL);
                $fields['textanswer'] = array("clob", ($post_data[$this->getId() . "_" . $entered_value . "_other"]) ? $post_data[$this->getId() . "_" . $entered_value . "_other"] : null);
                $fields['tstamp'] = array("integer", time());
                
                $affectedRows = $ilDB->insert("svy_answer", $fields);

                $debug_value = (strlen($entered_value)) ? $entered_value : "NULL";
                $debug_answer = ($post_data[$this->getId() . "_" . $entered_value . "_other"]) ? $post_data[$this->getId() . "_" . $entered_value . "_other"] : "NULL";
                $this->log->debug("INSERT svy_answer answer_id=".$next_id." question_fi=".$this->getId()." active_fi=".$active_id." value=".$debug_value. " textanswer=".$debug_answer);
        }

        function importResponses($a_data)
        {
                foreach ($a_data as $id => $data)
                {
                        $categorytext = "";
                        foreach ($data["material"] as $material)
                        {
                                $categorytext .= $material["text"];
                        }
                        $this->categories->addCategory(
                                $categorytext, 
                                strlen($data['other']) ? $data['other'] : 0, 
                                strlen($data['neutral']) ? $data['neutral'] : 0, 
                                strlen($data['label']) ? $data['label'] : null, 
                                strlen($data['scale']) ? $data['scale'] : null
                        );
                }
        }

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

        public function getPreconditionOptions()
        {
                global $lng;
                
                $options = array();
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $category = $this->categories->getCategory($i);                 
                        $options[$category->scale-1] = $category->scale . " - " . $category->title;
                }
                return $options;
        }

        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 getPreconditionValueOutput($value)
        {
                // #18136
                $category = $this->categories->getCategoryForScale($value+1);
                
                // #17895 - see getPreconditionOptions()
                return $category->scale . 
                        " - " .
                        ((strlen($category->title)) ? $category->title : $this->lng->txt('other_answer'));
        }

        public function getCategories()
        {
                return $this->categories;
        }

}
?>