assFileUploadGUI Class Reference

The assFileUploadGUI class encapsulates the GUI representation for file upload questions. More...

Inheritance diagram for assFileUploadGUI:

Collaboration diagram for assFileUploadGUI:

Public Member Functions
	__construct ($id=-1)
	assFileUploadGUI constructor
	getCommand ($cmd)
	writePostData ($always=false)
	Evaluates a posted edit form and writes the form data in the question object.
	editQuestion ($checkonly=FALSE)
	Creates an output of the edit form for the question.
	outQuestionForTest ($formaction, $active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE, $show_feedback=FALSE)
	getSolutionOutput ($active_id, $pass=NULL, $graphicalOutput=FALSE, $result_output=FALSE, $show_question_only=TRUE, $show_feedback=FALSE, $show_correct_solution=FALSE, $show_manual_scoring=FALSE)
	Get the question solution output.
	getPreview ($show_question_only=FALSE)
	getTestOutput ($active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE, $show_feedback=FALSE)
	saveFeedback ()
	Saves the feedback for a single choice question.
	setQuestionTabs ()
	Sets the ILIAS tabs for this question type.
Public Member Functions inherited from assQuestionGUI
	__construct ()
	assQuestionGUI constructor
&	executeCommand ()
	execute command
	getType ()
	needed for page editor compliance
	writePostData ()
	Evaluates a posted edit form and writes the form data in the question object.
	assessment ()
	output assessment
&	_getQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui note: please do not use $this inside this method to allow static calls.
	_getGUIClassNameForId ($a_q_id)
	_getClassNameForQType ($q_type)
&	createQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation.
	getQuestionTemplate ()
	get question template
	getILIASPage ($html="")
	Returns the ILIAS Page around a question.
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="")
	output question page
	cancel ()
	cancel action
	originalSyncForm ($return_to="")
	sync ()
	cancelSync ()
	saveEdit ()
	save question
	save ()
	save question
	apply ()
	apply changes
	getContextPath ($cont_obj, $a_endnode_id, $a_startnode_id=1)
	get context path in content object tree
	setSequenceNumber ($nr)
	getSequenceNumber ()
	setQuestionCount ($a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage ($errormessage)
	addErrorMessage ($errormessage)
	outAdditionalOutput ()
	getQuestionType ()
	Returns the question type string.
	getAsValueAttribute ($a_value)
	Returns a HTML value attribute.
	addNewIdListener (&$a_object, $a_method, $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved.
	callNewIdListeners ($a_new_id)
	Call the new id listeners.
	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode.
	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode.
	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries.
	getDefaultNrOfTries ()
	Get Default Nr of Tries.
	addQuestionFormCommandButtons ($form)
	Add the command buttons of a question properties form.
	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time.
	getAnswerFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback depending on the results of the question.
	feedback ($checkonly=false)
	Creates the output of the feedback page for the question.
	outQuestionType ()
	suggestedsolution ()
	Allows to add suggested solutions for questions.
	outSolutionExplorer ()
	saveSuggestedSolution ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()

Additional Inherited Members
Data Fields inherited from assQuestionGUI
	$object
	$tpl
	$lng
	$error
	$errormessage
	$sequence_no
	sequence number in test
	$question_count
	question count in test

Detailed Description

The assFileUploadGUI class encapsulates the GUI representation for file upload questions.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

Id:

class.assFileUploadGUI.php 23087 2010-03-01 08:51:28Z hschottm

assFileUploadGUI: ilObjQuestionPoolGUI

Definition at line 36 of file class.assFileUploadGUI.php.

Constructor & Destructor Documentation

assFileUploadGUI::__construct

(

$id = -1

)

assFileUploadGUI constructor

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

Parameters

integer

$id

The database id of a single choice question object public

Definition at line 46 of file class.assFileUploadGUI.php.

References assQuestionGUI\__construct(), and assQuestionGUI\setErrorMessage().

        {
                parent::__construct();
                include_once "./Modules/TestQuestionPool/classes/class.assFileUpload.php";
                $this->object = new assFileUpload();
                $this->setErrorMessage($this->lng->txt("msg_form_save_error"));
                if ($id >= 0)
                {
                        $this->object->loadFromDb($id);
                }
        }

Here is the call graph for this function:

Member Function Documentation

assFileUploadGUI::editQuestion

(

$checkonly = FALSE

)

Creates an output of the edit form for the question.

public

Definition at line 102 of file class.assFileUploadGUI.php.

References $errors, $points, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\outQuestionType(), ilFormPropertyGUI\setInfo(), and ilNumberInputGUI\setValue().

Referenced by writePostData().

        {
                $save = ((strcmp($this->ctrl->getCmd(), "save") == 0) || (strcmp($this->ctrl->getCmd(), "saveEdit") == 0)) ? TRUE : FALSE;
                $this->getQuestionTemplate();

                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->outQuestionType());
                $form->setMultipart(false);
                $form->setTableWidth("100%");
                $form->setId("assfileupload");

                $this->addBasicQuestionFormProperties($form);

                // maxsize
                $maxsize = new ilNumberInputGUI($this->lng->txt("maxsize"), "maxsize");
                $maxsize->setValue($this->object->getMaxSize());
                $maxsize->setInfo($this->lng->txt("maxsize_info"));
                $maxsize->setSize(10);
                $maxsize->setMinValue(0);
                $maxsize->setMaxValue($this->object->getMaxFilesizeInBytes());
                $maxsize->setRequired(FALSE);
                $form->addItem($maxsize);
                // allowedextensions
                $allowedextensions = new ilTextInputGUI($this->lng->txt("allowedextensions"), "allowedextensions");
                $allowedextensions->setInfo($this->lng->txt("allowedextensions_info"));
                $allowedextensions->setValue($this->object->getAllowedExtensions());
                $allowedextensions->setRequired(FALSE);
                $form->addItem($allowedextensions);
                // points
                $points = new ilNumberInputGUI($this->lng->txt("points"), "points");
                $points->setValue($this->object->getPoints());
                $points->setRequired(TRUE);
                $points->setSize(3);
                $points->setMinValue(0.0);
                $form->addItem($points);

                $this->addQuestionFormCommandButtons($form);
                
                $errors = false;
        
                if ($save)
                {
                        $form->setValuesByPost();
                        $errors = !$form->checkInput();
                        $form->setValuesByPost(); // again, because checkInput now performs the whole stripSlashes handling and we need this if we don't want to have duplication of backslashes
                        if ($errors) $checkonly = false;
                }

                if (!$checkonly) $this->tpl->setVariable("QUESTION_DATA", $form->getHTML());
                return $errors;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assFileUploadGUI::getCommand

(

$cmd

)

Reimplemented from assQuestionGUI.

Definition at line 58 of file class.assFileUploadGUI.php.

References $cmd.

        {
                return $cmd;
        }

assFileUploadGUI::getPreview

(

$show_question_only = FALSE

)

Definition at line 276 of file class.assFileUploadGUI.php.

References assQuestionGUI\getILIASPage().

        {
                $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
                if (strlen($this->object->getAllowedExtensions()))
                {
                        $template->setCurrentBlock("allowed_extensions");
                        $template->setVariable("TXT_ALLOWED_EXTENSIONS", $this->object->prepareTextareaOutput($this->lng->txt("allowedextensions") . ": " . $this->object->getAllowedExtensions()));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->question, TRUE));
                $template->setVariable("TEXT_UPLOAD", $this->object->prepareTextareaOutput($this->lng->txt('upload')));
                $template->setVariable("TXT_UPLOAD_FILE", $this->object->prepareTextareaOutput($this->lng->txt('file_add')));
                $template->setVariable("TXT_MAX_SIZE", $this->object->prepareTextareaOutput($this->lng->txt('file_notice') . ": " . $this->object->getMaxFilesizeAsString()));

                $questionoutput = $template->get();
                if (!$show_question_only)
                {
                        // get page object output
                        $questionoutput = $this->getILIASPage($questionoutput);
                }
                return $questionoutput;
        }

Here is the call graph for this function:

assFileUploadGUI::getSolutionOutput	(		$active_id,
			$pass = NULL,
			$graphicalOutput = FALSE,
			$result_output = FALSE,
			$show_question_only = TRUE,
			$show_feedback = FALSE,
			$show_correct_solution = FALSE,
			$show_manual_scoring = FALSE
	)

Get the question solution output.

Parameters

integer	$active_id	The active user id
integer	$pass	The test pass
boolean	$graphicalOutput	Show visual feedback for right/wrong answers
boolean	$result_output	Show the reached points for parts of the question
boolean	$show_question_only	Show the question without the ILIAS content around
boolean	$show_feedback	Show the question feedback
boolean	$show_correct_solution	Show the correct solution instead of the user solution
boolean	$show_manual_scoring	Show specific information for the manual scoring output

Returns

The solution output of the question as HTML code

Definition at line 177 of file class.assFileUploadGUI.php.

References $files, $pass, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), assQuestionGUI\getAnswerFeedbackOutput(), assQuestionGUI\getILIASPage(), and ilUtil\getImagePath().

        {
                // get the solution of the user for the active pass or from the last pass if allowed
                $template = new ilTemplate("tpl.il_as_qpl_fileupload_output_solution.html", TRUE, TRUE, "Modules/TestQuestionPool");

                $solutionvalue = "";
                if (($active_id > 0) && (!$show_correct_solution))
                {
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
                        {
                                if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        }
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);

                        $files = ($show_manual_scoring) ? $this->object->getUploadedFilesForWeb($active_id, $pass) : $this->object->getUploadedFiles($active_id, $pass);
                        if (count($files))
                        {
                                include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
                                $table_gui = new assFileUploadFileTableGUI("iltestoutputgui", 'gotoquestion');
                                $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.gif', $this->lng->txt('already_delivered_files'));
                                $table_gui->setData($files);
                                $table_gui->setRowTemplate("tpl.il_as_qpl_fileupload_file_view_row.html", "Modules/TestQuestionPool");
                                $table_gui->setSelectAllCheckbox("");
                                $table_gui->clearCommandButtons();
                                $table_gui->disable('select_all');
                                $table_gui->disable('numinfo');
                                $template->setCurrentBlock("files");
                                $template->setVariable('FILES', $table_gui->getHTML()); 
                                $template->parseCurrentBlock();
                        }
                }

                if (($active_id > 0) && (!$show_correct_solution))
                {
                        $reached_points = $this->object->getReachedPoints($active_id, $pass);
                        if ($graphicalOutput)
                        {
                                // output of ok/not ok icons for user entered solutions
                                if ($reached_points == $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");
                                        if ($reached_points > 0)
                                        {
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_mostly_ok.gif"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_not_correct_but_positive"));
                                        }
                                        else
                                        {
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.gif"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                                        }
                                        $template->parseCurrentBlock();
                                }
                        }
                }
                else
                {
                        $reached_points = $this->object->getPoints();
                }

                if ($result_output)
                {
                        $resulttext = ($reached_points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")"; 
                        $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $reached_points));
                }
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), TRUE));

                $questionoutput = $template->get();
                $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
                $feedback = ($show_feedback) ? $this->getAnswerFeedbackOutput($active_id, $pass) : "";
                if (strlen($feedback)) $solutiontemplate->setVariable("FEEDBACK", $feedback);
                $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
                $solutionoutput = $solutiontemplate->get(); 
                if (!$show_question_only)
                {
                        // get page object output
                        $solutionoutput = $this->getILIASPage($solutionoutput);
                }
                return $solutionoutput;
        }

Here is the call graph for this function:

assFileUploadGUI::getTestOutput	(		$active_id,
			$pass = NULL,
			$is_postponed = FALSE,
			$use_post_solutions = FALSE,
			$show_feedback = FALSE
	)

Definition at line 299 of file class.assFileUploadGUI.php.

References $files, $pass, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), assQuestionGUI\getILIASPage(), and assQuestionGUI\outQuestionPage().

Referenced by outQuestionForTest().

        {
                // generate the question output
                $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
                
                if ($active_id)
                {
                        $solutions = NULL;
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
                        {
                                if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        }
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);

                        $files = $this->object->getUploadedFiles($active_id, $pass);
                        if (count($files))
                        {
                                include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
                                $table_gui = new assFileUploadFileTableGUI("iltestoutputgui", 'gotoquestion');
                                $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.gif', $this->lng->txt('already_delivered_files'));
                                $table_gui->setData($files);
                                $template->setCurrentBlock("files");
                                $template->setVariable('FILES', $table_gui->getHTML()); 
                                $template->parseCurrentBlock();
                        }
                }
                
                if (strlen($this->object->getAllowedExtensions()))
                {
                        $template->setCurrentBlock("allowed_extensions");
                        $template->setVariable("TXT_ALLOWED_EXTENSIONS", $this->object->prepareTextareaOutput($this->lng->txt("allowedextensions") . ": " . $this->object->getAllowedExtensions()));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->question, TRUE));
                $template->setVariable("TEXT_UPLOAD", $this->object->prepareTextareaOutput($this->lng->txt('upload')));
                $template->setVariable("TXT_UPLOAD_FILE", $this->object->prepareTextareaOutput($this->lng->txt('file_add')));
                $template->setVariable("TXT_MAX_SIZE", $this->object->prepareTextareaOutput($this->lng->txt('file_notice') . ": " . $this->object->getMaxFilesizeAsString()));

                $questionoutput = $template->get();
                if (!$show_question_only)
                {
                        // get page object output
                        $questionoutput = $this->getILIASPage($questionoutput);
                }
                $questionoutput = $template->get();
                $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
                return $pageoutput;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assFileUploadGUI::outQuestionForTest	(		$formaction,
			$active_id,
			$pass = NULL,
			$is_postponed = FALSE,
			$use_post_solutions = FALSE,
			$show_feedback = FALSE
	)

Definition at line 156 of file class.assFileUploadGUI.php.

References $pass, and getTestOutput().

        {
                $test_output = $this->getTestOutput($active_id, $pass, $is_postponed, $use_post_solutions, $show_feedback); 
                $this->tpl->setVariable("QUESTION_OUTPUT", $test_output);
                $this->tpl->setVariable("FORMACTION", $formaction);
                $this->tpl->setVariable("ENCTYPE", 'enctype="multipart/form-data"');
        }

Here is the call graph for this function:

assFileUploadGUI::saveFeedback

(

)

Saves the feedback for a single choice question.

public

Reimplemented from assQuestionGUI.

Definition at line 354 of file class.assFileUploadGUI.php.

References $_POST, $errors, and assQuestionGUI\feedback().

        {
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $errors = $this->feedback(true);
                $this->object->saveFeedbackGeneric(0, $_POST["feedback_incomplete"]);
                $this->object->saveFeedbackGeneric(1, $_POST["feedback_complete"]);
                $this->object->cleanupMediaObjectUsage();
                parent::saveFeedback();
        }

Here is the call graph for this function:

assFileUploadGUI::setQuestionTabs

(

)

Sets the ILIAS tabs for this question type.

public

Definition at line 369 of file class.assFileUploadGUI.php.

References $_GET, and $ref_id.

        {
                global $rbacsystem, $ilTabs;
                
                $this->ctrl->setParameterByClass("ilpageobjectgui", "q_id", $_GET["q_id"]);
                include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
                $q_type = $this->object->getQuestionType();

                if (strlen($q_type))
                {
                        $classname = $q_type . "GUI";
                        $this->ctrl->setParameterByClass(strtolower($classname), "sel_question_types", $q_type);
                        $this->ctrl->setParameterByClass(strtolower($classname), "q_id", $_GET["q_id"]);
                }

                if ($_GET["q_id"])
                {
                        if ($rbacsystem->checkAccess('write', $_GET["ref_id"]))
                        {
                                // edit page
                                $ilTabs->addTarget("edit_content",
                                        $this->ctrl->getLinkTargetByClass("ilPageObjectGUI", "edit"),
                                        array("edit", "insert", "exec_pg"),
                                        "", "", $force_active);
                        }
        
                        // edit page
                        $ilTabs->addTarget("preview",
                                $this->ctrl->getLinkTargetByClass("ilPageObjectGUI", "preview"),
                                array("preview"),
                                "ilPageObjectGUI", "", $force_active);
                }

                $force_active = false;
                if ($rbacsystem->checkAccess('write', $_GET["ref_id"]))
                {
                        $url = "";
                        if ($classname) $url = $this->ctrl->getLinkTargetByClass($classname, "editQuestion");
                        // edit question properties
                        $ilTabs->addTarget("edit_properties",
                                $url,
                                array("editQuestion", "save", "cancel", "saveEdit"),
                                $classname, "");
                }

                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("feedback",
                                $this->ctrl->getLinkTargetByClass($classname, "feedback"),
                                array("feedback", "saveFeedback"),
                                $classname, "");
                }
                
                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("solution_hint",
                                $this->ctrl->getLinkTargetByClass($classname, "suggestedsolution"),
                                array("suggestedsolution", "saveSuggestedSolution", "outSolutionExplorer", "cancel", 
                                "addSuggestedSolution","cancelExplorer", "linkChilds", "removeSuggestedSolution"
                                ),
                                $classname, 
                                ""
                        );
                }

                // Assessment of questions sub menu entry
                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("statistics",
                                $this->ctrl->getLinkTargetByClass($classname, "assessment"),
                                array("assessment"),
                                $classname, "");
                }
                
                if (($_GET["calling_test"] > 0) || ($_GET["test_ref_id"] > 0))
                {
                        $ref_id = $_GET["calling_test"];
                        if (strlen($ref_id) == 0) $ref_id = $_GET["test_ref_id"];
                        $ilTabs->setBackTarget($this->lng->txt("backtocallingtest"), "ilias.php?baseClass=ilObjTestGUI&cmd=questions&ref_id=$ref_id");
                }
                else
                {
                        $ilTabs->setBackTarget($this->lng->txt("qpl"), $this->ctrl->getLinkTargetByClass("ilobjquestionpoolgui", "questions"));
                }
        }

assFileUploadGUI::writePostData

(

$always = false

)

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 69 of file class.assFileUploadGUI.php.

References $_POST, and editQuestion().

        {
                $hasErrors = (!$always) ? $this->editQuestion(true) : false;
                if (!$hasErrors)
                {
                        $this->object->setTitle($_POST["title"]);
                        $this->object->setAuthor($_POST["author"]);
                        $this->object->setComment($_POST["comment"]);
                        include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                        $questiontext = $_POST["question"];
                        $this->object->setQuestion($questiontext);
                        $this->object->setPoints($_POST["points"]);
                        // adding estimated working time
                        $this->object->setEstimatedWorkingTime(
                                $_POST["Estimated"]["hh"],
                                $_POST["Estimated"]["mm"],
                                $_POST["Estimated"]["ss"]
                        );
                        $this->object->setMaxSize($_POST["maxsize"]);
                        $this->object->setAllowedExtensions($_POST["allowedextensions"]);
                        return 0;
                }
                else
                {
                        return 1;
                }
        }

Here is the call graph for this function:

---

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

• Modules/TestQuestionPool/classes/class.assFileUploadGUI.php