Public Member Functions

assNumericGUI Class Reference

Numeric question GUI representation. More...

Inheritance diagram for assNumericGUI:
Collaboration diagram for assNumericGUI:

Public Member Functions

 assNumericGUI ($id=-1)
 assNumericGUI constructor
 getCommand ($cmd)
 editQuestion ()
 Creates an output of the edit form for the question.
 checkInput ()
 check input fields
 checkRange ()
 Checks the range limits.
 writePostData ()
 Evaluates a posted edit form and writes the form data in the question object.
 outQuestionForTest ($formaction, $active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE)
 getSolutionOutput ($active_id, $pass=NULL, $graphicalOutput=FALSE, $result_output=FALSE, $show_question_only=TRUE)
 getPreview ()
 getTestOutput ($active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE)
 addSuggestedSolution ()
 Handler for cmd[addSuggestedSolution] to add a suggested solution for the question.
 getQuestionType ()
 Returns the question type string.

Detailed Description

Numeric question GUI representation.

The assNumericGUI class encapsulates the GUI representation for numeric questions.

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

class.assNumericGUI.php Assessment

Definition at line 39 of file class.assNumericGUI.php.


Member Function Documentation

assNumericGUI::addSuggestedSolution (  ) 

Handler for cmd[addSuggestedSolution] to add a suggested solution for the question.

Handler for cmd[addSuggestedSolution] to add a suggested solution for the question

public

Reimplemented from assQuestionGUI.

Definition at line 437 of file class.assNumericGUI.php.

References $_GET, $_POST, $_SESSION, checkInput(), editQuestion(), assQuestionGUI::getErrorMessage(), assQuestionGUI::getQuestionTemplate(), sendInfo(), and writePostData().

        {
                $_SESSION["subquestion_index"] = 0;
                if ($_POST["cmd"]["addSuggestedSolution"])
                {
                        if ($this->writePostData())
                        {
                                sendInfo($this->getErrorMessage());
                                $this->editQuestion();
                                return;
                        }
                        if (!$this->checkInput())
                        {
                                sendInfo($this->lng->txt("fill_out_all_required_fields_add_answer"));
                                $this->editQuestion();
                                return;
                        }
                }
                $this->object->saveToDb();
                $_GET["q_id"] = $this->object->getId();
                $this->tpl->setVariable("HEADER", $this->object->getTitle());
                $this->getQuestionTemplate();
                parent::addSuggestedSolution();
        }

Here is the call graph for this function:

assNumericGUI::assNumericGUI ( id = -1  ) 

assNumericGUI constructor

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

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

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

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

        {
                $this->assQuestionGUI();
                include_once "./assessment/classes/class.assNumeric.php";
                $this->object = new assNumeric();
                if ($id >= 0)
                {
                        $this->object->loadFromDb($id);
                }
        }

Here is the call graph for this function:

assNumericGUI::checkInput (  ) 

check input fields

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

References $_POST, $cmd, and $key.

Referenced by addSuggestedSolution().

        {
                $cmd = $this->ctrl->getCmd();

                if ((!$_POST["title"]) or (!$_POST["author"]) or (!$_POST["question"]))
                {
//echo "<br>checkInput1:FALSE";
                        return false;
                }
                foreach ($_POST as $key => $value)
                {
                        if (preg_match("/range_(\d+)/", $key, $matches))
                        {
                                if (!$value)
                                {
//echo "<br>checkInput2:FALSE";
                                        return false;
                                }
                        }
                }

                return true;
        }

Here is the caller graph for this function:

assNumericGUI::checkRange (  ) 

Checks the range limits.

Checks the Range limits Upper and Lower for their correctness

Returns:
boolean private

Definition at line 211 of file class.assNumericGUI.php.

References $_POST.

        {
                if (is_numeric($_POST["rang_lower_limit"]) AND is_numeric ($_POST ["range_upper_limit"]))
                {
                        if ($_POST ["rang_lower_limit"] < $_POST ["range_upper_limit"])
                        {
                                return true;
                        }
                        else 
                        {
                                return false;
                        }
                }
                else 
                {
                        return false;
                }
        }

assNumericGUI::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 80 of file class.assNumericGUI.php.

References $_GET, $counter, $key, $obj_id, assQuestion::_getInternalLinkHref(), ilRTE::_getRTEClassname(), ilObject::_lookupType(), assQuestionGUI::getQuestionTemplate(), assQuestionGUI::outOtherQuestionData(), and ilUtil::prepareFormOutput().

Referenced by addSuggestedSolution().

        {
                $javascript = "<script type=\"text/javascript\">function initialSelect() {\n%s\n}</script>";
                $this->getQuestionTemplate();
                $this->tpl->addBlockFile("QUESTION_DATA", "question_data", "tpl.il_as_qpl_numeric.html", true);
                // call to other question data i.e. estimated working time block
                $this->outOtherQuestionData();

                $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();
                }
                
                if ($this->object->getRangeCount() == 0)
                {
                        $this->object->addRange(0.0, 0.0, 0);
                }
                
                $counter = 0;
                foreach ($this->object->ranges as $range)
                {
                        $this->tpl->setCurrentBlock("ranges");
                        $this->tpl->setVariable("COUNTER", $counter);
                        $this->tpl->setVariable("TEXT_RANGE", $this->lng->txt("range"));
                        if (strlen($range->getPoints())) $this->tpl->setVariable("VALUE_POINTS", " value=\"" . $range->getPoints() . "\"");
                        if (strlen($range->getLowerLimit())) $this->tpl->setVariable("VALUE_LOWER_LIMIT", " value=\"" . $range->getLowerLimit() . "\"");
                        if (strlen($range->getUpperLimit())) $this->tpl->setVariable("VALUE_UPPER_LIMIT", " value=\"" . $range->getUpperLimit() . "\"");
                        $this->tpl->setVariable("TEXT_RANGE_LOWER_LIMIT", $this->lng->txt("range_lower_limit"));
                        $this->tpl->setVariable("TEXT_RANGE_UPPER_LIMIT", $this->lng->txt("range_upper_limit"));
                        $this->tpl->setVariable("TEXT_POINTS", $this->lng->txt("points"));
                        $this->tpl->parseCurrentBlock();
                        $counter++;
                }
                
                $this->tpl->setCurrentBlock("question_data");
                $this->tpl->setVariable("NUMERIC_ID", $this->object->getId());
                $this->tpl->setVariable("VALUE_NUMERIC_TITLE", ilUtil::prepareFormOutput($this->object->getTitle()));
                $this->tpl->setVariable("VALUE_NUMERIC_COMMENT", ilUtil::prepareFormOutput($this->object->getComment()));
                $this->tpl->setVariable("VALUE_NUMERIC_AUTHOR", ilUtil::prepareFormOutput($this->object->getAuthor()));
                $questiontext = $this->object->getQuestion();
                $this->tpl->setVariable("VALUE_QUESTION", ilUtil::prepareFormOutput($this->object->prepareTextareaOutput($questiontext)));
                $this->tpl->setVariable("TEXT_TITLE", $this->lng->txt("title"));
                $this->tpl->setVariable("TEXT_AUTHOR", $this->lng->txt("author"));
                $this->tpl->setVariable("TEXT_COMMENT", $this->lng->txt("description"));
                $this->tpl->setVariable("TEXT_QUESTION", $this->lng->txt("question"));
                $this->tpl->setVariable("TEXT_SOLUTION_HINT", $this->lng->txt("solution_hint"));
                $this->tpl->setVariable("TEXT_MAXCHARS", $this->lng->txt("maxchars"));
                $this->tpl->setVariable("VALUE_MAXCHARS", $this->object->getMaxChars());
                if (count($this->object->suggested_solutions))
                {
                        $solution_array = $this->object->getSuggestedSolution(0);
                        include_once "./assessment/classes/class.assQuestion.php";
                        $href = assQuestion::_getInternalLinkHref($solution_array["internal_link"]);
                        $this->tpl->setVariable("TEXT_VALUE_SOLUTION_HINT", " <a href=\"$href\" target=\"content\">" . $this->lng->txt("solution_hint"). "</a> ");
                        $this->tpl->setVariable("BUTTON_REMOVE_SOLUTION", $this->lng->txt("remove"));
                        $this->tpl->setVariable("BUTTON_ADD_SOLUTION", $this->lng->txt("change"));
                        $this->tpl->setVariable("VALUE_SOLUTION_HINT", $solution_array["internal_link"]);
                }
                else
                {
                        $this->tpl->setVariable("BUTTON_ADD_SOLUTION", $this->lng->txt("add"));
                }
                $this->tpl->setVariable("SAVE",$this->lng->txt("save"));
                $this->tpl->setVariable("SAVE_EDIT", $this->lng->txt("save_edit"));
                $this->tpl->setVariable("CANCEL",$this->lng->txt("cancel"));
                $this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
                $this->ctrl->setParameter($this, "sel_question_types", "assNumeric");
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TEXT_QUESTION_TYPE", $this->lng->txt("assNumeric"));
                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");
                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, "assessment");
                
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("adm_content");
                // $this->tpl->setVariable("BODY_ATTRIBUTES", " onload=\"initialSelect();\""); 
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assNumericGUI::getCommand ( cmd  ) 

Reimplemented from assQuestionGUI.

Definition at line 62 of file class.assNumericGUI.php.

References $cmd.

        {
                if (substr($cmd, 0, 6) == "delete")
                {
                        $cmd = "delete";
                }

                return $cmd;
        }

assNumericGUI::getPreview (  ) 

Definition at line 388 of file class.assNumericGUI.php.

        {
                // generate the question output
                include_once "./classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_as_qpl_numeric_output.html", TRUE, TRUE, TRUE);
                $template->setVariable("NUMERIC_SIZE", $this->object->getMaxChars());
                $questiontext = $this->object->getQuestion();
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $questionoutput = $template->get();
                $questionoutput = preg_replace("/<div[^>]*?>(.*)<\/div>/is", "\\1", $questionoutput);
                return $questionoutput;
        }

assNumericGUI::getQuestionType (  ) 

Returns the question type string.

Returns the question type string

Returns:
string The question type string public

Reimplemented from assQuestionGUI.

Definition at line 470 of file class.assNumericGUI.php.

        {
                return "assNumeric";
        }

assNumericGUI::getSolutionOutput ( active_id,
pass = NULL,
graphicalOutput = FALSE,
result_output = FALSE,
show_question_only = TRUE 
)

Definition at line 320 of file class.assNumericGUI.php.

References $key, assQuestionGUI::getILIASPage(), and ilUtil::getImagePath().

        {
                // get the solution of the user for the active pass or from the last pass if allowed
                $solutions = array();
                if ($active_id)
                {
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);
                }
                else
                {
                        foreach ($this->object->ranges as $key => $range)
                        {
                                array_push($solutions, array("value1" => sprintf($this->lng->txt("value_between_x_and_y"), $range->getLowerLimit(), $range->getUpperLimit())));
                        }
                }
                
                // generate the question output
                include_once "./classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_as_qpl_numeric_output_solution.html", TRUE, TRUE, TRUE);
                $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", TRUE, TRUE, TRUE);
                if (is_array($solutions))
                {
                        if ($active_id)
                        {
                                if ($graphicalOutput)
                                {
                                        // output of ok/not ok icons for user entered solutions
                                        if ($this->object->getReachedPoints($active_id) == $this->object->getMaximumPoints())
                                        {
                                                $template->setCurrentBlock("icon_ok");
                                                $template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.gif"));
                                                $template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                                                $template->parseCurrentBlock();
                                        }
                                        else
                                        {
                                                $template->setCurrentBlock("icon_ok");
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.gif"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                                                $template->parseCurrentBlock();
                                        }
                                }
                        }
                        foreach ($solutions as $solution)
                        {
                                $template->setVariable("NUMERIC_VALUE", $solution["value1"]);
                        }
                        if (count($solutions) == 0)
                        {
                                $template->setVariable("NUMERIC_VALUE", "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;");
                        }
                }
                $template->setVariable("NUMERIC_SIZE", $this->object->getMaxChars());
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $questionoutput = $template->get();
                $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);

                $solutionoutput = $solutiontemplate->get(); 
                if (!$show_question_only)
                {
                        // get page object output
                        $pageoutput = $this->getILIASPage();
                        $solutionoutput = preg_replace("/(<div( xmlns:xhtml\=\"http:\/\/www.w3.org\/1999\/xhtml\"){0,1} class\=\"ilc_Question\"><\/div>)/ims", $solutionoutput, $pageoutput);
                }
                return $solutionoutput;
        }

Here is the call graph for this function:

assNumericGUI::getTestOutput ( active_id,
pass = NULL,
is_postponed = FALSE,
use_post_solutions = FALSE 
)

Definition at line 402 of file class.assNumericGUI.php.

References ilObjTest::_getHidePreviousResults(), ilObjTest::_getPass(), and assQuestionGUI::outQuestionPage().

Referenced by outQuestionForTest().

        {
                // get page object output
                $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id);

                // get the solution of the user for the active pass or from the last pass if allowed
                if ($active_id)
                {
                        $solutions = NULL;
                        include_once "./assessment/classes/class.ilObjTest.php";
                        if (ilObjTest::_getHidePreviousResults($active_id, true))
                        {
                                if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        }
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);
                }
                
                // generate the question output
                include_once "./classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_as_qpl_numeric_output.html", TRUE, TRUE, TRUE);
                if (is_array($solutions))
                {
                        foreach ($solutions as $solution)
                        {
                                $template->setVariable("NUMERIC_VALUE", " value=\"".$solution["value1"]."\"");
                        }
                }
                $template->setVariable("NUMERIC_SIZE", $this->object->getMaxChars());
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $questionoutput = $template->get();
                $questionoutput = preg_replace("/(<div( xmlns:xhtml\=\"http:\/\/www.w3.org\/1999\/xhtml\"){0,1} class\=\"ilc_Question\"><\/div>)/ims", $questionoutput, $pageoutput);
                return $questionoutput;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assNumericGUI::outQuestionForTest ( formaction,
active_id,
pass = NULL,
is_postponed = FALSE,
use_post_solutions = FALSE 
)

Definition at line 313 of file class.assNumericGUI.php.

References getTestOutput().

        {
                $test_output = $this->getTestOutput($active_id, $pass, $is_postponed, $use_post_solutions); 
                $this->tpl->setVariable("QUESTION_OUTPUT", $test_output);
                $this->tpl->setVariable("FORMACTION", $formaction);
        }

Here is the call graph for this function:

assNumericGUI::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

Reimplemented from assQuestionGUI.

Definition at line 238 of file class.assNumericGUI.php.

References $_GET, $_POST, $key, $result, ilObjAdvancedEditing::_getUsedHTMLTagsAsString(), assQuestionGUI::setErrorMessage(), ilUtil::stripSlashes(), and assQuestionGUI::writeOtherPostData().

Referenced by addSuggestedSolution().

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

                $this->object->setTitle(ilUtil::stripSlashes($_POST["title"]));
                $this->object->setAuthor(ilUtil::stripSlashes($_POST["author"]));
                $this->object->setComment(ilUtil::stripSlashes($_POST["comment"]));
                include_once "./classes/class.ilObjAdvancedEditing.php";
                $questiontext = ilUtil::stripSlashes($_POST["question"], false, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment"));
                $questiontext = preg_replace("/[\n\r]+/", "<br />", $questiontext);
                $this->object->setQuestion($questiontext);
                $this->object->setSuggestedSolution($_POST["solution_hint"], 0);
                $this->object->setShuffle($_POST["shuffle"]);
                $this->object->setMaxChars($_POST["maxchars"]);
                
                // adding estimated working time
                $saved = $saved | $this->writeOtherPostData($result);

                // Delete all existing ranges and create new answers from the form data
                $this->object->flushRanges();

                // Add all answers from the form into the object

                // ...for Numeric with single response
                foreach ($_POST as $key => $value)
                {
                        if (preg_match("/lowerlimit_(\d+)/", $key, $matches))
                        {
                                $points = $_POST["points_$matches[1]"];
                                if ($points < 0)
                                {
                                        $result = 1;
                                        $this->setErrorMessage($this->lng->txt("negative_points_not_allowed"));
                                }
                                $lowerlimit = str_replace(",", ".", $_POST["lowerlimit_".$matches[1]]);
                                if (strlen($lowerlimit) == 0) $lowerlimit = 0.0;
                                if (!is_numeric($lowerlimit))
                                {
                                        $this->setErrorMessage($this->lng->txt("value_is_not_a_numeric_value"));
                                        $result = 1;
                                }
                                $upperlimit = str_replace(",", ".", $_POST["upperlimit_".$matches[1]]);
                                if (strlen($upperlimit) == 0) $upperlimit = 0.0;
                                if (!is_numeric($upperlimit))
                                {
                                        $this->setErrorMessage($this->lng->txt("value_is_not_a_numeric_value"));
                                        $result = 1;
                                }
                                $this->object->addRange(
                                        $lowerlimit,
                                        $upperlimit,
                                        $points,
                                        $matches[1]
                                );
                        }
                }

                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();
                        $_GET["q_id"] = $this->object->getId();
                }

                return $result;
        }

Here is the call graph for this function:

Here is the caller graph for this function:


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