Public Member Functions

SurveyMetricQuestionGUI Class Reference

Metric survey question GUI representation. More...

Inheritance diagram for SurveyMetricQuestionGUI:
Collaboration diagram for SurveyMetricQuestionGUI:

Public Member Functions

 SurveyMetricQuestionGUI ($id=-1)
 SurveyMetricQuestionGUI constructor.
 getQuestionType ()
 Returns the question type string.
 editQuestion ()
 Creates an output of the edit form for the question.
 writePostData ()
 Evaluates a posted edit form and writes the form data in the question object.
 outWorkingForm ($working_data="", $question_title=1, $error_message="")
 Creates the question output form for the learner.
 preview ()
 Creates a preview of the question.
 setQuestionTabs ()
 outCumulatedResultsDetails (&$cumulated_results, $counter)

Detailed Description

Metric survey question GUI representation.

The SurveyMetricQuestionGUI class encapsulates the GUI representation for metric survey question types.

Author:
Helmut Schottmüller <helmut.schottmueller@mac.com>
Version:
Id:
class.SurveyMetricQuestionGUI.php 14114 2007-06-12 14:41:49Z hschottm

class.SurveyMetricQuestionGUI.php Survey

Definition at line 38 of file class.SurveyMetricQuestionGUI.php.

Member Function Documentation

SurveyMetricQuestionGUI::editQuestion (  ) 

Creates an output of the edit form for the question.

Creates an output of the edit form for the question

public

Definition at line 82 of file class.SurveyMetricQuestionGUI.php.

References $_GET, $key, $obj_id, SurveyQuestion::_getInternalLinkHref(), ilRTE::_getRTEClassname(), ilObject::_lookupType(), and ilUtil::prepareFormOutput().

        {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_metric.html", true);
          $this->tpl->addBlockFile("OTHER_QUESTION_DATA", "other_question_data", "tpl.il_svy_qpl_other_question_data.html", true);
                $internallinks = array(
                        "lm" => $this->lng->txt("obj_lm"),
                        "st" => $this->lng->txt("obj_st"),
                        "pg" => $this->lng->txt("obj_pg"),
                        "glo" => $this->lng->txt("glossary_term")
                );
                foreach ($internallinks as $key => $value)
                {
                        $this->tpl->setCurrentBlock("internallink");
                        $this->tpl->setVariable("TYPE_INTERNAL_LINK", $key);
                        $this->tpl->setVariable("TEXT_INTERNAL_LINK", $value);
                        $this->tpl->parseCurrentBlock();
                }
                
                $this->tpl->setCurrentBlock("adm_content");
                $this->tpl->setVariable("TEXT_MATERIAL", $this->lng->txt("material"));
                if (count($this->object->material))
                {
                        include_once "./survey/classes/class.SurveyQuestion.php";
                        $href = SurveyQuestion::_getInternalLinkHref($this->object->material["internal_link"]);
                        $this->tpl->setVariable("TEXT_VALUE_MATERIAL", " <a href=\"$href\" target=\"content\">" . $this->lng->txt("material"). "</a> ");
                        $this->tpl->setVariable("BUTTON_REMOVE_MATERIAL", $this->lng->txt("remove"));
                        $this->tpl->setVariable("BUTTON_ADD_MATERIAL", $this->lng->txt("change"));
                        $this->tpl->setVariable("VALUE_MATERIAL", $this->object->material["internal_link"]);
                        $this->tpl->setVariable("VALUE_MATERIAL_TITLE", $this->object->material["title"]);
                        $this->tpl->setVariable("TEXT_TITLE", $this->lng->txt("title"));
                }
                else
                {
                        $this->tpl->setVariable("BUTTON_ADD_MATERIAL", $this->lng->txt("add"));
                }
                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                $this->tpl->setVariable("VALUE_TITLE", $this->object->getTitle());
                $this->tpl->setVariable("VALUE_DESCRIPTION", $this->object->getDescription());
                $this->tpl->setVariable("VALUE_AUTHOR", $this->object->getAuthor());
                $questiontext = $this->object->getQuestiontext();
                $this->tpl->setVariable("VALUE_QUESTION", ilUtil::prepareFormOutput($this->object->prepareTextareaOutput($questiontext)));
                $this->tpl->setVariable("VALUE_MINIMUM", $this->object->getMinimum());
                $this->tpl->setVariable("VALUE_MAXIMUM", $this->object->getMaximum());
                $this->tpl->setVariable("TEXT_MINIMUM", $this->lng->txt("minimum"));
                $this->tpl->setVariable("TEXT_MAXIMUM", $this->lng->txt("maximum"));
                $this->tpl->setVariable("TEXT_NONRATIO", $this->lng->txt("non_ratio"));
                $this->tpl->setVariable("TEXT_RATIONONABSOLUTE", $this->lng->txt("ratio_non_absolute"));
                $this->tpl->setVariable("TEXT_RATIOABSOLUTE", $this->lng->txt("ratio_absolute"));
                if ($this->object->getSubtype() == SUBTYPE_NON_RATIO)
                {
                        $this->tpl->setVariable("SELECTED_NONRATIO", " selected=\"selected\"");
                }
                else if ($this->object->getSubtype() == SUBTYPE_RATIO_NON_ABSOLUTE)
                {
                        $this->tpl->setVariable("SELECTED_RATIONONABSOLUTE", " selected=\"selected\"");
                }
                else if ($this->object->getSubtype() == SUBTYPE_RATIO_ABSOLUTE)
                {
                        $this->tpl->setVariable("SELECTED_RATIOABSOLUTE", " selected=\"selected\"");
                }
                $this->tpl->setVariable("TEXT_TITLE", $this->lng->txt("title"));
                $this->tpl->setVariable("TEXT_AUTHOR", $this->lng->txt("author"));
                $this->tpl->setVariable("TEXT_DESCRIPTION", $this->lng->txt("description"));
                $this->tpl->setVariable("TEXT_QUESTION", $this->lng->txt("question"));
                $this->tpl->setVariable("TEXT_OBLIGATORY", $this->lng->txt("obligatory"));
                if ($this->object->getObligatory())
                {
                        $this->tpl->setVariable("CHECKED_OBLIGATORY", " checked=\"checked\"");
                }
                $this->tpl->setVariable("TEXT_QUESTION_TYPE", $this->lng->txt("questiontype"));
                $this->tpl->setVariable("SAVE",$this->lng->txt("save"));
                $this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
                $this->tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TEXT_QUESTION_TYPE", $this->lng->txt($this->getQuestionType()));
                $this->tpl->parseCurrentBlock();
                include_once "./Services/RTE/classes/class.ilRTE.php";
                $rtestring = ilRTE::_getRTEClassname();
                include_once "./Services/RTE/classes/class.$rtestring.php";
                $rte = new $rtestring();
                $rte->addPlugin("latex");
                $rte->addButton("latex");
                $rte->removePlugin("ibrowser");
                include_once "./classes/class.ilObject.php";
                $obj_id = $_GET["q_id"];
                $obj_type = ilObject::_lookupType($_GET["ref_id"], TRUE);
                $rte->addRTESupport($obj_id, $obj_type, "survey");
  }

Here is the call graph for this function:

SurveyMetricQuestionGUI::getQuestionType (  ) 

Returns the question type string.

Returns the question type string

Returns:
string The question type string public

Definition at line 70 of file class.SurveyMetricQuestionGUI.php.

        {
                return "SurveyMetricQuestion";
        }

SurveyMetricQuestionGUI::outCumulatedResultsDetails ( &$  cumulated_results,
$  counter 
)

Definition at line 316 of file class.SurveyMetricQuestionGUI.php.

References $data, and $key.

        {
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("question"));
                $questiontext = $this->object->getQuestiontext();
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("question_type"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $this->lng->txt($this->getQuestionType()));
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("users_answered"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $cumulated_results["USERS_ANSWERED"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("users_skipped"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $cumulated_results["USERS_SKIPPED"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("subtype"));
                switch ($this->object->getSubType())
                {
                        case SUBTYPE_NON_RATIO:
                                $this->tpl->setVariable("TEXT_OPTION_VALUE", $this->lng->txt("non_ratio"));
                                break;
                        case SUBTYPE_RATIO_NON_ABSOLUTE:
                                $this->tpl->setVariable("TEXT_OPTION_VALUE", $this->lng->txt("ratio_non_absolute"));
                                break;
                        case SUBTYPE_RATIO_ABSOLUTE:
                                $this->tpl->setVariable("TEXT_OPTION_VALUE", $this->lng->txt("ratio_absolute"));
                                break;
                }
                $this->tpl->parseCurrentBlock();
                

                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("mode"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $cumulated_results["MODE"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("mode_nr_of_selections"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $cumulated_results["MODE_NR_OF_SELECTIONS"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("median"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $cumulated_results["MEDIAN"]);
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("arithmetic_mean"));
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $cumulated_results["ARITHMETIC_MEAN"]);
                $this->tpl->parseCurrentBlock();

                $this->tpl->setCurrentBlock("detail_row");
                $this->tpl->setVariable("TEXT_OPTION", $this->lng->txt("values"));
                $values = "";
                if (is_array($cumulated_results["values"]))
                {
                        foreach ($cumulated_results["values"] as $key => $value)
                        {
                                $values .= "<li>" . $this->lng->txt("value") . ": " . "<span class=\"bold\">" . $value["value"] . "</span><br />" .
                                        $this->lng->txt("value_nr_entered") . ": " . "<span class=\"bold\">" . $value["selected"] . "</span><br />" .
                                        $this->lng->txt("percentage_of_entered_values") . ": " . "<span class=\"bold\">" . sprintf("%.2f", 100*$value["percentage"]) . "</span></li>";
                        }
                }
                $values = "<ol>$values</ol>";
                $this->tpl->setVariable("TEXT_OPTION_VALUE", $values);
                $this->tpl->parseCurrentBlock();
                
                // display chart for metric question for array $eval["values"]
                $this->tpl->setVariable("TEXT_CHART", $this->lng->txt("chart"));
                $this->tpl->setVariable("ALT_CHART", $data["title"] . "( " . $this->lng->txt("chart") . ")");
                $this->tpl->setVariable("CHART","./survey/displaychart.php?grName=" . urlencode($this->object->getTitle()) . 
                        "&type=bars" . 
                        "&x=" . urlencode($this->lng->txt("answers")) . 
                        "&y=" . urlencode($this->lng->txt("users_answered")) . 
                        "&arr=".base64_encode(serialize($cumulated_results["values"])));
                
                $this->tpl->setCurrentBlock("detail");
                $this->tpl->setVariable("QUESTION_TITLE", "$counter. ".$this->object->getTitle());
                $this->tpl->parseCurrentBlock();
        }

SurveyMetricQuestionGUI::outWorkingForm ( $  working_data = "",
$  question_title = 1,
$  error_message = "" 
)

Creates the question output form for the learner.

Creates the question output form for the learner

public

Definition at line 237 of file class.SurveyMetricQuestionGUI.php.

References SurveyQuestion::_getInternalLinkHref().

Referenced by preview().

        {
                if (count($this->object->material))
                {
                        $this->tpl->setCurrentBlock("material_metric");
                        include_once "./survey/classes/class.SurveyQuestion.php";
                        $href = SurveyQuestion::_getInternalLinkHref($this->object->material["internal_link"]);
                        $this->tpl->setVariable("TEXT_MATERIAL", $this->lng->txt("material") . ": <a href=\"$href\" target=\"content\">" . $this->object->material["title"]. "</a> ");
                        $this->tpl->parseCurrentBlock();
                }

                if (strlen($this->object->getMinimum()))
                {
                        $this->tpl->setCurrentBlock("minimum");
                        $this->tpl->setVariable("TEXT_MINIMUM", $this->lng->txt("minimum"));
                        $this->tpl->setVariable("VALUE_MINIMUM", $this->object->getMinimum());
                        $this->tpl->parseCurrentBlock();
                }
                if (strlen($this->object->getMaximum()))
                {
                        $this->tpl->setCurrentBlock("maximum");
                        $this->tpl->setVariable("TEXT_MAXIMUM", $this->lng->txt("maximum"));
                        $this->tpl->setVariable("VALUE_MAXIMUM", $this->object->getMaximum());
                        $this->tpl->parseCurrentBlock();
                }

                $this->tpl->setCurrentBlock("question_data_metric");
                $questiontext = $this->object->getQuestiontext();
                $this->tpl->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                if (! $this->object->getObligatory())
                {
                        $this->tpl->setVariable("OBLIGATORY_TEXT", $this->lng->txt("survey_question_optional"));
                }
                if ($question_title)
                {
                        $this->tpl->setVariable("QUESTION_TITLE", $this->object->getTitle());
                }
                $this->tpl->setVariable("TEXT_ANSWER", $this->lng->txt("answer"));
                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                if (is_array($working_data))
                {
                        $this->tpl->setVariable("VALUE_METRIC", $working_data[0]["value"]);
                }

                if (strlen($this->object->getMaximum())>1) {
                        $len = strlen($this->object->getMaximum()) + 2;
                        $this->tpl->setVariable("INPUT_SIZE", $len);
                }
                else {
                        $this->tpl->setVariable("INPUT_SIZE", 10);
                }

                if (strcmp($error_message, "") != 0)
                {
                        $this->tpl->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
                }
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

SurveyMetricQuestionGUI::preview (  ) 

Creates a preview of the question.

Creates a preview of the question

private

Definition at line 303 of file class.SurveyMetricQuestionGUI.php.

References outWorkingForm().

        {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_preview.html", true);
                $this->tpl->addBlockFile("METRIC", "metric", "tpl.il_svy_out_metric.html", true);
                $this->outWorkingForm();
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

SurveyMetricQuestionGUI::setQuestionTabs (  ) 

Definition at line 311 of file class.SurveyMetricQuestionGUI.php.

References SurveyQuestionGUI::setQuestionTabsForClass().

        {
                $this->setQuestionTabsForClass("surveymetricquestiongui");
        }

Here is the call graph for this function:

SurveyMetricQuestionGUI::SurveyMetricQuestionGUI ( $  id = -1  ) 

SurveyMetricQuestionGUI constructor.

The constructor takes possible arguments an creates an instance of the SurveyMetricQuestionGUI object.

Parameters:
integer $id The database id of a metric question object public

Definition at line 48 of file class.SurveyMetricQuestionGUI.php.

References $id, and SurveyQuestionGUI::SurveyQuestionGUI().

  {
                $this->SurveyQuestionGUI();
                include_once "./survey/classes/class.SurveyMetricQuestion.php";
                $this->object = new SurveyMetricQuestion();
                if ($id >= 0)
                {
                        $this->object->loadFromDb($id);
                }
        }

Here is the call graph for this function:

SurveyMetricQuestionGUI::writePostData (  ) 

Evaluates a posted edit form and writes the form data in the question object.

Evaluates a posted edit form and writes the form data in the question object

Returns:
integer A positive value, if one of the required fields wasn't set, else 0 private

Definition at line 178 of file class.SurveyMetricQuestionGUI.php.

References $_POST, $result, ilObjAdvancedEditing::_getUsedHTMLTagsAsString(), and ilUtil::stripSlashes().

        {
    $result = 0;
    if ((!$_POST["title"]) or (!$_POST["author"]) or (!$_POST["question"]))
      $result = 1;

    // Set the question id from a hidden form parameter
    if ($_POST["id"] > 0)
      $this->object->setId($_POST["id"]);

                include_once "./classes/class.ilUtil.php";      
                $this->object->setTitle(ilUtil::stripSlashes($_POST["title"]));
    $this->object->setAuthor(ilUtil::stripSlashes($_POST["author"]));
    $this->object->setDescription(ilUtil::stripSlashes($_POST["description"]));
                if (strlen($_POST["material"]))
                {
                        $this->object->setMaterial($_POST["material"], 0, ilUtil::stripSlashes($_POST["material_title"]));
                }
                include_once "./classes/class.ilObjAdvancedEditing.php";
                $questiontext = ilUtil::stripSlashes($_POST["question"], true, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("survey"));
                $this->object->setQuestiontext($questiontext);
                if ($_POST["obligatory"])
                {
                        $this->object->setObligatory(1);
                }
                else
                {
                        $this->object->setObligatory(0);
                }
                $this->object->setSubtype($_POST["type"]);
                $minimum = $_POST["minimum"];
                if ($this->object->getSubtype() > 3)
                {
                        if ($minimum < 0)
                        {
                                $this->errormessage = $this->lng->txt("ratio_scale_ge_zero");
                                $result = 1;
                        }
                }
                $this->object->setMinimum($minimum);
                $this->object->setMaximum($_POST["maximum"]);

                if ($saved) {
                        // If the question was saved automatically before an upload, we have to make
                        // sure, that the state after the upload is saved. Otherwise the user could be
                        // irritated, if he presses cancel, because he only has the question state before
                        // the upload process.
                        $this->object->saveToDb();
                }
    return $result;
  }

Here is the call graph for this function:

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 13:52:48 for ILIAS Release_3_7_x_branch .rev 46817 by  doxygen 1.7.1