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 ($original_id='')
	Saves a assFileUpload object to a database. More...

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

	loadFromDb ($question_id)
	Loads a assFileUpload object from a database. More...

	duplicate (bool $for_test=true, string $title='', string $author='', int $owner=-1, $testObjId=null)
	Duplicates an assFileUpload. More...

	copyObject ($target_questionpool_id, $title='')
	Copies an assFileUpload object. More...

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle='')

	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...

	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

	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 ($active_id, $pass=null, $authorized=true)
	Returns the uploaded files for an active user in a given pass. More...

	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 ($active_id, $pass=null, $authorized=true)
	public More...

	getUserSolutionPreferingIntermediate ($active_id, $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...

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, int $active_id, int $pass)
	{} More...

	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Creates a question from a QTI file. More...

	toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)

	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 ()

Public Member Functions inherited from assQuestion
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

	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...

	isComplete ()
	Returns true, if a question is complete for use. 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 $authorizedSolution=true)
	returns the reached points ... More...

	calculateResultsFromSolution (int $active_id, int $pass, bool $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...

	persistWorkingState (int $active_id, $pass, bool $obligationsEnabled=false, bool $authorized=true)
	persists the working state for current testactive and testpass More...

	persistPreviewState (ilAssQuestionPreviewSession $previewSession)
	persists the preview state for current user and question More...

	validateSolutionSubmit ()

	saveWorkingData (int $active_id, int $pass, bool $authorized=true)
	Saves the learners input of the question to the database. More...

	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, $pass=null)

	getSolutionValues ($active_id, $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	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=-1)

	saveToDb ()

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

	adjustReachedPointsByScoringOptions ($points, $active_id, $pass=null)
	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="")

	getQuestionType ()
	Returns the question type of the question. More...

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...

	hasSpecificFeedback ()

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, int $active_id, int $pass)

	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 ($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 ()

	duplicate (bool $for_test=true, string $title="", string $author="", int $owner=-1, $testObjId=null)

	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 $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

Public Member Functions inherited from ilObjFileHandlingQuestionType
	getFileUploadPath (int $test_id, int $active_id, int $question_id=null)

Static Public Member Functions
static	isObligationPossible (int $question_id)

Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $forcePassResultsUpdateEnabled)

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

static	_getReachedPoints (int $active_id, int $question_id, int $pass)

static	logAction (string $logtext, int $active_id, int $question_id)

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

static	instantiateQuestion (int $question_id)

static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...

static	_isWriteable (int $question_id, int $user_id)

static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled, ?int $test_id=null)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	_needsManualScoring (int $question_id)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	isObligationPossible (int $questionId)

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...

Data Fields
const	REUSE_FILES_TBL_POSTVAR = 'reusefiles'

const	DELETE_FILES_TBL_POSTVAR = 'deletefiles'

Data Fields inherited from assQuestion
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

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 ($userSolution)

	getPreviewFileUploadPath ($userId)
	Returns the filesystem path for file uploads. More...

	getPreviewFileUploadPathWeb ($userId)
	Returns the filesystem path for file uploads. More...

	deletePreviewFileUploads ($userId, $userSolution, $files)

	getMaxFilesizeInBytes ()

	resolveRIDStoDelete ()

	removeSolutionRecordById (int $solution_id)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	handleSubmission (int $active_id, int $pass, bool $obligations_answered, bool $authorized)

	isFileDeletionAction ()

	isFileDeletionSubmitAvailable ()

	isFileReuseSubmitAvailable ()

	isFileReuseHandlingRequired ()

	isFileUploadAvailable ()

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	log (int $active_id, string $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion (int $question_id)

	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)

	beforeSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)

	afterSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)

	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 ()

	syncSuggestedSolutions (int $target_question_id, int $target_obj_id)

	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...

	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)

	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints ($points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)

	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 ()
	build basic test question configuration instance More...

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

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

ILIAS TestQuestionPool QuestionInfoService	$questioninfo

ILIAS Test TestParticipantInfoService	$testParticipantInfo

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS TestQuestionPool QuestionFilesService	$questionFilesService

ILIAS DI LoggingServices	$ilLog

int	$id

string	$title

string	$comment

string	$owner

string	$author

int	$thumb_size

string	$question
	The question text. More...

float	$points
	The maximum available points for the question. More...

bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...

int	$test_id
	The database id of a test in which the question is contained. More...

int	$obj_id = 0
	Object id of the container object. More...

	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

Container	$dic

array	$suggested_solutions

int	$original_id = null

	$page

string	$external_id = null

ilAssQuestionProcessLocker	$processLocker

	$step

	$lastChange

Transformation	$shuffler

ilTestQuestionConfig	$testQuestionConfig

ilAssQuestionLifecycle	$lifecycle

ilObjUser	$current_user

SkillUsageService	$skillUsageService

assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Private Attributes
ILIAS ResourceStorage Services	$irss

ILIAS FileDelivery Services	$file_delivery

ILIAS FileUpload FileUpload	$file_upload

string	$current_cmd

Additional Inherited Members
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)

Static Protected Attributes inherited from assQuestion
static	$forcePassResultsUpdateEnabled = 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 35 of file class.assFileUpload.php.

Member Function Documentation

◆ buildTestPresentationConfig()

assFileUpload::buildTestPresentationConfig ( )

Definition at line 1114 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	(	$active_id,
		$pass = `null`,
		$authorizedSolution = `true`,
		$returndetails = `false`
	)

Returns the points, a learner has reached answering the question.

The points are calculated from the given answers.

public

Parameters

integer	$active_id
integer	$pass
boolean	$returndetails	(deprecated !!)

Returns: integer/array $points/$details (array $details is deprecated !!)

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

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

                                                                                                                         : float
     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
 
         if ($this->isCompletionBySubmissionEnabled()) {
             if (is_null($pass)) {
                 $pass = $this->getSolutionMaxPass($active_id);
             }
 
             global $DIC;
 
             $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
 
             while ($data = $DIC->database()->fetchAssoc($result)) {
                 if ($this->isDummySolutionRecord($data)) {
                     continue;
                 }
 
                 return $this->getPoints();
             }
         }
 
         return 0.0;
     }

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assFileUpload::calculateReachedPointsForSolution ( $userSolution )

protected

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

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

     {
         if ($this->isCompletionBySubmissionEnabled() &&
             is_array($userSolution) &&
             count($userSolution)) {
             return $this->getPoints();
         }
 
         return 0;
     }

Here is the call graph for this function:

◆ checkUpload()

assFileUpload::checkUpload ( )

Check file upload.

Returns: boolean Input ok, true/false

Definition at line 363 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:

◆ copyObject()

assFileUpload::copyObject	(	$target_questionpool_id,
		$title = `''`
	)

Copies an assFileUpload object.

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

References assQuestion\$original_id, assQuestion\$title, assQuestion\getId(), and assQuestion\getObjId().

                                                                     : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
         // duplicate the question in database
         $clone = $this;
         $original_id = $this->questioninfo->getOriginalId($this->id);
         $clone->id = -1;
         $source_questionpool_id = $this->getObjId();
         $clone->setObjId($target_questionpool_id);
         if ($title) {
             $clone->setTitle($title);
         }
         $clone->saveToDb();
 
         // copy question page content
         $clone->copyPageOfQuestion($original_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
 
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

assFileUpload::createNewOriginalFromThisDuplicate	(	$targetParentId,
		$targetQuestionTitle = `''`
	)

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

References assQuestion\$id, assQuestion\getId(), and assQuestion\getObjId().

                                                                                                   : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
 
         $sourceQuestionId = $this->id;
         $sourceParentId = $this->getObjId();
 
         // duplicate the question in database
         $clone = $this;
         $clone->id = -1;
 
         $clone->setObjId($targetParentId);
 
         if ($targetQuestionTitle) {
             $clone->setTitle($targetQuestionTitle);
         }
 
         $clone->saveToDb();
         // copy question page content
         $clone->copyPageOfQuestion($sourceQuestionId);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
 
         $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call 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 968 of file class.assFileUpload.php.

                                                : void
     {
     }

◆ deletePreviewFileUploads()

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

protected

Definition at line 597 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 1083 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 633 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:

◆ duplicate()

assFileUpload::duplicate	(	bool	$for_test = `true`,
		string	$title = `''`,
		string	$author = `''`,
		int	$owner = `-1`,
			$testObjId = `null`
	)

Duplicates an assFileUpload.

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

References assQuestion\$author, assQuestion\$original_id, assQuestion\$owner, assQuestion\$title, assQuestion\getId(), and assQuestion\getObjId().

      : int {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return -1;
         }
         // duplicate the question in database
         $this_id = $this->getId();
         $thisObjId = $this->getObjId();
 
         $clone = $this;
         $original_id = $this->questioninfo->getOriginalId($this->id);
         $clone->id = -1;
 
         if ((int) $testObjId > 0) {
             $clone->setObjId($testObjId);
         }
 
         if ($title) {
             $clone->setTitle($title);
         }
 
         if ($author) {
             $clone->setAuthor($author);
         }
         if ($owner) {
             $clone->setOwner($owner);
         }
 
         if ($for_test) {
             $clone->saveToDb($original_id);
         } else {
             $clone->saveToDb();
         }
 
         // copy question page content
         $clone->copyPageOfQuestion($this_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
 
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ fromXML()

assFileUpload::fromXML	(		$item,
		int	$questionpool_id,
		?int	$tst_id,
		&	$tst_object,
		int &	$question_counter,
		array	$import_mapping,
		array &	$solutionhints = `[]`
	)

Creates a question from a QTI file.

Receives parameters from a QTI parser and creates a valid ILIAS question object

Parameters

ilQTIItem	$item	The QTI item object
integer	$questionpool_id	The id of the parent questionpool
integer	$tst_id	The id of the parent test if the question is part of a test
object	$tst_object	A reference to the parent test object
integer	$question_counter	A reference to a question counter to count the questions of an imported question pool
array	$import_mapping	An array containing references to included ILIAS objects

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

                                                                                                                                                                : array
     {
         $import = new assFileUploadImport($this);
         return $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
     }

◆ getAdditionalTableName()

assFileUpload::getAdditionalTableName ( )

Definition at line 955 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 1052 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 1043 of file class.assFileUpload.php.

Referenced by checkUpload().

                                                : 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 960 of file class.assFileUpload.php.

                                         : string
     {
         return '';
     }

◆ getBestSolution()

assFileUpload::getBestSolution	(	$active_id,
		$pass
	)

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

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

◆ getFileUploadPath()

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

Returns the filesystem path for file uploads.

Definition at line 405 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 426 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 609 of file class.assFileUpload.php.

References getMaxFilesizeInBytes().

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

◆ getMaxFilesizeInBytes()

assFileUpload::getMaxFilesizeInBytes ( )

protected

Definition at line 623 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 ( )

Returns the maximum points, a learner can reach answering the question.

See also: $points

Definition at line 305 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 1033 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 416 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 ( $userId )

protected

Returns the filesystem path for file uploads.

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

References CLIENT_WEB_DIR, and ilFileUtils\removeTrailingPathSeparators().

Referenced by savePreviewData().

     {
         $webdir = ilFileUtils::removeTrailingPathSeparators(CLIENT_WEB_DIR)
             . "/assessment/qst_preview/{$userId}/{$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 485 of file class.assFileUpload.php.

References ilAssQuestionPreviewSession\getParticipantsSolution().

                                                                                       : 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 950 of file class.assFileUpload.php.

                                      : string
     {
         return 'assFileUpload';
     }

◆ 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 976 of file class.assFileUpload.php.

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

◆ getUploadedFiles()

assFileUpload::getUploadedFiles	(	$active_id,
		$pass = `null`,
		$authorized = `true`
	)

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

Returns: array Results

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

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

Referenced by getUploadedFilesForWeb(), and handleSubmission().

                                                                                   : array
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         // fau: testNav - check existing value1 because the intermediate solution will have a dummy entry
         $result = $ilDB->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 = $ilDB->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 499 of file class.assFileUpload.php.

References $data, $path, assQuestion\$step, assQuestion\$test_id, $url, getFileUploadPath(), getFileUploadPathWeb(), assQuestion\getSolutionValues(), assQuestion\getStep(), getUploadedFiles(), 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	(	$active_id,
		$pass = `null`
	)

Parameters

int	$active_id
int \| null	$pass

Definition at line 840 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:

◆ handleSubmission()

assFileUpload::handleSubmission	(	int	$active_id,
		int	$pass,
		bool	$obligations_answered,
		bool	$authorized
	)

protected

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

References assQuestion\$points, ilObjTest\_getObjectIDFromActiveID(), ilObjTestAccess\_getParticipantId(), assQuestion\_setReachedPoints(), ilLPStatusWrapper\_updateStatus(), assQuestion\getId(), getUploadedFiles(), and isCompletionBySubmissionEnabled().

                                                                                                                 : void
     {
         if (!$authorized
             || !$this->isCompletionBySubmissionEnabled()
             || !$this->getUploadedFiles($active_id, $pass, $authorized)) {
             return;
         }
 
         $maxpoints = $this->questioninfo->getMaximumPoints($this->getId());
 
         $points = $maxpoints;
 
         assQuestion::_setReachedPoints($active_id, $this->getId(), $points, $maxpoints, $pass, true, $obligations_answered);
 
         ilLPStatusWrapper::_updateStatus(
             ilObjTest::_getObjectIDFromActiveID((int) $active_id),
             ilObjTestAccess::_getParticipantId((int) $active_id)
         );
     }

Here is the call graph for this function:

◆ hasFileUploads()

assFileUpload::hasFileUploads ( int $test_id )

Implements ilObjFileHandlingQuestionType.

Definition at line 1062 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 90 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 1098 of file class.assFileUpload.php.

References $completion_by_submission.

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

                                                      : bool
     {
         return $this->completion_by_submission;
     }

Here is the caller graph for this function:

◆ isFileDeletionAction()

assFileUpload::isFileDeletionAction ( )

protected

Definition at line 1120 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 1125 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 1135 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 1130 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 1151 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:

◆ isObligationPossible()

static assFileUpload::isObligationPossible ( int $question_id )

static

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

                                                                  : bool
     {
         return true;
     }

◆ loadFromDb()

assFileUpload::loadFromDb ( $question_id )

Loads a assFileUpload object from a database.

Parameters

integer $question_id A unique key which defines the question in the database

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

References $data, $DIC, Vendor\Package\$e, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), 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
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $result = $ilDB->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 = $ilDB->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 860 of file class.assFileUpload.php.

References assQuestion\$test_id.

                                                                          : void
     {
         parent::removeIntermediateSolution($active_id, $pass);
 
         $test_id = $this->testParticipantInfo->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 831 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 812 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()) {
             $res = $this->db->query(
                 "SELECT value1 FROM tst_solutions WHERE value2 = 'rid' AND " . $this->db->in(
                     'solution_id',
                     $_POST[self::DELETE_FILES_TBL_POSTVAR],
                     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 $DIC, $ilDB, getAdditionalTableName(), getAllowedExtensions(), assQuestion\getId(), getMaxSize(), and isCompletionBySubmissionEnabled().

Referenced by saveToDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilDB->manipulateF(
             'DELETE FROM ' . $this->getAdditionalTableName() . ' WHERE question_fi = %s',
             ['integer'],
             [$this->getId()]
         );
         $ilDB->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 872 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.
                 $userSolution = $this->deletePreviewFileUploads($previewSession->getUserId(), $userSolution, $_POST['deletefiles']);
             } 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 ( $original_id = '' )

Saves a assFileUpload object to a database.

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

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assFileUpload::saveWorkingData	(	$active_id,
		$pass = `null`,
		$authorized = `true`
	)

public

Parameters

integer	$active_id	Active id of the user
integer	$pass	Test pass

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

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

                                                                                  : bool
     {
         if ($pass === null || $pass < 0) {
             $pass = \ilObjTest::_getPass($active_id);
         }
 
         $test_id = $this->testParticipantInfo->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()
             );
         }
 
         $entered_values = false;
 
         // 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 (
                 &$entered_values,
                 $upload_handling_required,
                 $test_id,
                 $active_id,
                 $pass,
                 $authorized,
                 $rid
             ) {
                 if ($authorized === false) {
                     $this->forceExistingIntermediateSolution($active_id, $pass, true);
                 }
 
                 if ($this->isFileDeletionAction()) {
                     if ($this->isFileDeletionSubmitAvailable()) {
                         foreach ($_POST[self::DELETE_FILES_TBL_POSTVAR] as $solution_id) {
                             $this->removeSolutionRecordById($solution_id);
                         }
                     } else {
                         $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
                     }
                 } else {
                     if ($this->isFileReuseHandlingRequired()) {
                         foreach ($_POST[self::REUSE_FILES_TBL_POSTVAR] 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()
                         );
 
                         $entered_values = true;
                     }
                 }
 
                 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
         );
 
         if ($entered_values) {
             if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                 assQuestion::logAction($this->lng->txtlng(
                     'assessment',
                     'log_user_entered_values',
                     ilObjAssessmentFolder::_getLogLanguage()
                 ), $active_id, $this->getId());
             }
         } else {
             if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                 assQuestion::logAction($this->lng->txtlng(
                     'assessment',
                     'log_user_not_entered_values',
                     ilObjAssessmentFolder::_getLogLanguage()
                 ), $active_id, $this->getId());
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ setAllowedExtensions()

assFileUpload::setAllowedExtensions ( string $a_value )

Definition at line 1057 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 1103 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:

◆ setExportDetailsXLSX()

assFileUpload::setExportDetailsXLSX	(	ilAssExcelFormatHelper	$worksheet,
		int	$startrow,
		int	$col,
		int	$active_id,
		int	$pass
	)

{}

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

References ilExcel\getColumnCoord(), assQuestion\getSolutionValues(), ILIAS\Repository\lng(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                                : int
     {
         parent::setExportDetailsXLSX($worksheet, $startrow, $col, $active_id, $pass);
 
         $i = 1;
         $solutions = $this->getSolutionValues($active_id, $pass);
         foreach ($solutions as $solution) {
             $worksheet->setCell($startrow + $i, $col, $this->lng->txt('result'));
             $worksheet->setBold($worksheet->getColumnCoord($col) . ($startrow + $i));
             if (strlen($solution['value1'])) {
                 $worksheet->setCell($startrow + $i, $col + 2, $solution['value1']);
                 $worksheet->setCell($startrow + $i, $col + 3, $solution['value2']);
             }
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setMaxSize()

assFileUpload::setMaxSize ( ?int $value )

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

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ toXML()

assFileUpload::toXML	(	$a_include_header = `true`,
		$a_include_binary = `true`,
		$a_shuffle = `false`,
		$test_output = `false`,
		$force_image_references = `false`
	)

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

                                                                                                                                                         : string
     {
         $export = new assFileUploadExport($this);
         return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
     }

Field Documentation

◆ $allowedextensions

string assFileUpload::$allowedextensions = ''

protected

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

Referenced by getAllowedExtensions().

◆ $completion_by_submission

assFileUpload::$completion_by_submission = false

protected

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

Referenced by isCompletionBySubmissionEnabled().

◆ $current_cmd

string assFileUpload::$current_cmd

private

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

◆ $file_delivery

ILIAS FileDelivery Services assFileUpload::$file_delivery

private

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

◆ $file_upload

ILIAS FileUpload FileUpload assFileUpload::$file_upload

private

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

◆ $irss

ILIAS ResourceStorage Services assFileUpload::$irss

private

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

◆ $maxsize

int assFileUpload::$maxsize = null

protected

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

Referenced by getMaxSize().

◆ DELETE_FILES_TBL_POSTVAR

const assFileUpload::DELETE_FILES_TBL_POSTVAR = 'deletefiles'

Definition at line 39 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 42 of file class.assFileUpload.php.

◆ REUSE_FILES_TBL_POSTVAR

const assFileUpload::REUSE_FILES_TBL_POSTVAR = 'reusefiles'

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

Referenced by assFileUploadGUI\getTestPresentationFileTablePostVar().

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

Modules/TestQuestionPool/classes/class.assFileUpload.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildTestPresentationConfig()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ checkUpload()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswers()

◆ deletePreviewFileUploads()

◆ deliverFileUploadZIPFile()

◆ determineMaxFilesize()

◆ duplicate()

◆ fromXML()

◆ getAdditionalTableName()

◆ getAllowedExtensions()

◆ getAllowedExtensionsArray()

◆ getAnswerTableName()

◆ getBestSolution()

◆ getFileUploadPath()

◆ getFileUploadPathWeb()

◆ getMaxFilesizeAsString()

◆ getMaxFilesizeInBytes()

◆ getMaximumPoints()

◆ getMaxSize()

◆ getPreviewFileUploadPath()

◆ getPreviewFileUploadPathWeb()

◆ getPreviewFileUploads()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getUploadedFiles()

◆ getUploadedFilesForWeb()

◆ getUserSolutionPreferingIntermediate()

◆ handleSubmission()

◆ hasFileUploads()

◆ isComplete()

◆ isCompletionBySubmissionEnabled()

◆ isFileDeletionAction()

◆ isFileDeletionSubmitAvailable()

◆ isFileReuseHandlingRequired()

◆ isFileReuseSubmitAvailable()

◆ isFileUploadAvailable()

◆ isObligationPossible()

◆ loadFromDb()

◆ removeIntermediateSolution()

◆ removeSolutionRecordById()

◆ resolveRIDStoDelete()

◆ saveAdditionalQuestionDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setAllowedExtensions()

◆ setCompletionBySubmission()

◆ setExportDetailsXLSX()

◆ setMaxSize()

◆ toXML()

Field Documentation

◆ $allowedextensions

◆ $completion_by_submission

◆ $current_cmd

◆ $file_delivery

◆ $file_upload

◆ $irss

◆ $maxsize

◆ DELETE_FILES_TBL_POSTVAR

◆ HAS_SPECIFIC_FEEDBACK

◆ REUSE_FILES_TBL_POSTVAR