ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
assTextQuestion Class Reference

Class for text questions. More...

+ Inheritance diagram for assTextQuestion:
+ Collaboration diagram for assTextQuestion:

Public Member Functions

 __construct ( $title="", $comment="", $author="", $owner=-1, $question="")
 assTextQuestion constructor More...
 
 isComplete ()
 Returns true, if a multiple choice question is complete for use. More...
 
 saveToDb ($original_id="")
 Saves a assTextQuestion object to a database. More...
 
 loadFromDb ($question_id)
 Loads a assTextQuestion object from a database. More...
 
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assTextQuestion. More...
 
 copyObject ($target_questionpool_id, $title="")
 Copies an assTextQuestion object. More...
 
 createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")
 
 getMaxNumOfChars ()
 Gets the maximum number of characters for the text solution. More...
 
 setMaxNumOfChars ($maxchars=0)
 Sets the maximum number of characters for the text solution. More...
 
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question. More...
 
 getMinimumPoints ()
 
 setReachedPoints ($active_id, $points, $pass=null)
 Sets the points, a learner has reached answering the question. More...
 
 isKeywordMatching ($answertext, $a_keyword)
 Checks if one of the keywords matches the answertext. More...
 
 calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
 Returns the points, a learner has reached answering the question. More...
 
 saveWorkingData ($active_id, $pass=null, $authorized=true)
 Saves the learners input of the question to the database. More...
 
 getSolutionSubmit ()
 
 createRandomSolution ($test_id, $user_id)
 
 getQuestionType ()
 Returns the question type of the question. More...
 
 getTextRating ()
 Returns the rating option for text comparisons. More...
 
 setTextRating ($a_text_rating)
 Sets the rating option for text comparisons. More...
 
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database. 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...
 
 toJSON ()
 Returns a JSON representation of the question. More...
 
 getAnswerCount ()
 
 addAnswer ( $answertext="", $points=0.0, $points_unchecked=0.0, $order=0, $answerimage="")
 Adds a possible answer for a multiple choice question. More...
 
 getAnswers ()
 
 getAnswer ($index=0)
 Returns an answer with a given index. More...
 
 deleteAnswer ($index=0)
 Deletes an answer with a given index. More...
 
 getAnswerTableName ()
 Returns the name of the answer table in the database. More...
 
 flushAnswers ()
 Deletes all answers. More...
 
 setAnswers ($answers)
 
 duplicateAnswers ($original_id)
 
 getKeywordRelation ()
 
 setKeywordRelation ($a_relation)
 This method implements a default behaviour. More...
 
 isAnswered ($active_id, $pass=null)
 returns boolean wether the question is answered during test pass or not More...
 
 countLetters ($text)
 
- 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...
 
 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 ()
 
 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...
 
 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)
 
 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...
 
- Public Member Functions inherited from ilObjQuestionScoringAdjustable
 saveAdditionalQuestionDataToDb ()
 Saves a record to the question types additional data table. More...
 
- Public Member Functions inherited from ilObjAnswerScoringAdjustable
 saveAnswerSpecificDataToDb ()
 Saves the answer specific records into a question types answer table. More...
 

Static Public Member Functions

static getValidScoringModes ()
 
static getScoringModesWithPointsByQuestion ()
 
static getScoringModesWithPointsByKeyword ()
 
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

 $maxNumOfChars
 
 $keywords
 
 $answers
 
 $text_rating
 
 $keyword_relation = 'any'
 
- 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 ($solution)
 
 reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)
 {Reworks the allready saved working data if neccessary.
Parameters
integer$active_id
integer$pass
boolean$obligationsAnswered
boolean$authorized
} More...
 
- Protected Member Functions inherited from assQuestion
 getQuestionAction ()
 
 isNonEmptyItemListPostSubmission ($postSubmissionFieldname)
 
 ensureCurrentTestPass ($active_id, $pass)
 
 lookupCurrentTestPass ($active_id, $pass)
 
 lookupTestId ($active_id)
 
 log ($active_id, $langVar)
 
 reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)
 Reworks the allready saved working data if neccessary. More...
 
 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)
 
 deleteSolutionRecordByValues ($activeId, $passIndex, $authorized, $matchValues)
 
 duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)
 
 forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)
 
 buildTestPresentationConfig ()
 build basic test question configuration instance More...
 

Private Member Functions

 isValidTextRating ($textRating)
 

Private Attributes

 $matchcondition
 

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 ()
 
- 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
 
- Static Protected Attributes inherited from assQuestion
static $allowedFileExtensionsByMimeType
 
static $allowedCharsetsByMimeType
 
static $allowedImageMaterialFileExtensionsByMimeType
 
static $forcePassResultsUpdateEnabled = false
 
static $imageSourceFixReplaceMap
 

Detailed Description

Class for text questions.

assTextQuestion is a class for text 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 22 of file class.assTextQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

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

assTextQuestion constructor

The constructor takes possible arguments an creates an instance of the assTextQuestion 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 text question

Reimplemented from assQuestion.

Definition at line 69 of file class.assTextQuestion.php.

75 {
76 parent::__construct($title, $comment, $author, $owner, $question);
77 $this->maxNumOfChars = 0;
78 $this->points = 1;
79 $this->answers = array();
80 $this->matchcondition = 0;
81 }

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

Member Function Documentation

◆ addAnswer()

assTextQuestion::addAnswer (   $answertext = "",
  $points = 0.0,
  $points_unchecked = 0.0,
  $order = 0,
  $answerimage = "" 
)

Adds a possible answer for a multiple choice question.

A ASS_AnswerBinaryStateImage object will be created and assigned to the array $this->answers.

Parameters
string$answertextThe answer text
double$pointsThe points for selecting the answer (even negative points can be used)
boolean$stateDefines the answer as correct (TRUE) or incorrect (FALSE)
integer$orderA possible display order of the answer
double$pointsThe points for not selecting the answer (even negative points can be used) @access public
See also
$answers
ASS_AnswerBinaryStateImage

Definition at line 832 of file class.assTextQuestion.php.

838 {
839 include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
840
841 // add answer
842 $answer = new ASS_AnswerMultipleResponseImage($answertext, $points);
843 $this->answers[] = $answer;
844 }
ASS_AnswerBinaryStateImage is a class for answers with a binary state indicator (checked/unchecked,...

References assQuestion\$points.

Referenced by loadFromDb(), and setAnswers().

+ Here is the caller graph for this function:

◆ calculateReachedPoints()

assTextQuestion::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 545 of file class.assTextQuestion.php.

546 {
547 if ($returndetails) {
548 throw new ilTestException('return details not implemented for ' . __METHOD__);
549 }
550
551 global $ilDB;
552
553 $points = 0;
554 if (is_null($pass)) {
555 $pass = $this->getSolutionMaxPass($active_id);
556 }
557
558 $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
559
560 // Return min points when no answer was given.
561 if ($ilDB->numRows($result) == 0) {
562 return $this->getMinimumPoints();
563 }
564
565 // Return points of points are already on the row.
566 $row = $ilDB->fetchAssoc($result);
567 if ($row["points"] != null) {
568 return $row["points"];
569 }
570
571 return $this->calculateReachedPointsForSolution($row['value1']);
572 }
$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.
calculateReachedPointsForSolution($solution)
Base Exception for all Exceptions relating to Modules/Test.
global $ilDB

References $ilDB, $pass, assQuestion\$points, $result, $row, calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), getMinimumPoints(), and assQuestion\getSolutionMaxPass().

+ Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assTextQuestion::calculateReachedPointsForSolution (   $solution)
protected

Definition at line 469 of file class.assTextQuestion.php.

470 {
471 // Return min points when keyword relation is NON KEYWORDS
472 if ($this->getKeywordRelation() == 'non') {
473 return $this->getMinimumPoints();
474 }
475
476 // Return min points if there are no answers present.
477 $answers = $this->getAnswers();
478
479 if (count($answers) == 0) {
480 return $this->getMinimumPoints();
481 }
482
483 switch ($this->getKeywordRelation()) {
484 case 'any':
485
486 $points = 0;
487
488 foreach ($answers as $answer) {
489 $qst_answer = $answer->getAnswertext();
490 $user_answer = ' ' . $solution;
491
492 if ($this->isKeywordMatching($user_answer, $qst_answer)) {
493 $points += $answer->getPoints();
494 }
495 }
496
497 break;
498
499 case 'all':
500
501 $points = $this->getMaximumPoints();
502
503 foreach ($answers as $answer) {
504 $qst_answer = $answer->getAnswertext();
505 $user_answer = ' ' . $solution;
506
507 if (!$this->isKeywordMatching($user_answer, $qst_answer)) {
508 $points = 0;
509 break;
510 }
511 }
512
513 break;
514
515 case 'one':
516
517 $points = 0;
518
519 foreach ($answers as $answer) {
520 $qst_answer = $answer->getAnswertext();
521 $user_answer = ' ' . $solution;
522
523 if ($this->isKeywordMatching($user_answer, $qst_answer)) {
524 $points = $this->getMaximumPoints();
525 break;
526 }
527 }
528
529 break;
530 }
531
532 return $points;
533 }
isKeywordMatching($answertext, $a_keyword)
Checks if one of the keywords matches the answertext.
getMaximumPoints()
Returns the maximum points, a learner can reach answering the question.

References $answers, assQuestion\$points, getAnswers(), getKeywordRelation(), getMaximumPoints(), getMinimumPoints(), and isKeywordMatching().

Referenced by calculateReachedPoints().

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

◆ copyObject()

assTextQuestion::copyObject (   $target_questionpool_id,
  $title = "" 
)

Copies an assTextQuestion object.

@access public

Definition at line 226 of file class.assTextQuestion.php.

227 {
228 if ($this->id <= 0) {
229 // The question has not been saved. It cannot be duplicated
230 return;
231 }
232 // duplicate the question in database
233 $clone = $this;
234 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
236 $clone->id = -1;
237 $source_questionpool_id = $this->getObjId();
238 $clone->setObjId($target_questionpool_id);
239 if ($title) {
240 $clone->setTitle($title);
241 }
242 $clone->saveToDb();
243 // copy question page content
244 $clone->copyPageOfQuestion($original_id);
245 // copy XHTML media objects
246 $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
247 // duplicate answers
248 #$clone->duplicateAnswers($original_id);
249
250 $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
251
252 return $clone->id;
253 }
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:

◆ countLetters()

assTextQuestion::countLetters (   $text)

Definition at line 1028 of file class.assTextQuestion.php.

1029 {
1030 $text = strip_tags($text);
1031
1032 $text = str_replace('&gt;', '>', $text);
1033 $text = str_replace('&lt;', '<', $text);
1034 $text = str_replace('&nbsp;', ' ', $text);
1035 $text = str_replace('&amp;', '&', $text);
1036
1037 $text = str_replace("\r\n", "\n", $text);
1038 $text = str_replace("\n", "", $text);
1039
1040 return ilStr::strLen($text);
1041 }
static strLen($a_string)
Definition: class.ilStr.php:78
$text
Definition: errorreport.php:18

References $text, and ilStr\strLen().

+ Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 255 of file class.assTextQuestion.php.

256 {
257 if ($this->id <= 0) {
258 // The question has not been saved. It cannot be duplicated
259 return;
260 }
261
262 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
263
264 $sourceQuestionId = $this->id;
265 $sourceParentId = $this->getObjId();
266
267 // duplicate the question in database
268 $clone = $this;
269 $clone->id = -1;
270
271 $clone->setObjId($targetParentId);
272
273 if ($targetQuestionTitle) {
274 $clone->setTitle($targetQuestionTitle);
275 }
276
277 $clone->saveToDb();
278 // copy question page content
279 $clone->copyPageOfQuestion($sourceQuestionId);
280 // copy XHTML media objects
281 $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
282 // duplicate answers
283 #$clone->duplicateAnswers($sourceQuestionId);
284
285 $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
286
287 return $clone->id;
288 }

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

+ Here is the call graph for this function:

◆ createRandomSolution()

assTextQuestion::createRandomSolution (   $test_id,
  $user_id 
)

Reimplemented from assQuestion.

Definition at line 695 of file class.assTextQuestion.php.

696 {
697 }

◆ deleteAnswer()

assTextQuestion::deleteAnswer (   $index = 0)

Deletes an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer @access public
See also
$answers

Definition at line 883 of file class.assTextQuestion.php.

884 {
885 if ($index < 0) {
886 return;
887 }
888 if (count($this->answers) < 1) {
889 return;
890 }
891 if ($index >= count($this->answers)) {
892 return;
893 }
894 $answer = $this->answers[$index];
895 if (strlen($answer->getImage())) {
896 $this->deleteImage($answer->getImage());
897 }
898 unset($this->answers[$index]);
899 $this->answers = array_values($this->answers);
900 for ($i = 0; $i < count($this->answers); $i++) {
901 if ($this->answers[$i]->getOrder() > $index) {
902 $this->answers[$i]->setOrder($i);
903 }
904 }
905 }
$i
Definition: disco.tpl.php:19
$index
Definition: metadata.php:60

References $i, and $index.

◆ duplicate()

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

Duplicates an assTextQuestion.

@access public

Reimplemented from assQuestion.

Definition at line 174 of file class.assTextQuestion.php.

175 {
176 if ($this->id <= 0) {
177 // The question has not been saved. It cannot be duplicated
178 return;
179 }
180 // duplicate the question in database
181 $this_id = $this->getId();
182 $thisObjId = $this->getObjId();
183
184 $clone = $this;
185 include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
187 $clone->id = -1;
188
189 if ((int) $testObjId > 0) {
190 $clone->setObjId($testObjId);
191 }
192
193 if ($title) {
194 $clone->setTitle($title);
195 }
196
197 if ($author) {
198 $clone->setAuthor($author);
199 }
200 if ($owner) {
201 $clone->setOwner($owner);
202 }
203
204 if ($for_test) {
205 $clone->saveToDb($original_id);
206 } else {
207 $clone->saveToDb();
208 }
209
210 // copy question page content
211 $clone->copyPageOfQuestion($this_id);
212 // copy XHTML media objects
213 $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
214 #$clone->duplicateAnswers($this_id);
215
216 $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
217
218 return $clone->id;
219 }
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:

◆ duplicateAnswers()

assTextQuestion::duplicateAnswers (   $original_id)

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

945 {
946 global $ilDB;
947
948 $result = $ilDB->queryF(
949 "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
950 array('integer'),
951 array($original_id)
952 );
953 if ($result->numRows()) {
954 while ($row = $ilDB->fetchAssoc($result)) {
955 $next_id = $ilDB->nextId('qpl_a_essay');
956 $affectedRows = $ilDB->manipulateF(
957 "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points)
958 VALUES (%s, %s, %s, %s)",
959 array('integer','integer','text','float'),
960 array($next_id, $this->getId(), $row["answertext"], $row["points"])
961 );
962 }
963 }
964 }

References $ilDB, assQuestion\$original_id, $result, $row, and assQuestion\getId().

+ Here is the call graph for this function:

◆ flushAnswers()

assTextQuestion::flushAnswers ( )

Deletes all answers.

@access public

See also
$answers

Definition at line 918 of file class.assTextQuestion.php.

919 {
920 $this->answers = array();
921 }

Referenced by loadFromDb(), and setAnswers().

+ Here is the caller graph for this function:

◆ getAdditionalTableName()

assTextQuestion::getAdditionalTableName ( )

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

Returns
string The additional table name @access public

Reimplemented from assQuestion.

Definition at line 753 of file class.assTextQuestion.php.

754 {
755 return "qpl_qst_essay";
756 }

Referenced by loadFromDb().

+ Here is the caller graph for this function:

◆ getAnswer()

assTextQuestion::getAnswer (   $index = 0)

Returns an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer
Returns
object ASS_AnswerBinaryStateImage-Object containing the answer @access public
See also
$answers

Definition at line 860 of file class.assTextQuestion.php.

861 {
862 if ($index < 0) {
863 return null;
864 }
865 if (count($this->answers) < 1) {
866 return null;
867 }
868 if ($index >= count($this->answers)) {
869 return null;
870 }
871
872 return $this->answers[$index];
873 }

References $index.

◆ getAnswerCount()

assTextQuestion::getAnswerCount ( )

Definition at line 814 of file class.assTextQuestion.php.

815 {
816 return count($this->answers);
817 }

◆ getAnswers()

assTextQuestion::getAnswers ( )

Definition at line 846 of file class.assTextQuestion.php.

847 {
848 return $this->answers;
849 }

References $answers.

Referenced by calculateReachedPointsForSolution().

+ Here is the caller graph for this function:

◆ getAnswerTableName()

assTextQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name @access public

Reimplemented from assQuestion.

Definition at line 907 of file class.assTextQuestion.php.

908 {
909 return 'qpl_a_essay';
910 }

◆ getKeywordRelation()

assTextQuestion::getKeywordRelation ( )

Definition at line 966 of file class.assTextQuestion.php.

967 {
969 }

References $keyword_relation.

Referenced by calculateReachedPointsForSolution(), getMaximumPoints(), and getMinimumPoints().

+ Here is the caller graph for this function:

◆ getMaximumPoints()

assTextQuestion::getMaximumPoints ( )

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

@access public

See also
$points

Reimplemented from assQuestion.

Definition at line 324 of file class.assTextQuestion.php.

325 {
326 if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
327 return parent::getPoints();
328 }
329
330 $points = 0;
331
332 foreach ($this->answers as $answer) {
333 if ($answer->getPoints() > 0) {
334 $points = $points + $answer->getPoints();
335 }
336 }
337
338 return $points;
339 }

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPointsForSolution(), and isComplete().

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

◆ getMaxNumOfChars()

assTextQuestion::getMaxNumOfChars ( )

Gets the maximum number of characters for the text solution.

Returns
integer The maximum number of characters for the text solution @access public
See also
$maxNumOfChars

Definition at line 297 of file class.assTextQuestion.php.

298 {
299 if (strcmp($this->maxNumOfChars, "") == 0) {
300 return 0;
301 } else {
303 }
304 }

References $maxNumOfChars.

Referenced by toJSON().

+ Here is the caller graph for this function:

◆ getMinimumPoints()

assTextQuestion::getMinimumPoints ( )

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

342 {
343 if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
344 return 0;
345 }
346
347 $points = 0;
348
349 foreach ($this->answers as $answer) {
350 if ($answer->getPoints() < 0) {
351 $points = $points + $answer->getPoints();
352 }
353 }
354
355 return $points;
356 }

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPoints(), and calculateReachedPointsForSolution().

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

◆ getQuestionType()

assTextQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question @access public

Reimplemented from assQuestion.

Definition at line 705 of file class.assTextQuestion.php.

706 {
707 return "assTextQuestion";
708 }

Referenced by toJSON().

+ Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assTextQuestion::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 762 of file class.assTextQuestion.php.

763 {
764 return parent::getRTETextWithMediaObjects();
765 }

◆ getScoringModesWithPointsByKeyword()

static assTextQuestion::getScoringModesWithPointsByKeyword ( )
static

Definition at line 990 of file class.assTextQuestion.php.

991 {
992 return array('any');
993 }

Referenced by assTextQuestionGUI\getBestAnswer().

+ Here is the caller graph for this function:

◆ getScoringModesWithPointsByQuestion()

static assTextQuestion::getScoringModesWithPointsByQuestion ( )
static

Definition at line 985 of file class.assTextQuestion.php.

986 {
987 return array('non', 'all', 'one');
988 }

◆ getSolutionSubmit()

assTextQuestion::getSolutionSubmit ( )
Returns
mixed|string

Definition at line 623 of file class.assTextQuestion.php.

624 {
625 $text = ilUtil::stripSlashes($_POST["TEXT"], false);
626
627 if (ilUtil::isHTML($text)) {
628 $text = $this->getHtmlUserSolutionPurifier()->purify($text);
629 }
630
631 return $text;
632 }
$_POST["username"]
static isHTML($a_text)
Checks if a given string contains HTML or not.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled

References $_POST, $text, assQuestion\getHtmlUserSolutionPurifier(), ilUtil\isHTML(), and ilUtil\stripSlashes().

Referenced by saveWorkingData().

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

◆ getTextRating()

assTextQuestion::getTextRating ( )

Returns the rating option for text comparisons.

Returns
string The rating option for text comparisons
See also
$text_rating @access User interface

Definition at line 717 of file class.assTextQuestion.php.

718 {
719 return $this->text_rating;
720 }

References $text_rating.

Referenced by isKeywordMatching().

+ Here is the caller graph for this function:

◆ getValidScoringModes()

static assTextQuestion::getValidScoringModes ( )
static

Definition at line 980 of file class.assTextQuestion.php.

981 {
982 return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
983 }

◆ isAnswered()

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

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

(overwrites method in class assQuestion)

Parameters
integer$active_id
integer$pass
Returns
boolean $answered

Reimplemented from assQuestion.

Definition at line 1006 of file class.assTextQuestion.php.

1007 {
1008 $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());
1009
1010 return $numExistingSolutionRecords > 0;
1011 }
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:

◆ isComplete()

assTextQuestion::isComplete ( )

Returns true, if a multiple choice question is complete for use.

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

Reimplemented from assQuestion.

Definition at line 88 of file class.assTextQuestion.php.

89 {
90 if (strlen($this->title)
91 && $this->author
92 && $this->question
93 && $this->getMaximumPoints() > 0
94 ) {
95 return true;
96 }
97 return false;
98 }

References getMaximumPoints().

+ Here is the call graph for this function:

◆ isKeywordMatching()

assTextQuestion::isKeywordMatching (   $answertext,
  $a_keyword 
)

Checks if one of the keywords matches the answertext.

Parameters
string$answertextThe answertext of the user
string$a_keywordThe keyword which should be checked
Returns
boolean TRUE if the keyword matches, FALSE otherwise @access private

Definition at line 410 of file class.assTextQuestion.php.

411 {
412 $result = false;
413 $textrating = $this->getTextRating();
414 include_once "./Services/Utilities/classes/class.ilStr.php";
415 switch ($textrating) {
417 if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) {
418 return true;
419 }
420 break;
422 if (ilStr::strPos($answertext, $a_keyword) !== false) {
423 return true;
424 }
425 break;
426 }
427
428 // "<p>red</p>" would not match "red" even with distance of 5
429 $answertext = strip_tags($answertext);
430
431 $answerwords = array();
432 if (preg_match_all("/([^\s.]+)/", $answertext, $matches)) {
433 foreach ($matches[1] as $answerword) {
434 array_push($answerwords, trim($answerword));
435 }
436 }
437 foreach ($answerwords as $a_original) {
438 switch ($textrating) {
440 if (levenshtein($a_original, $a_keyword) <= 1) {
441 return true;
442 }
443 break;
445 if (levenshtein($a_original, $a_keyword) <= 2) {
446 return true;
447 }
448 break;
450 if (levenshtein($a_original, $a_keyword) <= 3) {
451 return true;
452 }
453 break;
455 if (levenshtein($a_original, $a_keyword) <= 4) {
456 return true;
457 }
458 break;
460 if (levenshtein($a_original, $a_keyword) <= 5) {
461 return true;
462 }
463 break;
464 }
465 }
466 return $result;
467 }
getTextRating()
Returns the rating option for text comparisons.
static strPos($a_haystack, $a_needle, $a_offset=null)
Definition: class.ilStr.php:30
static strToLower($a_string)
Definition: class.ilStr.php:87
const TEXTGAP_RATING_LEVENSHTEIN5
const TEXTGAP_RATING_LEVENSHTEIN4
const TEXTGAP_RATING_LEVENSHTEIN3
const TEXTGAP_RATING_CASESENSITIVE
const TEXTGAP_RATING_LEVENSHTEIN2
const TEXTGAP_RATING_CASEINSENSITIVE
const TEXTGAP_RATING_LEVENSHTEIN1

References $result, getTextRating(), ilStr\strPos(), ilStr\strToLower(), TEXTGAP_RATING_CASEINSENSITIVE, TEXTGAP_RATING_CASESENSITIVE, TEXTGAP_RATING_LEVENSHTEIN1, TEXTGAP_RATING_LEVENSHTEIN2, TEXTGAP_RATING_LEVENSHTEIN3, TEXTGAP_RATING_LEVENSHTEIN4, and TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by calculateReachedPointsForSolution().

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

◆ isObligationPossible()

static assTextQuestion::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 1023 of file class.assTextQuestion.php.

1024 {
1025 return true;
1026 }

◆ isValidTextRating()

assTextQuestion::isValidTextRating (   $textRating)
private

◆ loadFromDb()

assTextQuestion::loadFromDb (   $question_id)

Loads a assTextQuestion object from a database.

Parameters
object$dbA pear DB object
integer$question_idA unique key which defines the text question in the database @access public

Reimplemented from assQuestion.

Definition at line 120 of file class.assTextQuestion.php.

121 {
122 global $ilDB;
123
124 $result = $ilDB->queryF(
125 "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",
126 array("integer"),
127 array($question_id)
128 );
129 if ($ilDB->numRows($result) == 1) {
130 $data = $ilDB->fetchAssoc($result);
131 $this->setId($question_id);
132 $this->setObjId($data["obj_fi"]);
133 $this->setTitle($data["title"]);
134 $this->setComment($data["description"]);
135 $this->setOriginalId($data["original_id"]);
136 $this->setNrOfTries($data['nr_of_tries']);
137 $this->setAuthor($data["author"]);
138 $this->setPoints((float) $data["points"]);
139 $this->setOwner($data["owner"]);
140 include_once("./Services/RTE/classes/class.ilRTE.php");
141 $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
142 $this->setShuffle($data["shuffle"]);
143 $this->setMaxNumOfChars($data["maxnumofchars"]);
144 $this->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : TEXTGAP_RATING_CASEINSENSITIVE);
145 $this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
146 $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
147 $this->setKeywordRelation(($data['keyword_relation']));
148
149 try {
150 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
151 } catch (ilTestQuestionPoolException $e) {
152 }
153 }
154
155 $result = $ilDB->queryF(
156 "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
157 array("integer"),
158 array($this->getId())
159 );
160
161 $this->flushAnswers();
162 while ($row = $ilDB->fetchAssoc($result)) {
163 $this->addAnswer($row['answertext'], $row['points']);
164 }
165
166 parent::loadFromDb($question_id);
167 }
setShuffle($shuffle=true)
Sets the shuffle flag.
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.
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.
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.
setMaxNumOfChars($maxchars=0)
Sets the maximum number of characters for the text solution.
addAnswer( $answertext="", $points=0.0, $points_unchecked=0.0, $order=0, $answerimage="")
Adds a possible answer for a multiple choice question.
setKeywordRelation($a_relation)
This method implements a default behaviour.
getAdditionalTableName()
Returns the name of the additional question data table in the database.
flushAnswers()
Deletes all answers.
setTextRating($a_text_rating)
Sets the rating option for text comparisons.
isValidTextRating($textRating)
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, $ilDB, $result, $row, ilRTE\_replaceMediaObjectImageSrc(), addAnswer(), flushAnswers(), getAdditionalTableName(), assQuestion\getId(), isValidTextRating(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setKeywordRelation(), setMaxNumOfChars(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), setTextRating(), assQuestion\setTitle(), and TEXTGAP_RATING_CASEINSENSITIVE.

+ Here is the call graph for this function:

◆ reworkWorkingData()

assTextQuestion::reworkWorkingData (   $active_id,
  $pass,
  $obligationsAnswered,
  $authorized 
)
protected

{Reworks the allready saved working data if neccessary.

Parameters
integer$active_id
integer$pass
boolean$obligationsAnswered
boolean$authorized
}

Reimplemented from assQuestion.

Definition at line 690 of file class.assTextQuestion.php.

691 {
692 // nothing to rework!
693 }

◆ saveToDb()

assTextQuestion::saveToDb (   $original_id = "")

Saves a assTextQuestion object to a database.

Parameters
string$original_id

Reimplemented from assQuestion.

Definition at line 105 of file class.assTextQuestion.php.

106 {
110 parent::saveToDb($original_id);
111 }
saveQuestionDataToDb($original_id="")
saveAnswerSpecificDataToDb()
Saves the answer specific records into a question types answer table.
saveAdditionalQuestionDataToDb()
Saves a record to the question types additional data table.

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

+ Here is the call graph for this function:

◆ saveWorkingData()

assTextQuestion::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 582 of file class.assTextQuestion.php.

583 {
584 global $ilDB;
585 global $ilUser;
586
587 include_once "./Services/Utilities/classes/class.ilStr.php";
588 if (is_null($pass)) {
589 include_once "./Modules/Test/classes/class.ilObjTest.php";
590 $pass = ilObjTest::_getPass($active_id);
591 }
592
593 $entered_values = 0;
594 $text = $this->getSolutionSubmit();
595
596 $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $active_id, $pass, $authorized, $text) {
597 $this->removeCurrentSolution($active_id, $pass, $authorized);
598
599 if (strlen($text)) {
600 $this->saveCurrentSolution($active_id, $pass, trim($text), null, $authorized);
601 $entered_values++;
602 }
603 });
604
605 if ($entered_values) {
606 include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
608 assQuestion::logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
609 }
610 } else {
611 include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
613 assQuestion::logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
614 }
615 }
616
617 return true;
618 }
saveCurrentSolution($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)
static logAction($logtext="", $active_id="", $question_id="")
Logs an action into the Test&Assessment log.
removeCurrentSolution($active_id, $pass, $authorized=true)
static _getLogLanguage()
retrieve the log language for assessment logging
static _enabledAssessmentLogging()
check wether assessment logging is enabled or not
static _getPass($active_id)
Retrieves the actual pass of a given user for a given test.
$ilUser
Definition: imgupload.php:18

References $ilDB, $ilUser, $pass, $text, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getProcessLocker(), getSolutionSubmit(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

+ Here is the call graph for this function:

◆ setAnswers()

assTextQuestion::setAnswers (   $answers)

Definition at line 923 of file class.assTextQuestion.php.

924 {
925 if (isset($answers['answer'])) {
926 $count = count($answers['answer']);
927 $withPoints = true;
928 } else {
929 $count = count($answers);
930 $withPoints = false;
931 }
932
933 $this->flushAnswers();
934
935 for ($i = 0; $i < $count; $i++) {
936 if ($withPoints) {
937 $this->addAnswer($answers['answer'][$i], $answers['points'][$i]);
938 } else {
939 $this->addAnswer($answers[$i], 0);
940 }
941 }
942 }

References $answers, $i, addAnswer(), and flushAnswers().

+ Here is the call graph for this function:

◆ setExportDetailsXLS()

assTextQuestion::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 770 of file class.assTextQuestion.php.

771 {
772 parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
773
774 $solutions = $this->getSolutionValues($active_id, $pass);
775
776 $i = 1;
777 $worksheet->setCell($startrow + $i, 0, $this->lng->txt("result"));
778 $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
779
780 require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
781 $assessment_folder = new ilObjAssessmentFolder();
782
783 $string_escaping_org_value = $worksheet->getStringEscaping();
784 if ($assessment_folder->getExportEssayQuestionsWithHtml() == 1) {
785 $worksheet->setStringEscaping(false);
786 }
787
788 if (strlen($solutions[0]["value1"])) {
789 $worksheet->setCell($startrow + $i, 1, $solutions[0]["value1"]);
790 }
791 $i++;
792
793 $worksheet->setStringEscaping($string_escaping_org_value);
794 return $startrow + $i + 1;
795 }
$worksheet
getSolutionValues($active_id, $pass=null, $authorized=true)
Loads solutions of a given user from the database an returns it.
Class ilObjAssessmentFolder.

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

+ Here is the call graph for this function:

◆ setKeywordRelation()

assTextQuestion::setKeywordRelation (   $a_relation)

This method implements a default behaviour.

During the creation of a text question, the record which holds the keyword relation is not existing, so keyword_relation defaults to 'one'.

Definition at line 975 of file class.assTextQuestion.php.

976 {
977 $this->keyword_relation = $a_relation;
978 }

Referenced by loadFromDb().

+ Here is the caller graph for this function:

◆ setMaxNumOfChars()

assTextQuestion::setMaxNumOfChars (   $maxchars = 0)

Sets the maximum number of characters for the text solution.

Parameters
integer$maxcharsThe maximum number of characters for the text solution @access public
See also
$maxNumOfChars

Definition at line 313 of file class.assTextQuestion.php.

314 {
315 $this->maxNumOfChars = $maxchars;
316 }

Referenced by loadFromDb().

+ Here is the caller graph for this function:

◆ setReachedPoints()

assTextQuestion::setReachedPoints (   $active_id,
  $points,
  $pass = null 
)

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

Parameters
integer$user_idThe database ID of the learner
integer$test_idThe database Id of the test containing the question
integer$pointsThe points the user has reached answering the question
Returns
boolean true on success, otherwise false @access public

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

367 {
368 global $ilDB;
369
370 if (($points > 0) && ($points <= $this->getPoints())) {
371 if (is_null($pass)) {
372 $pass = $this->getSolutionMaxPass($active_id);
373 }
374 $affectedRows = $ilDB->manipulateF(
375 "UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
376 array('float','integer','integer','integer'),
377 array($points, $active_id, $this->getId(), $pass)
378 );
379 self::_updateTestPassResults($active_id, $pass);
380 return true;
381 } else {
382 return true;
383 }
384 }
getPoints()
Returns the maximum available points for the question.

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

+ Here is the call graph for this function:

◆ setTextRating()

assTextQuestion::setTextRating (   $a_text_rating)

Sets the rating option for text comparisons.

Parameters
string$a_textgap_ratingThe rating option for text comparisons
See also
$textgap_rating @access User interface

Definition at line 729 of file class.assTextQuestion.php.

730 {
731 switch ($a_text_rating) {
739 $this->text_rating = $a_text_rating;
740 break;
741 default:
742 $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
743 break;
744 }
745 }

References TEXTGAP_RATING_CASEINSENSITIVE, TEXTGAP_RATING_CASESENSITIVE, TEXTGAP_RATING_LEVENSHTEIN1, TEXTGAP_RATING_LEVENSHTEIN2, TEXTGAP_RATING_LEVENSHTEIN3, TEXTGAP_RATING_LEVENSHTEIN4, and TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by loadFromDb().

+ Here is the caller graph for this function:

◆ toJSON()

assTextQuestion::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

801 {
802 include_once("./Services/RTE/classes/class.ilRTE.php");
803 $result = array();
804 $result['id'] = (int) $this->getId();
805 $result['type'] = (string) $this->getQuestionType();
806 $result['title'] = (string) $this->getTitle();
807 $result['question'] = $this->formatSAQuestion($this->getQuestion());
808 $result['nr_of_tries'] = (int) $this->getNrOfTries();
809 $result['shuffle'] = (bool) $this->getShuffle();
810 $result['maxlength'] = (int) $this->getMaxNumOfChars();
811 return json_encode($result);
812 }
formatSAQuestion($a_q)
Format self assessment question.
getShuffle()
Gets the shuffle flag.
getTitle()
Gets the title string of the assQuestion object.
getQuestion()
Gets the question string of the question object.
getQuestionType()
Returns the question type of the question.
getMaxNumOfChars()
Gets the maximum number of characters for the text solution.

References $result, assQuestion\formatSAQuestion(), assQuestion\getId(), getMaxNumOfChars(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitle().

+ Here is the call graph for this function:

Field Documentation

◆ $answers

assTextQuestion::$answers

◆ $keyword_relation

assTextQuestion::$keyword_relation = 'any'

Definition at line 55 of file class.assTextQuestion.php.

Referenced by getKeywordRelation().

◆ $keywords

assTextQuestion::$keywords

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

◆ $matchcondition

assTextQuestion::$matchcondition
private

Definition at line 53 of file class.assTextQuestion.php.

◆ $maxNumOfChars

assTextQuestion::$maxNumOfChars

Definition at line 31 of file class.assTextQuestion.php.

Referenced by getMaxNumOfChars().

◆ $text_rating

assTextQuestion::$text_rating

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

Referenced by getTextRating().


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