class.SurveyTextQuestion.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 SurveyTextQuestion extends SurveyQuestion 
{
        var $maxchars;
        var $textwidth;
        var $textheight;
        
        function SurveyTextQuestion(
                $title = "",
                $description = "",
                $author = "",
                $questiontext = "",
                $owner = -1
        )
        {
                $this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
                $this->maxchars = 0;
                $this->textwidth = 50;
                $this->textheight = 5;
        }
        
        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->setMaxChars($data["maxchars"]);
                        $this->setTextWidth($data["width"]);
                        $this->setTextHeight($data["height"]);

                }
                parent::loadFromDb($id);
        }

        function isComplete()
        {
                if (
                        strlen($this->getTitle()) &&
                        strlen($this->getAuthor()) &&
                        strlen($this->getQuestiontext())
                )
                {
                        return 1;
                }
                else
                {
                        return 0;
                }
        }
        
        function setMaxChars($maxchars = 0)
        {
                $this->maxchars = $maxchars;
        }
        
        function getMaxChars()
        {
                return ($this->maxchars) ? $this->maxchars : NULL;
        }
        
  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, maxchars, width, height) VALUES (%s, %s, %s, %s)",
                                array('integer', 'integer', 'integer', 'integer'),
                                array($this->getId(), $this->getMaxChars(), $this->getTextWidth(), $this->getTextHeight())
                        );

                        $this->saveMaterial();
                }
        }

        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, $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());
                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");
                $attrs = array(
                        "id" => "0",
                        "rows" => $this->getTextHeight(),
                        "columns" => $this->getTextWidth()
                );
                if ($this->getMaxChars() > 0)
                {
                        $attrs["maxlength"] = $this->getMaxChars();
                }
                $a_xml_writer->xmlElement("response_text", $attrs);
                $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->xmlEndTag("question");
        }

        function _getMaxChars($question_id)
        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT maxchars FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows())
                {
                        $row = $ilDB->fetchAssoc($result);
                        return $row["maxchars"];
                }
                return 0;
        }

        function getQuestionType()
        {
                return "SurveyTextQuestion";
        }

        function getAdditionalTableName()
        {
                return "svy_qst_text";
        }
        
        function &getWorkingDataFromUserInput($post_data)
        {
                $entered_value = $post_data[$this->getId() . "_text_question"];
                $data = array();
                if (strlen($entered_value))
                {
                        array_push($data, array("textanswer" => $entered_value));
                }
                return $data;
        }
        
        function checkUserInput($post_data, $survey_id)
        {
                $entered_value = $post_data[$this->getId() . "_text_question"];
                
                if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
                
                if (strlen($entered_value) == 0) return $this->lng->txt("text_question_not_filled_out");

                return "";
        }
        
        function randomText($length)
        {
                $random= "";
                $char_list = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
                $char_list .= "abcdefghijklmnopqrstuvwxyz";
                $char_list .= "1234567890";
                for($i = 0; $i < $length; $i++)
                { 
                        $random .= substr($char_list,(rand()%(strlen($char_list))), 1);
                        if (!rand(0,5)) $random .= ' ';
                }
                return $random;
        }
        
        public function saveRandomData($active_id)
        {
                global $ilDB;
                // single response
                $randomtext = $this->randomText(rand(25,100));
                $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, NULL, $randomtext, time())
                );
        }

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

                include_once "./Services/Utilities/classes/class.ilUtil.php";
                $entered_value = ilUtil::stripSlashes($post_data[$this->getId() . "_text_question"]);
                $maxchars = $this->getMaxChars();
                if ($maxchars > 0)
                {
                        $entered_value = substr($entered_value, 0, $maxchars);
                }
                
                if($a_return)
                {
                        return array(array("value"=>null, "textanswer"=>$entered_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, NULL, (strlen($entered_value)) ? $entered_value : NULL, time())
                );
        }
        
        function &getCumulatedResults($survey_id, $nr_of_users, $finished_ids)
        {
                global $ilDB;
                
                $question_id = $this->getId();
                
                $result_array = array();
                $cumulated = array();
                $textvalues = array();
                
                $sql = "SELECT svy_answer.* FROM svy_answer".
                        " JOIN svy_finished ON (svy_finished.finished_id = svy_answer.active_fi)".
                        " WHERE svy_answer.question_fi = ".$ilDB->quote($question_id, "integer").
                        " AND svy_finished.survey_fi = ".$ilDB->quote($survey_id, "integer");           
                if($finished_ids)
                {
                        $sql .= " AND ".$ilDB->in("svy_finished.finished_id", $finished_ids, "", "integer");
                }

                $result = $ilDB->query($sql);           
                while ($row = $ilDB->fetchAssoc($result))
                {
                        $cumulated[$row["value"]]++;
                        array_push($textvalues, $row["textanswer"]);
                }
                asort($cumulated, SORT_NUMERIC);
                end($cumulated);
                $numrows = $result->numRows();
                $result_array["USERS_ANSWERED"] = $result->numRows();
                $result_array["USERS_SKIPPED"] = $nr_of_users - $result->numRows();
                $result_array["QUESTION_TYPE"] = "SurveyTextQuestion";
                $result_array["textvalues"] = $textvalues;
                return $result_array;
        }
        
        function setExportDetailsXLS(&$workbook, &$format_title, &$format_bold, &$eval_data, $export_label)
        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $worksheet =& $workbook->addWorksheet();
                $rowcounter = 0;
                switch ($export_label)
                {
                        case 'label_only':
                                $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("label")), $format_bold);
                                $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->label));
                                break;
                        case 'title_only':
                                $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
                                $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
                                break;
                        default:
                                $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
                                $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
                                $rowcounter++;
                                $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("label")), $format_bold);
                                $worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->label));
                                break;
                }
                $rowcounter++;
                $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
                $worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
                $rowcounter++;
                $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
                $worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
                $rowcounter++;
                $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
                $worksheet->write($rowcounter, 1, $eval_data["USERS_ANSWERED"]);
                $rowcounter++;
                $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
                $worksheet->write($rowcounter, 1, $eval_data["USERS_SKIPPED"]);
                $rowcounter++;

                $worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("given_answers")), $format_bold);
                $textvalues = "";
                if (is_array($eval_data["textvalues"]))
                {
                        foreach ($eval_data["textvalues"] as $textvalue)
                        {
                                $worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($textvalue));
                        }
                }
        }

        function addUserSpecificResultsData(&$a_array, &$resultset)
        {
                if (count($resultset["answers"][$this->getId()]))
                {
                        foreach ($resultset["answers"][$this->getId()] as $key => $answer)
                        {
                                array_push($a_array, $answer["textanswer"]);
                        }
                }
                else
                {
                        array_push($a_array, $this->getSkippedValue());
                }
        }

        function &getUserAnswers($survey_id, $finished_ids)
        {
                global $ilDB;
                
                $answers = array();
                
                $sql = "SELECT svy_answer.* FROM svy_answer, svy_finished".
                        " WHERE svy_finished.survey_fi = ".$ilDB->quote($survey_id, "integer").
                        " AND svy_answer.question_fi = ".$ilDB->quote($this->getId(), "integer").
                        " AND svy_finished.finished_id = svy_answer.active_fi"; 
                if($finished_ids)
                {
                        $sql .= " AND ".$ilDB->in("svy_finished.finished_id", $finished_ids, "", "integer");
                }
                $result = $ilDB->query($sql);
                while ($row = $ilDB->fetchAssoc($result))
                {
                        $answers[$row["active_fi"]] = $row["textanswer"];
                }
                return $answers;
        }

        function importResponses($a_data)
        {
                foreach ($a_data as $id => $data)
                {
                        if ($data["maxlength"] > 0)
                        {
                                $this->setMaxChars($data["maxlength"]);
                        }
                        if ($data["rows"] > 0)
                        {
                                $this->setTextHeight($data["rows"]);
                        }
                        if ($data["columns"] > 0)
                        {
                                $this->setTextWidth($data["columns"]);
                        }
                }
        }

        function usableForPrecondition()
        {
                return FALSE;
        }

        function getTextWidth()
        {
                return ($this->textwidth) ? $this->textwidth : NULL;
        }
        
        function getTextHeight()
        {
                return ($this->textheight) ? $this->textheight : NULL;
        }
        
        function setTextWidth($a_textwidth)
        {
                if ($a_textwidth < 1)
                {
                        $this->textwidth = 50;
                }
                else
                {
                        $this->textwidth = $a_textwidth;
                }
        }
        
        function setTextHeight($a_textheight)
        {
                if ($a_textheight < 1)
                {
                        $this->textheight = 5;
                }
                else
                {
                        $this->textheight = $a_textheight;
                }
        }
}
?>