class.SurveyMetricQuestion.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 SurveyMetricQuestion extends SurveyQuestion 
{
        const SUBTYPE_NON_RATIO = 3;
        const SUBTYPE_RATIO_NON_ABSOLUTE = 4;
        const SUBTYPE_RATIO_ABSOLUTE = 5;
        
  var $subtype;

  var $minimum;

  var $maximum;

        function __construct($title = "", $description = "", $author = "", $questiontext = "",  $owner = -1, $subtype = self::SUBTYPE_NON_RATIO)
        {
                parent::__construct($title, $description, $author, $questiontext, $owner);
                
                $this->subtype = $subtype;
                $this->minimum = "";
                $this->maximum = "";
        }
        
  function setSubtype($subtype = self::SUBTYPE_NON_RATIO) 
        {
    $this->subtype = $subtype;
  }

  function setMinimum($minimum = 0) 
        {
           if($minimum !== NULL)
          {
                  $minimum = (float)$minimum;            
          }
           if(!$minimum)
                {
                        $minimum = NULL;
                }
    $this->minimum = $minimum;
  }

  function setMaximum($maximum = "") 
        {
            if($maximum !== NULL)
          {
                  $maximum = (float)$maximum;
          }
           if(!$maximum)
                {
                        $maximum = NULL;
                }
    $this->maximum = $maximum;
  }

  function getSubtype() 
        {
    return $this->subtype;
  }
        
        function getMinimum() 
        {
                if ((strlen($this->minimum) == 0) && ($this->getSubtype() > 3))
                {
                        $this->minimum = 0;
                }
                return (strlen($this->minimum)) ? $this->minimum : NULL;
        }
        
        function getMaximum() 
        {
                return (strlen($this->maximum)) ? $this->maximum : NULL;
        }
        
        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"]);
                        $this->label = $data['label'];
                        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"]);

                        $result = $ilDB->queryF("SELECT svy_variable.* FROM svy_variable WHERE svy_variable.question_fi = %s",
                                array('integer'),
                                array($id)
                        );
                        if ($result->numRows() > 0) 
                        {
                                if ($data = $ilDB->fetchAssoc($result)) 
                                {
                                        $this->minimum = $data["value1"];
                                        if (($data["value2"] < 0) or (strcmp($data["value2"], "") == 0))
                                        {
                                                $this->maximum = "";
                                        }
                                        else
                                        {
                                                $this->maximum = $data["value2"];
                                        }
                                }
                        }
                }
                parent::loadFromDb($id);
        }

        function isComplete()
        {
                if (
                        strlen($this->getTitle()) &&
                        strlen($this->getAuthor()) &&
                        strlen($this->getQuestiontext())
                )
                {
                        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, subtype) VALUES (%s, %s)",
                                array('integer', 'text'),
                                array($this->getId(), $this->getSubType())
                        );

                        // saving material uris in the database
                        $this->saveMaterial();
                        
                        // save categories
                        $affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
                                array('integer'),
                                array($this->getId())
                        );

                        if (preg_match("/[\D]/", $this->maximum) or (strcmp($this->maximum, "&infin;") == 0))
                        {
                                $max = -1;
                        }
                        else
                        {
                                $max = $this->getMaximum();
                        }
                        $next_id = $ilDB->nextId('svy_variable');
                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, value2, sequence, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s)",
                                array('integer','integer','integer','float','float','integer','integer'),
                                array($next_id, 0, $this->getId(), $this->getMinimum(), $max, 0, time())
                        );
                } 
  }
        
        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("responses");
                switch ($this->getSubtype())
                {
                        case 3:
                                $attrs = array(
                                        "id" => "0",
                                        "format" => "double"
                                );
                                if (strlen($this->getMinimum()))
                                {
                                        $attrs["min"] = $this->getMinimum();
                                }
                                if (strlen($this->getMaximum()))
                                {
                                        $attrs["max"] = $this->getMaximum();
                                }
                                break;
                        case 4:
                                $attrs = array(
                                        "id" => "0",
                                        "format" => "double"
                                );
                                if (strlen($this->getMinimum()))
                                {
                                        $attrs["min"] = $this->getMinimum();
                                }
                                if (strlen($this->getMaximum()))
                                {
                                        $attrs["max"] = $this->getMaximum();
                                }
                                break;
                        case 5:
                                $attrs = array(
                                        "id" => "0",
                                        "format" => "integer"
                                );
                                if (strlen($this->getMinimum()))
                                {
                                        $attrs["min"] = $this->getMinimum();
                                }
                                if (strlen($this->getMaximum()))
                                {
                                        $attrs["max"] = $this->getMaximum();
                                }
                                break;
                }
                $a_xml_writer->xmlStartTag("response_num", $attrs);
                $a_xml_writer->xmlEndTag("response_num");

                $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 getQuestionTypeID()
        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT questiontype_id FROM svy_qtype WHERE type_tag = %s",
                        array('text'),
                        array($this->getQuestionType())
                );
                $row = $ilDB->fetchAssoc($result);
                return $row["questiontype_id"];
        }

        function getQuestionType()
        {
                return "SurveyMetricQuestion";
        }
        
        function getAdditionalTableName()
        {
                return "svy_qst_metric";
        }
        
        function &getWorkingDataFromUserInput($post_data)
        {
                $entered_value = $post_data[$this->getId() . "_metric_question"];
                $data = array();
                if (strlen($entered_value))
                {
                        array_push($data, array("value" => $entered_value));
                }
                return $data;
        }
        
        function checkUserInput($post_data, $survey_id)
        {
                $entered_value = $post_data[$this->getId() . "_metric_question"];
                // replace german notation with international notation
                $entered_value = str_replace(",", ".", $entered_value);
                
                if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
                
                if (strlen($entered_value) == 0) return $this->lng->txt("survey_question_obligatory");
                
                if (strlen($this->getMinimum()))
                {
                        if ($entered_value < $this->getMinimum())
                        {
                                return $this->lng->txt("metric_question_out_of_bounds");
                        }
                }

                if (strlen($this->getMaximum()))
                {
                        if (($this->getMaximum() == 1) && ($this->getMaximum() < $this->getMinimum()))
                        {
                                // old &infty; values as maximum
                        }
                        else
                        {
                                if ($entered_value > $this->getMaximum())
                                {
                                        return $this->lng->txt("metric_question_out_of_bounds");
                                }
                        }
                }

                if (!is_numeric($entered_value))
                {
                        return $this->lng->txt("metric_question_not_a_value");
                }

                if (($this->getSubType() == self::SUBTYPE_RATIO_ABSOLUTE) && (intval($entered_value) != doubleval($entered_value)))
                {
                        return $this->lng->txt("metric_question_floating_point");
                }
                return "";
        }
        
        function saveUserInput($post_data, $active_id, $a_return = false)
        {
                global $ilDB;
                
                $entered_value = $post_data[$this->getId() . "_metric_question"];
                
                // replace german notation with international notation
                $entered_value = str_replace(",", ".", $entered_value);
                
                if($a_return)
                {
                        return array(array("value"=>$entered_value, "textanswer"=>null));
                }
                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", NULL);
                $fields['tstamp'] = array("integer", time());

                $affectedRows = $ilDB->insert("svy_answer", $fields);   
        }

        function importResponses($a_data)
        {
                foreach ($a_data as $id => $data)
                {
                        $this->setMinimum($data["min"]);
                        $this->setMaximum($data["max"]);
                }
        }

        function usableForPrecondition()
        {
                return TRUE;
        }

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

        function outPreconditionSelectValue(&$template)
        {
                $template->setCurrentBlock("textfield");
                $template->setVariable("TEXTFIELD_VALUE", "");
                $template->parseCurrentBlock();
        }
        
        public function getPreconditionSelectValue($default = "", $title, $variable)
        {
                include_once "./Services/Form/classes/class.ilNumberInputGUI.php";
                $step3 = new ilNumberInputGUI($title, $variable);
                $step3->setValue($default);
                return $step3;
        }

        function getMinMaxText()
        {
                $min = $this->getMinimum();
                $max = $this->getMaximum();
                if (strlen($min) && strlen($max))
                {
                        return "(" . $min . " " . strtolower($this->lng->txt("to")) . " " . $max . ")";
                }
                else if (strlen($min))
                {
                        return "(&gt;= " . $min . ")";
                }
                else if (strlen($max))
                {
                        return "(&lt;= " . $max . ")";
                }
                else
                {
                        return "";
                }
        }
}
?>