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 More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	editQuestion ($checkonly=false)
	Creates an output of the edit form for the question. More...
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
	determineMaxFilesize ()
	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, $show_question_text=true)
	Get the question solution output. More...
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	getTestOutput ($active_id, $pass, $is_postponed=false, $use_post_solutions=false, $show_feedback=false)
	getSpecificFeedbackOutput ($userSolution)
	Returns the answer specific feedback for the question. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAggregatedAnswersView ($relevant_answers)
	Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface. More...
	getFormEncodingType ()
	isAnswerFreuqencyStatisticSupported ()
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
Public Member Functions inherited from assQuestionGUI
	__construct ()
	assQuestionGUI constructor More...
	hasInlineFeedback ()
	this method can be overwritten per question type More...
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	getNotesHTML ()
	executeCommand ()
	execute command More...
	getType ()
	needed for page editor compliance More...
	getPresentationContext ()
	setPresentationContext ($presentationContext)
	isTestPresentationContext ()
	isPreviousSolutionPrefilled ()
	setPreviousSolutionPrefilled ($previousSolutionPrefilled)
	getRenderPurpose ()
	setRenderPurpose ($renderPurpose)
	isRenderPurposePrintPdf ()
	isRenderPurposePreview ()
	isRenderPurposeInputValue ()
	isRenderPurposePlayback ()
	isRenderPurposeDemoplay ()
	renderPurposeSupportsFormHtml ()
	getEditContext ()
	setEditContext ($editContext)
	isAuthoringEditContext ()
	isAdjustmentEditContext ()
	setAdjustmentEditContext ()
	getNavigationGUI ()
	setNavigationGUI ($navigationGUI)
	setTaxonomyIds ($taxonomyIds)
	getTaxonomyIds ()
	setTargetGui ($linkTargetGui)
	setTargetGuiClass ($targetGuiClass)
	getTargetGuiClass ()
	setQuestionHeaderBlockBuilder ($questionHeaderBlockBuilder)
	getQuestionHeaderBlockBuilder ()
	setQuestionActionCmd ($questionActionCmd)
	getQuestionActionCmd ()
&	createQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation. More...
	populateJavascriptFilesRequiredForWorkForm (ilGlobalTemplateInterface $tpl)
	getPresentationJavascripts ()
	getQuestionTemplate ()
	get question template More...
	getILIASPage ($html="")
	Returns the ILIAS Page around a question. More...
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	output question page More...
	cancel ()
	cancel action More...
	originalSyncForm ($return_to="", $return_to_feedback='')
	sync ()
	cancelSync ()
	saveEdit ()
	save question More...
	save ()
	save question More...
	saveReturn ()
	save question More...
	apply ()
	apply changes More...
	getContextPath ($cont_obj, $a_endnode_id, $a_startnode_id=1)
	get context path in content object tree More...
	setSequenceNumber ($nr)
	getSequenceNumber ()
	setQuestionCount ($a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage ($errormessage)
	addErrorMessage ($errormessage)
	outAdditionalOutput ()
	getQuestionType ()
	Returns the question type string. More...
	getAsValueAttribute ($a_value)
	Returns a HTML value attribute. More...
	addNewIdListener (&$a_object, $a_method, $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...
	callNewIdListeners ($a_new_id)
	Call the new id listeners. More...
	addQuestionFormCommandButtons ($form)
	Add the command buttons of a question properties form. More...
	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time. More...
	getAnswerFeedbackOutput ($active_id, $pass)
	Returns the answer generic feedback depending on the results of the question. More...
	getGenericFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question. More...
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	getSpecificFeedbackOutput ($userSolution)
	Returns the answer specific feedback for the question. More...
	outQuestionType ()
	showSuggestedSolution ()
	suggestedsolution ()
	Allows to add suggested solutions for questions. More...
	outSolutionExplorer ()
	saveSuggestedSolution ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, $classname)
	getEditQuestionTabCommands ()
	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, $show_question_text=true)
	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() More...
	hasIntermediateSolution ($activeId, $passIndex)
	Check if the question has an intermediate solution. More...
	setUseIntermediateSolution ($use)
	getUseIntermediateSolution ()
	Get if intermediate solution should be used for solution output. More...
	isAutosaveable ()
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	outQuestionForTest ( $formaction, $active_id, $pass, $is_question_postponed=false, $user_post_solutions=false, $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)
	getFormEncodingType ()
	setPreviewSession ($previewSession)
	getPreviewSession ()
	showHints ()
	buildFocusAnchorHtml ()
	isAnswerFreuqencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAggregatedAnswersView ($relevant_answers)
	Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface. More...

Data Fields
const	REUSE_FILES_TBL_POSTVAR = 'reusefiles'
const	DELETE_FILES_TBL_POSTVAR = 'deletefiles'
Data Fields inherited from assQuestionGUI
const	FORM_MODE_EDIT = 'edit'
const	FORM_MODE_ADJUST = 'adjust'
const	FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded'
const	FORM_ENCODING_MULTIPART = 'multipart/form-data'
const	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'
	$object
	$tpl
	$lng
	$error
	$errormessage
	$request
	$sequence_no
	sequence number in test More...
	$question_count
	question count in test More...
const	PRESENTATION_CONTEXT_TEST = 'pContextTest'
const	PRESENTATION_CONTEXT_RESULTS = 'pContextResults'
const	RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback'
const	RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay'
const	RENDER_PURPOSE_PREVIEW = 'renderPurposePreview'
const	RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf'
const	RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue'
const	EDIT_CONTEXT_AUTHORING = 'authoring'
const	EDIT_CONTEXT_ADJUSTMENT = 'adjustment'

Protected Member Functions
	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 } More...
	buildFileTableDeleteButtonInstance ()
	buildFileTableReuseButtonInstance ()
	buildTestPresentationFileTableCommandButtonInstance ()
	getTestPresentationFileTablePostVar ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
Protected Member Functions inherited from assQuestionGUI
	hasSpecialQuestionCommands ()
	writePostData ($always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...
	renderEditForm ($form)
	getUseUnchangedAnswerCheckboxHtml ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
	saveTaxonomyAssignments ()
	populateTaxonomyFormSection (ilPropertyFormGUI $form)
	setDefaultTabs (ilTabsGUI $ilTabs)
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	getBasicEditQuestionTabCommands ()
	getAdditionalEditQuestionCommands ()
	addTab_QuestionFeedback (ilTabsGUI $tabs)
	adds the feedback tab to ilTabsGUI More...
	addTab_QuestionHints (ilTabsGUI $tabs)
	adds the hints tab to ilTabsGUI More...
	addTab_Question (ilTabsGUI $tabsGUI)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction ($formAction, $active_id, $pass)
	addBackTab (ilTabsGUI $ilTabs)
	buildBasicEditFormObject ()
	escapeTemplatePlaceholders (string $text)
	buildEditForm ()
	addSaveOnEnterOnLoadCode ()

Private Attributes
const	HANDLE_FILE_UPLOAD = 'handleFileUpload'

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_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. More...
static	_getGUIClassNameForId ($a_q_id)
static	_getClassNameForQType ($q_type)
static	getCommandsFromClassConstants ($guiClassName, $cmdConstantNameBegin='CMD_')
	extracts values of all constants of given class with given prefix as array can be used to get all possible commands in case of these commands are defined as constants More...
Protected Attributes inherited from assQuestionGUI
const	HAS_SPECIAL_QUESTION_COMMANDS = false
	$ctrl
	$editForm
	$use_intermediate_solution = false

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

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

@ilctrl_iscalledby assFileUploadGUI: ilObjQuestionPoolGUI @ilCtrl_Calls assFileUploadGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

__construct()

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

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

    {
        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);
        }
    }

References ILIAS\GlobalScreen\Provider\__construct(), and assQuestionGUI\setErrorMessage().

Here is the call graph for this function:

Member Function Documentation

buildFileTableDeleteButtonInstance()

assFileUploadGUI::buildFileTableDeleteButtonInstance ( )

protected

Returns

ilAssFileUploadFileTableDeleteButton

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

    {
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssFileUploadFileTableDeleteButton.php';
        return ilAssFileUploadFileTableDeleteButton::getInstance();
    }

References ilAssFileUploadFileTableDeleteButton\getInstance().

Referenced by buildTestPresentationFileTableCommandButtonInstance(), and getPreview().

Here is the call graph for this function:

Here is the caller graph for this function:

buildFileTableReuseButtonInstance()

assFileUploadGUI::buildFileTableReuseButtonInstance ( )

protected

Returns

ilAssFileUploadFileTableReuseButton

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

    {
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssFileUploadFileTableReuseButton.php';
        return ilAssFileUploadFileTableReuseButton::getInstance();
    }

References ilAssFileUploadFileTableReuseButton\getInstance().

Referenced by buildTestPresentationFileTableCommandButtonInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

buildTestPresentationFileTableCommandButtonInstance()

assFileUploadGUI::buildTestPresentationFileTableCommandButtonInstance ( )

protected

Returns

ilAssFileUploadFileTableCommandButton

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

    {
        if ($this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled()) {
            return $this->buildFileTableReuseButtonInstance();
        }
 
        return $this->buildFileTableDeleteButtonInstance();
    }

References buildFileTableDeleteButtonInstance(), and buildFileTableReuseButtonInstance().

Referenced by getTestOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

determineMaxFilesize()

assFileUploadGUI::determineMaxFilesize

(

)

Returns

mixed

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

    {
        //mbecker: Quick fix for mantis bug 8595: Change size file
        $upload_max_filesize = get_cfg_var("upload_max_filesize");
        // get the value for the maximal post data from the php.ini (if available)
        $post_max_size = get_cfg_var("post_max_size");
 
        //convert from short-string representation to "real" bytes
        $multiplier_a = array( "K" => 1024, "M" => 1024 * 1024, "G" => 1024 * 1024 * 1024 );
        $umf_parts = preg_split(
            "/(\d+)([K|G|M])/",
            $upload_max_filesize,
            -1,
            PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
        );
        $pms_parts = preg_split(
            "/(\d+)([K|G|M])/",
            $post_max_size,
            -1,
            PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
        );
 
        if (count($umf_parts) == 2) {
            $upload_max_filesize = $umf_parts[0] * $multiplier_a[$umf_parts[1]];
        }
 
        if (count($pms_parts) == 2) {
            $post_max_size = $pms_parts[0] * $multiplier_a[$pms_parts[1]];
        }
 
        // use the smaller one as limit
        $max_filesize = min($upload_max_filesize, $post_max_size);
 
        if (!$max_filesize) {
            $max_filesize = max($upload_max_filesize, $post_max_size);
            return $max_filesize;
        }
        return $max_filesize;
    }

Referenced by populateQuestionSpecificFormPart().

Here is the caller graph for this function:

editQuestion()

assFileUploadGUI::editQuestion

(

$checkonly = false

)

Creates an output of the edit form for the question.

@access public

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

    {
        $save = $this->isSaveCommand();
        $this->getQuestionTemplate();
 
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $this->editForm = $form;
 
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->outQuestionType());
        $form->setMultipart(false);
        $form->setTableWidth("100%");
        $form->setId("assfileupload");
 
        $this->addBasicQuestionFormProperties($form);
        $this->populateQuestionSpecificFormPart($form);
 
        $this->populateTaxonomyFormSection($form);
        $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;
    }

References $errors, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\isSaveCommand(), assQuestionGUI\outQuestionType(), populateQuestionSpecificFormPart(), and assQuestionGUI\populateTaxonomyFormSection().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

getAfterParticipationSuppressionQuestionPostVars()

assFileUploadGUI::getAfterParticipationSuppressionQuestionPostVars

(

)

Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.

The form elements will be shown disabled, so the users see the usual form but can only edit the settings, which make sense in the given context.

E.g. array('cloze_type', 'image_filename')

Returns

string[]

Implements ilGuiQuestionScoringAdjustable.

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

    {
        return array();
    }

getAggregatedAnswersView()

assFileUploadGUI::getAggregatedAnswersView

(

$relevant_answers

)

Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface.

Parameters

array

$relevant_answers

Returns

string

Implements ilGuiQuestionScoringAdjustable.

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

    {
        // Empty implementation here since a feasible way to aggregate answer is not known.
        return ''; //print_r($relevant_answers,true);
    }

getFormEncodingType()

assFileUploadGUI::getFormEncodingType

(

)

Reimplemented from assQuestionGUI.

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

    {
        return self::FORM_ENCODING_MULTIPART;
    }

References assQuestionGUI\FORM_ENCODING_MULTIPART.

getPreview()

assFileUploadGUI::getPreview	(		$show_question_only = false,
			$showInlineFeedback = false
	)

Reimplemented from assQuestionGUI.

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

    {
        $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html", true, true, "Modules/TestQuestionPool");
 
        if (is_object($this->getPreviewSession())) {
            $files = $this->object->getPreviewFileUploads($this->getPreviewSession());
            include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
            $table_gui = new assFileUploadFileTableGUI(null, $this->getQuestionActionCmd(), 'ilAssQuestionPreview');
            $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.svg', $this->lng->txt('already_delivered_files'));
            $table_gui->setData($files);
            // hey: prevPassSolutions - support file reuse with table
            $table_gui->initCommand(
                $this->buildFileTableDeleteButtonInstance(),
                assFileUpload::DELETE_FILES_TBL_POSTVAR
            );
            // hey.
            $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->getQuestionForHTMLOutput());
        $template->setVariable("CMD_UPLOAD", $this->getQuestionActionCmd());
        $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;
    }

References buildFileTableDeleteButtonInstance(), assFileUpload\DELETE_FILES_TBL_POSTVAR, assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), and assQuestionGUI\getQuestionActionCmd().

Here is the call graph for this function:

getPreviousSolutionConfirmationCheckboxHtml()

assFileUploadGUI::getPreviousSolutionConfirmationCheckboxHtml ( )

protected

Reimplemented from assQuestionGUI.

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

    {
        return '';
    }

getPreviousSolutionProvidedMessage()

assFileUploadGUI::getPreviousSolutionProvidedMessage ( )

protected

Reimplemented from assQuestionGUI.

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

    {
        return $this->lng->txt('use_previous_solution_advice_file_upload');
    }

getSolutionOutput()

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,
			$show_question_text = true
	)

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

Reimplemented from assQuestionGUI.

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

      {
        // 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);
            include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
            $table_gui = new assFileUploadFileTableGUI($this->getTargetGuiClass(), 'gotoquestion');
            $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.svg', $this->lng->txt('already_delivered_files'));
            $table_gui->setData($files);
            // hey: prevPassSolutions - table refactored
            #$table_gui->initCommand(
            #$this->buildFileTableDeleteButtonInstance(), assFileUploadGUI::DELETE_FILES_TBL_POSTVAR
            #);
            // hey.
            $table_gui->setRowTemplate("tpl.il_as_qpl_fileupload_file_view_row.html", "Modules/TestQuestionPool");
            $table_gui->setSelectAllCheckbox("");
            // hey: prevPassSolutions - table refactored
            #$table_gui->clearCommandButtons();
            #$table_gui->disable('select_all');
            // hey.
            $table_gui->disable('numinfo');
            $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("CMD_UPLOAD", self::HANDLE_FILE_UPLOAD);
        $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()));
 
        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.svg"));
                    $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.svg"));
                        $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.svg"));
                        $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));
        }
        if ($show_question_text == true) {
            $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
        }
        $questionoutput = $template->get();
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
        $feedback = ($show_feedback && !$this->isTestPresentationContext()) ? $this->getAnswerFeedbackOutput($active_id, $pass) : "";
        if (strlen($feedback)) {
            $cssClass = (
                $this->hasCorrectSolution($active_id, $pass) ?
                ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
            );
 
            $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
            $solutiontemplate->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($feedback, true));
        }
        $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
        $solutionoutput = $solutiontemplate->get();
        if (!$show_question_only) {
            // get page object output
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

References $pass, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\getAnswerFeedbackOutput(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), assQuestionGUI\getTargetGuiClass(), assQuestionGUI\hasCorrectSolution(), and assQuestionGUI\isTestPresentationContext().

Here is the call graph for this function:

getSpecificFeedbackOutput()

assFileUploadGUI::getSpecificFeedbackOutput

(

$userSolution

)

Returns the answer specific feedback for the question.

This method should be overwritten by the actual question.

Todo:

Mark this method abstract!

Parameters

array

$userSolution

($userSolution[<value1>] = <value2>)

Returns

string HTML Code with the answer specific feedback @access public

Reimplemented from assQuestionGUI.

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

    {
        $output = "";
        return $this->object->prepareTextareaOutput($output, true);
    }

getTestOutput()

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

Reimplemented from assQuestionGUI.

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

    {
        // generate the question output
        $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html", true, true, "Modules/TestQuestionPool");
 
        if ($active_id) {
            // hey: prevPassSolutions - obsolete due to central check
            #$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);
            #}
            $files = $this->object->getTestOutputSolutions($active_id, $pass);
            // hey.
            include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
            $table_gui = new assFileUploadFileTableGUI(null, $this->getQuestionActionCmd());
            $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.svg', $this->lng->txt('already_delivered_files'));
            $table_gui->setData($files);
            // hey: prevPassSolutions - support file reuse with table
            $table_gui->initCommand(
                $this->buildTestPresentationFileTableCommandButtonInstance(),
                $this->getTestPresentationFileTablePostVar()
            );
            // hey.
            $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->getQuestionForHTMLOutput());
        $template->setVariable("CMD_UPLOAD", self::HANDLE_FILE_UPLOAD);
        $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;
    }

References $pass, buildTestPresentationFileTableCommandButtonInstance(), assQuestionGUI\getILIASPage(), assQuestionGUI\getQuestionActionCmd(), getTestPresentationFileTablePostVar(), and assQuestionGUI\outQuestionPage().

Here is the call graph for this function:

getTestPresentationFileTablePostVar()

assFileUploadGUI::getTestPresentationFileTablePostVar ( )

protected

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

    {
        if ($this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled()) {
            return assFileUpload::REUSE_FILES_TBL_POSTVAR;
        }
 
        return assFileUpload::DELETE_FILES_TBL_POSTVAR;
    }

References assFileUpload\DELETE_FILES_TBL_POSTVAR, and assFileUpload\REUSE_FILES_TBL_POSTVAR.

Referenced by getTestOutput().

Here is the caller graph for this function:

isAnswerFreuqencyStatisticSupported()

assFileUploadGUI::isAnswerFreuqencyStatisticSupported

(

)

Reimplemented from assQuestionGUI.

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

    {
        return false;
    }

populateCorrectionsFormProperties()

assFileUploadGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

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

    {
        // points
        $points = new ilNumberInputGUI($this->lng->txt("points"), "points");
        $points->allowDecimals(true);
        $points->setValue(
            is_numeric($this->object->getPoints()) && $this->object->getPoints(
            ) >= 0 ? $this->object->getPoints() : ''
        );
        $points->setRequired(true);
        $points->setSize(3);
        $points->setMinValue(0.0);
        $points->setMinvalueShouldBeGreater(false);
        $form->addItem($points);
 
        $subcompl = new ilCheckboxInputGUI($this->lng->txt(
            'ass_completion_by_submission'
        ), 'completion_by_submission');
        $subcompl->setInfo($this->lng->txt('ass_completion_by_submission_info'));
        $subcompl->setValue(1);
        $subcompl->setChecked($this->object->isCompletionBySubmissionEnabled());
        $form->addItem($subcompl);
    }

References ilPropertyFormGUI\addItem().

Here is the call graph for this function:

populateQuestionSpecificFormPart()

assFileUploadGUI::populateQuestionSpecificFormPart

(

ilPropertyFormGUI

$form

)

Adds the question specific forms parts to a question property form gui.

Parameters

ilPropertyFormGUI

$form

Returns

ilPropertyFormGUI

Implements ilGuiQuestionScoringAdjustable.

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

    {
        // 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->determineMaxFilesize());
        $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->allowDecimals(true);
        $points->setValue(
            is_numeric($this->object->getPoints()) && $this->object->getPoints(
            ) >= 0 ? $this->object->getPoints() : ''
        );
        $points->setRequired(true);
        $points->setSize(3);
        $points->setMinValue(0.0);
        $points->setMinvalueShouldBeGreater(false);
        $form->addItem($points);
 
        $subcompl = new ilCheckboxInputGUI($this->lng->txt(
            'ass_completion_by_submission'
        ), 'completion_by_submission');
        $subcompl->setInfo($this->lng->txt('ass_completion_by_submission_info'));
        $subcompl->setValue(1);
        $subcompl->setChecked($this->object->isCompletionBySubmissionEnabled());
        $form->addItem($subcompl);
        return $form;
    }

References ilPropertyFormGUI\addItem(), and determineMaxFilesize().

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

saveCorrectionsFormProperties()

assFileUploadGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

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

    {
        $this->object->setPoints((float) $form->getInput('points'));
        $this->object->setCompletionBySubmission((bool) $form->getInput('completion_by_submission'));
    }

References ilPropertyFormGUI\getInput().

Here is the call graph for this function:

writePostData()

assFileUploadGUI::writePostData (   $always = false )

protected

{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

}

Reimplemented from assQuestionGUI.

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

    {
        $hasErrors = (!$always) ? $this->editQuestion(true) : false;
        if (!$hasErrors) {
            require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
            $this->writeQuestionGenericPostData();
            $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
            $this->saveTaxonomyAssignments();
            return 0;
        }
        return 1;
    }

References editQuestion(), assQuestionGUI\saveTaxonomyAssignments(), assQuestionGUI\writeQuestionGenericPostData(), and writeQuestionSpecificPostData().

Here is the call graph for this function:

writeQuestionSpecificPostData()

assFileUploadGUI::writeQuestionSpecificPostData

(

ilPropertyFormGUI

$form

)

Extracts the question specific values from $_POST and applies them to the data object.

Parameters

bool

$always

If true, a check for form validity is omitted.

Returns

void

Implements ilGuiQuestionScoringAdjustable.

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

    {
        $this->object->setPoints($_POST["points"]);
        $this->object->setMaxSize($_POST["maxsize"]);
        $this->object->setAllowedExtensions($_POST["allowedextensions"]);
        $this->object->setCompletionBySubmission($_POST['completion_by_submission'] == 1 ? true : false);
    }

References $_POST.

Referenced by writePostData().

Here is the caller graph for this function:

Field Documentation

DELETE_FILES_TBL_POSTVAR

const assFileUploadGUI::DELETE_FILES_TBL_POSTVAR = 'deletefiles'

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

HANDLE_FILE_UPLOAD

const assFileUploadGUI::HANDLE_FILE_UPLOAD = 'handleFileUpload'

private

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

REUSE_FILES_TBL_POSTVAR

const assFileUploadGUI::REUSE_FILES_TBL_POSTVAR = 'reusefiles'

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

---

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

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