ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
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.

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

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

883 {
884 include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
885
886 // add answer
887 $answer = new ASS_AnswerMultipleResponseImage($answertext, $points);
888 $this->answers[] = $answer;
889 }
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 575 of file class.assTextQuestion.php.

576 {
577 if( $returndetails )
578 {
579 throw new ilTestException('return details not implemented for '.__METHOD__);
580 }
581
582 global $ilDB;
583
584 $points = 0;
585 if (is_null($pass))
586 {
587 $pass = $this->getSolutionMaxPass($active_id);
588 }
589
590 $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
591
592 // Return min points when no answer was given.
593 if ($ilDB->numRows($result) == 0)
594 {
595 return $this->getMinimumPoints();
596 }
597
598 // Return points of points are already on the row.
599 $row = $ilDB->fetchAssoc($result);
600 if ($row["points"] != NULL)
601 {
602 return $row["points"];
603 }
604
605 return $this->calculateReachedPointsForSolution($row['value1']);
606 }
$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 490 of file class.assTextQuestion.php.

491 {
492 // Return min points when keyword relation is NON KEYWORDS
493 if( $this->getKeywordRelation() == 'non' )
494 {
495 return $this->getMinimumPoints();
496 }
497
498 // Return min points if there are no answers present.
499 $answers = $this->getAnswers();
500
501 if (count($answers) == 0)
502 {
503 return $this->getMinimumPoints();
504 }
505
506 switch( $this->getKeywordRelation() )
507 {
508 case 'any':
509
510 $points = 0;
511
512 foreach ($answers as $answer)
513 {
514 $qst_answer = $answer->getAnswertext();
515 $user_answer = ' '.$solution;
516
517 if( $this->isKeywordMatching( $user_answer, $qst_answer ) )
518 {
519 $points += $answer->getPoints();
520 }
521 }
522
523 break;
524
525 case 'all':
526
527 $points = $this->getMaximumPoints();
528
529 foreach ($answers as $answer)
530 {
531 $qst_answer = $answer->getAnswertext();
532 $user_answer = ' '.$solution;
533
534 if( !$this->isKeywordMatching( $user_answer, $qst_answer ) )
535 {
536 $points = 0;
537 break;
538 }
539 }
540
541 break;
542
543 case 'one':
544
545 $points = 0;
546
547 foreach ($answers as $answer)
548 {
549 $qst_answer = $answer->getAnswertext();
550 $user_answer = ' '.$solution;
551
552 if( $this->isKeywordMatching( $user_answer, $qst_answer ) )
553 {
554 $points = $this->getMaximumPoints();
555 break;
556 }
557 }
558
559 break;
560 }
561
562 return $points;
563 }
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 239 of file class.assTextQuestion.php.

240 {
241 if ($this->id <= 0)
242 {
243 // The question has not been saved. It cannot be duplicated
244 return;
245 }
246 // duplicate the question in database
247 $clone = $this;
248 include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
250 $clone->id = -1;
251 $source_questionpool_id = $this->getObjId();
252 $clone->setObjId($target_questionpool_id);
253 if ($title)
254 {
255 $clone->setTitle($title);
256 }
257 $clone->saveToDb();
258 // copy question page content
259 $clone->copyPageOfQuestion($original_id);
260 // copy XHTML media objects
261 $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
262 // duplicate answers
263 #$clone->duplicateAnswers($original_id);
264
265 $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
266
267 return $clone->id;
268 }
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 1069 of file class.assTextQuestion.php.

1070 {
1071 $text = strip_tags($text);
1072
1073 $text = str_replace('&gt;', '>', $text);
1074 $text = str_replace('&lt;', '<', $text);
1075 $text = str_replace('&nbsp;', ' ', $text);
1076 $text = str_replace('&amp;', '&', $text);
1077
1078 $text = str_replace("\r\n", "\n", $text);
1079 $text = str_replace("\n", "", $text);
1080
1081 require_once 'Services/Utilities/classes/class.ilStr.php';
1082 return ilStr::strLen($text);
1083 }
static strLen($a_string)
Definition: class.ilStr.php:91
$text

References $text, and ilStr\strLen().

+ Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

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

271 {
272 if ($this->id <= 0)
273 {
274 // The question has not been saved. It cannot be duplicated
275 return;
276 }
277
278 include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
279
280 $sourceQuestionId = $this->id;
281 $sourceParentId = $this->getObjId();
282
283 // duplicate the question in database
284 $clone = $this;
285 $clone->id = -1;
286
287 $clone->setObjId($targetParentId);
288
289 if ($targetQuestionTitle)
290 {
291 $clone->setTitle($targetQuestionTitle);
292 }
293
294 $clone->saveToDb();
295 // copy question page content
296 $clone->copyPageOfQuestion($sourceQuestionId);
297 // copy XHTML media objects
298 $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
299 // duplicate answers
300 #$clone->duplicateAnswers($sourceQuestionId);
301
302 $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
303
304 return $clone->id;
305 }

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

737 {
738 }

◆ 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 922 of file class.assTextQuestion.php.

923 {
924 if ($index < 0) return;
925 if (count($this->answers) < 1) return;
926 if ($index >= count($this->answers)) return;
927 $answer = $this->answers[$index];
928 if (strlen($answer->getImage())) $this->deleteImage($answer->getImage());
929 unset($this->answers[$index]);
930 $this->answers = array_values($this->answers);
931 for ($i = 0; $i < count($this->answers); $i++)
932 {
933 if ($this->answers[$i]->getOrder() > $index)
934 {
935 $this->answers[$i]->setOrder($i);
936 }
937 }
938 }

◆ duplicate()

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

Duplicates an assTextQuestion.

@access public

Reimplemented from assQuestion.

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

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

985 {
986 global $ilDB;
987
988 $result = $ilDB->queryF("SELECT * FROM qpl_a_essay WHERE question_fi = %s",
989 array('integer'),
990 array($original_id)
991 );
992 if ($result->numRows())
993 {
994 while ($row = $ilDB->fetchAssoc($result))
995 {
996 $next_id = $ilDB->nextId('qpl_a_essay');
997 $affectedRows = $ilDB->manipulateF(
998 "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points)
999 VALUES (%s, %s, %s, %s)",
1000 array('integer','integer','text','float'),
1001 array($next_id, $this->getId(), $row["answertext"], $row["points"])
1002 );
1003 }
1004 }
1005 }

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

952 {
953 $this->answers = array();
954 }

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

796 {
797 return "qpl_qst_essay";
798 }

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

906 {
907 if ($index < 0) return NULL;
908 if (count($this->answers) < 1) return NULL;
909 if ($index >= count($this->answers)) return NULL;
910
911 return $this->answers[$index];
912 }

◆ getAnswerCount()

assTextQuestion::getAnswerCount ( )

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

859 {
860 return count($this->answers);
861 }

◆ getAnswers()

assTextQuestion::getAnswers ( )

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

892 {
893 return $this->answers;
894 }

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

941 {
942 return 'qpl_a_essay';
943 }

◆ getKeywordRelation()

assTextQuestion::getKeywordRelation ( )

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

1008 {
1010 }

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

345 {
346 if( in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion()) )
347 {
348 return parent::getPoints();
349 }
350
351 $points = 0;
352
353 foreach ($this->answers as $answer)
354 {
355 if ($answer->getPoints() > 0)
356 {
357 $points = $points + $answer->getPoints();
358 }
359 }
360
361 return $points;
362 }

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

315 {
316 if (strcmp($this->maxNumOfChars, "") == 0)
317 {
318 return 0;
319 }
320 else
321 {
323 }
324 }

References $maxNumOfChars.

Referenced by toJSON().

+ Here is the caller graph for this function:

◆ getMinimumPoints()

assTextQuestion::getMinimumPoints ( )

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

365 {
366 if( in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion()) )
367 {
368 return 0;
369 }
370
371 $points = 0;
372
373 foreach ($this->answers as $answer)
374 {
375 if ($answer->getPoints() < 0)
376 {
377 $points = $points + $answer->getPoints();
378 }
379 }
380
381 return $points;
382 }

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

747 {
748 return "assTextQuestion";
749 }

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

805 {
806 return parent::getRTETextWithMediaObjects();
807 }

◆ getScoringModesWithPointsByKeyword()

static assTextQuestion::getScoringModesWithPointsByKeyword ( )
static

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

1032 {
1033 return array('any');
1034 }

Referenced by assTextQuestionGUI\getBestAnswer().

+ Here is the caller graph for this function:

◆ getScoringModesWithPointsByQuestion()

static assTextQuestion::getScoringModesWithPointsByQuestion ( )
static

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

1027 {
1028 return array('non', 'all', 'one');
1029 }

◆ getSolutionSubmit()

assTextQuestion::getSolutionSubmit ( )
Returns
mixed|string

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

667 {
668 $text = ilUtil::stripSlashes($_POST["TEXT"], FALSE);
669
670 if( ilUtil::isHTML($text) )
671 {
672 $text = $this->getHtmlUserSolutionPurifier()->purify($text);
673 }
674
675 return $text;
676 }
$_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 758 of file class.assTextQuestion.php.

759 {
760 return $this->text_rating;
761 }

References $text_rating.

Referenced by isKeywordMatching().

+ Here is the caller graph for this function:

◆ getValidScoringModes()

static assTextQuestion::getValidScoringModes ( )
static

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

1022 {
1023 return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
1024 }

◆ 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 1047 of file class.assTextQuestion.php.

1048 {
1049 $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());
1050
1051 return $numExistingSolutionRecords > 0;
1052 }
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 89 of file class.assTextQuestion.php.

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

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

441 {
442 $result = FALSE;
443 $textrating = $this->getTextRating();
444 include_once "./Services/Utilities/classes/class.ilStr.php";
445 switch ($textrating)
446 {
448 if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) return TRUE;
449 break;
451 if (ilStr::strPos($answertext, $a_keyword) !== false) return TRUE;
452 break;
453 }
454
455 // "<p>red</p>" would not match "red" even with distance of 5
456 $answertext = strip_tags($answertext);
457
458 $answerwords = array();
459 if (preg_match_all("/([^\s.]+)/", $answertext, $matches))
460 {
461 foreach ($matches[1] as $answerword)
462 {
463 array_push($answerwords, trim($answerword));
464 }
465 }
466 foreach ($answerwords as $a_original)
467 {
468 switch ($textrating)
469 {
471 if (levenshtein($a_original, $a_keyword) <= 1) return TRUE;
472 break;
474 if (levenshtein($a_original, $a_keyword) <= 2) return TRUE;
475 break;
477 if (levenshtein($a_original, $a_keyword) <= 3) return TRUE;
478 break;
480 if (levenshtein($a_original, $a_keyword) <= 4) return TRUE;
481 break;
483 if (levenshtein($a_original, $a_keyword) <= 5) return TRUE;
484 break;
485 }
486 }
487 return $result;
488 }
getTextRating()
Returns the rating option for text comparisons.
static strPos($a_haystack, $a_needle, $a_offset=NULL)
Definition: class.ilStr.php:34
static strToLower($a_string)
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 1064 of file class.assTextQuestion.php.

1065 {
1066 return true;
1067 }

◆ isValidTextRating()

assTextQuestion::isValidTextRating (   $textRating)
private

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

416 {
417 switch($textRating)
418 {
426 return true;
427 }
428
429 return false;
430 }

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:

◆ 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 122 of file class.assTextQuestion.php.

123 {
124 global $ilDB;
125
126 $result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
127 array("integer"),
128 array($question_id)
129 );
130 if ($ilDB->numRows($result) == 1)
131 {
132 $data = $ilDB->fetchAssoc($result);
133 $this->setId($question_id);
134 $this->setObjId($data["obj_fi"]);
135 $this->setTitle($data["title"]);
136 $this->setComment($data["description"]);
137 $this->setOriginalId($data["original_id"]);
138 $this->setNrOfTries($data['nr_of_tries']);
139 $this->setAuthor($data["author"]);
140 $this->setPoints((float) $data["points"]);
141 $this->setOwner($data["owner"]);
142 include_once("./Services/RTE/classes/class.ilRTE.php");
143 $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
144 $this->setShuffle($data["shuffle"]);
145 $this->setMaxNumOfChars($data["maxnumofchars"]);
146 $this->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : TEXTGAP_RATING_CASEINSENSITIVE);
147 $this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
148 $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
149 $this->setKeywordRelation(($data['keyword_relation']));
150
151 try
152 {
153 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
154 }
156 {
157 }
158 }
159
160 $result = $ilDB->queryF("SELECT * FROM qpl_a_essay WHERE question_fi = %s",
161 array("integer"),
162 array($this->getId())
163 );
164
165 $this->flushAnswers();
166 while ($row = $ilDB->fetchAssoc($result))
167 {
168 $this->addAnswer($row['answertext'], $row['points']);
169 }
170
171 parent::loadFromDb($question_id);
172 }
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 731 of file class.assTextQuestion.php.

732 {
733 // nothing to rework!
734 }

◆ saveToDb()

assTextQuestion::saveToDb (   $original_id = "")

Saves a assTextQuestion object to a database.

Parameters
string$original_id

Reimplemented from assQuestion.

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

108 {
112 parent::saveToDb($original_id);
113 }
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 616 of file class.assTextQuestion.php.

617 {
618 global $ilDB;
619 global $ilUser;
620
621 include_once "./Services/Utilities/classes/class.ilStr.php";
622 if (is_null($pass))
623 {
624 include_once "./Modules/Test/classes/class.ilObjTest.php";
625 $pass = ilObjTest::_getPass($active_id);
626 }
627
628 $entered_values = 0;
629 $text = $this->getSolutionSubmit();
630
631 $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function() use (&$entered_values, $active_id, $pass, $authorized, $text) {
632
633 $this->removeCurrentSolution($active_id, $pass, $authorized);
634
635 if(strlen($text))
636 {
637 $this->saveCurrentSolution($active_id, $pass, trim($text), null, $authorized);
638 $entered_values++;
639 }
640
641 });
642
643 if ($entered_values)
644 {
645 include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
647 {
648 assQuestion::logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
649 }
650 }
651 else
652 {
653 include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
655 {
656 assQuestion::logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
657 }
658 }
659
660 return true;
661 }
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 956 of file class.assTextQuestion.php.

957 {
958 if( isset($answers['answer']) )
959 {
960 $count = count($answers['answer']);
961 $withPoints = true;
962 }
963 else
964 {
965 $count = count($answers);
966 $withPoints = false;
967 }
968
969 $this->flushAnswers();
970
971 for( $i = 0; $i < $count; $i++ )
972 {
973 if($withPoints)
974 {
975 $this->addAnswer($answers['answer'][$i], $answers['points'][$i]);
976 }
977 else
978 {
979 $this->addAnswer($answers[$i], 0);
980 }
981 }
982 }

References $answers, 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 812 of file class.assTextQuestion.php.

813 {
814 parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
815
816 $solutions = $this->getSolutionValues($active_id, $pass);
817
818 $i = 1;
819 $worksheet->setCell($startrow + $i, 0, $this->lng->txt("result"));
820 $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
821
822 require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
823 $assessment_folder = new ilObjAssessmentFolder();
824
825 $string_escaping_org_value = $worksheet->getStringEscaping();
826 if($assessment_folder->getExportEssayQuestionsWithHtml() == 1)
827 {
828 $worksheet->setStringEscaping(false);
829 }
830
831 if (strlen($solutions[0]["value1"]))
832 {
833 $worksheet->setCell($startrow + $i, 1, $solutions[0]["value1"]);
834 }
835 $i++;
836
837 $worksheet->setStringEscaping($string_escaping_org_value);
838 return $startrow + $i + 1;
839 }
$worksheet
getSolutionValues($active_id, $pass=NULL, $authorized=true)
Loads solutions of a given user from the database an returns it.
Class ilObjAssessmentFolder.

References $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 1016 of file class.assTextQuestion.php.

1017 {
1018 $this->keyword_relation = $a_relation;
1019 }

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

334 {
335 $this->maxNumOfChars = $maxchars;
336 }

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

393 {
394 global $ilDB;
395
396 if (($points > 0) && ($points <= $this->getPoints()))
397 {
398 if (is_null($pass))
399 {
400 $pass = $this->getSolutionMaxPass($active_id);
401 }
402 $affectedRows = $ilDB->manipulateF("UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
403 array('float','integer','integer','integer'),
404 array($points, $active_id, $this->getId(), $pass)
405 );
406 self::_updateTestPassResults($active_id, $pass);
407 return TRUE;
408 }
409 else
410 {
411 return TRUE;
412 }
413 }
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 770 of file class.assTextQuestion.php.

771 {
772 switch ($a_text_rating)
773 {
781 $this->text_rating = $a_text_rating;
782 break;
783 default:
784 $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
785 break;
786 }
787 }

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

845 {
846 include_once("./Services/RTE/classes/class.ilRTE.php");
847 $result = array();
848 $result['id'] = (int) $this->getId();
849 $result['type'] = (string) $this->getQuestionType();
850 $result['title'] = (string) $this->getTitle();
851 $result['question'] = $this->formatSAQuestion($this->getQuestion());
852 $result['nr_of_tries'] = (int) $this->getNrOfTries();
853 $result['shuffle'] = (bool) $this->getShuffle();
854 $result['maxlength'] = (int) $this->getMaxNumOfChars();
855 return json_encode($result);
856 }
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: