ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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...
 
 getUserSolutionPreferingIntermediate ($active_id, $pass=null)
 Get the user solution preferring the intermediate solution. More...
 
 removeIntermediateSolution ($active_id, $pass)
 Remove an intermediate soluton (overridden to remove unused fies) 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)
 {Creates an Excel worksheet for the detailed cumulated results of this question.
Parameters
object$worksheetReference to the parent excel worksheet
object$startrowStartrow of the output in the excel worksheet
object$active_idActive id of the participant
object$passTest pass
Returns
object
} 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 ($ref_id, $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 ()
 
 buildTestPresentationConfig ()
 Get the test question configuration Overridden from parent to disable the form change detection Otherwise just checking a file would delete it at navigation. More...
 
- 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...
 
 getTitleFilenameCompliant ()
 returns the object title prepared to be used as a filename 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...
 
 getLifecycle ()
 
 setLifecycle (ilAssQuestionLifecycle $lifecycle)
 
 setExternalId ($external_id)
 
 getExternalId ()
 
 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, $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...
 
 validateSolutionSubmit ()
 
 saveWorkingData ($active_id, $pass=null, $authorized=true)
 Saves the learners input of the question to the database. 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...
 
 getTestOutputSolutions ($activeId, $pass)
 
 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...
 
 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...
 
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 
 syncXHTMLMediaObjectsOfQuestion ()
 
 createPageObject ()
 create page object of question More...
 
 copyPageOfQuestion ($a_q_id)
 
 getPageOfQuestion ()
 
 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)
 
 syncWithOriginal ()
 
 _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...
 
 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...
 
 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...
 
 buildHashedImageFilename ($plain_image_filename, $unique=false)
 
 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...
 
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id. More...
 
 setExportDetailsXLS ($worksheet, $startrow, $active_id, $pass)
 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)
 
 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)
 
 saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)
 
 updateCurrentSolution ($solutionId, $value1, $value2, $authorized=true)
 
 updateCurrentSolutionsAuthorization ($activeId, $pass, $authorized, $keepTime=false)
 
 setStep ($step)
 
 getStep ()
 
 toJSON ()
 
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 
 intermediateSolutionExists ($active_id, $pass)
 
 authorizedSolutionExists ($active_id, $pass)
 
 authorizedOrIntermediateSolutionExists ($active_id, $pass)
 
 isAddableAnswerOptionValue ($qIndex, $answerOptionValue)
 
 addAnswerOptionValue ($qIndex, $answerOptionValue, $points)
 
 removeAllExistingSolutions ()
 
 removeExistingSolutions ($activeId, $pass)
 
 resetUsersAnswer ($activeId, $pass)
 
 removeResultRecord ($activeId, $pass)
 
 fetchValuePairsFromIndexedValues (array $indexedValues)
 
 fetchIndexedValuesFromValuePairs (array $valuePairs)
 
 areObligationsToBeConsidered ()
 
 setObligationsToBeConsidered ($obligationsToBeConsidered)
 
 updateTimestamp ()
 
 getTestPresentationConfig ()
 Get the test question configuration (initialised once) More...
 
 savePartial ()
 
 saveAdditionalQuestionDataToDb ()
 Saves a record to the question types additional data table. More...
 
 hasFileUploads ($test_id)
 Checks if file uploads exist for a given test and the original id of the question. More...
 
 deliverFileUploadZIPFile ($ref_id, $test_id, $test_title)
 Generates a ZIP file containing all file uploads for a given test and the original id of the question. More...
 
 getFileUploadPath ($test_id, $active_id, $question_id=null)
 Returns the path for uploaded files from given active in given test on current or given question. More...
 

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 getAllowedImageMaterialFileExtensions ()
 
static _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question. More...
 
static _getQuestionInfo ($question_id)
 Returns question information from the database. More...
 
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 _getReachedPoints ($active_id, $question_id, $pass=null)
 Returns the points, a learner has reached answering the question. More...
 
static _updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
 @TODO Move this to a proper place. More...
 
static logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log. More...
 
static getQuestionTypeFromDb ($question_id)
 get question type for question id More...
 
static _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method More...
 
static _getTitle ($a_q_id)
 Returns the title of a question. More...
 
static _getQuestionText ($a_q_id)
 Returns question text. More...
 
static isFileAvailable ($file)
 
static _getQuestionType ($question_id)
 Returns the question type of a question with a given id. More...
 
static _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id. More...
 
static saveOriginalId ($questionId, $originalId)
 
static resetOriginalId ($questionId)
 
static _getInternalLinkHref ($target="")
 
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 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution. More...
 
static _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user. More...
 
static _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not. More...
 
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 _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...
 
static _needsManualScoring ($question_id)
 
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 _questionExistsInTest ($question_id, $test_id)
 
static lookupParentObjId ($questionId)
 @global ilDBInterface $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 implodeKeyValues ($keyValues)
 
static explodeKeyValues ($keyValues)
 
static setResultGateway ($resultGateway)
 
static getResultGateway ()
 
static sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)
 
static convertISO8601FormatH_i_s_ExtendedToSeconds ($time)
 
static missingResultRecordExists ($activeId, $pass, $questionIds)
 
static getQuestionsMissingResultRecord ($activeId, $pass, $questionIds)
 
static lookupResultRecordExist ($activeId, $questionId, $pass)
 

Data Fields

const REUSE_FILES_TBL_POSTVAR = 'reusefiles'
 
const DELETE_FILES_TBL_POSTVAR = 'deletefiles'
 
- 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'
 
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...
 
 deleteUploadedFiles ($files, $test_id, $active_id, $authorized)
 Delete uploaded files. More...
 
 deletePreviewFileUploads ($userId, $userSolution, $files)
 
 savePreviewData (ilAssQuestionPreviewSession $previewSession)
 
 handleSubmission ($active_id, $pass, $obligationsAnswered, $authorized)
 This method is called after an user submitted one or more files. More...
 
 isFileDeletionAction ()
 
 isFileDeletionSubmitAvailable ()
 
 isFileReuseSubmitAvailable ()
 
 isFileReuseHandlingRequired ()
 
 isFileUploadAvailable ()
 
- Protected Member Functions inherited from assQuestion
 getQuestionAction ()
 
 isNonEmptyItemListPostSubmission ($postSubmissionFieldname)
 
 ensureCurrentTestPass ($active_id, $pass)
 
 lookupCurrentTestPass ($active_id, $pass)
 
 lookupTestId ($active_id)
 
 log ($active_id, $langVar)
 
 savePreviewData (ilAssQuestionPreviewSession $previewSession)
 
 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)
 
 ensureNonNegativePoints ($points)
 
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
 
 getSelfAssessmentFormatter ()
 
 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)
 
 getSolutionRecordById ($solutionId)
 
 deleteDummySolutionRecord ($activeId, $passIndex)
 
 isDummySolutionRecord ($solutionRecord)
 
 deleteSolutionRecordByValues ($activeId, $passIndex, $authorized, $matchValues)
 
 duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)
 
 forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)
 
 buildTestPresentationConfig ()
 build basic test question configuration instance More...
 

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 = OUTPUT_JAVASCRIPT
 
 $suggested_solutions
 
 $original_id
 
 $page
 
 $external_id = ''
 
 $questionChangeListeners = array()
 
 $processLocker
 
 $step = null
 
 $lastChange
 
 $shuffler
 
 $testQuestionConfig
 
 $lifecycle
 

Additional Inherited Members

- 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 getKeyValuesImplosionSeparator ()
 
- Static Protected Attributes inherited from assQuestion
static $allowedFileExtensionsByMimeType
 
static $allowedCharsetsByMimeType
 
static $allowedImageMaterialFileExtensionsByMimeType
 
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$titleA title string to describe the question
string$commentA comment string to describe the question
string$authorA string containing the name of the questions author
integer$ownerA numerical ID to identify the owner/creator
string$questionThe question string of the single choice question
See also
assQuestion:__construct()

Reimplemented from assQuestion.

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

References assQuestion\$author, assQuestion\$comment, assQuestion\$owner, assQuestion\$question, assQuestion\$title, and ILIAS\GlobalScreen\Provider\__construct().

+ Here is the call graph for this function:

Member Function Documentation

◆ __get()

assFileUpload::__get (   $value)

Object getter.

Reimplemented from assQuestion.

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

1075 {
1076 switch ($value) {
1077 case "maxsize":
1078 return $this->getMaxSize();
1079 break;
1080 case "allowedextensions":
1081 return $this->getAllowedExtensions();
1082 break;
1083 case 'completion_by_submission':
1084 return $this->isCompletionBySubmissionEnabled();
1085 break;
1086 default:
1087 return parent::__get($value);
1088 break;
1089 }
1090 }
isCompletionBySubmissionEnabled()
Checks whether completion by submission is enabled or not.
getAllowedExtensions()
Get allowed file extensions.
getMaxSize()
Get max file size.

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

+ Here is the call graph for this function:

◆ __set()

assFileUpload::__set (   $key,
  $value 
)

Object setter.

Reimplemented from assQuestion.

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

1096 {
1097 switch ($key) {
1098 case "maxsize":
1099 $this->setMaxSize($value);
1100 break;
1101 case "allowedextensions":
1102 $this->setAllowedExtensions($value);
1103 break;
1104 case 'completion_by_submission':
1105 $this->setCompletionBySubmission($value);
1106 break;
1107 default:
1108 parent::__set($key, $value);
1109 break;
1110 }
1111 }
setMaxSize($a_value)
Set max file size.
setAllowedExtensions($a_value)
Set allowed file extensions.
setCompletionBySubmission($bool)
Enabled/Disable completion by submission.

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

+ Here is the call graph for this function:

◆ buildTestPresentationConfig()

assFileUpload::buildTestPresentationConfig ( )

Get the test question configuration Overridden from parent to disable the form change detection Otherwise just checking a file would delete it at navigation.

Returns
ilTestQuestionConfig

Reimplemented from assQuestion.

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

1248 {
1249 // hey: refactored identifiers
1250 return parent::buildTestPresentationConfig()
1251 // hey.
1252 ->setFormChangeDetectionEnabled(false);
1253 }

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

@access public

Parameters
integer$active_id
integer$pass
boolean$returndetails(deprecated !!)
Returns
integer/array $points/$details (array $details is deprecated !!)

Reimplemented from assQuestion.

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

289 {
290 if ($returndetails) {
291 throw new ilTestException('return details not implemented for ' . __METHOD__);
292 }
293
294 if ($this->isCompletionBySubmissionEnabled()) {
295 if (is_null($pass)) {
296 $pass = $this->getSolutionMaxPass($active_id);
297 }
298
299 global $DIC;
300
301 $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
302
303 while ($data = $DIC->database()->fetchAssoc($result)) {
304 if ($this->isDummySolutionRecord($data)) {
305 continue;
306 }
307
308 return $this->getPoints();
309 }
310 }
311
312 return 0;
313 }
$result
getCurrentSolutionResultSet($active_id, $pass, $authorized=true)
Get a restulset for the current user solution for a this question by active_id and pass.
getSolutionMaxPass($active_id)
Returns the maximum pass a users question solution.
isDummySolutionRecord($solutionRecord)
getPoints()
Returns the maximum available points for the question.
Base Exception for all Exceptions relating to Modules/Test.
$data
Definition: storeScorm.php:23
$DIC
Definition: xapitoken.php:46

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

+ Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assFileUpload::calculateReachedPointsForSolution (   $userSolution)
protected

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

316 {
317 if ($this->isCompletionBySubmissionEnabled() && count($userSolution)) {
318 return $this->getPoints();
319 }
320
321 return 0;
322 }

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

+ Here is the call graph for this function:

◆ checkUpload()

assFileUpload::checkUpload ( )

Check file upload.

Returns
boolean Input ok, true/false

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

330 {
331 $this->lng->loadLanguageModule("form");
332 // remove trailing '/'
333 $_FILES["upload"]["name"] = rtrim($_FILES["upload"]["name"], '/');
334
335 $filename = $_FILES["upload"]["name"];
336 $filename_arr = pathinfo($_FILES["upload"]["name"]);
337 $suffix = $filename_arr["extension"];
338 $mimetype = $_FILES["upload"]["type"];
339 $size_bytes = $_FILES["upload"]["size"];
340 $temp_name = $_FILES["upload"]["tmp_name"];
341 $error = $_FILES["upload"]["error"];
342
343 if ($size_bytes > $this->getMaxFilesizeInBytes()) {
344 ilUtil::sendFailure($this->lng->txt("form_msg_file_size_exceeds"), true);
345 return false;
346 }
347
348 // error handling
349 if ($error > 0) {
350 switch ($error) {
351 case UPLOAD_ERR_INI_SIZE:
352 ilUtil::sendFailure($this->lng->txt("form_msg_file_size_exceeds"), true);
353 return false;
354 break;
355
356 case UPLOAD_ERR_FORM_SIZE:
357 ilUtil::sendFailure($this->lng->txt("form_msg_file_size_exceeds"), true);
358 return false;
359 break;
360
361 case UPLOAD_ERR_PARTIAL:
362 ilUtil::sendFailure($this->lng->txt("form_msg_file_partially_uploaded"), true);
363 return false;
364 break;
365
366 case UPLOAD_ERR_NO_FILE:
367 ilUtil::sendFailure($this->lng->txt("form_msg_file_no_upload"), true);
368 return false;
369 break;
370
371 case UPLOAD_ERR_NO_TMP_DIR:
372 ilUtil::sendFailure($this->lng->txt("form_msg_file_missing_tmp_dir"), true);
373 return false;
374 break;
375
376 case UPLOAD_ERR_CANT_WRITE:
377 ilUtil::sendFailure($this->lng->txt("form_msg_file_cannot_write_to_disk"), true);
378 return false;
379 break;
380
381 case UPLOAD_ERR_EXTENSION:
382 ilUtil::sendFailure($this->lng->txt("form_msg_file_upload_stopped_ext"), true);
383 return false;
384 break;
385 }
386 }
387
388 // check suffixes
389 if (count($this->getAllowedExtensionsArray())) {
390 if (!strlen($suffix)) {
391 ilUtil::sendFailure($this->lng->txt("form_msg_file_missing_file_ext"), true);
392 return false;
393 }
394
395 if (!in_array(strtolower($suffix), $this->getAllowedExtensionsArray())) {
396 ilUtil::sendFailure($this->lng->txt("form_msg_file_wrong_file_type"), true);
397 return false;
398 }
399 }
400
401 // virus handling
402 if (strlen($temp_name)) {
403 $vir = ilUtil::virusHandling($temp_name, $filename);
404 if ($vir[0] == false) {
405 ilUtil::sendFailure($this->lng->txt("form_msg_file_virus_found") . "<br />" . $vir[1], true);
406 return false;
407 }
408 }
409 return true;
410 }
$filename
Definition: buildRTE.php:89
getAllowedExtensionsArray()
Get allowed file extensions.
getMaxFilesizeInBytes()
Return the maximum allowed file size in bytes.
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
static virusHandling($a_file, $a_orig_name="", $a_clean=true)
scan file for viruses and clean files if possible

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

Referenced by savePreviewData(), and saveWorkingData().

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

208 {
209 if ($this->id <= 0) {
210 // The question has not been saved. It cannot be duplicated
211 return;
212 }
213 // duplicate the question in database
214 $clone = $this;
215 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
217 $clone->id = -1;
218 $source_questionpool_id = $this->getObjId();
219 $clone->setObjId($target_questionpool_id);
220 if ($title) {
221 $clone->setTitle($title);
222 }
223 $clone->saveToDb();
224
225 // copy question page content
226 $clone->copyPageOfQuestion($original_id);
227 // copy XHTML media objects
228 $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
229
230 $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
231
232 return $clone->id;
233 }
static _getOriginalId($question_id)
Returns the original id of a question.
getObjId()
Get the object id of the container object.

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

+ Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

assFileUpload::createNewOriginalFromThisDuplicate (   $targetParentId,
  $targetQuestionTitle = "" 
)

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

236 {
237 if ($this->id <= 0) {
238 // The question has not been saved. It cannot be duplicated
239 return;
240 }
241
242 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
243
244 $sourceQuestionId = $this->id;
245 $sourceParentId = $this->getObjId();
246
247 // duplicate the question in database
248 $clone = $this;
249 $clone->id = -1;
250
251 $clone->setObjId($targetParentId);
252
253 if ($targetQuestionTitle) {
254 $clone->setTitle($targetQuestionTitle);
255 }
256
257 $clone->saveToDb();
258 // copy question page content
259 $clone->copyPageOfQuestion($sourceQuestionId);
260 // copy XHTML media objects
261 $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
262
263 $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
264
265 return $clone->id;
266 }

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

+ Here is the call graph for this function:

◆ deleteAnswers()

assFileUpload::deleteAnswers (   $question_id)

Deletes datasets from answers tables.

Parameters
integer$question_idThe question id which should be deleted in the answers table

Reimplemented from assQuestion.

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

940 {
941 }

◆ deletePreviewFileUploads()

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

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

591 {
592 foreach ($files as $name) {
593 if (isset($userSolution[$name])) {
594 unset($userSolution[$name]);
595 @unlink($this->getPreviewFileUploadPath($userId) . $name);
596 }
597 }
598
599 return $userSolution;
600 }
getPreviewFileUploadPath($userId)
Returns the filesystem path for file uploads.
if($format !==null) $name
Definition: metadata.php:230

References $name, and getPreviewFileUploadPath().

Referenced by savePreviewData().

+ 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
arrayArray with ID's of the file datasets

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

523 {
524 global $DIC;
525 $ilDB = $DIC['ilDB'];
526
527 $pass = null;
528 $active_id = null;
529 foreach ($files as $solution_id) {
530 $result = $ilDB->queryF(
531 "SELECT * FROM tst_solutions WHERE solution_id = %s AND authorized = %s",
532 array("integer", 'integer'),
533 array($solution_id, (int) $authorized)
534 );
535 if ($result->numRows() == 1) {
536 $data = $ilDB->fetchAssoc($result);
537 $pass = $data['pass'];
538 $active_id = $data['active_fi'];
539 @unlink($this->getFileUploadPath($test_id, $active_id) . $data['value1']);
540 }
541 }
542 foreach ($files as $solution_id) {
543 $affectedRows = $ilDB->manipulateF(
544 "DELETE FROM tst_solutions WHERE solution_id = %s AND authorized = %s",
545 array("integer", 'integer'),
546 array($solution_id, $authorized)
547 );
548 }
549 }
getFileUploadPath($test_id, $active_id, $question_id=null)
Returns the filesystem path for file uploads.
global $ilDB

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

+ Here is the call graph for this function:

◆ deliverFileUploadZIPFile()

assFileUpload::deliverFileUploadZIPFile (   $ref_id,
  $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 1147 of file class.assFileUpload.php.

1148 {
1149 global $DIC;
1150 $ilDB = $DIC['ilDB'];
1151 $lng = $DIC['lng'];
1152
1153 require_once 'Modules/TestQuestionPool/classes/class.ilAssFileUploadUploadsExporter.php';
1154 $exporter = new ilAssFileUploadUploadsExporter($ilDB, $lng);
1155
1156 $exporter->setRefId($ref_id);
1157 $exporter->setTestId($test_id);
1158 $exporter->setTestTitle($test_title);
1159 $exporter->setQuestion($this);
1160
1161 $exporter->build();
1162
1164 $exporter->getFinalZipFilePath(),
1165 $exporter->getDispoZipFileName(),
1166 $exporter->getZipFileMimeType(),
1167 false,
1168 true
1169 );
1170 }
static deliverFile( $a_file, $a_filename, $a_mime='', $isInline=false, $removeAfterDelivery=false, $a_exit_after=true)
deliver file for download via browser.

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

+ Here is the call graph for this function:

◆ duplicate()

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

Duplicates an assFileUpload.

Reimplemented from assQuestion.

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

159 {
160 if ($this->id <= 0) {
161 // The question has not been saved. It cannot be duplicated
162 return;
163 }
164 // duplicate the question in database
165 $this_id = $this->getId();
166 $thisObjId = $this->getObjId();
167
168 $clone = $this;
169 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
171 $clone->id = -1;
172
173 if ((int) $testObjId > 0) {
174 $clone->setObjId($testObjId);
175 }
176
177 if ($title) {
178 $clone->setTitle($title);
179 }
180
181 if ($author) {
182 $clone->setAuthor($author);
183 }
184 if ($owner) {
185 $clone->setOwner($owner);
186 }
187
188 if ($for_test) {
189 $clone->saveToDb($original_id);
190 } else {
191 $clone->saveToDb();
192 }
193
194 // copy question page content
195 $clone->copyPageOfQuestion($this_id);
196 // copy XHTML media objects
197 $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
198
199 $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
200
201 return $clone->id;
202 }
getId()
Gets the id of the assQuestion object.

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

+ 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$itemThe QTI item object
integer$questionpool_idThe id of the parent questionpool
integer$tst_idThe id of the parent test if the question is part of a test
object$tst_objectA reference to the parent test object
integer$question_counterA reference to a question counter to count the questions of an imported question pool
array$import_mappingAn array containing references to included ILIAS objects

Reimplemented from assQuestion.

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

988 {
989 include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assFileUploadImport.php";
990 $import = new assFileUploadImport($this);
991 $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
992 }
Class for file upload question imports.

◆ getAdditionalTableName()

assFileUpload::getAdditionalTableName ( )

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

Returns
string The additional table name

Reimplemented from assQuestion.

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

920 {
921 return "qpl_qst_fileupload";
922 }

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

+ Here is the caller graph for this function:

◆ getAllowedExtensions()

assFileUpload::getAllowedExtensions ( )

Get allowed file extensions.

Returns
string Allowed file extensions

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

1057 {
1059 }

References $allowedextensions.

Referenced by __get(), and saveAdditionalQuestionDataToDb().

+ Here is the caller graph for this function:

◆ getAllowedExtensionsArray()

assFileUpload::getAllowedExtensionsArray ( )

Get allowed file extensions.

Returns
array Allowed file extensions

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

1044 {
1045 if (strlen($this->allowedextensions)) {
1046 return array_filter(array_map('trim', explode(",", $this->allowedextensions)));
1047 }
1048 return array();
1049 }

Referenced by checkUpload().

+ 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

Reimplemented from assQuestion.

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

930 {
931 return "";
932 }

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

1013 {
1014 $user_solution = array();
1015 return $user_solution;
1016 }

◆ getFileUploadPath()

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

Returns the filesystem path for file uploads.

Implements ilObjFileHandlingQuestionType.

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

416 {
417 if (is_null($question_id)) {
418 $question_id = $this->getId();
419 }
420 return CLIENT_WEB_DIR . "/assessment/tst_$test_id/$active_id/$question_id/files/";
421 }

References assQuestion\getId().

Referenced by deleteUploadedFiles(), and saveWorkingData().

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

@access public

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

437 {
438 if (is_null($question_id)) {
439 $question_id = $this->getId();
440 }
441 include_once "./Services/Utilities/classes/class.ilUtil.php";
442 $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/assessment/tst_$test_id/$active_id/$question_id/files/";
443 return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
444 }
static removeTrailingPathSeparators($path)

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

Referenced by getUploadedFilesForWeb().

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

608 {
609 $size = $this->getMaxFilesizeInBytes();
610 if ($size < 1024) {
611 $max_filesize = sprintf("%d Bytes", $size);
612 } elseif ($size < 1024 * 1024) {
613 $max_filesize = sprintf("%.1f KB", $size / 1024);
614 } else {
615 $max_filesize = sprintf("%.1f MB", $size / 1024 / 1024);
616 }
617
618 return $max_filesize;
619 }
$size
Definition: RandomTest.php:84

References $size, and getMaxFilesizeInBytes().

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

627 {
628 if (strlen($this->getMaxSize())) {
629 return $this->getMaxSize();
630 } else {
631 // get the value for the maximal uploadable filesize from the php.ini (if available)
632 $umf = get_cfg_var("upload_max_filesize");
633 // get the value for the maximal post data from the php.ini (if available)
634 $pms = get_cfg_var("post_max_size");
635
636 //convert from short-string representation to "real" bytes
637 $multiplier_a = array("K" => 1024, "M" => 1024 * 1024, "G" => 1024 * 1024 * 1024);
638
639 $umf_parts = preg_split("/(\d+)([K|G|M])/", $umf, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
640 $pms_parts = preg_split("/(\d+)([K|G|M])/", $pms, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
641
642 if (count($umf_parts) == 2) {
643 $umf = $umf_parts[0] * $multiplier_a[$umf_parts[1]];
644 }
645 if (count($pms_parts) == 2) {
646 $pms = $pms_parts[0] * $multiplier_a[$pms_parts[1]];
647 }
648
649 // use the smaller one as limit
650 $max_filesize = min($umf, $pms);
651
652 if (!$max_filesize) {
653 $max_filesize = max($umf, $pms);
654 }
655 return $max_filesize;
656 }
657 }

References getMaxSize().

Referenced by checkUpload(), and getMaxFilesizeAsString().

+ 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

Reimplemented from assQuestion.

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

274 {
275 return $this->getPoints();
276 }

References assQuestion\getPoints().

Referenced by isComplete().

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

1024 {
1025 return $this->maxsize;
1026 }

References $maxsize.

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

+ Here is the caller graph for this function:

◆ getPreviewFileUploadPath()

assFileUpload::getPreviewFileUploadPath (   $userId)
protected

Returns the filesystem path for file uploads.

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

427 {
428 return CLIENT_WEB_DIR . "/assessment/qst_preview/$userId/{$this->getId()}/fileuploads/";
429 }

Referenced by deletePreviewFileUploads(), and savePreviewData().

+ Here is the caller graph for this function:

◆ getPreviewFileUploadPathWeb()

assFileUpload::getPreviewFileUploadPathWeb (   $userId)
protected

Returns the filesystem path for file uploads.

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

450 {
451 include_once "./Services/Utilities/classes/class.ilUtil.php";
452 $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/assessment/qst_preview/$userId/{$this->getId()}/fileuploads/";
453 return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
454 }

References ILIAS_HTTP_PATH, and ilUtil\removeTrailingPathSeparators().

Referenced by savePreviewData().

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

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

References ilAssQuestionPreviewSession\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

Reimplemented from assQuestion.

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

910 {
911 return "assFileUpload";
912 }

◆ getRTETextWithMediaObjects()

assFileUpload::getRTETextWithMediaObjects ( )

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

Reimplemented from assQuestion.

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

948 {
949 $text = parent::getRTETextWithMediaObjects();
950 return $text;
951 }

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

462 {
463 global $DIC;
464 $ilDB = $DIC['ilDB'];
465
466 if (is_null($pass)) {
467 $pass = $this->getSolutionMaxPass($active_id);
468 }
469 // fau: testNav - check existing value1 because the intermediate solution will have a dummy entry
470 $result = $ilDB->queryF(
471 "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",
472 array("integer", "integer", "integer", 'integer'),
473 array($active_id, $this->getId(), $pass, (int) $authorized)
474 );
475 // fau.
476 $found = array();
477
478 while ($data = $ilDB->fetchAssoc($result)) {
479 array_push($found, $data);
480 }
481
482 return $found;
483 }

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

Referenced by getUploadedFilesForWeb(), and handleSubmission().

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

496 {
497 global $DIC;
498 $ilDB = $DIC['ilDB'];
499
500 $found = $this->getUploadedFiles($active_id, $pass);
501 $result = $ilDB->queryF(
502 "SELECT test_fi FROM tst_active WHERE active_id = %s",
503 array('integer'),
504 array($active_id)
505 );
506 if ($result->numRows() == 1) {
507 $row = $ilDB->fetchAssoc($result);
508 $test_id = $row["test_fi"];
509 $path = $this->getFileUploadPathWeb($test_id, $active_id);
510 foreach ($found as $idx => $data) {
511 $found[$idx]['webpath'] = $path;
512 }
513 }
514 return $found;
515 }
getFileUploadPathWeb($test_id, $active_id, $question_id=null)
Returns the file upload path for web accessible files of a question.
getUploadedFiles($active_id, $pass=null, $authorized=true)
Returns the uploaded files for an active user in a given pass.

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

+ Here is the call graph for this function:

◆ getUserSolutionPreferingIntermediate()

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

Get the user solution preferring the intermediate solution.

Parameters
int$active_id
int | null$pass
Returns
array

Reimplemented from assQuestion.

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

773 {
774 $solution = $this->getSolutionValues($active_id, $pass, false);
775
776 if (!count($solution)) {
777 $solution = $this->getSolutionValues($active_id, $pass, true);
778 } else {
779 $cleaned = array();
780 foreach ($solution as $row) {
781 if (!empty($row['value1'])) {
782 $cleaned[] = $row;
783 }
784 }
785 $solution = $cleaned;
786 }
787
788 return $solution;
789 }
getSolutionValues($active_id, $pass=null, $authorized=true)
Loads solutions of a given user from the database an returns it.

References $pass, and assQuestion\getSolutionValues().

+ 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@access protected

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

876 {
877 if (!$authorized) {
878 return;
879 }
880
881 if ($this->isCompletionBySubmissionEnabled()) {
882 $maxpoints = assQuestion::_getMaximumPoints($this->getId());
883
884 if ($this->getUploadedFiles($active_id, $pass, $authorized)) {
885 $points = $maxpoints;
886 } else {
887 // fau: testNav - don't set reached points if no file is available
888 return;
889 // fau.
890 }
891
892 assQuestion::_setReachedPoints($active_id, $this->getId(), $points, $maxpoints, $pass, 1, $obligationsAnswered);
893
894 // update learning progress
895 include_once 'Modules/Test/classes/class.ilObjTestAccess.php';
896 include_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
898 ilObjTest::_getObjectIDFromActiveID((int) $active_id),
899 ilObjTestAccess::_getParticipantId((int) $active_id)
900 );
901 }
902 }
static _getMaximumPoints($question_id)
Returns the maximum points, a learner can reach answering the question.
static _setReachedPoints($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
Sets the points, a learner has reached answering the question Additionally objective results are upda...
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_force_raise=false)
Update status.
static _getParticipantId($active_id)
Get user id for active id.
static _getObjectIDFromActiveID($active_id)
Returns the ILIAS test object id for a given active id.

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

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

1121 {
1122 global $DIC;
1123 $ilDB = $DIC['ilDB'];
1124 $query = "
1125 SELECT tst_solutions.solution_id
1126 FROM tst_solutions, tst_active, qpl_questions
1127 WHERE tst_solutions.active_fi = tst_active.active_id
1128 AND tst_solutions.question_fi = qpl_questions.question_id
1129 AND tst_solutions.question_fi = %s AND tst_active.test_fi = %s";
1130 $result = $ilDB->queryF(
1131 $query,
1132 array("integer", "integer"),
1133 array($this->getId(), $test_id)
1134 );
1135 if ($result->numRows() > 0) {
1136 return true;
1137 } else {
1138 return false;
1139 }
1140 }
$query

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

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

@global ilDBInterface $ilDB

Parameters
integer$active_id
integer$pass
Returns
boolean $answered

Reimplemented from assQuestion.

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

1212 {
1213 $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());
1214
1215 return $numExistingSolutionRecords > 0;
1216 }
static getNumExistingSolutionRecords($activeId, $pass, $questionId)
returns the number of existing solution records for the given test active / pass and given question i...

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

+ Here is the call graph for this function:

◆ isAutosaveable()

assFileUpload::isAutosaveable ( )

Reimplemented from assQuestion.

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

1234 {
1235 return false;
1236 }

◆ isComplete()

assFileUpload::isComplete ( )

Returns true, if the question is complete for use.

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

Reimplemented from assQuestion.

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

63 {
64 if (
65 strlen($this->title)
66 && ($this->author)
67 && ($this->question)
68 && ($this->getMaximumPoints() >= 0)
69 && is_numeric($this->getMaximumPoints())) {
70 return true;
71 }
72 return false;
73 }
getMaximumPoints()
Returns the maximum points, a learner can reach answering the question.

References getMaximumPoints().

+ Here is the call graph for this function:

◆ isCompletionBySubmissionEnabled()

assFileUpload::isCompletionBySubmissionEnabled ( )

Checks whether completion by submission is enabled or not.

Returns
boolean @access public

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

1181 {
1183 }

References $completion_by_submission.

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

+ Here is the caller graph for this function:

◆ isFileDeletionAction()

assFileUpload::isFileDeletionAction ( )
protected
Returns
bool

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

1261 {
1262 require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssFileUploadFileTableDeleteButton.php';
1264 }

References ilAssFileUploadFileTableDeleteButton\ACTION, and assQuestion\getQuestionAction().

Referenced by savePreviewData(), and saveWorkingData().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isFileDeletionSubmitAvailable()

assFileUpload::isFileDeletionSubmitAvailable ( )
protected
Returns
bool

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

1270 {
1271 return $this->isNonEmptyItemListPostSubmission(self::DELETE_FILES_TBL_POSTVAR);
1272 }
isNonEmptyItemListPostSubmission($postSubmissionFieldname)

References assQuestion\isNonEmptyItemListPostSubmission().

Referenced by savePreviewData(), and saveWorkingData().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isFileReuseHandlingRequired()

assFileUpload::isFileReuseHandlingRequired ( )
protected
Returns
bool

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

1286 {
1287 if (!$this->getTestPresentationConfig()->isPreviousPassSolutionReuseAllowed()) {
1288 return false;
1289 }
1290
1291 if (!$this->isFileReuseSubmitAvailable()) {
1292 return false;
1293 }
1294
1295 return true;
1296 }
getTestPresentationConfig()
Get the test question configuration (initialised once)

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

Referenced by saveWorkingData().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isFileReuseSubmitAvailable()

assFileUpload::isFileReuseSubmitAvailable ( )
protected
Returns
bool

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

1278 {
1279 return $this->isNonEmptyItemListPostSubmission(self::REUSE_FILES_TBL_POSTVAR);
1280 }

References assQuestion\isNonEmptyItemListPostSubmission().

Referenced by isFileReuseHandlingRequired().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isFileUploadAvailable()

assFileUpload::isFileUploadAvailable ( )
protected
Returns
bool

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

1302 {
1303 if (!isset($_FILES['upload'])) {
1304 return false;
1305 }
1306
1307 if (!isset($_FILES['upload']['tmp_name'])) {
1308 return false;
1309 }
1310
1311 return strlen($_FILES['upload']['tmp_name']) > 0;
1312 }

Referenced by savePreviewData(), and saveWorkingData().

+ 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

Reimplemented from assQuestion.

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

1229 {
1230 return true;
1231 }

◆ loadFromDb()

assFileUpload::loadFromDb (   $question_id)

Loads a assFileUpload object from a database.

Parameters
integer$question_idA unique key which defines the question in the database

Reimplemented from assQuestion.

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

113 {
114 global $DIC;
115 $ilDB = $DIC['ilDB'];
116 $result = $ilDB->queryF(
117 "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",
118 array("integer"),
119 array($question_id)
120 );
121 if ($result->numRows() == 1) {
122 $data = $ilDB->fetchAssoc($result);
123 $this->setId($question_id);
124 $this->setTitle($data["title"]);
125 $this->setComment($data["description"]);
126 $this->setNrOfTries($data['nr_of_tries']);
127 $this->setSuggestedSolution($data["solution_hint"]);
128 $this->setOriginalId($data["original_id"]);
129 $this->setObjId($data["obj_fi"]);
130 $this->setAuthor($data["author"]);
131 $this->setOwner($data["owner"]);
132 $this->setPoints($data["points"]);
133
134 include_once("./Services/RTE/classes/class.ilRTE.php");
135 $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
136 $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
137 $this->setMaxSize($data["maxsize"]);
138 $this->setAllowedExtensions($data["allowedextensions"]);
139 $this->setCompletionBySubmission($data['compl_by_submission'] == 1 ? true : false);
140
141 try {
145 }
146
147 try {
148 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
150 }
151 }
152 parent::loadFromDb($question_id);
153 }
getAdditionalTableName()
Returns the name of the additional question data table in the database.
setId($id=-1)
Sets the id of the assQuestion object.
setOriginalId($original_id)
setObjId($obj_id=0)
Set the object id of the container object.
setSuggestedSolution($solution_id="", $subquestion_index=0, $is_import=false)
Sets a suggested solution for the question.
setTitle($title="")
Sets the title string of the assQuestion object.
setOwner($owner="")
Sets the creator/owner ID of the assQuestion object.
setEstimatedWorkingTime($hour=0, $min=0, $sec=0)
Sets the estimated working time of a question from given hour, minute and second.
setAuthor($author="")
Sets the authors name of the assQuestion object.
setLifecycle(ilAssQuestionLifecycle $lifecycle)
setPoints($a_points)
Sets the maximum available points for the question.
setComment($comment="")
Sets the comment string of the assQuestion object.
setNrOfTries($a_nr_of_tries)
setAdditionalContentEditingMode($additinalContentEditingMode)
setter for additional content editing mode for this question
setQuestion($question="")
Sets the question string of the question object.
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...

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

+ Here is the call graph for this function:

◆ removeIntermediateSolution()

assFileUpload::removeIntermediateSolution (   $active_id,
  $pass 
)

Remove an intermediate soluton (overridden to remove unused fies)

Parameters
int$active_id
int$pass
Returns
int|object

Reimplemented from assQuestion.

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

801 {
802 global $DIC;
803 $ilDB = $DIC['ilDB'];
804
805 $result = parent::removeIntermediateSolution($active_id, $pass);
806
807 // get the current test id
808 // hey: prevPassSolutions - exract until you drop :-D
809 $test_id = $this->lookupTestId($active_id);
810 // hey.
811
812 $this->deleteUnusedFiles($test_id, $active_id, $pass);
813
814 return $result;
815 }
lookupTestId($active_id)

References $DIC, $ilDB, $pass, $result, assQuestion\$test_id, and assQuestion\lookupTestId().

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

86 {
87 global $DIC;
88 $ilDB = $DIC['ilDB'];
89 $ilDB->manipulateF(
90 "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
91 array( "integer" ),
92 array( $this->getId() )
93 );
94 $ilDB->manipulateF(
95 "INSERT INTO " . $this->getAdditionalTableName(
96 ) . " (question_fi, maxsize, allowedextensions, compl_by_submission) VALUES (%s, %s, %s, %s)",
97 array( "integer", "float", "text", "integer" ),
98 array(
99 $this->getId(),
100 (strlen($this->getMaxSize())) ? $this->getMaxSize() : null,
101 (strlen($this->getAllowedExtensions())) ? $this->getAllowedExtensions() : null,
103 )
104 );
105 }

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

Referenced by saveToDb().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ savePreviewData()

assFileUpload::savePreviewData ( ilAssQuestionPreviewSession  $previewSession)
protected

Reimplemented from assQuestion.

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

820 {
821 $userSolution = $previewSession->getParticipantsSolution();
822
823 if (!is_array($userSolution)) {
824 $userSolution = array();
825 }
826
827 // hey: prevPassSolutions - readability spree - get a chance to understand the code
828 if ($this->isFileDeletionAction()) {
829 // hey.
830 // hey: prevPassSolutions - readability spree - get a chance to understand the code
831 if ($this->isFileDeletionSubmitAvailable()) {
832 // hey.
833 $userSolution = $this->deletePreviewFileUploads($previewSession->getUserId(), $userSolution, $_POST['deletefiles']);
834 } else {
835 ilUtil::sendInfo($this->lng->txt('no_checkbox'), true);
836 }
837 } else {
838 // hey: prevPassSolutions - readability spree - get a chance to understand the code
839 if ($this->isFileUploadAvailable()) {
840 // hey.
841 if ($this->checkUpload()) {
842 if (!@file_exists($this->getPreviewFileUploadPath($previewSession->getUserId()))) {
844 }
845
846 $version = time();
847 $filename_arr = pathinfo($_FILES["upload"]["name"]);
848 $extension = $filename_arr["extension"];
849 $newfile = "file_" . md5($_FILES["upload"]["name"]) . "_" . $version . "." . $extension;
850 ilUtil::moveUploadedFile($_FILES["upload"]["tmp_name"], $_FILES["upload"]["name"], $this->getPreviewFileUploadPath($previewSession->getUserId()) . $newfile);
851
852 $userSolution[$newfile] = array(
853 'solution_id' => $newfile,
854 'value1' => $newfile,
855 'value2' => $_FILES['upload']['name'],
856 'tstamp' => $version,
857 'webpath' => $this->getPreviewFileUploadPathWeb($previewSession->getUserId())
858 );
859 }
860 }
861 }
862
863 $previewSession->setParticipantsSolution($userSolution);
864 }
$_POST["username"]
getPreviewFileUploadPathWeb($userId)
Returns the filesystem path for file uploads.
deletePreviewFileUploads($userId, $userSolution, $files)
checkUpload()
Check file upload.
static moveUploadedFile($a_file, $a_name, $a_target, $a_raise_errors=true, $a_mode="move_uploaded")
move uploaded file
static makeDirParents($a_dir)
Create a new directory and all parent directories.
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.

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

+ Here is the call graph for this function:

◆ saveToDb()

assFileUpload::saveToDb (   $original_id = "")

Saves a assFileUpload object to a database.

Reimplemented from assQuestion.

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

79 {
82 parent::saveToDb();
83 }
saveAdditionalQuestionDataToDb()
Saves a record to the question types additional data table.
saveQuestionDataToDb($original_id="")

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

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

@access public

Parameters
integer$active_idActive id of the user
integer$passTest pass
Returns
boolean $status

Reimplemented from assQuestion.

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

671 {
672 $pass = $this->ensureCurrentTestPass($active_id, $pass);
673 $test_id = $this->lookupTestId($active_id);
674
675 $uploadHandlingRequired = $this->isFileUploadAvailable() && $this->checkUpload();
676
677 $entered_values = false;
678
679 $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $uploadHandlingRequired, $test_id, $active_id, $pass, $authorized) {
680 if ($authorized == false) {
681 $this->forceExistingIntermediateSolution($active_id, $pass, true);
682 }
683
684 if ($this->isFileDeletionAction()) {
685 if ($this->isFileDeletionSubmitAvailable()) {
686 foreach ($_POST[self::DELETE_FILES_TBL_POSTVAR] as $solution_id) {
687 $this->removeSolutionRecordById($solution_id);
688 }
689 } else {
690 ilUtil::sendInfo($this->lng->txt('no_checkbox'), true);
691 }
692 } else {
693 if ($this->isFileReuseHandlingRequired()) {
694 foreach ($_POST[self::REUSE_FILES_TBL_POSTVAR] as $solutionId) {
695 $solution = $this->getSolutionRecordById($solutionId);
696
697 $this->saveCurrentSolution(
698 $active_id,
699 $pass,
700 $solution['value1'],
701 $solution['value2'],
702 false,
703 $solution['tstamp']
704 );
705 }
706 }
707
708 if ($uploadHandlingRequired) {
709 if (!@file_exists($this->getFileUploadPath($test_id, $active_id))) {
711 }
712
713 $solutionFileVersioningUploadTS = time();
714 $filename_arr = pathinfo($_FILES["upload"]["name"]);
715 $extension = $filename_arr["extension"];
716 $newfile = "file_" . $active_id . "_" . $pass . "_" . $solutionFileVersioningUploadTS . "." . $extension;
717
718 include_once 'Services/Utilities/classes/class.ilFileUtils.php';
719 $dispoFilename = ilFileUtils::getValidFilename($_FILES['upload']['name']);
720 $newfile = ilFileUtils::getValidFilename($newfile);
721
722 ilUtil::moveUploadedFile($_FILES["upload"]["tmp_name"], $_FILES["upload"]["name"], $this->getFileUploadPath($test_id, $active_id) . $newfile);
723
724 $this->saveCurrentSolution(
725 $active_id,
726 $pass,
727 $newfile,
728 $dispoFilename,
729 false,
730 $solutionFileVersioningUploadTS
731 );
732
733 $entered_values = true;
734 }
735 }
736
737 if ($authorized == true && $this->intermediateSolutionExists($active_id, $pass)) {
738 // remove the dummy record of the intermediate solution
739 $this->deleteDummySolutionRecord($active_id, $pass);
740
741 // delete the authorized solution and make the intermediate solution authorized (keeping timestamps)
742 $this->removeCurrentSolution($active_id, $pass, true);
743 $this->updateCurrentSolutionsAuthorization($active_id, $pass, true, true);
744 }
745
746 $this->deleteUnusedFiles($test_id, $active_id, $pass);
747 });
748
749 if ($entered_values) {
750 include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
752 assQuestion::logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
753 }
754 } else {
755 include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
757 assQuestion::logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
758 }
759 }
760
761 return true;
762 }
deleteDummySolutionRecord($activeId, $passIndex)
saveCurrentSolution($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)
getSolutionRecordById($solutionId)
static logAction($logtext="", $active_id="", $question_id="")
Logs an action into the Test&Assessment log.
removeCurrentSolution($active_id, $pass, $authorized=true)
removeSolutionRecordById($solutionId)
ensureCurrentTestPass($active_id, $pass)
intermediateSolutionExists($active_id, $pass)
forceExistingIntermediateSolution($activeId, $passIndex, $considerDummyRecordCreation)
updateCurrentSolutionsAuthorization($activeId, $pass, $authorized, $keepTime=false)
static getValidFilename($a_filename)
Get valid filename.
static _getLogLanguage()
retrieve the log language for assessment logging
static _enabledAssessmentLogging()
check wether assessment logging is enabled or not

References $_POST, $pass, assQuestion\$test_id, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), checkUpload(), assQuestion\deleteDummySolutionRecord(), assQuestion\ensureCurrentTestPass(), assQuestion\forceExistingIntermediateSolution(), getFileUploadPath(), assQuestion\getProcessLocker(), assQuestion\getSolutionRecordById(), ilFileUtils\getValidFilename(), assQuestion\intermediateSolutionExists(), isFileDeletionAction(), isFileDeletionSubmitAvailable(), isFileReuseHandlingRequired(), isFileUploadAvailable(), assQuestion\logAction(), assQuestion\lookupTestId(), ilUtil\makeDirParents(), ilUtil\moveUploadedFile(), assQuestion\removeCurrentSolution(), assQuestion\removeSolutionRecordById(), assQuestion\saveCurrentSolution(), ilUtil\sendInfo(), and assQuestion\updateCurrentSolutionsAuthorization().

+ Here is the call graph for this function:

◆ setAllowedExtensions()

assFileUpload::setAllowedExtensions (   $a_value)

Set allowed file extensions.

Parameters
string$a_valueAllowed file extensions

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

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

Referenced by __set(), and loadFromDb().

+ Here is the caller graph for this function:

◆ setCompletionBySubmission()

assFileUpload::setCompletionBySubmission (   $bool)

Enabled/Disable completion by submission.

Parameters
boolean
Returns
assFileUpload @access public

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

1195 {
1196 $this->completion_by_submission = (bool) $bool;
1197 return $this;
1198 }

Referenced by __set(), and loadFromDb().

+ Here is the caller graph for this function:

◆ setExportDetailsXLS()

assFileUpload::setExportDetailsXLS (   $worksheet,
  $startrow,
  $active_id,
  $pass 
)

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

Parameters
object$worksheetReference to the parent excel worksheet
object$startrowStartrow of the output in the excel worksheet
object$active_idActive id of the participant
object$passTest pass
Returns
object
}

Reimplemented from assQuestion.

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

957 {
958 parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
959
960 $i = 1;
961 $solutions = $this->getSolutionValues($active_id, $pass);
962 foreach ($solutions as $solution) {
963 $worksheet->setCell($startrow + $i, 0, $this->lng->txt("result"));
964 $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
965 if (strlen($solution["value1"])) {
966 $worksheet->setCell($startrow + $i, 1, $solution["value1"]);
967 $worksheet->setCell($startrow + $i, 2, $solution["value2"]);
968 }
969 $i++;
970 }
971
972 return $startrow + $i + 1;
973 }
$i
Definition: metadata.php:24

References $i, $pass, and assQuestion\getSolutionValues().

+ Here is the call graph for this function:

◆ setMaxSize()

assFileUpload::setMaxSize (   $a_value)

Set max file size.

Parameters
double$a_valueMax file size

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

1034 {
1035 $this->maxsize = $a_value;
1036 }

Referenced by __set(), and loadFromDb().

+ 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

Reimplemented from assQuestion.

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

1001 {
1002 include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assFileUploadExport.php";
1003 $export = new assFileUploadExport($this);
1004 return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
1005 }
Class for file upload question exports.

Field Documentation

◆ $allowedextensions

assFileUpload::$allowedextensions
protected

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

Referenced by getAllowedExtensions().

◆ $completion_by_submission

assFileUpload::$completion_by_submission = false
protected

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

Referenced by isCompletionBySubmissionEnabled().

◆ $maxsize

assFileUpload::$maxsize
protected

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

Referenced by getMaxSize().

◆ DELETE_FILES_TBL_POSTVAR

const assFileUpload::DELETE_FILES_TBL_POSTVAR = 'deletefiles'

◆ REUSE_FILES_TBL_POSTVAR

const assFileUpload::REUSE_FILES_TBL_POSTVAR = 'reusefiles'

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