assFileUpload Class Reference

Class for file upload questions. More...

Inheritance diagram for assFileUpload:

Collaboration diagram for assFileUpload:

Public Member Functions
	isComplete ()
	Returns true, if the question is complete for use. More...
	saveToDb (?int $original_id=null)
	Saves a assFileUpload object to a database. More...
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...
	loadFromDb (int $question_id)
	getMaximumPoints ()
	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)
	checkUpload ()
	Check file upload. More...
	getFileUploadPath ($test_id, $active_id, $question_id=null)
	Returns the filesystem path for file uploads. More...
	getFileUploadPathWeb ($test_id, $active_id, $question_id=null)
	Returns the file upload path for web accessible files of a question. More...
	getUploadedFiles (int $active_id, ?int $pass=null, bool $authorized=true)
	getPreviewFileUploads (ilAssQuestionPreviewSession $previewSession)
	getUploadedFilesForWeb ($active_id, $pass)
	Returns the web accessible uploaded files for an active user in a given pass. More...
	getMaxFilesizeAsString ()
	determineMaxFilesize ()
	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)
	getUserSolutionPreferingIntermediate (int $active_id, ?int $pass=null)
	removeIntermediateSolution (int $active_id, int $pass)
	getQuestionType ()
	getAdditionalTableName ()
	getAnswerTableName ()
	deleteAnswers ($question_id)
	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
	getBestSolution ($active_id, $pass)
	getMaxSize ()
	setMaxSize (?int $value)
	getAllowedExtensionsArray ()
	getAllowedExtensions ()
	setAllowedExtensions (string $a_value)
	hasFileUploads (int $test_id)
	deliverFileUploadZIPFile (int $ref_id, int $test_id, string $test_title)
	isCompletionBySubmissionEnabled ()
	setCompletionBySubmission (bool $bool)
	buildTestPresentationConfig ()
	toLog (AdditionalInformationGenerator $additional_info)
	solutionValuesToText (array $solution_values)
	getCorrectSolutionForTextOutput (int $active_id, int $pass)
Public Member Functions inherited from assQuestion
	getQuestionType ()
	isComplete ()
	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)
	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)
	getAdditionalTableName ()
	getAnswerTableName ()
	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...
	getCurrentUser ()
	getShuffler ()
	setShuffler (Transformation $shuffler)
	setProcessLocker (ilAssQuestionProcessLocker $processLocker)
	getProcessLocker ()
	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping, array $solutionhints=[])
	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...
	setTitle (string $title="")
	setId (int $id=-1)
	setTestId (int $id=-1)
	setComment (string $comment="")
	setShuffle (?bool $shuffle=true)
	setAuthor (string $author="")
	setOwner (int $owner=-1)
	getTitle ()
	getTitleForHTMLOutput ()
	getTitleFilenameCompliant ()
	getId ()
	getShuffle ()
	getTestId ()
	getComment ()
	getDescriptionForHTMLOutput ()
	getThumbSize ()
	setThumbSize (int $a_size)
	getMinimumThumbSize ()
	getMaximumThumbSize ()
	getAuthor ()
	getAuthorForHTMLOutput ()
	getOwner ()
	getObjId ()
	setObjId (int $obj_id=0)
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId (?string $external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
	getSuggestedSolutions ()
	getReachedPoints (int $active_id, int $pass)
	getMaximumPoints ()
	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorized_solution=true)
	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	getSuggestedSolutionPath ()
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	getSuggestedSolutionPathWeb ()
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getTestOutputSolutions (int $activeId, int $pass)
	getUserSolutionPreferingIntermediate (int $active_id, ?int $pass=null)
	getSolutionValues (int $active_id, ?int $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	deleteAnswers (int $question_id)
	deleteAdditionalTableData (int $question_id)
	delete (int $question_id)
	getTotalAnswers ()
	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)
	createPageObject ()
	clonePageOfQuestion (int $a_q_id)
	getPageOfQuestion ()
	setOriginalId (?int $original_id)
	getOriginalId ()
static	fixSvgToPng (string $imageFilenameContainingString)
	fixUnavailableSkinImageSources (string $html)
	loadFromDb (int $question_id)
	createNewQuestion (bool $a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
	saveQuestionDataToDb (?int $original_id=null)
	duplicate (bool $for_test=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)
	copyObject (int $target_parent_id, string $title='')
	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')
	saveToDb (?int $original_id=null)
	deleteSuggestedSolutions ()
	getSuggestedSolution (int $subquestion_index=0)
	resolveInternalLink (string $internal_link)
	resolveSuggestedSolutionLinks ()
	getInternalLinkHref (string $target)
	syncWithOriginal ()
	getPoints ()
	setPoints (float $points)
	getSolutionMaxPass (int $active_id)
	isWriteable ()
	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $preview_session, $reached_points)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)
	adjustReachedPointsByScoringOptions (float $points, int $active_id)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)
	getQuestion ()
	getQuestionForHTMLOutput ()
	setQuestion (string $question="")
	getQuestionTypeID ()
	cloneHints (int $source_question_id, int $target_question_id)
	cleanupMediaObjectUsage ()
	getInstances ()
	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...
	hasSpecificFeedback ()
	getNrOfTries ()
	setNrOfTries (int $a_nr_of_tries)
	setExportImagePath (string $path)
	formatSAQuestion ($a_q)
	setPreventRteUsage (bool $prevent_rte_usage)
	getPreventRteUsage ()
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)
	getSelfAssessmentEditingMode ()
	setDefaultNrOfTries (int $defaultnroftries)
	getDefaultNrOfTries ()
	syncSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	ensureHintPageObjectExists ($pageObjectId)
	isAnswered (int $active_id, int $pass)
	getAdditionalContentEditingMode ()
	setAdditionalContentEditingMode (?string $additionalContentEditingMode)
	isAdditionalContentEditingModePageObject ()
	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)
	getValidAdditionalContentEditingModes ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange (int $lastChange)
	getLastChange ()
	removeIntermediateSolution (int $active_id, int $pass)
	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)
	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)
	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)
	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)
	setStep ($step)
	getStep ()
	toJSON ()
	intermediateSolutionExists (int $active_id, int $pass)
	authorizedSolutionExists (int $active_id, ?int $pass)
	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)
	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...
	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)
	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)
	removeAllExistingSolutions ()
	removeExistingSolutions (int $activeId, int $pass)
	resetUsersAnswer (int $activeId, int $pass)
	removeResultRecord (int $activeId, int $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $value_pairs)
	updateTimestamp ()
	getTestPresentationConfig ()
	hasWritableOriginalInQuestionPool ()
	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)
	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)
	getSolutionForTextOutput (int $active_id, int $pass)
	getCorrectSolutionForTextOutput (int $active_id, int $pass)
	getVariablesAsTextArray (int $active_id, int $pass)
Public Member Functions inherited from ilObjFileHandlingQuestionType
	getFileUploadPath (int $test_id, int $active_id, ?int $question_id=null)

Data Fields
const	REUSE_FILES_TBL_POSTVAR = 'reusefiles'
const	DELETE_FILES_TBL_POSTVAR = 'deletefiles'
Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+|[\p{C}\p{Z}]+$/u'
ilAssQuestionFeedback	$feedbackOBJ
bool	$prevent_rte_usage = false
bool	$selfassessmenteditingmode = false
int	$defaultnroftries = 0
string	$questionActionCmd = 'handleQuestionAction'
const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Protected Member Functions
	calculateReachedPointsForSolution (?array $user_solution)
	getPreviewFileUploadPath ($userId)
	Returns the filesystem path for file uploads. More...
	getPreviewFileUploadPathWeb (int $user_id)
	deletePreviewFileUploads ($userId, $userSolution, $files)
	getMaxFilesizeInBytes ()
	resolveRIDStoDelete ()
	removeSolutionRecordById (int $solution_id)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	isFileDeletionAction ()
	isFileDeletionSubmitAvailable ()
	isFileReuseSubmitAvailable ()
	isFileReuseHandlingRequired ()
	isFileUploadAvailable ()
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...
	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...
	getQuestionAction ()
	isNonEmptyItemListPostSubmission (string $post_submission_field_name)
	savePreviewData (ilAssQuestionPreviewSession $preview_session)
	deletePageOfQuestion (int $question_id)
	cloneQuestionTypeSpecificProperties (self $target)
	removeAllImageFiles (string $image_target_path)
	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)
	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)
	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)
	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)
	deleteComments ()
	getNotesManager ()
	getNotesDataService ()
	getNotesRepo ()
	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)
	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)
	copySuggestedSolutions (int $target_question_id)
	ensureNonNegativePoints (float $points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints (int $original_question_id, int $duplicate_question_id)
	duplicateSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)
	removeSolutionRecordById (int $solutionId)
	getSolutionRecordById (int $solutionId)
	deleteDummySolutionRecord (int $activeId, int $passIndex)
	isDummySolutionRecord (array $solutionRecord)
	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)
	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)
	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)
	lookupMaxStep (int $active_id, int $pass)
	buildTestPresentationConfig ()
	getSuggestedSolutionsRepo ()
	loadSuggestedSolutions ()
	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
const	HAS_SPECIFIC_FEEDBACK = false
int	$maxsize = null
string	$allowedextensions = ''
	$completion_by_submission = false
Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true
GeneralQuestionPropertiesRepository	$questionrepository
RequestDataCollector	$questionpool_request
QuestionFiles	$question_files
ilAssQuestionProcessLocker	$processLocker
ilTestQuestionConfig	$testQuestionConfig
SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo
ILIAS	$ilias
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
ilDBInterface	$db
ilObjUser	$current_user
SkillUsageService	$skillUsageService
HTTPServices	$http
Refinery	$refinery
Transformation	$shuffler
LoggingServices	$log
Container	$dic
ilAssQuestionLifecycle	$lifecycle
ilAssQuestionPage	$page
int	$id
string	$title
string	$comment
int	$owner
string	$author
int	$thumb_size
string	$question
float	$points = 0.0
bool	$shuffle = true
int	$test_id
int	$obj_id = 0
int	$original_id = null
int	$lastChange = null
string	$external_id = null
int	$step = null
array	$suggested_solutions

Private Attributes
ParticipantRepository	$participant_repository
ILIAS ResourceStorage Services	$irss
ILIAS FileDelivery Services	$file_delivery
ILIAS FileUpload FileUpload	$file_upload
string	$current_cmd

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $force_pass_results_update_enabled)
static	isForcePassResultUpdateEnabled ()
static	_getSuggestedSolutionOutput (int $question_id)
static	_getReachedPoints (int $active_id, int $question_id, int $pass)
static	isFileAvailable (string $file)
static	saveOriginalId (int $questionId, int $originalId)
static	resetOriginalId (int $questionId)
static	instantiateQuestion (int $question_id)
static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...
static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
static	getFeedbackClassNameByQuestionType (string $questionType)
static	_questionExistsInTest (int $question_id, int $test_id)
static	lookupParentObjId (int $question_id)
static	implodeKeyValues (array $keyValues)
static	explodeKeyValues (string $keyValues)
static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)
static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)
Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = false
static	$imageSourceFixReplaceMap

Detailed Description

Class 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$

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

Member Function Documentation

buildTestPresentationConfig()

assFileUpload::buildTestPresentationConfig

(

)

Definition at line 869 of file class.assFileUpload.php.

References ilTestQuestionConfig\setFormChangeDetectionEnabled().

                                                 : ilTestQuestionConfig
    {
        return parent::buildTestPresentationConfig()
            ->setFormChangeDetectionEnabled(false);
    }

Here is the call graph for this function:

calculateReachedPoints()

assFileUpload::calculateReachedPoints	(	int	$active_id,
		?int	$pass = null,
		bool	$authorized_solution = true
	)

Definition at line 185 of file class.assFileUpload.php.

References $data, assQuestion\getCurrentSolutionResultSet(), assQuestion\getPoints(), assQuestion\getSolutionMaxPass(), isCompletionBySubmissionEnabled(), assQuestion\isDummySolutionRecord(), and null.

     : float {
        if (!$this->isCompletionBySubmissionEnabled()) {
            return 0.0;
        }

        if ($pass === null) {
            $pass = $this->getSolutionMaxPass($active_id);
        }

        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);

        while ($data = $this->db->fetchAssoc($result)) {
            if ($this->isDummySolutionRecord($data)) {
                continue;
            }

            return $this->getPoints();
        }

        return 0.0;
    }

Here is the call graph for this function:

calculateReachedPointsForSolution()

assFileUpload::calculateReachedPointsForSolution ( ?array  $user_solution )

protected

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

References assQuestion\getPoints(), and isCompletionBySubmissionEnabled().

                                                                               : float
    {
        if ($this->isCompletionBySubmissionEnabled()
            && is_array($user_solution)
            && $user_solution !== []) {
            return $this->getPoints();
        }

        return 0.0;
    }

Here is the call graph for this function:

checkUpload()

assFileUpload::checkUpload

(

)

Check file upload.

Returns

boolean Input ok, true/false

Definition at line 227 of file class.assFileUpload.php.

References getAllowedExtensionsArray(), getMaxFilesizeInBytes(), and ILIAS\Repository\lng().

Referenced by savePreviewData(), and saveWorkingData().

                                 : bool
    {
        $this->lng->loadLanguageModule('form');

        foreach (
            $this->file_upload->getResults() as $upload_result
        ) { // only one supported at the moment, but we check all
            if (!$upload_result->isOK()) {
                $this->tpl->setOnScreenMessage('failure', $upload_result->getStatus()->getMessage(), true);
                return false;
            }

            // check file size
            $size_bytes = $upload_result->getSize();
            if ($size_bytes > $this->getMaxFilesizeInBytes()) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_msg_file_size_exceeds'), true);
                return false;
            }

            // check suffixes
            if (count($this->getAllowedExtensionsArray())) {
                $filename_arr = pathinfo($upload_result->getName());
                $suffix = $filename_arr['extension'] ?? '';
                $mimetype = $upload_result->getMimeType();
                if ($suffix === '') {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_msg_file_missing_file_ext'), true);
                    return false;
                }

                if (!in_array(strtolower($suffix), $this->getAllowedExtensionsArray(), true)) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_msg_file_wrong_file_type'), true);
                    return false;
                }
            }
            // virus handling already done in upload-service
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAnswers()

assFileUpload::deleteAnswers

(

$question_id

)

Parameters

integer

$question_id

The question id which should be deleted in the answers table

Definition at line 774 of file class.assFileUpload.php.

                                               : void
    {
    }

deletePreviewFileUploads()

assFileUpload::deletePreviewFileUploads (   $userId,   $userSolution,   $files  )

protected

Definition at line 453 of file class.assFileUpload.php.

References getPreviewFileUploadPath().

Referenced by savePreviewData().

    {
        foreach ($files as $name) {
            if (isset($userSolution[$name])) {
                unset($userSolution[$name]);
                @unlink($this->getPreviewFileUploadPath($userId) . $name);
            }
        }

        return $userSolution;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverFileUploadZIPFile()

assFileUpload::deliverFileUploadZIPFile	(	int	$ref_id,
		int	$test_id,
		string	$test_title
	)

Implements ilObjFileHandlingQuestionType.

Definition at line 843 of file class.assFileUpload.php.

References ILIAS\Repository\lng().

                                                                                           : void
    {
        $exporter = new ilAssFileUploadUploadsExporter(
            $this->db,
            $this->lng,
            $ref_id,
            $test_id
        );

        $exporter->setTestTitle($test_title);
        $exporter->setQuestion($this);

        $exporter->buildAndDownload();
    }

Here is the call graph for this function:

determineMaxFilesize()

assFileUpload::determineMaxFilesize

(

)

Definition at line 489 of file class.assFileUpload.php.

Referenced by getMaxFilesizeInBytes().

                                          : int
    {
        $upload_max_filesize = ini_get('upload_max_filesize');
        $post_max_size = ini_get('post_max_size');

        //convert from short-string representation to "real" bytes
        $multiplier_a = [ "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;
    }

Here is the caller graph for this function:

getAdditionalTableName()

assFileUpload::getAdditionalTableName

(

)

Definition at line 761 of file class.assFileUpload.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                            : string
    {
        return 'qpl_qst_fileupload';
    }

Here is the caller graph for this function:

getAllowedExtensions()

assFileUpload::getAllowedExtensions

(

)

Definition at line 812 of file class.assFileUpload.php.

References $allowedextensions.

Referenced by saveAdditionalQuestionDataToDb().

                                          : string
    {
        return $this->allowedextensions;
    }

Here is the caller graph for this function:

getAllowedExtensionsArray()

assFileUpload::getAllowedExtensionsArray

(

)

Definition at line 803 of file class.assFileUpload.php.

Referenced by checkUpload(), and toLog().

                                               : array
    {
        if ($this->allowedextensions === '') {
            return [];
        }

        return array_filter(array_map('trim', explode(',', $this->allowedextensions)));
    }

Here is the caller graph for this function:

getAnswerTableName()

assFileUpload::getAnswerTableName

(

)

Definition at line 766 of file class.assFileUpload.php.

                                        : string
    {
        return '';
    }

getBestSolution()

assFileUpload::getBestSolution	(		$active_id,
			$pass
	)

Definition at line 787 of file class.assFileUpload.php.

                                                      : array
    {
        $user_solution = [];
        return $user_solution;
    }

getCorrectSolutionForTextOutput()

assFileUpload::getCorrectSolutionForTextOutput	(	int	$active_id,
		int	$pass
	)

Definition at line 949 of file class.assFileUpload.php.

                                                                              : string
    {
        return '';
    }

getFileUploadPath()

assFileUpload::getFileUploadPath	(		$test_id,
			$active_id,
			$question_id = null
	)

Returns the filesystem path for file uploads.

Definition at line 269 of file class.assFileUpload.php.

References CLIENT_WEB_DIR, and assQuestion\getId().

Referenced by getUploadedFilesForWeb().

                                                                                : string
    {
        if (is_null($question_id)) {
            $question_id = $this->getId();
        }
        return CLIENT_WEB_DIR . "/assessment/tst_{$test_id}/{$active_id}/{$question_id}/files/";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileUploadPathWeb()

assFileUpload::getFileUploadPathWeb	(		$test_id,
			$active_id,
			$question_id = null
	)

Returns the file upload path for web accessible files of a question.

public

Definition at line 290 of file class.assFileUpload.php.

References CLIENT_WEB_DIR, assQuestion\getId(), and ilFileUtils\removeTrailingPathSeparators().

Referenced by getUploadedFilesForWeb().

    {
        if (is_null($question_id)) {
            $question_id = $this->getId();
        }
        $webdir = ilFileUtils::removeTrailingPathSeparators(CLIENT_WEB_DIR)
            . "/assessment/tst_{$test_id}/{$active_id}/{$question_id}/files/";
        return str_replace(
            ilFileUtils::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
            ilFileUtils::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
            $webdir
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxFilesizeAsString()

assFileUpload::getMaxFilesizeAsString

(

)

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

References getMaxFilesizeInBytes().

Referenced by toLog().

                                            : string
    {
        $size = $this->getMaxFilesizeInBytes();
        if ($size < 1024) {
            return sprintf('%d Bytes', $size);
        }

        if ($size < 1024 * 1024) {
            return  sprintf('%.1f KB', $size / 1024);
        }

        return sprintf('%.1f MB', $size / 1024 / 1024);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxFilesizeInBytes()

assFileUpload::getMaxFilesizeInBytes ( )

protected

Definition at line 479 of file class.assFileUpload.php.

References determineMaxFilesize(), and getMaxSize().

Referenced by checkUpload(), and getMaxFilesizeAsString().

                                              : int
    {
        if ($this->getMaxSize() > 0) {
            return $this->getMaxSize();
        }

        return $this->determineMaxFilesize();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaximumPoints()

assFileUpload::getMaximumPoints

(

)

Definition at line 180 of file class.assFileUpload.php.

References assQuestion\getPoints().

Referenced by isComplete().

                                      : float
    {
        return $this->getPoints();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxSize()

assFileUpload::getMaxSize

(

)

Definition at line 793 of file class.assFileUpload.php.

References $maxsize.

Referenced by getMaxFilesizeInBytes(), and saveAdditionalQuestionDataToDb().

                                : ?int
    {
        return $this->maxsize;
    }

Here is the caller graph for this function:

getPreviewFileUploadPath()

assFileUpload::getPreviewFileUploadPath (   $userId )

protected

Returns the filesystem path for file uploads.

Definition at line 280 of file class.assFileUpload.php.

References CLIENT_WEB_DIR.

Referenced by deletePreviewFileUploads(), and savePreviewData().

                                                        : string
    {
        return CLIENT_WEB_DIR . "/assessment/qst_preview/{$userId}/{$this->getId()}/fileuploads/";
    }

Here is the caller graph for this function:

getPreviewFileUploadPathWeb()

assFileUpload::getPreviewFileUploadPathWeb ( int  $user_id )

protected

Definition at line 304 of file class.assFileUpload.php.

References CLIENT_WEB_DIR, and ilFileUtils\removeTrailingPathSeparators().

Referenced by savePreviewData().

                                                                : string
    {
        $webdir = ilFileUtils::removeTrailingPathSeparators(CLIENT_WEB_DIR)
            . "/assessment/qst_preview/{$user_id}/{$this->getId()}/fileuploads/";
        return str_replace(
            ilFileUtils::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
            ilFileUtils::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
            $webdir
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPreviewFileUploads()

assFileUpload::getPreviewFileUploads

(

ilAssQuestionPreviewSession

$previewSession

)

Definition at line 341 of file class.assFileUpload.php.

References ilAssQuestionPreviewSession\getParticipantsSolution(), and null.

                                                                                      : array
    {
        if ($previewSession->getParticipantsSolution() === false || $previewSession->getParticipantsSolution() === null) {
            return [];
        }

        return $previewSession->getParticipantsSolution();
    }

Here is the call graph for this function:

getQuestionType()

assFileUpload::getQuestionType

(

)

Definition at line 756 of file class.assFileUpload.php.

Referenced by toLog().

                                     : string
    {
        return 'assFileUpload';
    }

Here is the caller graph for this function:

getRTETextWithMediaObjects()

assFileUpload::getRTETextWithMediaObjects

(

)

Collects all text in the question which could contain media objects which were created with the Rich Text Editor.

Definition at line 782 of file class.assFileUpload.php.

                                                : string
    {
        return parent::getRTETextWithMediaObjects();
    }

getUploadedFiles()

assFileUpload::getUploadedFiles	(	int	$active_id,
		?int	$pass = null,
		bool	$authorized = true
	)

Definition at line 315 of file class.assFileUpload.php.

References $data, assQuestion\getId(), and assQuestion\getSolutionMaxPass().

Referenced by getUploadedFilesForWeb().

     : array {
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        // fau: testNav - check existing value1 because the intermediate solution will have a dummy entry
        $result = $this->db->queryF(
            'SELECT * FROM tst_solutions WHERE active_fi = %s '
            . 'AND question_fi = %s AND pass = %s AND authorized = %s '
            . 'AND value1 IS NOT NULL ORDER BY tstamp',
            ['integer', 'integer', 'integer', 'integer'],
            [$active_id, $this->getId(), $pass, (int) $authorized]
        );
        // fau.
        $found = [];

        while ($data = $this->db->fetchAssoc($result)) {
            array_push($found, $data);
        }

        return $found;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUploadedFilesForWeb()

assFileUpload::getUploadedFilesForWeb	(		$active_id,
			$pass
	)

Returns the web accessible uploaded files for an active user in a given pass.

Returns

array Results

Definition at line 355 of file class.assFileUpload.php.

References $data, $path, assQuestion\$step, assQuestion\$test_id, $url, getFileUploadPath(), getFileUploadPathWeb(), assQuestion\getSolutionValues(), assQuestion\getStep(), getUploadedFiles(), null, and assQuestion\setStep().

                                                             : array
    {
        $found = $this->getUploadedFiles($active_id, $pass);
        $result = $this->db->queryF(
            'SELECT test_fi FROM tst_active WHERE active_id = %s',
            ['integer'],
            [$active_id]
        );
        if ($result->numRows() == 1) {
            $row = $this->db->fetchAssoc($result);
            $test_id = $row['test_fi'];
            $path = $this->getFileUploadPathWeb($test_id, $active_id);
            foreach ($found as $idx => $data) {
                // depending on whether the files are already stored in the IRSS or not, the files are compiled differently here.
                // this can be removed with ILIAs 10 and switched exclusively to the IRSS variant.
                // We recommend then to revise the whole handling of files

                if ($data['value2'] === 'rid') {
                    $rid = $this->irss->manage()->find($data['value1']);
                    if ($rid === null) {
                        continue;
                    }
                    $revision = $this->irss->manage()->getCurrentRevision($rid);
                    $stream = $this->irss->consume()->stream($rid)->getStream();
                    $url = $this->file_delivery->buildTokenURL(
                        $stream,
                        $revision->getTitle(),
                        Disposition::ATTACHMENT,
                        $this->current_user->getId(),
                        1
                    );

                    $path = (string) $url;
                    $found[$idx]['webpath'] = $path;
                    $found[$idx]['value2'] = $revision->getTitle();
                } else {
                    $found[$idx]['webpath'] = $path;
                }
            }
        }
        return $found;
    }

Here is the call graph for this function:

getUserSolutionPreferingIntermediate()

assFileUpload::getUserSolutionPreferingIntermediate	(	int	$active_id,
		?int	$pass = null
	)

Definition at line 663 of file class.assFileUpload.php.

References assQuestion\getSolutionValues().

     : array {
        $solution = $this->getSolutionValues($active_id, $pass, false);

        if (!count($solution)) {
            $solution = $this->getSolutionValues($active_id, $pass, true);
        } else {
            $cleaned = [];
            foreach ($solution as $row) {
                if (!empty($row['value1'])) {
                    $cleaned[] = $row;
                }
            }
            $solution = $cleaned;
        }

        return $solution;
    }

Here is the call graph for this function:

hasFileUploads()

assFileUpload::hasFileUploads

(

int

$test_id

)

Implements ilObjFileHandlingQuestionType.

Definition at line 822 of file class.assFileUpload.php.

References assQuestion\getId().

                                                : bool
    {
        $query = '
                SELECT tst_solutions.solution_id
                FROM tst_solutions, tst_active, qpl_questions
                WHERE tst_solutions.active_fi = tst_active.active_id
                AND tst_solutions.question_fi = qpl_questions.question_id
                AND tst_solutions.question_fi = %s AND tst_active.test_fi = %s
                AND tst_solutions.value1 is not null';
        $result = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->getId(), $test_id]
        );
        if ($result->numRows() > 0) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

isComplete()

assFileUpload::isComplete

(

)

Returns true, if the question is complete for use.

Returns

boolean True, if the question is complete for use, otherwise false

Definition at line 95 of file class.assFileUpload.php.

References getMaximumPoints().

                                : bool
    {
        if (
            strlen($this->title)
            && ($this->author)
            && ($this->question)
            && ($this->getMaximumPoints() >= 0)
            && is_numeric($this->getMaximumPoints())) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

isCompletionBySubmissionEnabled()

assFileUpload::isCompletionBySubmissionEnabled

(

)

Definition at line 858 of file class.assFileUpload.php.

References $completion_by_submission.

Referenced by calculateReachedPoints(), calculateReachedPointsForSolution(), saveAdditionalQuestionDataToDb(), and toLog().

                                                     : bool
    {
        return $this->completion_by_submission;
    }

Here is the caller graph for this function:

isFileDeletionAction()

assFileUpload::isFileDeletionAction ( )

protected

Definition at line 875 of file class.assFileUpload.php.

References assFileUploadGUI\DELETE_FILES_ACTION, and assQuestion\getQuestionAction().

Referenced by resolveRIDStoDelete(), savePreviewData(), and saveWorkingData().

                                             : bool
    {
        return $this->getQuestionAction() == assFileUploadGUI::DELETE_FILES_ACTION;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFileDeletionSubmitAvailable()

assFileUpload::isFileDeletionSubmitAvailable ( )

protected

Definition at line 880 of file class.assFileUpload.php.

References assQuestion\isNonEmptyItemListPostSubmission().

Referenced by resolveRIDStoDelete(), savePreviewData(), and saveWorkingData().

                                                      : bool
    {
        return $this->isNonEmptyItemListPostSubmission(self::DELETE_FILES_TBL_POSTVAR);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFileReuseHandlingRequired()

assFileUpload::isFileReuseHandlingRequired ( )

protected

Definition at line 890 of file class.assFileUpload.php.

References assQuestion\getTestPresentationConfig(), and isFileReuseSubmitAvailable().

Referenced by saveWorkingData().

                                                    : bool
    {
        if (!$this->getTestPresentationConfig()->isPreviousPassSolutionReuseAllowed()) {
            return false;
        }

        if (!$this->isFileReuseSubmitAvailable()) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFileReuseSubmitAvailable()

assFileUpload::isFileReuseSubmitAvailable ( )

protected

Definition at line 885 of file class.assFileUpload.php.

References assQuestion\isNonEmptyItemListPostSubmission().

Referenced by isFileReuseHandlingRequired().

                                                   : bool
    {
        return $this->isNonEmptyItemListPostSubmission(self::REUSE_FILES_TBL_POSTVAR);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFileUploadAvailable()

assFileUpload::isFileUploadAvailable ( )

protected

Exceptions

IllegalStateException

Definition at line 906 of file class.assFileUpload.php.

Referenced by savePreviewData(), and saveWorkingData().

                                              : bool
    {
        if (!$this->file_upload->hasBeenProcessed()) {
            $this->file_upload->process();
        }
        return $this->file_upload->hasUploads();
    }

Here is the caller graph for this function:

loadFromDb()

assFileUpload::loadFromDb

(

int

$question_id

)

Definition at line 138 of file class.assFileUpload.php.

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), null, assQuestion\setAdditionalContentEditingMode(), setAllowedExtensions(), assQuestion\setAuthor(), assQuestion\setComment(), setCompletionBySubmission(), assQuestion\setId(), assQuestion\setLifecycle(), setMaxSize(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), and assQuestion\setTitle().

                                                : void
    {

        $result = $this->db->queryF(
            'SELECT qpl_questions.*, ' . $this->getAdditionalTableName()
            . '.* FROM qpl_questions LEFT JOIN ' . $this->getAdditionalTableName()
            . ' ON ' . $this->getAdditionalTableName()
            . '.question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s',
            ['integer'],
            [$question_id]
        );
        if ($result->numRows() == 1) {
            $data = $this->db->fetchAssoc($result);
            $this->setId($question_id);
            $this->setTitle((string) $data['title']);
            $this->setComment((string) $data['description']);
            $this->setNrOfTries($data['nr_of_tries']);
            $this->setOriginalId($data['original_id']);
            $this->setObjId($data['obj_fi']);
            $this->setAuthor($data['author']);
            $this->setOwner($data['owner']);
            $this->setPoints($data['points']);

            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data['question_text'], 1));
            $this->setMaxSize(($data['maxsize'] ?? null) ? (int) $data['maxsize'] : null);
            $this->setAllowedExtensions($data['allowedextensions'] ?? '');
            $this->setCompletionBySubmission($data['compl_by_submission'] == 1 ? true : false);

            try {
                $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
            }

            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
        }
        parent::loadFromDb($question_id);
    }

Here is the call graph for this function:

removeIntermediateSolution()

assFileUpload::removeIntermediateSolution	(	int	$active_id,
		int	$pass
	)

Definition at line 684 of file class.assFileUpload.php.

References assQuestion\$test_id.

                                                                         : void
    {
        parent::removeIntermediateSolution($active_id, $pass);

        $test_id = $this->participant_repository->lookupTestIdByActiveId($active_id);
        if ($test_id !== -1) {
            // TODO: This can be removed with ILIAS 10
            $this->deleteUnusedFiles([], $test_id, $active_id, $pass);
        }
    }

removeSolutionRecordById()

assFileUpload::removeSolutionRecordById ( int  $solution_id )

protected

Definition at line 658 of file class.assFileUpload.php.

Referenced by saveWorkingData().

                                                                 : int
    {
        return parent::removeSolutionRecordById($solution_id);
    }

Here is the caller graph for this function:

resolveRIDStoDelete()

assFileUpload::resolveRIDStoDelete ( )

protected

Definition at line 637 of file class.assFileUpload.php.

References Vendor\Package\$d, $res, isFileDeletionAction(), and isFileDeletionSubmitAvailable().

Referenced by saveWorkingData().

                                            : array
    {
        $rids_to_delete = [];
        if ($this->isFileDeletionAction() && $this->isFileDeletionSubmitAvailable()) {
            $delete_files = $this->questionpool_request->intArray(self::DELETE_FILES_TBL_POSTVAR);

            $res = $this->db->query(
                "SELECT value1 FROM tst_solutions WHERE value2 = 'rid' AND " . $this->db->in(
                    'solution_id',
                    $delete_files,
                    false,
                    'integer'
                )
            );
            while ($d = $this->db->fetchAssoc($res)) {
                $rids_to_delete[] = $d['value1'];
            }
        }
        return $rids_to_delete;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAdditionalQuestionDataToDb()

assFileUpload::saveAdditionalQuestionDataToDb

(

)

Saves a record to the question types additional data table.

Returns

mixed

Implements ilObjQuestionScoringAdjustable.

Definition at line 118 of file class.assFileUpload.php.

References getAdditionalTableName(), getAllowedExtensions(), assQuestion\getId(), getMaxSize(), isCompletionBySubmissionEnabled(), and null.

Referenced by saveToDb().

    {
        $this->db->manipulateF(
            'DELETE FROM ' . $this->getAdditionalTableName() . ' WHERE question_fi = %s',
            ['integer'],
            [$this->getId()]
        );
        $this->db->manipulateF(
            'INSERT INTO ' . $this->getAdditionalTableName(
            ) . ' (question_fi, maxsize, allowedextensions, compl_by_submission) VALUES (%s, %s, %s, %s)',
            ['integer', 'float', 'text', 'integer' ],
            [
                $this->getId(),
                $this->getMaxSize(),
                (strlen($this->getAllowedExtensions())) ? $this->getAllowedExtensions() : null,
                (int) $this->isCompletionBySubmissionEnabled()
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePreviewData()

assFileUpload::savePreviewData ( ilAssQuestionPreviewSession  $previewSession )

protected

Definition at line 696 of file class.assFileUpload.php.

References Vendor\Package\$e, $version, checkUpload(), deletePreviewFileUploads(), ilAssQuestionPreviewSession\getParticipantsSolution(), getPreviewFileUploadPath(), getPreviewFileUploadPathWeb(), ilAssQuestionPreviewSession\getUserId(), isFileDeletionAction(), isFileDeletionSubmitAvailable(), isFileUploadAvailable(), ILIAS\Repository\lng(), ilFileUtils\makeDirParents(), ilFileUtils\moveUploadedFile(), and ilAssQuestionPreviewSession\setParticipantsSolution().

                                                                                   : void
    {
        $userSolution = $previewSession->getParticipantsSolution();

        if (!is_array($userSolution)) {
            $userSolution = [];
        }

        // hey: prevPassSolutions - readability spree - get a chance to understand the code
        if ($this->isFileDeletionAction()) {
            // hey.
            // hey: prevPassSolutions - readability spree - get a chance to understand the code
            if ($this->isFileDeletionSubmitAvailable()) {
                // hey.
                $delete_files = $this->questionpool_request->strArray(self::DELETE_FILES_TBL_POSTVAR);

                $userSolution = $this->deletePreviewFileUploads($previewSession->getUserId(), $userSolution, $delete_files);
            } else {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
            }
        } else {
            // hey: prevPassSolutions - readability spree - get a chance to understand the code
            try {
                $fileUploadAvailable = $this->current_cmd !== 'instantResponse'
                    && $this->isFileUploadAvailable();
            } catch (IllegalStateException $e) {
                $this->tpl->setOnScreenMessage('failure', $e->getMessage(), true);
                return;
            }
            if ($fileUploadAvailable) {
                // hey.
                if ($this->checkUpload()) {
                    if (!@file_exists($this->getPreviewFileUploadPath($previewSession->getUserId()))) {
                        ilFileUtils::makeDirParents($this->getPreviewFileUploadPath($previewSession->getUserId()));
                    }

                    $version = time();
                    $filename_arr = pathinfo($_FILES['upload']['name']);
                    $extension = $filename_arr['extension'];
                    $newfile = 'file_' . md5($_FILES['upload']['name']) . '_' . $version . '.' . $extension;
                    ilFileUtils::moveUploadedFile(
                        $_FILES['upload']['tmp_name'],
                        $_FILES['upload']['name'],
                        $this->getPreviewFileUploadPath($previewSession->getUserId()) . $newfile
                    );

                    $userSolution[$newfile] = [
                        'solution_id' => $newfile,
                        'value1' => $newfile,
                        'value2' => $_FILES['upload']['name'],
                        'tstamp' => $version,
                        'webpath' => $this->getPreviewFileUploadPathWeb($previewSession->getUserId())
                    ];
                }
            }
        }

        $previewSession->setParticipantsSolution($userSolution);
    }

Here is the call graph for this function:

saveToDb()

assFileUpload::saveToDb

(

?int

$original_id = null

)

Saves a assFileUpload object to a database.

Definition at line 111 of file class.assFileUpload.php.

References assQuestion\$original_id, saveAdditionalQuestionDataToDb(), and assQuestion\saveQuestionDataToDb().

                                                      : void
    {
        $this->saveQuestionDataToDb($original_id);
        $this->saveAdditionalQuestionDataToDb();
        parent::saveToDb();
    }

Here is the call graph for this function:

saveWorkingData()

assFileUpload::saveWorkingData	(	int	$active_id,
		?int	$pass = null,
		bool	$authorized = true
	)

Definition at line 528 of file class.assFileUpload.php.

References Vendor\Package\$e, assQuestion\$test_id, ilObjTest\_getPass(), checkUpload(), assQuestion\deleteDummySolutionRecord(), assQuestion\forceExistingIntermediateSolution(), assQuestion\getProcessLocker(), assQuestion\getSolutionRecordById(), assQuestion\intermediateSolutionExists(), isFileDeletionAction(), isFileDeletionSubmitAvailable(), isFileReuseHandlingRequired(), isFileUploadAvailable(), ILIAS\Repository\lng(), null, assQuestion\removeCurrentSolution(), removeSolutionRecordById(), resolveRIDStoDelete(), assQuestion\saveCurrentSolution(), and assQuestion\updateCurrentSolutionsAuthorization().

     : bool {
        if ($pass === null || $pass < 0) {
            $pass = \ilObjTest::_getPass($active_id);
        }

        $test_id = $this->participant_repository->lookupTestIdByActiveId($active_id);

        try {
            $upload_handling_required = $this->current_cmd !== 'submitSolution'
                && $this->current_cmd !== 'showInstantResponse'
                && !$this->isFileDeletionAction()
                && $this->isFileUploadAvailable()
                && $this->checkUpload();
        } catch (IllegalStateException $e) {
            $this->tpl->setOnScreenMessage('failure', $e->getMessage(), true);
            return false;
        }

        $rid = null;

        if ($upload_handling_required) {
            // upload new file to storage
            $upload_results = $this->file_upload->getResults();
            $upload_result = end($upload_results); // only one supported at the moment
            $rid = $this->irss->manage()->upload(
                $upload_result,
                new assFileUploadStakeholder()
            );
        }

        // RIDS to delete
        // Unfortunately, at the moment it is not possible to delete the files from the IRSS, because the process takes
        // place within the ProcessLocker and the IRSS tables cannot be used. we have to remove them after the lock.
        // therefore we store the rids to delete in an array for later deletion.
        $rids_to_delete = $this->resolveRIDStoDelete();

        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
            function () use ($upload_handling_required, $active_id, $pass, $authorized, $rid) {
                if ($authorized === false) {
                    $this->forceExistingIntermediateSolution($active_id, $pass, true);
                }

                if ($this->isFileDeletionAction()) {
                    if ($this->isFileDeletionSubmitAvailable()) {
                        $delete_files = $this->questionpool_request->intArray(self::DELETE_FILES_TBL_POSTVAR);

                        foreach ($delete_files as $solution_id) {
                            $this->removeSolutionRecordById($solution_id);
                        }
                    } else {
                        $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
                    }
                } else {
                    if ($this->isFileReuseHandlingRequired()) {
                        $reuse_files = $this->questionpool_request->intArray(self::REUSE_FILES_TBL_POSTVAR);

                        foreach ($reuse_files as $solutionId) {
                            $solution = $this->getSolutionRecordById($solutionId);

                            $this->saveCurrentSolution(
                                $active_id,
                                $pass,
                                $solution['value1'],
                                $solution['value2'],
                                false,
                                $solution['tstamp']
                            );
                        }
                    }

                    if ($upload_handling_required && $rid !== null) {
                        $revision = $this->irss->manage()->getCurrentRevision($rid);
                        $this->saveCurrentSolution(
                            $active_id,
                            $pass,
                            $rid->serialize(),
                            'rid',
                            false,
                            time()
                        );
                    }
                }

                if ($authorized === true && $this->intermediateSolutionExists($active_id, $pass)) {
                    // remove the dummy record of the intermediate solution
                    $this->deleteDummySolutionRecord($active_id, $pass);

                    // delete the authorized solution and make the intermediate solution authorized (keeping timestamps)
                    $this->removeCurrentSolution($active_id, $pass, true);
                    $this->updateCurrentSolutionsAuthorization($active_id, $pass, true, true);
                }

            }
        );

        $this->deleteUnusedFiles(
            $rids_to_delete,
            $test_id,
            $active_id,
            $pass
        );

        return true;
    }

Here is the call graph for this function:

setAllowedExtensions()

assFileUpload::setAllowedExtensions

(

string

$a_value

)

Definition at line 817 of file class.assFileUpload.php.

Referenced by loadFromDb().

                                                         : void
    {
        $this->allowedextensions = strtolower(trim($a_value));
    }

Here is the caller graph for this function:

setCompletionBySubmission()

assFileUpload::setCompletionBySubmission

(

bool

$bool

)

Definition at line 863 of file class.assFileUpload.php.

Referenced by loadFromDb().

                                                         : assFileUpload
    {
        $this->completion_by_submission = (bool) $bool;
        return $this;
    }

Here is the caller graph for this function:

setMaxSize()

assFileUpload::setMaxSize

(

?int

$value

)

Definition at line 798 of file class.assFileUpload.php.

Referenced by loadFromDb().

                                           : void
    {
        $this->maxsize = $value;
    }

Here is the caller graph for this function:

solutionValuesToLog()

assFileUpload::solutionValuesToLog ( AdditionalInformationGenerator  $additional_info, array  $solution_values  )

protected

Definition at line 931 of file class.assFileUpload.php.

     : array {
        return array_map(
            static fn(array $v): string => "{$v['value1']} - {$v['value2']}",
            $solution_values
        );
    }

solutionValuesToText()

assFileUpload::solutionValuesToText

(

array

$solution_values

)

Definition at line 941 of file class.assFileUpload.php.

                                                                : array
    {
        return array_map(
            static fn(array $v): string => "{$v['value1']} - {$v['value2']}",
            $solution_values
        );
    }

toLog()

assFileUpload::toLog

(

AdditionalInformationGenerator

$additional_info

)

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 914 of file class.assFileUpload.php.

References assQuestion\formatSAQuestion(), getAllowedExtensionsArray(), ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool(), getMaxFilesizeAsString(), assQuestion\getPoints(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getTitleForHTMLOutput(), and isCompletionBySubmissionEnabled().

                                                                          : array
    {
        return [
            AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
            AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
            AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
            AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => $this->getPoints(),
            AdditionalInformationGenerator::KEY_QUESTION_UPLOAD_MAXSIZE => $this->getMaxFilesizeAsString(),
            AdditionalInformationGenerator::KEY_QUESTION_UPLOAD_ALLOWED_EXTENSIONS => $this->getAllowedExtensionsArray(),
            AdditionalInformationGenerator::KEY_QUESTION_UPLOAD_COMPLETION_BY_SUBMISSION => $additional_info->getEnabledDisabledTagForBool($this->isCompletionBySubmissionEnabled()),
            AdditionalInformationGenerator::KEY_FEEDBACK => [
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_INCOMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_COMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
            ]
        ];
    }

Here is the call graph for this function:

Field Documentation

$allowedextensions

string assFileUpload::$allowedextensions = ''

protected

Definition at line 52 of file class.assFileUpload.php.

Referenced by getAllowedExtensions().

$completion_by_submission

assFileUpload::$completion_by_submission = false

protected

Definition at line 57 of file class.assFileUpload.php.

Referenced by isCompletionBySubmissionEnabled().

$current_cmd

string assFileUpload::$current_cmd

private

Definition at line 54 of file class.assFileUpload.php.

$file_delivery

ILIAS FileDelivery Services assFileUpload::$file_delivery

private

Definition at line 47 of file class.assFileUpload.php.

$file_upload

ILIAS FileUpload FileUpload assFileUpload::$file_upload

private

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

$irss

ILIAS ResourceStorage Services assFileUpload::$irss

private

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

$maxsize

int assFileUpload::$maxsize = null

protected

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

Referenced by getMaxSize().

$participant_repository

ParticipantRepository assFileUpload::$participant_repository

private

Definition at line 45 of file class.assFileUpload.php.

DELETE_FILES_TBL_POSTVAR

const assFileUpload::DELETE_FILES_TBL_POSTVAR = 'deletefiles'

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

Referenced by assFileUploadGUI\getPreview(), and assFileUploadGUI\getTestPresentationFileTablePostVar().

HAS_SPECIFIC_FEEDBACK

const assFileUpload::HAS_SPECIFIC_FEEDBACK = false

protected

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

REUSE_FILES_TBL_POSTVAR

const assFileUpload::REUSE_FILES_TBL_POSTVAR = 'reusefiles'

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

Referenced by assFileUploadGUI\getTestPresentationFileTablePostVar().

---

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

• components/ILIAS/TestQuestionPool/classes/class.assFileUpload.php