assFileUploadGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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...
	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 (array $userSolution)
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAggregatedAnswersView (array $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
	hasInlineFeedback ()
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	geCommentsPanelHTML ()
	executeCommand ()
	getType ()
	needed for page editor compliance More...
	getPresentationContext ()
	setPresentationContext (string $presentationContext)
	isTestPresentationContext ()
	isPreviousSolutionPrefilled ()
	setPreviousSolutionPrefilled (bool $previousSolutionPrefilled)
	getRenderPurpose ()
	setRenderPurpose (string $renderPurpose)
	isRenderPurposePrintPdf ()
	isRenderPurposePreview ()
	isRenderPurposeInputValue ()
	isRenderPurposePlayback ()
	isRenderPurposeDemoplay ()
	renderPurposeSupportsFormHtml ()
	getEditContext ()
	setEditContext (string $editContext)
	isAuthoringEditContext ()
	isAdjustmentEditContext ()
	setAdjustmentEditContext ()
	getNavigationGUI ()
	setNavigationGUI (?ilTestQuestionNavigationGUI $navigationGUI)
	setTaxonomyIds (array $taxonomyIds)
	getTaxonomyIds ()
	setTargetGui ($linkTargetGui)
	setTargetGuiClass ($targetGuiClass)
	getTargetGuiClass ()
	setQuestionHeaderBlockBuilder (\ilQuestionHeaderBlockBuilder $questionHeaderBlockBuilder)
	getQuestionHeaderBlockBuilder ()
	setQuestionActionCmd (string $questionActionCmd)
	getQuestionActionCmd ()
	assessment ()
	populateJavascriptFilesRequiredForWorkForm (ilGlobalTemplateInterface $tpl)
	getPresentationJavascripts ()
	getQuestionTemplate ()
	getILIASPage (string $html="")
	Returns the ILIAS Page around a question. More...
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	cancel ()
	originalSyncForm (string $return_to="", string $return_to_feedback='')
	sync ()
	cancelSync ()
	saveEdit ()
	save ()
	saveReturn ()
	apply ()
	getContextPath ($cont_obj, int $a_endnode_id, int $a_startnode_id=1)
	get context path in content object tree More...
	setSequenceNumber (int $nr)
	getSequenceNumber ()
	setQuestionCount (int $a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage (string $errormessage)
	addErrorMessage (string $errormessage)
	outAdditionalOutput ()
	Why are you here? Some magic for plugins? More...
	getQuestionType ()
	getAsValueAttribute (string $a_value)
	addNewIdListener ($a_object, string $a_method, string $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...
	callNewIdListeners (int $a_new_id)
	addQuestionFormCommandButtons (ilPropertyFormGUI $form)
	addBasicQuestionFormProperties (ilPropertyFormGUI $form)
	getGenericFeedbackOutput (int $active_id, ?int $pass)
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. More...
	outQuestionType ()
	suggestedsolution ()
	outSolutionExplorer ()
	saveSuggestedSolutionType ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, string $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)
	renderSolutionOutput (mixed $user_solutions, int $active_id, int $pass, bool $graphical_output=false, bool $result_output=false, bool $show_question_only=true, bool $show_feedback=false, bool $show_correct_solution=false, bool $show_manual_scoring=false, bool $show_question_text=true, bool $show_autosave_title=false, bool $show_inline_feedback=false,)
	isAutosaveable ()
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	outQuestionForTest (string $formaction, int $active_id, ?int $pass, bool $is_question_postponed=false, $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)
	getFormEncodingType ()
	setPreviewSession (ilAssQuestionPreviewSession $previewSession)
	getPreviewSession ()
	showHints ()
	buildFocusAnchorHtml ()
	isAnswerFrequencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
	isInLearningModuleContext ()
	setInLearningModuleContext (bool $flag)
	getAutoSavedSolutionOutput (int $active_id, int $pass, bool $graphical_output=false, bool $result_output=false, bool $show_question_only=true, bool $show_feedback=false, bool $show_correct_solution=false, bool $show_manual_scoring=false, bool $show_question_text=true, bool $show_autosave_title=false, bool $show_inline_feedback=false)

Data Fields
const	REUSE_FILES_TBL_POSTVAR = 'reusefiles'
const	REUSE_FILES_LANGVAR = 'ass_file_upload_reuse_btn'
const	REUSE_FILES_ACTION = 'reuse'
const	DELETE_FILES_TBL_POSTVAR = 'deletefiles'
const	DELETE_FILES_LANGVAR = 'delete'
const	DELETE_FILES_ACTION = 'delete'
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	CORRECTNESS_NOT_OK = 0
const	CORRECTNESS_MOSTLY_OK = 1
const	CORRECTNESS_OK = 2
const	ALLOWED_PLAIN_TEXT_TAGS = "<em>, <strong>"
	sk - 12.05.2023: This const is also used in ilKprimChoiceWizardInputGUI. More...
const	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'
assQuestion	$object
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
	$error
string	$errormessage
int	$sequence_no
	sequence number in test More...
int	$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 (bool $always=false)
	{} More...
	getTestPresentationFileTablePostVar ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
Protected Member Functions inherited from assQuestionGUI
	hasSpecialQuestionCommands ()
	writePostData (bool $always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...
	renderEditForm (ilPropertyFormGUI $form)
	getUseUnchangedAnswerCheckboxHtml ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
	addNumberOfTriesToFormIfNecessary (ilPropertyFormGUI $form)
	saveTaxonomyAssignments ()
	populateTaxonomyFormSection (ilPropertyFormGUI $form)
	genericFeedbackOutputBuilder (string $feedback_correct, string $feedback_incorrect, int $active_id, ?int $pass)
	getTypeOptions ()
	createSuggestedSolutionLinkingTo (string $type, string $target)
	setDefaultTabs (ilTabsGUI $ilTabs)
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	getBasicEditQuestionTabCommands ()
	getAdditionalEditQuestionCommands ()
	addTab_QuestionFeedback (ilTabsGUI $tabs)
	addTab_QuestionHints (ilTabsGUI $tabs)
	addTab_Question (ilTabsGUI $tabsGUI)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction ($formAction, $active_id, $pass)
	addBackTab (ilTabsGUI $ilTabs)
	buildBasicEditFormObject ()
	escapeTemplatePlaceholders (string $text)
	buildEditForm ()
	generateCorrectnessIconsForCorrectness (int $correctness)
	getSuggestedSolutionsRepo ()
	cleanupAnswerText (array $answer_text, bool $is_rte)
	sk - 12.05.2023: This is one more of those that we need, but don't want. More...
	addSaveOnEnterOnLoadCode ()

Private Member Functions
	getCommandButtonLangVarAndAction ()

Private Attributes
const	HANDLE_FILE_UPLOAD = 'handleFileUpload'

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_getQuestionGUI (string $question_type='', int $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui. More...
static	_getGUIClassNameForId ($a_q_id)
static	_getClassNameForQType ($q_type)
static	getCommandsFromClassConstants (string $guiClassName, string $cmdConstantNameBegin='CMD_')
static	prepareTextareaOutput (?string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output where latex code may be in it If the text is HTML-free, CHR(13) will be converted to a line break. More...
Protected Attributes inherited from assQuestionGUI
const	SUGGESTED_SOLUTION_COMMANDS_CANCEL = 'cancelSuggestedSolution'
const	SUGGESTED_SOLUTION_COMMANDS_SAVE = 'saveSuggestedSolution'
const	SUGGESTED_SOLUTION_COMMANDS_DEFAULT = 'suggestedsolution'
const	HAS_SPECIAL_QUESTION_COMMANDS = false
ilLogger	$logger
ILIAS TestQuestionPool QuestionInfoService	$questioninfo
ILIAS Notes GUIService	$notes_gui
ilCtrl	$ctrl
Refinery	$refinery
ilPropertyFormGUI	$editForm
ILIAS TestQuestionPool InternalRequestService	$request
bool	$parent_type_is_lm = false
assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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$

assFileUploadGUI: ilObjQuestionPoolGUI assFileUploadGUI: ilFormPropertyDispatchGUI

Definition at line 35 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 53 of file class.assFileUploadGUI.php.

References $id, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\lng(), and assQuestionGUI\setErrorMessage().

    {
        parent::__construct();

        $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

editQuestion()

assFileUploadGUI::editQuestion

(

$checkonly = false

)

Creates an output of the edit form for the question.

public

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

References assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), ILIAS\Repository\ctrl(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\isSaveCommand(), assQuestionGUI\outQuestionType(), populateQuestionSpecificFormPart(), and assQuestionGUI\populateTaxonomyFormSection().

Referenced by writePostData().

                                                    : bool
    {
        $save = $this->isSaveCommand();
        $this->getQuestionTemplate();

        $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;
    }

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

                                                                      : array
    {
        return [];
    }

getAggregatedAnswersView()

assFileUploadGUI::getAggregatedAnswersView

(

array

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

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

getCommandButtonLangVarAndAction()

assFileUploadGUI::getCommandButtonLangVarAndAction ( )

private

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

References ILIAS\Repository\object().

Referenced by getPreview(), and getTestOutput().

                                                       : array
    {
        if ($this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled()) {
            return [self::REUSE_FILES_LANGVAR, self::REUSE_FILES_ACTION];
        }
        return [self::DELETE_FILES_LANGVAR, self::DELETE_FILES_ACTION];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFormEncodingType()

assFileUploadGUI::getFormEncodingType

(

)

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

                                         : string
    {
        return self::FORM_ENCODING_MULTIPART;
    }

getPreview()

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

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

References assFileUpload\DELETE_FILES_TBL_POSTVAR, getCommandButtonLangVarAndAction(), assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), assQuestionGUI\getQuestionActionCmd(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

                                                                                        : string
    {
        $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());
            $table_gui = new assFileUploadFileTableGUI(null, $this->getQuestionActionCmd(), 'ilAssQuestionPreview');
            $table_gui->setTitle(
                $this->lng->txt('already_delivered_files'),
                'standard/icon_file.svg',
                $this->lng->txt('already_delivered_files')
            );
            $table_gui->setData($files);
            // hey: prevPassSolutions - support file reuse with table

            list($lang_var, $cmd) = $this->getCommandButtonLangVarAndAction();
            $table_gui->initCommand(
                $lang_var,
                $cmd,
                assFileUpload::DELETE_FILES_TBL_POSTVAR
            );
            // hey.
            $template->setCurrentBlock("files");
            $template->setVariable('FILES', $table_gui->getHTML());
            $template->parseCurrentBlock();
        }

        if ($this->object->getAllowedExtensions() !== '') {
            $template->setCurrentBlock("allowed_extensions");
            $template->setVariable("TXT_ALLOWED_EXTENSIONS", ilLegacyFormElementsUtil::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", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt('upload')));
        $template->setVariable("TXT_UPLOAD_FILE", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt('file_add')));
        $template->setVariable("TXT_MAX_SIZE", ilLegacyFormElementsUtil::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:

getPreviousSolutionConfirmationCheckboxHtml()

assFileUploadGUI::getPreviousSolutionConfirmationCheckboxHtml ( )

protected

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

                                                                    : string
    {
        return '';
    }

getPreviousSolutionProvidedMessage()

assFileUploadGUI::getPreviousSolutionProvidedMessage ( )

protected

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

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

string The solution output of the question as HTML code

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

References ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\generateCorrectnessIconsForCorrectness(), assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), assQuestionGUI\hasCorrectSolution(), assQuestionGUI\isTestPresentationContext(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

     : string {
        // 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);

            $files = ($show_manual_scoring) ? $this->object->getUploadedFilesForWeb($active_id, $pass) : $this->object->getUploadedFiles($active_id, $pass);
            $table_gui = new assFileUploadFileTableGUI($this, 'gotoquestion');
            $table_gui->setTitle(
                $this->lng->txt('already_delivered_files'),
                'standard/icon_file.svg',
                $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->disable('numinfo');
            $template->setCurrentBlock("files");
            $template->setVariable('FILES', $table_gui->getHTML());
            $template->parseCurrentBlock();
        }

        if ($this->object->getAllowedExtensions() === '') {
            $template->setCurrentBlock("allowed_extensions");
            $template->setVariable("TXT_ALLOWED_EXTENSIONS", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt("allowedextensions") . ": " . $this->object->getAllowedExtensions()));
            $template->parseCurrentBlock();
        }
        $template->setVariable("CMD_UPLOAD", self::HANDLE_FILE_UPLOAD);
        $template->setVariable("TEXT_UPLOAD", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt('upload')));
        $template->setVariable("TXT_UPLOAD_FILE", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt('file_add')));
        $template->setVariable("TXT_MAX_SIZE", ilLegacyFormElementsUtil::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) {
                $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK);
                if ($reached_points == $this->object->getMaximumPoints()) {
                    $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK);
                } elseif ($reached_points > 0) {
                    $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_MOSTLY_OK);
                }
                $template->setCurrentBlock("icon_ok");
                $template->setVariable("ICON_OK", $correctness_icon);
                $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->getGenericFeedbackOutput((int) $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", ilLegacyFormElementsUtil::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;
    }

Here is the call graph for this function:

getSpecificFeedbackOutput()

assFileUploadGUI::getSpecificFeedbackOutput

(

array

$userSolution

)

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

References ilLegacyFormElementsUtil\prepareTextareaOutput().

                                                                  : string
    {
        $output = "";
        return ilLegacyFormElementsUtil::prepareTextareaOutput($output, true);
    }

Here is the call graph for this function:

getTestOutput()

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

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

References getCommandButtonLangVarAndAction(), assQuestionGUI\getILIASPage(), assQuestionGUI\getQuestionActionCmd(), getTestPresentationFileTablePostVar(), ILIAS\Repository\lng(), ILIAS\Repository\object(), assQuestionGUI\outQuestionPage(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

                                                                                                                                : string
    {
        // generate the question output
        $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html", true, true, "Modules/TestQuestionPool");

        if ($active_id) {
            $files = $this->object->getTestOutputSolutions($active_id, $pass);
            // hey.
            $table_gui = new assFileUploadFileTableGUI(null, $this->getQuestionActionCmd());
            $table_gui->setTitle(
                $this->lng->txt('already_delivered_files'),
                'standard/icon_file.svg',
                $this->lng->txt('already_delivered_files')
            );
            $table_gui->setData($files);

            list($lang_var, $cmd) = $this->getCommandButtonLangVarAndAction();
            $table_gui->initCommand(
                $lang_var,
                $cmd,
                $this->getTestPresentationFileTablePostVar()
            );
            // hey.
            $template->setCurrentBlock("files");
            $template->setVariable('FILES', $table_gui->getHTML());
            $template->parseCurrentBlock();
        }

        if ($this->object->getAllowedExtensions() !== '') {
            $template->setCurrentBlock("allowed_extensions");
            $template->setVariable("TXT_ALLOWED_EXTENSIONS", ilLegacyFormElementsUtil::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", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt('upload')));
        $template->setVariable("TXT_UPLOAD_FILE", ilLegacyFormElementsUtil::prepareTextareaOutput($this->lng->txt('file_add')));
        $template->setVariable("TXT_MAX_SIZE", ilLegacyFormElementsUtil::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:

getTestPresentationFileTablePostVar()

assFileUploadGUI::getTestPresentationFileTablePostVar ( )

protected

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

References assFileUpload\DELETE_FILES_TBL_POSTVAR, ILIAS\Repository\object(), and assFileUpload\REUSE_FILES_TBL_POSTVAR.

Referenced by getTestOutput().

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

        return assFileUpload::DELETE_FILES_TBL_POSTVAR;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAnswerFreuqencyStatisticSupported()

assFileUploadGUI::isAnswerFreuqencyStatisticSupported

(

)

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

                                                         : bool
    {
        return false;
    }

populateCorrectionsFormProperties()

assFileUploadGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

                                                                              : void
    {
        // 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(true);
        $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);
    }

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.

Implements ilGuiQuestionScoringAdjustable.

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by editQuestion().

                                                                             : ilPropertyFormGUI
    {
        $maxsize = new ilNumberInputGUI($this->lng->txt("maxsize"), "maxsize");
        $maxsize->allowDecimals(false);
        $maxsize->setValue($this->object->getMaxSize() > 0 ? (string) $this->object->getMaxSize() : null);
        $maxsize->setInfo($this->lng->txt("maxsize_info"));
        $maxsize->setSize(10);
        $maxsize->setMinValue(0);
        $maxsize->setMaxValue((float) $this->object->determineMaxFilesize());
        $maxsize->setRequired(false);
        $form->addItem($maxsize);

        $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 = 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(true);
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveCorrectionsFormProperties()

assFileUploadGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

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

References ilPropertyFormGUI\getInput().

                                                                          : void
    {
        $this->object->setPoints((float) str_replace(',', '.', $form->getInput('points')));
        $this->object->setCompletionBySubmission((bool) $form->getInput('completion_by_submission'));
    }

Here is the call graph for this function:

writePostData()

assFileUploadGUI::writePostData ( bool  $always = false )

protected

{}

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

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

                                                          : int
    {
        $hasErrors = (!$always) ? $this->editQuestion(true) : false;
        if (!$hasErrors) {
            $this->writeQuestionGenericPostData();
            $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
            $this->saveTaxonomyAssignments();
            return 0;
        }
        return 1;
    }

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.

Implements ilGuiQuestionScoringAdjustable.

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

Referenced by writePostData().

                                                                          : void
    {
        $this->object->setPoints((float) str_replace(',', '.', $_POST["points"]));
        $this->object->setMaxSize($this->request->int('maxsize') !== 0 ? $this->request->int('maxsize') : null);
        $this->object->setAllowedExtensions($_POST["allowedextensions"] ?? '');
        $this->object->setCompletionBySubmission(isset($_POST['completion_by_submission']) && $_POST['completion_by_submission'] == 1);
    }

Here is the caller graph for this function:

Field Documentation

DELETE_FILES_ACTION

const assFileUploadGUI::DELETE_FILES_ACTION = 'delete'

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

Referenced by assFileUpload\isFileDeletionAction().

DELETE_FILES_LANGVAR

const assFileUploadGUI::DELETE_FILES_LANGVAR = 'delete'

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

DELETE_FILES_TBL_POSTVAR

const assFileUploadGUI::DELETE_FILES_TBL_POSTVAR = 'deletefiles'

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

HANDLE_FILE_UPLOAD

const assFileUploadGUI::HANDLE_FILE_UPLOAD = 'handleFileUpload'

private

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

REUSE_FILES_ACTION

const assFileUploadGUI::REUSE_FILES_ACTION = 'reuse'

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

REUSE_FILES_LANGVAR

const assFileUploadGUI::REUSE_FILES_LANGVAR = 'ass_file_upload_reuse_btn'

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

REUSE_FILES_TBL_POSTVAR

const assFileUploadGUI::REUSE_FILES_TBL_POSTVAR = 'reusefiles'

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

---

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

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