Public Member Functions

SurveyTextQuestionGUI Class Reference

Text survey question GUI representation. More...

Inheritance diagram for SurveyTextQuestionGUI:
Collaboration diagram for SurveyTextQuestionGUI:

Public Member Functions

 SurveyTextQuestionGUI ($id=-1)
 SurveyTextQuestionGUI 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.
 setQuestionTabs ()

Detailed Description

Text survey question GUI representation.

The SurveyTextQuestionGUI class encapsulates the GUI representation for text survey question types.

Author:
Helmut Schottmüller <hschottm@tzi.de>
Version:
Id:
class.SurveyTextQuestionGUI.php 6510 2005-01-16 12:04:26Z hschottm

class.SurveyTextQuestionGUI.php Survey

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


Member Function Documentation

SurveyTextQuestionGUI::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 81 of file class.SurveyTextQuestionGUI.php.

References SurveyQuestion::_getInternalLinkHref().

                          {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_text.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))
                {
                        $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());
                if ($this->object->getMaxChars() > 0)
                {
                        $this->tpl->setVariable("VALUE_MAXCHARS", $this->object->getMaxChars());
                }
                $questiontext = $this->object->getQuestiontext();
                $questiontext = str_replace("<br />", "\n", $questiontext);
                $this->tpl->setVariable("VALUE_QUESTION", htmlspecialchars($questiontext));
                $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_MAXCHARS", $this->lng->txt("maxchars"));
                $this->tpl->setVariable("DESCRIPTION_MAXCHARS", $this->lng->txt("description_maxchars"));
                $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("SAVE",$this->lng->txt("save"));
                $this->tpl->setVariable("CANCEL",$this->lng->txt("cancel"));
                $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:

SurveyTextQuestionGUI::getQuestionType (  ) 

Returns the question type string.

Returns the question type string

Returns:
string The question type string public

Definition at line 69 of file class.SurveyTextQuestionGUI.php.

        {
                return "qt_text";
        }

SurveyTextQuestionGUI::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 151 of file class.SurveyTextQuestionGUI.php.

References SurveyQuestion::_getInternalLinkHref().

Referenced by preview().

        {
                if (count($this->object->material))
                {
                        $this->tpl->setCurrentBlock("material_text");
                        $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();
                }
                $this->tpl->setCurrentBlock("question_data_text");
                $this->tpl->setVariable("QUESTIONTEXT", $this->object->getQuestiontext());
                if ($this->object->getObligatory())
                {
                        $this->tpl->setVariable("OBLIGATORY_TEXT", $this->lng->txt("survey_question_obligatory"));
                }
                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_ANSWER", $working_data[0]["textanswer"]);
                }
                if (strcmp($error_message, "") != 0)
                {
                        $this->tpl->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
                }
                if ($this->object->getMaxChars())
                {
                        $this->tpl->setVariable("TEXT_MAXCHARS", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxChars()));
                }
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

SurveyTextQuestionGUI::preview (  ) 

Creates a preview of the question.

Creates a preview of the question

private

Definition at line 194 of file class.SurveyTextQuestionGUI.php.

References outWorkingForm().

        {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_svy_qpl_preview.html", true);
                $this->tpl->addBlockFile("TEXT", "text", "tpl.il_svy_out_text.html", true);
                $this->outWorkingForm();
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

SurveyTextQuestionGUI::setQuestionTabs (  ) 

Definition at line 249 of file class.SurveyTextQuestionGUI.php.

References SurveyQuestionGUI::setQuestionTabsForClass().

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

Here is the call graph for this function:

SurveyTextQuestionGUI::SurveyTextQuestionGUI ( id = -1  ) 

SurveyTextQuestionGUI constructor.

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

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

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

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

  {
                $this->SurveyQuestionGUI();
                $this->object = new SurveyTextQuestion();
                if ($id >= 0)
                {
                        $this->object->loadFromDb($id);
                }
        }

Here is the call graph for this function:

SurveyTextQuestionGUI::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 210 of file class.SurveyTextQuestionGUI.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"]);

    $this->object->setTitle(ilUtil::stripSlashes($_POST["title"]));
    $this->object->setAuthor(ilUtil::stripSlashes($_POST["author"]));
    $this->object->setDescription(ilUtil::stripSlashes($_POST["description"]));
                $this->object->setMaxChars(ilUtil::stripSlashes($_POST["maxchars"]));
                if (strlen($_POST["material"]))
                {
                        $this->object->setMaterial($_POST["material"], 0, ilUtil::stripSlashes($_POST["material_title"]));
                }
                $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();
                }
    return $result;
  }

Here is the call graph for this function:


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