Public Member Functions

SurveyNominalQuestionGUI Class Reference

Nominal survey question GUI representation. More...

Inheritance diagram for SurveyNominalQuestionGUI:
Collaboration diagram for SurveyNominalQuestionGUI:

Public Member Functions

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

Detailed Description

Nominal survey question GUI representation.

The SurveyNominalQuestionGUI class encapsulates the GUI representation for nominal survey question types.

Author:
Helmut Schottmüller <helmut.schottmueller@mac.com>
Version:
Id:
class.SurveyNominalQuestionGUI.php 10882 2006-05-17 22:11:38Z hschottm

class.SurveyNominalQuestionGUI.php Survey

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


Member Function Documentation

SurveyNominalQuestionGUI::categories ( add = false  ) 

Creates the form to edit the question categories.

Creates the form to edit the question categories

private

Definition at line 415 of file class.SurveyNominalQuestionGUI.php.

References $_POST, $_SESSION, $add, ilUtil::getImagePath(), ilUtil::prepareFormOutput(), and sendInfo().

        {
                if ($this->object->getId() < 1) 
                {
                        sendInfo($this->lng->txt("fill_out_all_required_fields_add_category"), true);
                        $this->ctrl->redirect($this, "editQuestion");
                }
                if (strcmp($this->ctrl->getCmd(), "categories") == 0) $_SESSION["spl_modified"] = false;
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_nominal_answers.html", true);
    // output of existing single response answers
                for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) 
                {
                        $this->tpl->setCurrentBlock("cat_selector");
                        $this->tpl->setVariable("CATEGORY_ORDER", $i);
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->setCurrentBlock("categories");
                        $category = $this->object->categories->getCategory($i);
                        $this->tpl->setVariable("CATEGORY_ORDER", $i);
                        $this->tpl->setVariable("CATEGORY_NUMBER", $i+1);
                        $this->tpl->setVariable("VALUE_CATEGORY", $category);
                        $this->tpl->setVariable("TEXT_CATEGORY", $this->lng->txt("category"));
                        $this->tpl->parseCurrentBlock();
                }
                
                if ($add)
                {
                        $nrOfCategories = $_POST["nrOfCategories"];
                        if ($nrOfCategories < 1) $nrOfCategories = 1;
                        // Create template for a new category
                        for ($i = 1; $i <= $nrOfCategories; $i++)
                        {
                                $this->tpl->setCurrentBlock("categories");
                                $this->tpl->setVariable("CATEGORY_ORDER", $this->object->categories->getCategoryCount() + $i - 1);
                                $this->tpl->setVariable("TEXT_CATEGORY", $this->lng->txt("category"));
                                $this->tpl->parseCurrentBlock();
                        }
                }

                if (is_array($_SESSION["spl_move"]))
                {
                        if (count($_SESSION["spl_move"]))
                        {
                                $this->tpl->setCurrentBlock("move_buttons");
                                $this->tpl->setVariable("INSERT_BEFORE", $this->lng->txt("insert_before"));
                                $this->tpl->setVariable("INSERT_AFTER", $this->lng->txt("insert_after"));
                                $this->tpl->parseCurrentBlock();
                        }
                }
                
                include_once "./classes/class.ilUtil.php";
                if ($this->object->categories->getCategoryCount() == 0)
                {
                        if (!$add)
                        {
                                $this->tpl->setCurrentBlock("nocategories");
                                $this->tpl->setVariable("NO_CATEGORIES", $this->lng->txt("question_contains_no_categories"));
                                $this->tpl->parseCurrentBlock();
                        }
                }
                else
                {
                        $this->tpl->setCurrentBlock("selectall");
                        $this->tpl->setVariable("SELECT_ALL", $this->lng->txt("select_all"));
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->setCurrentBlock("existingcategories");
                        $this->tpl->setVariable("DELETE", $this->lng->txt("delete"));
                        $this->tpl->setVariable("MOVE", $this->lng->txt("move"));
                        $this->tpl->setVariable("ARROW", "<img src=\"" . ilUtil::getImagePath("arrow_downright.gif") . "\" alt=\"".$this->lng->txt("arrow_downright")."\">");
                        $this->tpl->parseCurrentBlock();
                }

                for ($i = 1; $i < 10; $i++)
                {
                        $this->tpl->setCurrentBlock("numbers");
                        $this->tpl->setVariable("VALUE_NUMBER", $i);
                        if ($i == 1)
                        {
                                $this->tpl->setVariable("TEXT_NUMBER", $i . " " . $this->lng->txt("category"));
                        }
                        else
                        {
                                $this->tpl->setVariable("TEXT_NUMBER", $i . " " . $this->lng->txt("categories"));
                        }
                        $this->tpl->parseCurrentBlock();
                }
                
                $this->tpl->setCurrentBlock("adm_content");
                $this->tpl->setVariable("FORM_ACTION", $this->ctrl->getFormAction($this));
                $this->tpl->setVariable("VALUE_ADD_CATEGORY", $this->lng->txt("add"));
                $this->tpl->setVariable("SAVE", $this->lng->txt("save"));
                if ($_SESSION["spl_modified"])
                {
                        $this->tpl->setVariable("FORM_DATA_MODIFIED_PRESS_SAVE", $this->lng->txt("form_data_modified_press_save"));
                }
                $this->tpl->setVariable("QUESTION_TEXT", ilUtil::prepareFormOutput($this->object->getQuestiontext()));
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

SurveyNominalQuestionGUI::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 83 of file class.SurveyNominalQuestionGUI.php.

References $key, and SurveyQuestion::_getInternalLinkHref().

        {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_nominal.html", true);
          $this->tpl->addBlockFile("OTHER_QUESTION_DATA", "other_question_data", "tpl.il_svy_qpl_other_question_data.html", true);
                $this->tpl->setVariable("TEXT_ORIENTATION", $this->lng->txt("orientation"));
                switch ($this->object->getOrientation())
                {
                        case 0:
                                $this->tpl->setVariable("SELECTED_VERTICAL", " selected=\"selected\"");
                                break;
                        case 1:
                                $this->tpl->setVariable("SELECTED_HORIZONTAL", " selected=\"selected\"");
                                break;
                        case 2:
                                $this->tpl->setVariable("SELECTED_COMBOBOX", " selected=\"selected\"");
                                break;
                }
                $this->tpl->setVariable("TXT_VERTICAL", $this->lng->txt("vertical"));
                $this->tpl->setVariable("TXT_HORIZONTAL", $this->lng->txt("horizontal"));
                if ($this->object->getSubtype() == SUBTYPE_MCSR)
                {
                        $this->tpl->setVariable("TXT_COMBOBOX", $this->lng->txt("combobox"));
                }

                $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();
                $questiontext = str_replace("<br />", "\n", $questiontext);
                $this->tpl->setVariable("VALUE_QUESTION", htmlspecialchars($questiontext));
                $this->tpl->setVariable("TXT_SR", $this->lng->txt("multiple_choice_single_response"));
                $this->tpl->setVariable("TXT_MR", $this->lng->txt("multiple_choice_multiple_response"));
                if ($this->object->getSubtype() == SUBTYPE_MCSR)
                {
                        $this->tpl->setVariable("SELECTED_SR", " selected=\"selected\"");
                }
                else
                {
                        $this->tpl->setVariable("SELECTED_MR", " 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_QUESTION_TYPE", $this->lng->txt("questiontype"));
                $this->tpl->setVariable("TEXT_OBLIGATORY", $this->lng->txt("obligatory"));
                if ($this->object->getObligatory())
                {
                        $this->tpl->setVariable("CHECKED_OBLIGATORY", " checked=\"checked\"");
                }
                $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->parseCurrentBlock();
  }

Here is the call graph for this function:

SurveyNominalQuestionGUI::getQuestionType (  ) 

Returns the question type string.

Returns the question type string

Returns:
string The question type string public

Definition at line 71 of file class.SurveyNominalQuestionGUI.php.

        {
                return "qt_nominal";
        }

SurveyNominalQuestionGUI::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 178 of file class.SurveyNominalQuestionGUI.php.

References $row, and SurveyQuestion::_getInternalLinkHref().

Referenced by preview().

        {
                if (count($this->object->material))
                {
                        $this->tpl->setCurrentBlock("material_nominal");
                        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();
                }
                switch ($this->object->getOrientation())
                {
                        case 0:
                                // vertical orientation
                                for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
                                        $category = $this->object->categories->getCategory($i);
                                        if ($this->object->getSubtype() == SUBTYPE_MCSR)
                                        {
                                                $this->tpl->setCurrentBlock("nominal_row_sr");
                                                $this->tpl->setVariable("TEXT_NOMINAL", $category);
                                                $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                                if (is_array($working_data))
                                                {
                                                        if (strcmp($working_data[0]["value"], "") != 0)
                                                        {
                                                                if ($working_data[0]["value"] == $i)
                                                                {
                                                                        $this->tpl->setVariable("CHECKED_NOMINAL", " checked=\"checked\"");
                                                                }
                                                        }
                                                }
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        else
                                        {
                                                $this->tpl->setCurrentBlock("nominal_row_mr");
                                                $this->tpl->setVariable("TEXT_NOMINAL", $category);
                                                $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                                if (is_array($working_data))
                                                {
                                                        foreach ($working_data as $row)
                                                        {
                                                                if (strcmp($row["value"], "") != 0)
                                                                {
                                                                        if ($row["value"] == $i)
                                                                        {
                                                                                $this->tpl->setVariable("CHECKED_NOMINAL", " checked=\"checked\"");
                                                                        }
                                                                }
                                                        }
                                                }
                                                $this->tpl->parseCurrentBlock();
                                        }
                                }
                                break;
                        case 1:
                                // horizontal orientation
                                if ($this->object->getSubtype() == SUBTYPE_MCSR)
                                {
                                        for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) 
                                        {
                                                $category = $this->object->categories->getCategory($i);
                                                $this->tpl->setCurrentBlock("radio_col_nominal");
                                                $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                                if (is_array($working_data))
                                                {
                                                        if (strcmp($working_data[0]["value"], "") != 0)
                                                        {
                                                                if ($working_data[0]["value"] == $i)
                                                                {
                                                                        $this->tpl->setVariable("CHECKED_NOMINAL", " checked=\"checked\"");
                                                                }
                                                        }
                                                }
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) 
                                        {
                                                $category = $this->object->categories->getCategory($i);
                                                $this->tpl->setCurrentBlock("text_col_nominal");
                                                $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                                $this->tpl->setVariable("TEXT_NOMINAL", $category);
                                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                                $this->tpl->parseCurrentBlock();
                                        }
                                }
                                else
                                {
                                        for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) 
                                        {
                                                $category = $this->object->categories->getCategory($i);
                                                $this->tpl->setCurrentBlock("checkbox_col_nominal");
                                                $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                                if (is_array($working_data))
                                                {
                                                        if (strcmp($working_data[0]["value"], "") != 0)
                                                        {
                                                                if ($working_data[0]["value"] == $i)
                                                                {
                                                                        $this->tpl->setVariable("CHECKED_NOMINAL", " checked=\"checked\"");
                                                                }
                                                        }
                                                }
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) 
                                        {
                                                $category = $this->object->categories->getCategory($i);
                                                $this->tpl->setCurrentBlock("text_col_nominal_mr");
                                                $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                                $this->tpl->setVariable("TEXT_NOMINAL", $category);
                                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                                $this->tpl->parseCurrentBlock();
                                        }
                                }
                                break;
                        case 2:
                                // combobox output
                                for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) 
                                {
                                        $category = $this->object->categories->getCategory($i);
                                        $this->tpl->setCurrentBlock("comborow_nominal");
                                        $this->tpl->setVariable("TEXT_NOMINAL", $category);
                                        $this->tpl->setVariable("VALUE_NOMINAL", $i);
                                        if (is_array($working_data))
                                        {
                                                if (strcmp($working_data[0]["value"], "") != 0)
                                                {
                                                        if ($working_data[0]["value"] == $i)
                                                        {
                                                                $this->tpl->setVariable("SELECTED_NOMINAL", " selected=\"selected\"");
                                                        }
                                                }
                                        }
                                        $this->tpl->parseCurrentBlock();
                                }
                                $this->tpl->setCurrentBlock("combooutput_nominal");
                                $this->tpl->setVariable("QUESTION_ID", $this->object->getId());
                                $this->tpl->setVariable("SELECT_OPTION", $this->lng->txt("select_option"));
                                $this->tpl->setVariable("TEXT_SELECTION", $this->lng->txt("selection"));
                                $this->tpl->parseCurrentBlock();
                                break;
                }
                
                $this->tpl->setCurrentBlock("question_data_nominal");
                if (strcmp($error_message, "") != 0)
                {
                        $this->tpl->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
                }
                $this->tpl->setVariable("QUESTIONTEXT", $this->object->getQuestiontext());
                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->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

SurveyNominalQuestionGUI::preview (  ) 

Creates a preview of the question.

Creates a preview of the question

private

Definition at line 350 of file class.SurveyNominalQuestionGUI.php.

References outWorkingForm().

        {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_preview.html", true);
                $this->tpl->addBlockFile("NOMINAL", "nominal", "tpl.il_svy_out_nominal.html", true);
                $this->outWorkingForm();
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

SurveyNominalQuestionGUI::setQuestionTabs (  ) 

Definition at line 513 of file class.SurveyNominalQuestionGUI.php.

References SurveyQuestionGUI::setQuestionTabsForClass().

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

Here is the call graph for this function:

SurveyNominalQuestionGUI::SurveyNominalQuestionGUI ( id = -1  ) 

SurveyNominalQuestionGUI constructor.

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

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

Definition at line 49 of file class.SurveyNominalQuestionGUI.php.

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

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

Here is the call graph for this function:

SurveyNominalQuestionGUI::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 366 of file class.SurveyNominalQuestionGUI.php.

References $_POST, $result, 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"]));
                }
                $this->object->setSubtype($_POST["type"]);
                $this->object->setOrientation($_POST["orientation"]);
                $questiontext = ilUtil::stripSlashes($_POST["question"]);
                $questiontext = str_replace("\n", "<br />", $questiontext);
    $this->object->setQuestiontext($questiontext);
                if ($_POST["obligatory"])
                {
                        $this->object->setObligatory(1);
                }
                else
                {
                        $this->object->setObligatory(0);
                }

                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("", false);
                }
    return $result;
  }

Here is the call graph for this function:


The documentation for this class was generated from the following file: