assFileUpload Class Reference

Class for file upload questions. More...

Inheritance diagram for assFileUpload:

Collaboration diagram for assFileUpload:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assFileUpload constructor More...
	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 ($for_test=true, $title="", $author="", $owner="", $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 ()
	Return the maximum allowed file size as string. More...
	getMaxFilesizeInBytes ()
	Return the maximum allowed file size in bytes. More...
	saveWorkingData ($active_id, $pass=NULL, $authorized=true)
	Saves the learners input of the question to the database. More...
	getQuestionType ()
	Returns the question type of the question. More...
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getAnswerTableName ()
	Returns the name of the answer table in the database. More...
	deleteAnswers ($question_id)
	Deletes datasets from answers tables. More...
	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
	setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...
	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	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)
	Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation. More...
	getBestSolution ($active_id, $pass)
	Returns the best solution for a given pass of a participant. More...
	getMaxSize ()
	Get max file size. More...
	setMaxSize ($a_value)
	Set max file size. More...
	getAllowedExtensionsArray ()
	Get allowed file extensions. More...
	getAllowedExtensions ()
	Get allowed file extensions. More...
	setAllowedExtensions ($a_value)
	Set allowed file extensions. More...
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	hasFileUploads ($test_id)
	Checks if file uploads exist for a given test and the original id of the question. More...
	deliverFileUploadZIPFile ($test_id, $test_title)
	Generates a ZIP file containing all file uploads for a given test and the original id of the question. More...
	isCompletionBySubmissionEnabled ()
	Checks whether completion by submission is enabled or not. More...
	setCompletionBySubmission ($bool)
	Enabled/Disable completion by submission. More...
	isAnswered ($active_id, $pass=null)
	returns boolean wether the question is answered during test pass or not More...
	isAutosaveable ()
Public Member Functions inherited from assQuestion
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assQuestion constructor More...
	getShuffler ()
	setShuffler (ilArrayElementShuffler $shuffler)
	setProcessLocker ($processLocker)
	getProcessLocker ()
	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
	toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
	Returns a QTI xml representation of the question. More...
	isComplete ()
	Returns true, if a question is complete for use. More...
	questionTitleExists ($questionpool_id, $title)
	Returns TRUE if the question title exists in the database. More...
	setTitle ($title="")
	Sets the title string of the assQuestion object. More...
	setId ($id=-1)
	Sets the id of the assQuestion object. More...
	setTestId ($id=-1)
	Sets the test id of the assQuestion object. More...
	setComment ($comment="")
	Sets the comment string of the assQuestion object. More...
	setOutputType ($outputType=OUTPUT_HTML)
	Sets the output type. More...
	setShuffle ($shuffle=true)
	Sets the shuffle flag. More...
	setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
	Sets the estimated working time of a question from given hour, minute and second. More...
	setEstimatedWorkingTimeFromDurationString ($durationString)
	Sets the estimated working time of a question from a given datetime string. More...
	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array More...
	setAuthor ($author="")
	Sets the authors name of the assQuestion object. More...
	setOwner ($owner="")
	Sets the creator/owner ID of the assQuestion object. More...
	getTitle ()
	Gets the title string of the assQuestion object. More...
	getId ()
	Gets the id of the assQuestion object. More...
	getShuffle ()
	Gets the shuffle flag. More...
	getTestId ()
	Gets the test id of the assQuestion object. More...
	getComment ()
	Gets the comment string of the assQuestion object. More...
	getOutputType ()
	Gets the output type. More...
	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output. More...
	supportsNonJsOutput ()
	requiresJsSwitch ()
	getEstimatedWorkingTime ()
	Gets the estimated working time of a question. More...
	getAuthor ()
	Gets the authors name of the assQuestion object. More...
	getOwner ()
	Gets the creator/owner ID of the assQuestion object. More...
	getObjId ()
	Get the object id of the container object. More...
	setObjId ($obj_id=0)
	Set the object id of the container object. More...
	setExternalId ($external_id)
	getExternalId ()
	_getMaximumPoints ($question_id)
	Returns the maximum points, a learner can reach answering the question. More...
&	_getQuestionInfo ($question_id)
	Returns question information from the database. More...
	getSuggestedSolutionOutput ()
&	_getSuggestedSolution ($question_id, $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutions ()
	Return the suggested solutions. More...
	_getReachedPoints ($active_id, $question_id, $pass=NULL)
	Returns the points, a learner has reached answering the question. More...
	getReachedPoints ($active_id, $pass=NULL)
	Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...
	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...
	getAdjustedReachedPoints ($active_id, $pass=NULL, $authorizedSolution=true)
	returns the reached points ... More...
	calculateResultsFromSolution ($active_id, $pass=NULL, $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState ($active_id, $pass=NULL, $obligationsEnabled=false, $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...
	saveWorkingData ($active_id, $pass=NULL, $authorized=true)
	Saves the learners input of the question to the database. More...
	_updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
	Move this to a proper place. More...
	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...
	_logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...
	moveUploadedMediaFile ($file, $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...
	getSuggestedSolutionPath ()
	Returns the path for a suggested solution. More...
	getJavaPath ()
	Returns the image path for web accessable images of a question. More...
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	buildImagePath ($questionId, $parentObjectId)
	getFlashPath ()
	Returns the image path for web accessable flash files of a question. More...
	getJavaPathWeb ()
	Returns the web image path for web accessable java applets of a question. More...
	getSuggestedSolutionPathWeb ()
	Returns the web path for a suggested solution. More...
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getFlashPathWeb ()
	Returns the web image path for web accessable flash applications of a question. More...
	getUserSolutionPreferingIntermediate ($active_id, $pass=NULL)
	getSolutionValues ($active_id, $pass=NULL, $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	isInUse ($question_id="")
	Checks whether the question is in use or not. More...
	isClone ($question_id="")
	Checks whether the question is a clone of another question or not. More...
	pcArrayShuffle ($array)
	Shuffles the values of a given array. More...
	getQuestionTypeFromDb ($question_id)
	get question type for question id More...
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getAnswerTableName ()
	Returns the name of the answer table in the database. More...
	deleteAnswers ($question_id)
	Deletes datasets from answers tables. More...
	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...
	delete ($question_id)
	Deletes a question and all materials from the database. More...
	getTotalAnswers ()
	get total number of answers More...
	_getTotalAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...
	_getTitle ($a_q_id)
	Returns the title of a question. More...
	_getQuestionText ($a_q_id)
	Returns question text. More...
	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	create page object of question More...
	copyPageOfQuestion ($a_q_id)
	getPageOfQuestion ()
	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...
	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id. More...
	setOriginalId ($original_id)
	getOriginalId ()
	fixSvgToPng ($imageFilenameContainingString)
	fixUnavailableSkinImageSources ($html)
	loadFromDb ($question_id)
	Loads the question from the database. More...
	createNewQuestion ($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 ($original_id="")
	saveToDb ($original_id="")
	Saves the question to the database. More...
	setNewOriginalId ($newId)
	deleteSuggestedSolutions ()
	Deletes all suggestes solutions in the database. More...
	getSuggestedSolution ($subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutionTitle ($subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...
	setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
	Sets a suggested solution for the question. More...
	_resolveInternalLink ($internal_link)
	_resolveIntLinks ($question_id)
	_getInternalLinkHref ($target="")
	syncWithOriginal ()
	createRandomSolution ($test_id, $user_id)
	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...
	_questionExistsInPool ($question_id)
	Returns true if the question already exists in the database and is assigned to a question pool. More...
	getPoints ()
	Returns the maximum available points for the question. More...
	setPoints ($a_points)
	Sets the maximum available points for the question. More...
	getSolutionMaxPass ($active_id)
	Returns the maximum pass a users question solution. More...
	_getSolutionMaxPass ($question_id, $active_id)
	Returns the maximum pass a users question solution. More...
	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...
	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not. More...
	calculateReachedPoints ($active_id, $pass=NULL, $authorizedSolution=true, $returndetails=FALSE)
	Returns the points, a learner has reached answering the question. More...
	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...
	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...
	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output in tests. More...
	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string. More...
	addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
	Creates a QTI material tag from a plain text or xhtml text. More...
	createNewImageFileName ($image_filename, $unique=false)
	_setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
	getQuestion ()
	Gets the question string of the question object. More...
	setQuestion ($question="")
	Sets the question string of the question object. More...
	getQuestionType ()
	Returns the question type of the question. More...
	getQuestionTypeID ()
	Returns the question type of the question. More...
	cleanupMediaObjectUsage ()
	synchronises appearances of media objects in the question with media object usage table More...
&	getInstances ()
	Gets all instances of the question. More...
	_needsManualScoring ($question_id)
	getActiveUserData ($active_id)
	Returns the user id and the test id for a given active id. More...
	setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	getNrOfTries ()
	setNrOfTries ($a_nr_of_tries)
	setExportImagePath ($a_path)
	_questionExistsInTest ($question_id, $test_id)
	formatSAQuestion ($a_q)
	Format self assessment question. More...
	setPreventRteUsage ($a_val)
	Set prevent rte usage. More...
	getPreventRteUsage ()
	Get prevent rte usage. More...
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode. More...
	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode. More...
	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries. More...
	getDefaultNrOfTries ()
	Get Default Nr of Tries. More...
	syncSkillAssignments ($srcParentId, $srcQuestionId, $trgParentId, $trgQuestionId)
	isAnswered ($active_id, $pass=null)
	returns boolean wether the question is answered during test pass or not More...
	isAutosaveable ()
	getAdditionalContentEditingMode ()
	getter for additional content editing mode for this question More...
	setAdditionalContentEditingMode ($additinalContentEditingMode)
	setter for additional content editing mode for this question More...
	isAdditionalContentEditingModePageObject ()
	isser for additional "pageobject" content editing mode More...
	isValidAdditionalContentEditingMode ($additionalContentEditingMode)
	returns the fact wether the passed additional content mode is valid or not More...
	getValidAdditionalContentEditingModes ()
	getter for valid additional content editing modes More...
	addQuestionChangeListener (ilQuestionChangeListener $listener)
	getQuestionChangeListeners ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange ($lastChange)
	getLastChange ()
	removeIntermediateSolution ($active_id, $pass)
	removeCurrentSolution ($active_id, $pass, $authorized=true, $ignoredSolutionIds=array())
	saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true)
	updateCurrentSolution ($solutionId, $value1, $value2, $authorized=true)
	updateCurrentSolutionsAuthorization ($activeId, $pass, $authorized)
	setStep ($step)
	getStep ()
	toJSON ()
	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	authorizedSolutionExists ($active_id, $pass)
	authorizedOrIntermediateSolutionExists ($active_id, $pass)
	lookupForExistingSolutions ($activeId, $pass)
	Lookup if an authorized or intermediate solution exists. More...
	removeExistingSolutions ($activeId, $pass)
	resetUsersAnswer ($activeId, $pass)
	removeResultRecord ($activeId, $pass)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered ($obligationsToBeConsidered)
	validateSolutionSubmit ()
	updateTimestamp ()

Static Public Member Functions
static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled ($forcePassResultsUpdateEnabled)
static	isForcePassResultUpdateEnabled ()
static	isAllowedImageMimeType ($mimeType)
static	fetchMimeTypeIdentifier ($contentTypeString)
static	getAllowedFileExtensionsForMimeType ($mimeType)
static	isAllowedImageFileExtension ($mimeType, $fileExtension)
static	getAllowedImageFileExtensions ()
static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question. More...
static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution. More...
static	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...
static	isFileAvailable ($file)
static	_getOriginalId ($question_id)
	Returns the original id of a question. More...
static	originalQuestionExists ($questionId)
static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...
static	_instantiateQuestion ($question_id)
static	_isWorkedThrough ($active_id, $question_id, $pass=NULL)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...
static	_areAnswered ($a_user_id, $a_question_ids)
	Checks if an array of question ids is answered by an user or not. More...
static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...
static	getGuiClassNameByQuestionType ($questionType)
static	getObjectClassNameByQuestionType ($questionType)
static	getFeedbackClassNameByQuestionType ($questionType)
static	isCoreQuestionType ($questionType)
static	includeCoreClass ($questionType, $withGuiClass)
static	includePluginClass ($questionType, $withGuiClass)
static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...
static &	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id. More...
static	instantiateQuestionGUI ($a_question_id)
	Creates an instance of a question gui with a given question id. More...
static	lookupParentObjId ($questionId)
	ilDB $ilDB More...
static	lookupOriginalParentObjId ($originalQuestionId)
	returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...
static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
static	setResultGateway ($resultGateway)
static	getResultGateway ()
static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)
static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)
static	missingResultRecordExists ($activeId, $pass, $questionIds)
static	lookupResultRecordExist ($activeId, $questionId, $pass)

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...
	deleteUploadedFiles ($files, $test_id, $active_id, $authorized)
	Delete uploaded files. More...
	deletePreviewFileUploads ($userId, $userSolution, $files)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)
	Reworks the allready saved working data if neccessary. More...
	handleSubmission ($active_id, $pass, $obligationsAnswered, $authorized)
	This method is called after an user submitted one or more files. More...
Protected Member Functions inherited from assQuestion
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	Reworks the allready saved working data if neccessary. More...
	deletePageOfQuestion ($question_id)
	Deletes the page object of a question with a given ID. More...
	onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
	Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...
	beforeSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
	Will be called when a question is copied (into another question pool) More...
	duplicateSuggestedSolutionFiles ($parent_id, $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	syncSuggestedSolutionFiles ($original_id)
	Syncs the files of a suggested solution if the question is synced. More...
	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)
	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)
	duplicateSkillAssignments ($srcParentId, $srcQuestionId, $trgParentId, $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet ($active_id, $pass, $authorized=true)
	Get a restulset for the current user solution for a this question by active_id and pass. More...
	removeSolutionRecordById ($solutionId)
	getSelfAssessmentFormatter ()

Protected Attributes
	$maxsize
	$allowedextensions
	$completion_by_submission = false
Protected Attributes inherited from assQuestion
	$id
	$title
	$comment
	$owner
	$author
	$question
	$points
	$est_working_time
	$shuffle
	$test_id
	$obj_id
	$ilias
	$tpl
	$lng
	$db
	$outputType
	$suggested_solutions
	$original_id
	$page
	$external_id = ''
	$questionChangeListeners = array()
	$processLocker
	$step = null
	$lastChange
	$shuffler

Additional Inherited Members
Data Fields inherited from assQuestion
const	IMG_MIME_TYPE_JPG = 'image/jpeg'
const	IMG_MIME_TYPE_PNG = 'image/png'
const	IMG_MIME_TYPE_GIF = 'image/gif'
const	ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
	constant for additional content editing mode "default" More...
const	ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
	constant for additional content editing mode "pageobject" More...
	$feedbackOBJ = null
	$prevent_rte_usage = false
	$selfassessmenteditingmode = false
	$defaultnroftries = 0
	$questionActionCmd = 'handleQuestionAction'
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords ($activeId, $pass, $questionId)
	returns the number of existing solution records for the given test active / pass and given question id More...
Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType
static	$allowedCharsetsByMimeType
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 20 of file class.assFileUpload.php.

Constructor & Destructor Documentation

__construct()

assFileUpload::__construct	(		$title = "",
			$comment = "",
			$author = "",
			$owner = -1,
			$question = ""
	)

assFileUpload constructor

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

Parameters

string	$title	A title string to describe the question
string	$comment	A comment string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator
string	$question	The question string of the single choice question

See also

assQuestion:__construct()

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

References assQuestion\$author, assQuestion\$comment, assQuestion\$owner, assQuestion\$question, and assQuestion\$title.

        {
                parent::__construct($title, $comment, $author, $owner, $question);
        }

Member Function Documentation

__get()

assFileUpload::__get

(

$value

)

Object getter.

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

References getAllowedExtensions(), getMaxSize(), and isCompletionBySubmissionEnabled().

        {
                switch ($value)
                {
                        case "maxsize":
                                return $this->getMaxSize();
                                break;
                        case "allowedextensions":
                                return $this->getAllowedExtensions();
                                break;
                        case 'completion_by_submission':
                                return $this->isCompletionBySubmissionEnabled();
                                break;
                        default:
                                return parent::__get($value);
                                break;
                }
        }

Here is the call graph for this function:

__set()

assFileUpload::__set	(		$key,
			$value
	)

Object setter.

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

References setAllowedExtensions(), setCompletionBySubmission(), and setMaxSize().

        {
                switch ($key)
                {
                        case "maxsize":
                                $this->setMaxSize($value);
                                break;
                        case "allowedextensions":
                                $this->setAllowedExtensions($value);
                                break;
                        case 'completion_by_submission':
                                $this->setCompletionBySubmission($value);
                                break;
                        default:
                                parent::__set($key, $value);
                                break;
                }
        }

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

References $ilDB, $pass, assQuestion\$points, and assQuestion\getSolutionMaxPass().

        {
                if( $returndetails )
                {
                        throw new ilTestException('return details not implemented for '.__METHOD__);
                }
                
                global $ilDB;
                
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                $points = 0;
                return $points;
        }

Here is the call graph for this function:

calculateReachedPointsForSolution()

assFileUpload::calculateReachedPointsForSolution (   $userSolution )

protected

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

References assQuestion\$points.

        {
                $points = 0;
                return $points;
        }

checkUpload()

assFileUpload::checkUpload

(

)

Check file upload.

Returns

boolean Input ok, true/false

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

References $filename, getAllowedExtensionsArray(), getMaxFilesizeInBytes(), ilUtil\sendFailure(), and ilUtil\virusHandling().

Referenced by savePreviewData(), and saveWorkingData().

        {
                $this->lng->loadLanguageModule("form");
                // remove trailing '/'
                while (substr($_FILES["upload"]["name"],-1) == '/')
                {
                        $_FILES["upload"]["name"] = substr($_FILES["upload"]["name"],0,-1);
                }

                $filename = $_FILES["upload"]["name"];
                $filename_arr = pathinfo($_FILES["upload"]["name"]);
                $suffix = $filename_arr["extension"];
                $mimetype = $_FILES["upload"]["type"];
                $size_bytes = $_FILES["upload"]["size"];
                $temp_name = $_FILES["upload"]["tmp_name"];
                $error = $_FILES["upload"]["error"];
                
                if ($size_bytes > $this->getMaxFilesizeInBytes())
                {
                        ilUtil::sendFailure($this->lng->txt("form_msg_file_size_exceeds"), true);
                        return false;
                }

                // error handling
                if ($error > 0)
                {
                        switch ($error)
                        {
                                case UPLOAD_ERR_INI_SIZE:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_size_exceeds"), true);
                                        return false;
                                        break;
                                         
                                case UPLOAD_ERR_FORM_SIZE:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_size_exceeds"), true);
                                        return false;
                                        break;
        
                                case UPLOAD_ERR_PARTIAL:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_partially_uploaded"), true);
                                        return false;
                                        break;
        
                                case UPLOAD_ERR_NO_FILE:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_no_upload"), true);
                                        return false;
                                        break;
         
                                case UPLOAD_ERR_NO_TMP_DIR:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_missing_tmp_dir"), true);
                                        return false;
                                        break;
                                         
                                case UPLOAD_ERR_CANT_WRITE:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_cannot_write_to_disk"), true);
                                        return false;
                                        break;
         
                                case UPLOAD_ERR_EXTENSION:
                                        ilUtil::sendFailure($this->lng->txt("form_msg_file_upload_stopped_ext"), true);
                                        return false;
                                        break;
                        }
                }
                
                // check suffixes
                if (strlen($suffix) && count($this->getAllowedExtensionsArray()))
                {
                        if (!in_array(strtolower($suffix), $this->getAllowedExtensionsArray()))
                        {
                                ilUtil::sendFailure($this->lng->txt("form_msg_file_wrong_file_type"), true);
                                return false;
                        }
                }
                
                // virus handling
                if (strlen($temp_name))
                {
                        $vir = ilUtil::virusHandling($temp_name, $filename);
                        if ($vir[0] == false)
                        {
                                ilUtil::sendFailure($this->lng->txt("form_msg_file_virus_found")."<br />".$vir[1], true);
                                return false;
                        }
                }
                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 205 of file class.assFileUpload.php.

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

        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $clone = $this;
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                $original_id = assQuestion::_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 235 of file class.assFileUpload.php.

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

        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }

                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");

                $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

)

Deletes datasets from answers tables.

Parameters

integer

$question_id

The question id which should be deleted in the answers table

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

        {
        }

deletePreviewFileUploads()

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

protected

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

deleteUploadedFiles()

assFileUpload::deleteUploadedFiles (   $files,   $test_id,   $active_id,   $authorized  )

protected

Delete uploaded files.

Parameters

array

Array with ID's of the file datasets

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

References $data, $ilDB, $pass, $result, assQuestion\$test_id, and getFileUploadPath().

Referenced by saveWorkingData().

        {
                global $ilDB;
                
                $pass = null;
                $active_id = null;
                foreach ($files as $solution_id)
                {
                        $result = $ilDB->queryF("SELECT * FROM tst_solutions WHERE solution_id = %s AND authorized = %s",
                                array("integer", 'integer'),
                                array($solution_id, (int)$authorized)
                        );
                        if ($result->numRows() == 1)
                        {
                                $data = $ilDB->fetchAssoc($result);
                                $pass = $data['pass'];
                                $active_id = $data['active_fi'];
                                @unlink($this->getFileUploadPath($test_id, $active_id) . $data['value1']);
                        }
                }
                foreach ($files as $solution_id)
                {
                        $affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE solution_id = %s AND authorized = %s",
                                array("integer", 'integer'),
                                array($solution_id, $authorized)
                        );
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverFileUploadZIPFile()

assFileUpload::deliverFileUploadZIPFile	(		$test_id,
			$test_title
	)

Generates a ZIP file containing all file uploads for a given test and the original id of the question.

Parameters

int

$test_id

Implements ilObjFileHandlingQuestionType.

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

References $ilDB, assQuestion\$lng, assQuestion\$test_id, and ilUtil\deliverFile().

        {
                global $ilDB, $lng;
                
                require_once 'Modules/TestQuestionPool/classes/class.ilAssFileUploadUploadsExporter.php';
                $exporter = new ilAssFileUploadUploadsExporter($ilDB, $lng);
                
                $exporter->setTestId($test_id);
                $exporter->setTestTitle($test_title);
                $exporter->setQuestion($this);
                
                $exporter->build();

                ilUtil::deliverFile(
                        $exporter->getFinalZipFilePath(), $exporter->getDispoZipFileName(),
                        $exporter->getZipFileMimeType(), false, true
                );
        }

Here is the call graph for this function:

duplicate()

assFileUpload::duplicate	(		$for_test = true,
			$title = "",
			$author = "",
			$owner = "",
			$testObjId = null
	)

Duplicates an assFileUpload.

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

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

        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $this_id = $this->getId();
                $thisObjId = $this->getObjId();
                
                $clone = $this;
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                $original_id = assQuestion::_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,
		&	$questionpool_id,
		&	$tst_id,
		&	$tst_object,
		&	$question_counter,
		&	$import_mapping
	)

Creates a question from a QTI file.

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

Parameters

object	$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 908 of file class.assFileUpload.php.

        {
                include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assFileUploadImport.php";
                $import = new assFileUploadImport($this);
                $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
        }

getAdditionalTableName()

assFileUpload::getAdditionalTableName

(

)

Returns the name of the additional question data table in the database.

Returns

string The additional table name

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

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

        {
                return "qpl_qst_fileupload";
        }

Here is the caller graph for this function:

getAllowedExtensions()

assFileUpload::getAllowedExtensions

(

)

Get allowed file extensions.

Returns

string Allowed file extensions

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

References $allowedextensions.

Referenced by __get(), and saveAdditionalQuestionDataToDb().

        {
                return $this->allowedextensions;
        }

Here is the caller graph for this function:

getAllowedExtensionsArray()

assFileUpload::getAllowedExtensionsArray

(

)

Get allowed file extensions.

Returns

array Allowed file extensions

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

Referenced by checkUpload().

        {
                if (strlen($this->allowedextensions))
                {
                        return array_filter(array_map('trim', explode(",", $this->allowedextensions)));
                }
                return array();
        }

Here is the caller graph for this function:

getAnswerTableName()

assFileUpload::getAnswerTableName

(

)

Returns the name of the answer table in the database.

Returns

string The answer table name

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

        {
                return "";
        }

getBestSolution()

assFileUpload::getBestSolution	(		$active_id,
			$pass
	)

Returns the best solution for a given pass of a participant.

Returns

array An associated array containing the best solution

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

        {
                $user_solution = array();
                return $user_solution;
        }

getFileUploadPath()

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

Returns the filesystem path for file uploads.

Implements ilObjFileHandlingQuestionType.

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

References assQuestion\getId().

Referenced by deleteUploadedFiles(), and saveWorkingData().

        {
                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 428 of file class.assFileUpload.php.

References assQuestion\getId(), ILIAS_ABSOLUTE_PATH, and ilUtil\removeTrailingPathSeparators().

Referenced by getUploadedFilesForWeb().

        {
                if (is_null($question_id)) $question_id = $this->getId();
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/assessment/tst_$test_id/$active_id/$question_id/files/";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxFilesizeAsString()

assFileUpload::getMaxFilesizeAsString

(

)

Return the maximum allowed file size as string.

Returns

string The number of bytes of the maximum allowed file size

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

References $size, and getMaxFilesizeInBytes().

        {
                $size = $this->getMaxFilesizeInBytes();
                if ($size < 1024)
                {
                        $max_filesize = sprintf("%d Bytes",$size);
                }
                else if ($size < 1024*1024)
                {
                        $max_filesize = sprintf("%.1f KB",$size/1024);
                }
                else
                {
                        $max_filesize = sprintf("%.1f MB",$size/1024/1024);
                }
                
                return $max_filesize;
        }

Here is the call graph for this function:

getMaxFilesizeInBytes()

assFileUpload::getMaxFilesizeInBytes

(

)

Return the maximum allowed file size in bytes.

Returns

integer The number of bytes of the maximum allowed file size

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

References getMaxSize().

Referenced by checkUpload(), and getMaxFilesizeAsString().

        {
                if (strlen($this->getMaxSize()))
                {
                        return $this->getMaxSize();
                }
                else
                {
                        // get the value for the maximal uploadable filesize from the php.ini (if available)
                        $umf = get_cfg_var("upload_max_filesize");
                        // get the value for the maximal post data from the php.ini (if available)
                        $pms = get_cfg_var("post_max_size");

                        //convert from short-string representation to "real" bytes
                        $multiplier_a=array("K"=>1024, "M"=>1024*1024, "G"=>1024*1024*1024);

                        $umf_parts=preg_split("/(\d+)([K|G|M])/", $umf, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);
                        $pms_parts=preg_split("/(\d+)([K|G|M])/", $pms, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);

                        if (count($umf_parts) == 2) { $umf = $umf_parts[0]*$multiplier_a[$umf_parts[1]]; }
                        if (count($pms_parts) == 2) { $pms = $pms_parts[0]*$multiplier_a[$pms_parts[1]]; }

                        // use the smaller one as limit
                        $max_filesize = min($umf, $pms);

                        if (!$max_filesize) $max_filesize=max($umf, $pms);
                        return $max_filesize;
                }
        }

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

References assQuestion\getPoints().

Referenced by isComplete().

        {
                return $this->getPoints();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxSize()

assFileUpload::getMaxSize

(

)

Get max file size.

Returns

double Max file size

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

References $maxsize.

Referenced by __get(), getMaxFilesizeInBytes(), and saveAdditionalQuestionDataToDb().

        {
                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 418 of file class.assFileUpload.php.

Referenced by deletePreviewFileUploads(), and savePreviewData().

        {
                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 439 of file class.assFileUpload.php.

References ILIAS_ABSOLUTE_PATH, and ilUtil\removeTrailingPathSeparators().

Referenced by savePreviewData().

        {
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/assessment/qst_preview/$userId/{$this->getId()}/fileuploads/";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::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 475 of file class.assFileUpload.php.

References ilAssQuestionPreviewSession\getParticipantsSolution().

        {
                return (array)$previewSession->getParticipantsSolution();
        }

Here is the call graph for this function:

getQuestionType()

assFileUpload::getQuestionType

(

)

Returns the question type of the question.

Returns

integer The question type of the question

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

        {
                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 859 of file class.assFileUpload.php.

References $text.

        {
                $text = parent::getRTETextWithMediaObjects();
                return $text;
        }

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

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

Referenced by getUploadedFilesForWeb(), and handleSubmission().

        {
                global $ilDB;
                
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                
                $result = $ilDB->queryF("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s AND authorized = %s ORDER BY tstamp",
                        array("integer", "integer", "integer", 'integer'),
                        array($active_id, $this->getId(), $pass, (int)$authorized)
                );
                
                $found = array();
                
                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 485 of file class.assFileUpload.php.

References $data, $ilDB, $pass, $path, $result, $row, assQuestion\$test_id, getFileUploadPathWeb(), and getUploadedFiles().

        {
                global $ilDB;
                
                $found = $this->getUploadedFiles($active_id, $pass);
                $result = $ilDB->queryF("SELECT test_fi FROM tst_active WHERE active_id = %s",
                        array('integer'),
                        array($active_id)
                );
                if ($result->numRows() == 1)
                {
                        $row = $ilDB->fetchAssoc($result);
                        $test_id = $row["test_fi"];
                        $path = $this->getFileUploadPathWeb($test_id, $active_id);
                        foreach ($found as $idx => $data)
                        {
                                $found[$idx]['webpath'] = $path;
                        }
                }
                return $found;
        }

Here is the call graph for this function:

handleSubmission()

assFileUpload::handleSubmission (   $active_id,   $pass,   $obligationsAnswered,   $authorized  )

protected

This method is called after an user submitted one or more files.

It should handle the setting "Completion by Submission" and, if enabled, set the status of the current user.

Parameters

integer
integer	protected

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

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

Referenced by reworkWorkingData().

        {
                if(!$authorized)
                {
                        return;
                }

                if($this->isCompletionBySubmissionEnabled())
                {
                        $maxpoints = assQuestion::_getMaximumPoints($this->getId());
        
                        if($this->getUploadedFiles($active_id, $pass, $authorized))
                        {
                                $points = $maxpoints;   
                        }
                        else
                        {
                                $points = 0;
                        }

                        assQuestion::_setReachedPoints($active_id, $this->getId(), $points, $maxpoints, $pass, 1, $obligationsAnswered);                                        
                        
                        // update learning progress
                        include_once 'Modules/Test/classes/class.ilObjTestAccess.php';
                        include_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
                        ilLPStatusWrapper::_updateStatus(
                                ilObjTest::_getObjectIDFromActiveID((int)$active_id),
                                ilObjTestAccess::_getParticipantId((int) $active_id)
                        );
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

hasFileUploads()

assFileUpload::hasFileUploads

(

$test_id

)

Checks if file uploads exist for a given test and the original id of the question.

Parameters

int

$test_id

Returns

boolean TRUE if file uploads exist, FALSE otherwise

Implements ilObjFileHandlingQuestionType.

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

References $ilDB, $query, $result, assQuestion\$test_id, and assQuestion\getId().

        {
                global $ilDB;
                $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";
                $result = $ilDB->queryF( $query,
                        array("integer", "integer"),
                        array($this->getId(), $test_id)
                );
                if ($result->numRows() > 0)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Here is the call graph for this function:

isAnswered()

assFileUpload::isAnswered	(		$active_id,
			$pass = null
	)

returns boolean wether the question is answered during test pass or not

(overwrites method in class assQuestion)

ilDB $ilDB

Parameters

integer	$active_id
integer	$pass

Returns

boolean $answered

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

References $pass, assQuestion\getId(), and assQuestion\getNumExistingSolutionRecords().

        {
                $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());
                
                return $numExistingSolutionRecords > 0;
        }

Here is the call graph for this function:

isAutosaveable()

assFileUpload::isAutosaveable

(

)

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

        {
                return FALSE;
        }

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

References getMaximumPoints().

        {
                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

(

)

Checks whether completion by submission is enabled or not.

Returns

boolean public

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

References $completion_by_submission.

Referenced by __get(), handleSubmission(), and saveAdditionalQuestionDataToDb().

        {
                return $this->completion_by_submission;
        }

Here is the caller graph for this function:

isObligationPossible()

static assFileUpload::isObligationPossible (   $questionId )

static

returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration

(overwrites method in class assQuestion)

Parameters

integer

$questionId

Returns

boolean $obligationPossible

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

        {
                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 106 of file class.assFileUpload.php.

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAdditionalContentEditingMode(), setAllowedExtensions(), assQuestion\setAuthor(), assQuestion\setComment(), setCompletionBySubmission(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setMaxSize(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setSuggestedSolution(), and assQuestion\setTitle().

        {
                global $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",
                        array("integer"),
                        array($question_id)
                );
                if ($result->numRows() == 1)
                {
                        $data = $ilDB->fetchAssoc($result);
                        $this->setId($question_id);
                        $this->setTitle($data["title"]);
                        $this->setComment($data["description"]);
                        $this->setNrOfTries($data['nr_of_tries']);
                        $this->setSuggestedSolution($data["solution_hint"]);
                        $this->setOriginalId($data["original_id"]);
                        $this->setObjId($data["obj_fi"]);
                        $this->setAuthor($data["author"]);
                        $this->setOwner($data["owner"]);
                        $this->setPoints($data["points"]);                      

                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                        $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                        $this->setMaxSize($data["maxsize"]);
                        $this->setAllowedExtensions($data["allowedextensions"]);
                        $this->setCompletionBySubmission($data['compl_by_submission'] == 1 ? true : false);
                        
                        try
                        {
                                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
                        }
                        catch(ilTestQuestionPoolException $e)
                        {
                        }
                }
                parent::loadFromDb($question_id);
        }

Here is the call graph for this function:

reworkWorkingData()

assFileUpload::reworkWorkingData (   $active_id,   $pass,   $obligationsAnswered,   $authorized  )

protected

Reworks the allready saved working data if neccessary.

protected

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered

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

References $pass, and handleSubmission().

        {
                $this->handleSubmission($active_id, $pass, $obligationsAnswered, $authorized);
        }

Here is the call graph for this function:

saveAdditionalQuestionDataToDb()

assFileUpload::saveAdditionalQuestionDataToDb

(

)

Saves a record to the question types additional data table.

Returns

mixed

Implements ilObjQuestionScoringAdjustable.

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

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

Referenced by saveToDb().

        {
                global $ilDB;
                $ilDB->manipulateF( "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                                                        array( "integer" ),
                                                        array( $this->getId() )
                );
                $ilDB->manipulateF( "INSERT INTO " . $this->getAdditionalTableName(
                                                                                                                                                                                         ) . " (question_fi, maxsize, allowedextensions, compl_by_submission) VALUES (%s, %s, %s, %s)",
                                                        array( "integer", "float", "text", "integer" ),
                                                        array(
                                                                $this->getId(),
                                                                (strlen( $this->getMaxSize() )) ? $this->getMaxSize() : NULL,
                                                                (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 711 of file class.assFileUpload.php.

References $_POST, checkUpload(), deletePreviewFileUploads(), ilAssQuestionPreviewSession\getParticipantsSolution(), getPreviewFileUploadPath(), getPreviewFileUploadPathWeb(), ilAssQuestionPreviewSession\getUserId(), ilUtil\makeDirParents(), ilUtil\moveUploadedFile(), ilUtil\sendInfo(), and ilAssQuestionPreviewSession\setParticipantsSolution().

        {
                $userSolution = $previewSession->getParticipantsSolution();
                
                if( !is_array($userSolution) )
                {
                        $userSolution = array();
                }
                
                if (strcmp($_POST['cmd'][$this->questionActionCmd], $this->lng->txt('delete')) == 0)
                {
                        if (is_array($_POST['deletefiles']) && count($_POST['deletefiles']) > 0)
                        {
                                $userSolution = $this->deletePreviewFileUploads($previewSession->getUserId(), $userSolution, $_POST['deletefiles']);
                        }
                        else
                        {
                                ilUtil::sendInfo($this->lng->txt('no_checkbox'), true);
                        }
                }
                else
                {
                        if (strlen($_FILES["upload"]["tmp_name"]))
                        {
                                if ($this->checkUpload())
                                {
                                        if( !@file_exists($this->getPreviewFileUploadPath($previewSession->getUserId())) )
                                        {
                                                ilUtil::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;
                                        ilUtil::moveUploadedFile($_FILES["upload"]["tmp_name"], $_FILES["upload"]["name"], $this->getPreviewFileUploadPath($previewSession->getUserId()) . $newfile);

                                        $userSolution[$newfile] = array(
                                                '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 75 of file class.assFileUpload.php.

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

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

Saves the learners input of the question to the database.

public

Parameters

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

Returns

boolean $status

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

References $_POST, $ilDB, $ilUser, $pass, $result, $row, assQuestion\$test_id, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), checkUpload(), deleteUploadedFiles(), getFileUploadPath(), assQuestion\getId(), assQuestion\getProcessLocker(), assQuestion\logAction(), ilUtil\makeDirParents(), ilUtil\moveUploadedFile(), assQuestion\saveCurrentSolution(), ilUtil\sendInfo(), and assQuestion\updateCurrentSolutionsAuthorization().

        {
                global $ilDB;
                global $ilUser;

                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }

                if( $_POST['cmd'][$this->questionActionCmd] != $this->lng->txt('delete')
                        && strlen($_FILES["upload"]["tmp_name"]) )
                {
                        $checkUploadResult = $this->checkUpload();
                }
                else
                {
                        $checkUploadResult = false;
                }
                
                $result = $ilDB->queryF("SELECT test_fi FROM tst_active WHERE active_id = %s",
                        array('integer'),
                        array($active_id)
                );
                $test_id = 0;
                if ($result->numRows() == 1)
                {
                        $row = $ilDB->fetchAssoc($result);
                        $test_id = $row["test_fi"];
                }

                $this->getProcessLocker()->requestUserSolutionUpdateLock();

                $this->updateCurrentSolutionsAuthorization($active_id, $pass, $authorized);

                $entered_values = false;
                if( $_POST['cmd'][$this->questionActionCmd] == $this->lng->txt('delete') )
                {
                        if (is_array($_POST['deletefiles']) && count($_POST['deletefiles']) > 0)
                        {
                                $this->deleteUploadedFiles($_POST['deletefiles'], $test_id, $active_id, $authorized);
                        }
                        else
                        {
                                ilUtil::sendInfo($this->lng->txt('no_checkbox'), true);
                        }
                }
                elseif( $checkUploadResult )
                {
                        if(!@file_exists($this->getFileUploadPath($test_id, $active_id)))
                        {
                                ilUtil::makeDirParents($this->getFileUploadPath($test_id, $active_id));
                        }
                        
                        $version = time();
                        $filename_arr = pathinfo($_FILES["upload"]["name"]);
                        $extension = $filename_arr["extension"];
                        $newfile = "file_" . $active_id . "_" . $pass . "_" . $version . "." . $extension;
                        
                        ilUtil::moveUploadedFile($_FILES["upload"]["tmp_name"], $_FILES["upload"]["name"], $this->getFileUploadPath($test_id, $active_id) . $newfile);
                        
                        $this->saveCurrentSolution($active_id, $pass, $newfile, $_FILES['upload']['name'], $authorized);
                        
                        $entered_values = true;
                }
                
                $this->getProcessLocker()->releaseUserSolutionUpdateLock();

                if ($entered_values)
                {
                        include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                }
                else
                {
                        include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                $this->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

(

$a_value

)

Set allowed file extensions.

Parameters

string

$a_value

Allowed file extensions

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

Referenced by __set(), and loadFromDb().

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

Here is the caller graph for this function:

setCompletionBySubmission()

assFileUpload::setCompletionBySubmission

(

$bool

)

Enabled/Disable completion by submission.

Parameters

boolean

Returns

assFileUpload public

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

Referenced by __set(), and loadFromDb().

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

Here is the caller graph for this function:

setExportDetailsXLS()

assFileUpload::setExportDetailsXLS	(	&	$worksheet,
			$startrow,
			$active_id,
			$pass,
		&	$format_title,
		&	$format_bold
	)

Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass
object	$format_title	Excel title format
object	$format_bold	Excel bold format
array	$eval_data	Cumulated evaluation data

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

References $pass, ilExcelUtils\_convert_text(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
                $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
                $i = 1;
                $solutions = $this->getSolutionValues($active_id, $pass);
                foreach ($solutions as $solution)
                {
                        $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($this->lng->txt("result")), $format_bold);
                        if (strlen($solution["value1"]))
                        {
                                $worksheet->write($startrow + $i, 1, ilExcelUtils::_convert_text($solution["value1"]));
                                $worksheet->write($startrow + $i, 2, ilExcelUtils::_convert_text($solution["value2"]));
                        }
                        $i++;
                }
                return $startrow + $i + 1;
        }

Here is the call graph for this function:

setMaxSize()

assFileUpload::setMaxSize

(

$a_value

)

Set max file size.

Parameters

double

$a_value

Max file size

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

Referenced by __set(), and loadFromDb().

        {
                $this->maxsize = $a_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
	)

Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.

Returns

string The QTI xml representation of the question

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

        {
                include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assFileUploadExport.php";
                $export = new assFileUploadExport($this);
                return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
        }

Field Documentation

$allowedextensions

assFileUpload::$allowedextensions

protected

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

Referenced by getAllowedExtensions().

$completion_by_submission

assFileUpload::$completion_by_submission = false

protected

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

Referenced by isCompletionBySubmissionEnabled().

$maxsize

assFileUpload::$maxsize

protected

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

Referenced by getMaxSize().

---

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

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