ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
assTextSubset Class Reference

Class for TextSubset questions. More...

+ Inheritance diagram for assTextSubset:
+ Collaboration diagram for assTextSubset:

Public Member Functions

 __construct ( $title="", $comment="", $author="", $owner=-1, $question="")
 assTextSubset constructor More...
 
 isComplete ()
 Returns true, if a TextSubset question is complete for use. More...
 
 saveToDb ($original_id="")
 Saves a assTextSubset object to a database. More...
 
 loadFromDb ($question_id)
 Loads a assTextSubset object from a database. More...
 
 addAnswer ($answertext, $points, $order)
 Adds an answer to the question. More...
 
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assTextSubsetQuestion. More...
 
 copyObject ($target_questionpool_id, $title="")
 Copies an assTextSubset object. More...
 
 createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")
 
 getAnswerCount ()
 Returns the number of answers. More...
 
 getAnswer ($index=0)
 Returns an answer with a given index. More...
 
 deleteAnswer ($index=0)
 Deletes an answer with a given index. More...
 
 flushAnswers ()
 Deletes all answers. More...
 
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question. More...
 
getAvailableAnswers ()
 Returns the available answers for the question. More...
 
 isAnswerCorrect ($answers, $answer)
 Returns the index of the found answer, if the given answer is in the set of correct answers and matchess the matching options, otherwise FALSE is returned. More...
 
 getTextRating ()
 Returns the rating option for text comparisons. More...
 
 setTextRating ($a_text_rating)
 Sets the rating option for text comparisons. More...
 
 calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question. More...
 
 setCorrectAnswers ($a_correct_answers)
 Sets the number of correct answers needed to solve the question. More...
 
 getCorrectAnswers ()
 Returns the number of correct answers needed to solve the question. More...
 
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database. More...
 
 getQuestionType ()
 Returns the question type of the question. More...
 
joinAnswers ()
 Returns the answers of the question as a comma separated string. More...
 
 getMaxTextboxWidth ()
 Returns the maximum width needed for the answer textboxes. 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...
 
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
 
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question. More...
 
 getAnswers ()
 
 toJSON ()
 Returns a JSON representation of the question. More...
 
 getOperators ($expression)
 Get all available operations for a specific question. More...
 
 getExpressionTypes ()
 Get all available expression types for a specific question. More...
 
 getAvailableAnswerOptions ($index=null)
 If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...
 
- Public Member Functions inherited from assQuestion
 __construct ( $title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor More...
 
 setProcessLocker ($processLocker)
 
 getProcessLocker ()
 
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
 
 toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
 Returns a QTI xml representation of the question. More...
 
 isComplete ()
 Returns true, if a question is complete for use. More...
 
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database. More...
 
 setTitle ($title="")
 Sets the title string of the assQuestion object. More...
 
 setId ($id=-1)
 Sets the id of the assQuestion object. More...
 
 setTestId ($id=-1)
 Sets the test id of the assQuestion object. More...
 
 setComment ($comment="")
 Sets the comment string of the assQuestion object. More...
 
 setOutputType ($outputType=OUTPUT_HTML)
 Sets the output type. More...
 
 setShuffle ($shuffle=true)
 Sets the shuffle flag. More...
 
 setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
 Sets the estimated working time of a question from given hour, minute and second. More...
 
 setEstimatedWorkingTimeFromDurationString ($durationString)
 Sets the estimated working time of a question from a given datetime string. More...
 
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array More...
 
 setAuthor ($author="")
 Sets the authors name of the assQuestion object. More...
 
 setOwner ($owner="")
 Sets the creator/owner ID of the assQuestion object. More...
 
 getTitle ()
 Gets the title string of the assQuestion object. More...
 
 getId ()
 Gets the id of the assQuestion object. More...
 
 getShuffle ()
 Gets the shuffle flag. More...
 
 getTestId ()
 Gets the test id of the assQuestion object. More...
 
 getComment ()
 Gets the comment string of the assQuestion object. More...
 
 getOutputType ()
 Gets the output type. More...
 
 supportsJavascriptOutput ()
 Returns true if the question type supports JavaScript output. More...
 
 supportsNonJsOutput ()
 
 requiresJsSwitch ()
 
 getEstimatedWorkingTime ()
 Gets the estimated working time of a question. More...
 
 getAuthor ()
 Gets the authors name of the assQuestion object. More...
 
 getOwner ()
 Gets the creator/owner ID of the assQuestion object. More...
 
 getObjId ()
 Get the object id of the container object. More...
 
 setObjId ($obj_id=0)
 Set the object id of the container object. More...
 
 setExternalId ($external_id)
 
 getExternalId ()
 
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question. More...
 
_getQuestionInfo ($question_id)
 Returns question information from the database. More...
 
 getSuggestedSolutionOutput ()
 
_getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index. More...
 
 getSuggestedSolutions ()
 Return the suggested solutions. More...
 
 _getReachedPoints ($active_id, $question_id, $pass=NULL)
 Returns the points, a learner has reached answering the question. More...
 
 getReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...
 
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question. More...
 
 getAdjustedReachedPoints ($active_id, $pass=NULL)
 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)
 persists the working state for current testactive and testpass More...
 
 persistPreviewState (ilAssQuestionPreviewSession $previewSession)
 persists the preview state for current user and question More...
 
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database. More...
 
 _updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
 Move this to a proper place. More...
 
 logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log. More...
 
 _logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log. More...
 
 moveUploadedMediaFile ($file, $name)
 Move an uploaded media file to an public accessible temp dir to present it. More...
 
 getSuggestedSolutionPath ()
 Returns the path for a suggested solution. More...
 
 getJavaPath ()
 Returns the image path for web accessable images of a question. More...
 
 getImagePath ($question_id=null, $object_id=null)
 Returns the image path for web accessable images of a question. More...
 
 buildImagePath ($questionId, $parentObjectId)
 
 getFlashPath ()
 Returns the image path for web accessable flash files of a question. More...
 
 getJavaPathWeb ()
 Returns the web image path for web accessable java applets of a question. More...
 
 getSuggestedSolutionPathWeb ()
 Returns the web path for a suggested solution. More...
 
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question. More...
 
 getFlashPathWeb ()
 Returns the web image path for web accessable flash applications of a question. More...
 
getSolutionValues ($active_id, $pass=NULL)
 Loads solutions of a given user from the database an returns it. More...
 
 isInUse ($question_id="")
 Checks whether the question is in use or not. More...
 
 isClone ($question_id="")
 Checks whether the question is a clone of another question or not. More...
 
 pcArrayShuffle ($array)
 Shuffles the values of a given array. More...
 
 getQuestionTypeFromDb ($question_id)
 get question type for question id More...
 
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database. More...
 
 getAnswerTableName ()
 Returns the name of the answer table in the database. More...
 
 deleteAnswers ($question_id)
 Deletes datasets from answers tables. More...
 
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database. More...
 
 delete ($question_id)
 Deletes a question and all materials from the database. More...
 
 getTotalAnswers ()
 get total number of answers More...
 
 _getTotalAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method More...
 
 _getTitle ($a_q_id)
 Returns the title of a question. More...
 
 _getQuestionText ($a_q_id)
 Returns question text. More...
 
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 
 syncXHTMLMediaObjectsOfQuestion ()
 
 createPageObject ()
 create page object of question More...
 
 copyPageOfQuestion ($a_q_id)
 
 getPageOfQuestion ()
 
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id. More...
 
 _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id. More...
 
 setOriginalId ($original_id)
 
 getOriginalId ()
 
 fixSvgToPng ($imageFilenameContainingString)
 
 fixUnavailableSkinImageSources ($html)
 
 loadFromDb ($question_id)
 Loads the question from the database. More...
 
 createNewQuestion ($a_create_page=true)
 Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
 
 saveQuestionDataToDb ($original_id="")
 
 saveToDb ($original_id="")
 Saves the question to the database. More...
 
 setNewOriginalId ($newId)
 
 deleteSuggestedSolutions ()
 Deletes all suggestes solutions in the database. More...
 
 getSuggestedSolution ($subquestion_index=0)
 Returns a suggested solution for a given subquestion index. More...
 
 getSuggestedSolutionTitle ($subquestion_index=0)
 Returns the title of a suggested solution at a given subquestion_index. More...
 
 setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
 Sets a suggested solution for the question. More...
 
 _resolveInternalLink ($internal_link)
 
 _resolveIntLinks ($question_id)
 
 _getInternalLinkHref ($target="")
 
 syncWithOriginal ()
 
 createRandomSolution ($test_id, $user_id)
 
 _questionExists ($question_id)
 Returns true if the question already exists in the database. More...
 
 _questionExistsInPool ($question_id)
 Returns true if the question already exists in the database and is assigned to a question pool. More...
 
 getPoints ()
 Returns the maximum available points for the question. More...
 
 setPoints ($a_points)
 Sets the maximum available points for the question. More...
 
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution. More...
 
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution. More...
 
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user. More...
 
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not. More...
 
 calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question. More...
 
 calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
 
 isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)
 
 adjustReachedPointsByScoringOptions ($points, $active_id, $pass=NULL)
 Adjust the given reached points by checks for all special scoring options in the test container. More...
 
 isHTML ($a_text)
 Checks if a given string contains HTML or not. More...
 
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests. More...
 
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string. More...
 
 addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
 Creates a QTI material tag from a plain text or xhtml text. More...
 
 createNewImageFileName ($image_filename, $unique=false)
 
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
 Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
 
 getQuestion ()
 Gets the question string of the question object. More...
 
 setQuestion ($question="")
 Sets the question string of the question object. More...
 
 getQuestionType ()
 Returns the question type of the question. More...
 
 getQuestionTypeID ()
 Returns the question type of the question. More...
 
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table More...
 
getInstances ()
 Gets all instances of the question. More...
 
 _needsManualScoring ($question_id)
 
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id. More...
 
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question. More...
 
 __get ($value)
 Object getter. More...
 
 __set ($key, $value)
 Object setter. More...
 
 getNrOfTries ()
 
 setNrOfTries ($a_nr_of_tries)
 
 setExportImagePath ($a_path)
 
 _questionExistsInTest ($question_id, $test_id)
 
 formatSAQuestion ($a_q)
 Format self assessment question. More...
 
 setPreventRteUsage ($a_val)
 Set prevent rte usage. More...
 
 getPreventRteUsage ()
 Get prevent rte usage. More...
 
 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...
 
 isAnswered ($active_id, $pass=null)
 returns boolean wether the question is answered during test pass or not More...
 
 setObligationsToBeConsidered ($obligationsToBeConsidered=true)
 sets the flag wether obligations are to be considered or not More...
 
 areObligationsToBeConsidered ()
 gets the flag wether obligations are to be considered 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 ()
 
 setStep ($step)
 
 getStep ()
 
 toJSON ()
 
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 
- 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...
 
- Public Member Functions inherited from iQuestionCondition
 getUserQuestionResult ($active_id, $pass)
 Get the user solution for a question by active_id and the test pass. More...
 

Data Fields

 $answers
 
 $correctanswers
 
 $text_rating
 
- 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'
 
- Data Fields inherited from iQuestionCondition
const StringResultExpression = '~TEXT~'
 
const PercentageResultExpression = '%n%'
 
const NumericResultExpression = '#n#'
 
const MatchingResultExpression = ';n:m;'
 
const OrderingResultExpression = '$n,m,o,p$'
 
const NumberOfResultExpression = '+n+'
 
const ExclusiveResultExpression = '*n,m,o,p*'
 
const EmptyAnswerExpression = "?"
 

Protected Member Functions

 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary. More...
 
 getSolutionSubmit ()
 
 calculateReachedPointsForSolution ($enteredTexts)
 
- Protected Member Functions inherited from assQuestion
 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 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)
 
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
 
 duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)
 
 buildQuestionDataQuery ()
 
 getSelfAssessmentFormatter ()
 

Additional Inherited Members

- Static Public Member Functions inherited from assQuestion
static isAllowedImageMimeType ($mimeType)
 
static fetchMimeTypeIdentifier ($contentTypeString)
 
static getAllowedFileExtensionsForMimeType ($mimeType)
 
static isAllowedImageFileExtension ($mimeType, $fileExtension)
 
static getAllowedImageFileExtensions ()
 
static _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question. More...
 
static _getSuggestedSolutionOutput ($question_id)
 Returns the output of the suggested solution. More...
 
static _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method More...
 
static isFileAvailable ($file)
 
static _getOriginalId ($question_id)
 Returns the original id of a question. More...
 
static originalQuestionExists ($questionId)
 
static _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id. More...
 
static _instantiateQuestion ($question_id)
 
static _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...
 
static _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not. More...
 
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type. More...
 
static getGuiClassNameByQuestionType ($questionType)
 
static getObjectClassNameByQuestionType ($questionType)
 
static getFeedbackClassNameByQuestionType ($questionType)
 
static isCoreQuestionType ($questionType)
 
static includeCoreClass ($questionType, $withGuiClass)
 
static includePluginClass ($questionType, $withGuiClass)
 
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag. More...
 
static & _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id. More...
 
static instantiateQuestionGUI ($a_question_id)
 Creates an instance of a question gui with a given question id. More...
 
static lookupParentObjId ($questionId)
 ilDB $ilDB More...
 
static lookupOriginalParentObjId ($originalQuestionId)
 returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...
 
static isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
 
static setResultGateway ($resultGateway)
 
static getResultGateway ()
 
static sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)
 
static convertISO8601FormatH_i_s_ExtendedToSeconds ($time)
 
- Static 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...
 
- Protected Attributes inherited from assQuestion
 $id
 
 $title
 
 $comment
 
 $owner
 
 $author
 
 $question
 
 $points
 
 $est_working_time
 
 $shuffle
 
 $test_id
 
 $obj_id
 
 $ilias
 
 $tpl
 
 $lng
 
 $db
 
 $outputType
 
 $suggested_solutions
 
 $original_id
 
 $page
 
 $external_id = ''
 
 $questionChangeListeners = array()
 
 $processLocker
 
 $step = null
 
 $lastChange
 
- Static Protected Attributes inherited from assQuestion
static $allowedFileExtensionsByMimeType
 
static $allowedCharsetsByMimeType
 
static $imageSourceFixReplaceMap
 

Detailed Description

Class for TextSubset questions.

assTextSubset is a class for TextSubset questions. To solve a TextSubset question, a learner has to enter a TextSubsetal value in a defined range

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
Nina Gharib nina@.nosp@m.wgse.nosp@m.rve.d.nosp@m.e
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 26 of file class.assTextSubset.php.

Constructor & Destructor Documentation

◆ __construct()

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

assTextSubset constructor

The constructor takes possible arguments an creates an instance of the assTextSubset 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 TextSubsetal ID to identify the owner/creator
string$questionThe question string of the TextSubset question

Definition at line 66 of file class.assTextSubset.php.

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

73  {
74  parent::__construct($title, $comment, $author, $owner, $question);
75  $this->answers = array();
76  $this->correctanswers = 0;
77  }

Member Function Documentation

◆ addAnswer()

assTextSubset::addAnswer (   $answertext,
  $points,
  $order 
)

Adds an answer to the question.

public

Definition at line 181 of file class.assTextSubset.php.

References $changed, and assQuestion\$points.

182  {
183  include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
184  if (array_key_exists($order, $this->answers))
185  {
186  // insert answer
187  $answer = new ASS_AnswerBinaryStateImage($answertext, $points, $order);
188  $newchoices = array();
189  for ($i = 0; $i < $order; $i++)
190  {
191  array_push($newchoices, $this->answers[$i]);
192  }
193  array_push($newchoices, $answer);
194  for ($i = $order; $i < count($this->answers); $i++)
195  {
196  $changed = $this->answers[$i];
197  $changed->setOrder($i+1);
198  array_push($newchoices, $changed);
199  }
200  $this->answers = $newchoices;
201  }
202  else
203  {
204  // add answer
205  array_push($this->answers, new ASS_AnswerBinaryStateImage($answertext, $points, count($this->answers)));
206  }
207  }
Class for answers with a binary state indicator.

◆ calculateReachedPoints()

assTextSubset::calculateReachedPoints (   $active_id,
  $pass = NULL,
  $returndetails = FALSE 
)

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

The points are calculated from the given answers.

public

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

Definition at line 536 of file class.assTextSubset.php.

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

Referenced by getExpressionTypes().

537  {
538  if( $returndetails )
539  {
540  throw new ilTestException('return details not implemented for '.__METHOD__);
541  }
542 
543  global $ilDB;
544 
545 
546  if (is_null($pass))
547  {
548  $pass = $this->getSolutionMaxPass($active_id);
549  }
550  $result = $this->getCurrentSolutionResultSet($active_id, $pass);
551 
552  $enteredTexts = array();
553  while ($data = $ilDB->fetchAssoc($result))
554  {
555  $enteredTexts[] = $data["value1"];
556  }
557 
558  $points = $this->calculateReachedPointsForSolution($enteredTexts);
559 
560  return $points;
561  }
calculateReachedPointsForSolution($enteredTexts)
$result
getSolutionMaxPass($active_id)
Returns the maximum pass a users question solution.
Base Exception for all Exceptions relating to Modules/Test.
global $ilDB
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ calculateReachedPointsForSolution()

assTextSubset::calculateReachedPointsForSolution (   $enteredTexts)
protected
Parameters
$enteredTexts
Returns
int

Definition at line 885 of file class.assTextSubset.php.

References assQuestion\$points, getAvailableAnswers(), and isAnswerCorrect().

Referenced by calculateReachedPoints().

886  {
887  $available_answers = $this->getAvailableAnswers();
888  $points = 0;
889  foreach($enteredTexts as $enteredtext)
890  {
891  $index = $this->isAnswerCorrect($available_answers, $enteredtext);
892  if($index !== FALSE)
893  {
894  unset($available_answers[$index]);
895  $points += $this->answers[$index]->getPoints();
896  }
897  }
898  return $points;
899  }
& getAvailableAnswers()
Returns the available answers for the question.
isAnswerCorrect($answers, $answer)
Returns the index of the found answer, if the given answer is in the set of correct answers and match...
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ copyObject()

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

Copies an assTextSubset object.

public

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

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

274  {
275  if ($this->id <= 0)
276  {
277  // The question has not been saved. It cannot be duplicated
278  return;
279  }
280  // duplicate the question in database
281  $clone = $this;
282  include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
284  $clone->id = -1;
285  $source_questionpool_id = $this->getObjId();
286  $clone->setObjId($target_questionpool_id);
287  if ($title)
288  {
289  $clone->setTitle($title);
290  }
291  $clone->saveToDb();
292  // copy question page content
293  $clone->copyPageOfQuestion($original_id);
294  // copy XHTML media objects
295  $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
296 
297  $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
298 
299  return $clone->id;
300  }
static _getOriginalId($question_id)
Returns the original id of a question.
getObjId()
Get the object id of the container object.
+ Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 302 of file class.assTextSubset.php.

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

303  {
304  if ($this->id <= 0)
305  {
306  // The question has not been saved. It cannot be duplicated
307  return;
308  }
309 
310  include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
311 
312  $sourceQuestionId = $this->id;
313  $sourceParentId = $this->getObjId();
314 
315  // duplicate the question in database
316  $clone = $this;
317  $clone->id = -1;
318 
319  $clone->setObjId($targetParentId);
320 
321  if ($targetQuestionTitle)
322  {
323  $clone->setTitle($targetQuestionTitle);
324  }
325 
326  $clone->saveToDb();
327  // copy question page content
328  $clone->copyPageOfQuestion($sourceQuestionId);
329  // copy XHTML media objects
330  $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
331 
332  $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
333 
334  return $clone->id;
335  }
getObjId()
Get the object id of the container object.
+ Here is the call graph for this function:

◆ deleteAnswer()

assTextSubset::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 public
See also
$answers

Definition at line 375 of file class.assTextSubset.php.

376  {
377  if ($index < 0) return;
378  if (count($this->answers) < 1) return;
379  if ($index >= count($this->answers)) return;
380  unset($this->answers[$index]);
381  $this->answers = array_values($this->answers);
382  for ($i = 0; $i < count($this->answers); $i++)
383  {
384  if ($this->answers[$i]->getOrder() > $index)
385  {
386  $this->answers[$i]->setOrder($i);
387  }
388  }
389  }

◆ duplicate()

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

Duplicates an assTextSubsetQuestion.

public

Definition at line 214 of file class.assTextSubset.php.

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

215  {
216  if ($this->id <= 0)
217  {
218  // The question has not been saved. It cannot be duplicated
219  return;
220  }
221  // duplicate the question in database
222  $this_id = $this->getId();
223  $thisObjId = $this->getObjId();
224 
225  $clone = $this;
226  include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
228  $clone->id = -1;
229 
230  if( (int)$testObjId > 0 )
231  {
232  $clone->setObjId($testObjId);
233  }
234 
235  if ($title)
236  {
237  $clone->setTitle($title);
238  }
239 
240  if ($author)
241  {
242  $clone->setAuthor($author);
243  }
244  if ($owner)
245  {
246  $clone->setOwner($owner);
247  }
248 
249  if ($for_test)
250  {
251  $clone->saveToDb($original_id);
252  }
253  else
254  {
255  $clone->saveToDb();
256  }
257 
258  // copy question page content
259  $clone->copyPageOfQuestion($this_id);
260  // copy XHTML media objects
261  $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
262 
263  $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
264 
265  return $clone->id;
266  }
getId()
Gets the id of the assQuestion object.
static _getOriginalId($question_id)
Returns the original id of a question.
getObjId()
Get the object id of the container object.
+ Here is the call graph for this function:

◆ flushAnswers()

assTextSubset::flushAnswers ( )

Deletes all answers.

public

See also
$answers

Definition at line 397 of file class.assTextSubset.php.

398  {
399  $this->answers = array();
400  }

◆ getAdditionalTableName()

assTextSubset::getAdditionalTableName ( )

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

Returns
string The additional table name public

Definition at line 758 of file class.assTextSubset.php.

Referenced by loadFromDb(), and saveWorkingData().

759  {
760  return "qpl_qst_textsubset";
761  }
+ Here is the caller graph for this function:

◆ getAnswer()

assTextSubset::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_assAnswerBinaryStateImage-Object containing the answer public
See also
$answers

Definition at line 358 of file class.assTextSubset.php.

Referenced by getAvailableAnswerOptions().

359  {
360  if ($index < 0) return NULL;
361  if (count($this->answers) < 1) return NULL;
362  if ($index >= count($this->answers)) return NULL;
363 
364  return $this->answers[$index];
365  }
+ Here is the caller graph for this function:

◆ getAnswerCount()

assTextSubset::getAnswerCount ( )

Returns the number of answers.

Returns
integer The number of answers of the TextSubset question public
See also
$ranges

Definition at line 344 of file class.assTextSubset.php.

345  {
346  return count($this->answers);
347  }

◆ getAnswers()

assTextSubset::getAnswers ( )

Definition at line 810 of file class.assTextSubset.php.

References $answers.

Referenced by getAvailableAnswerOptions(), and toJSON().

811  {
812  return $this->answers;
813  }
+ Here is the caller graph for this function:

◆ getAnswerTableName()

assTextSubset::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name public

Definition at line 769 of file class.assTextSubset.php.

770  {
771  return "qpl_a_textsubset";
772  }

◆ getAvailableAnswerOptions()

assTextSubset::getAvailableAnswerOptions (   $index = null)

If index is null, the function returns an array with all anwser options Else it returns the specific answer option.

Parameters
null | int$index
Returns
array|ASS_AnswerSimple

Implements iQuestionCondition.

Definition at line 973 of file class.assTextSubset.php.

References getAnswer(), and getAnswers().

974  {
975  if($index !== null)
976  {
977  return $this->getAnswer($index);
978  }
979  else
980  {
981  return $this->getAnswers();
982  }
983  }
getAnswer($index=0)
Returns an answer with a given index.
+ Here is the call graph for this function:

◆ getAvailableAnswers()

& assTextSubset::getAvailableAnswers ( )

Returns the available answers for the question.

private

See also
$answers

Definition at line 433 of file class.assTextSubset.php.

Referenced by calculateReachedPointsForSolution().

434  {
435  $available_answers = array();
436  foreach ($this->answers as $answer)
437  {
438  array_push($available_answers, $answer->getAnswertext());
439  }
440  return $available_answers;
441  }
+ Here is the caller graph for this function:

◆ getCorrectAnswers()

assTextSubset::getCorrectAnswers ( )

Returns the number of correct answers needed to solve the question.

Returns
integer The number of correct answers public

Definition at line 580 of file class.assTextSubset.php.

References $correctanswers.

Referenced by getMaximumPoints(), saveWorkingData(), and toJSON().

581  {
582  return $this->correctanswers;
583  }
+ Here is the caller graph for this function:

◆ getExpressionTypes()

◆ getMaximumPoints()

assTextSubset::getMaximumPoints ( )

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

public

See also
$points

Definition at line 408 of file class.assTextSubset.php.

References assQuestion\$points, and getCorrectAnswers().

Referenced by getExpressionTypes(), and isComplete().

409  {
410  $points = array();
411  foreach ($this->answers as $answer)
412  {
413  if ($answer->getPoints() > 0)
414  {
415  array_push($points, $answer->getPoints());
416  }
417  }
418  rsort($points, SORT_NUMERIC);
419  $maxpoints = 0;
420  for ($counter = 0; $counter < $this->getCorrectAnswers(); $counter++)
421  {
422  $maxpoints += $points[$counter];
423  }
424  return $maxpoints;
425  }
getCorrectAnswers()
Returns the number of correct answers needed to solve the question.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMaxTextboxWidth()

assTextSubset::getMaxTextboxWidth ( )

Returns the maximum width needed for the answer textboxes.

Returns
integer Maximum textbox width public

Definition at line 741 of file class.assTextSubset.php.

742  {
743  $maxwidth = 0;
744  foreach ($this->answers as $answer)
745  {
746  $len = strlen($answer->getAnswertext());
747  if ($len > $maxwidth) $maxwidth = $len;
748  }
749  return $maxwidth + 3;
750  }

◆ getOperators()

assTextSubset::getOperators (   $expression)

Get all available operations for a specific question.

Parameters
$expression

Implements iQuestionCondition.

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

910  {
911  require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
913  }
+ Here is the call graph for this function:

◆ getQuestionType()

assTextSubset::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Definition at line 710 of file class.assTextSubset.php.

Referenced by toJSON().

711  {
712  return "assTextSubset";
713  }
+ Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assTextSubset::getRTETextWithMediaObjects ( )

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

Definition at line 778 of file class.assTextSubset.php.

779  {
780  return parent::getRTETextWithMediaObjects();
781  }

◆ getSolutionSubmit()

assTextSubset::getSolutionSubmit ( )
protected
Returns
array

Definition at line 862 of file class.assTextSubset.php.

References $_POST, and assQuestion\getHtmlUserSolutionPurifier().

Referenced by saveWorkingData().

863  {
864  $solutionSubmit = array();
865  $purifier = $this->getHtmlUserSolutionPurifier();
866  foreach($_POST as $key => $val)
867  {
868  if(preg_match("/^TEXTSUBSET_(\d+)/", $key, $matches))
869  {
870  $val = trim($val);
871  if(strlen($val))
872  {
873  $val = $purifier->purify($val);
874  $solutionSubmit[] = $val;
875  }
876  }
877  }
878  return $solutionSubmit;
879  }
$_POST['username']
Definition: cron.php:12
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTextRating()

assTextSubset::getTextRating ( )

Returns the rating option for text comparisons.

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

Definition at line 495 of file class.assTextSubset.php.

References $text_rating.

Referenced by isAnswerCorrect(), saveWorkingData(), and toJSON().

496  {
497  return $this->text_rating;
498  }
+ Here is the caller graph for this function:

◆ isAnswerCorrect()

assTextSubset::isAnswerCorrect (   $answers,
  $answer 
)

Returns the index of the found answer, if the given answer is in the set of correct answers and matchess the matching options, otherwise FALSE is returned.

Parameters
array$answersAn array containing the correct answers
string$answerThe text of the given answer
Returns
mixed The index of the correct answer, FALSE otherwise public

Definition at line 453 of file class.assTextSubset.php.

References $result, assQuestion\getPoints(), getTextRating(), 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().

454  {
455  include_once "./Services/Utilities/classes/class.ilStr.php";
456  $result = 0;
457  $textrating = $this->getTextRating();
458  foreach ($answers as $key => $value)
459  {
460  switch ($textrating)
461  {
463  if (strcmp(ilStr::strToLower($value), ilStr::strToLower($answer)) == 0 && $this->answers[$key]->getPoints() > 0) return $key;
464  break;
466  if (strcmp($value, $answer) == 0 && $this->answers[$key]->getPoints() > 0) return $key;
467  break;
469  if (levenshtein($value, $answer) <= 1 && $this->answers[$key]->getPoints() > 0) return $key;
470  break;
472  if (levenshtein($value, $answer) <= 2 && $this->answers[$key]->getPoints() > 0) return $key;
473  break;
475  if (levenshtein($value, $answer) <= 3 && $this->answers[$key]->getPoints() > 0) return $key;
476  break;
478  if (levenshtein($value, $answer) <= 4 && $this->answers[$key]->getPoints() > 0) return $key;
479  break;
481  if (levenshtein($value, $answer) <= 5 && $this->answers[$key]->getPoints() > 0) return $key;
482  break;
483  }
484  }
485  return FALSE;
486  }
const TEXTGAP_RATING_LEVENSHTEIN5
$result
getPoints()
Returns the maximum available points for the question.
const TEXTGAP_RATING_LEVENSHTEIN2
const TEXTGAP_RATING_LEVENSHTEIN1
getTextRating()
Returns the rating option for text comparisons.
static strToLower($a_string)
Definition: class.ilStr.php:89
const TEXTGAP_RATING_LEVENSHTEIN3
const TEXTGAP_RATING_CASESENSITIVE
const TEXTGAP_RATING_LEVENSHTEIN4
const TEXTGAP_RATING_CASEINSENSITIVE
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isComplete()

assTextSubset::isComplete ( )

Returns true, if a TextSubset question is complete for use.

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

Definition at line 85 of file class.assTextSubset.php.

References getMaximumPoints().

86  {
87  if (
88  strlen($this->title)
89  && $this->author
90  && $this->question &&
91  count($this->answers) >= $this->correctanswers
92  && $this->getMaximumPoints() > 0
93  )
94  {
95  return true;
96  }
97  return false;
98  }
getMaximumPoints()
Returns the maximum points, a learner can reach answering the question.
+ Here is the call graph for this function:

◆ joinAnswers()

& assTextSubset::joinAnswers ( )

Returns the answers of the question as a comma separated string.

Returns
string The answer string public

Definition at line 721 of file class.assTextSubset.php.

722  {
723  $join = array();
724  foreach ($this->answers as $answer)
725  {
726  if (!is_array($join[$answer->getPoints() . ""]))
727  {
728  $join[$answer->getPoints() . ""] = array();
729  }
730  array_push($join[$answer->getPoints() . ""], $answer->getAnswertext());
731  }
732  return $join;
733  }

◆ loadFromDb()

assTextSubset::loadFromDb (   $question_id)

Loads a assTextSubset object from a database.

Parameters
object$dbA pear DB object
integer$question_idA unique key which defines the multiple choice test in the database public

Definition at line 124 of file class.assTextSubset.php.

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

125  {
126  global $ilDB;
127 
128  $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",
129  array("integer"),
130  array($question_id)
131  );
132  if ($result->numRows() == 1)
133  {
134  $data = $ilDB->fetchAssoc($result);
135  $this->setId($question_id);
136  $this->setObjId($data["obj_fi"]);
137  $this->setNrOfTries($data['nr_of_tries']);
138  $this->setTitle($data["title"]);
139  $this->setComment($data["description"]);
140  $this->setOriginalId($data["original_id"]);
141  $this->setAuthor($data["author"]);
142  $this->setPoints($data["points"]);
143  $this->setOwner($data["owner"]);
144  include_once("./Services/RTE/classes/class.ilRTE.php");
145  $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
146  $this->setCorrectAnswers($data["correctanswers"]);
147  $this->setTextRating($data["textgap_rating"]);
148  $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
149 
150  try
151  {
152  $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
153  }
155  {
156  }
157  }
158 
159 
160  $result = $ilDB->queryF("SELECT * FROM qpl_a_textsubset WHERE question_fi = %s ORDER BY aorder ASC",
161  array('integer'),
162  array($question_id)
163  );
164  include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
165  if ($result->numRows() > 0)
166  {
167  while ($data = $ilDB->fetchAssoc($result))
168  {
169  array_push($this->answers, new ASS_AnswerBinaryStateImage($data["answertext"], $data["points"], $data["aorder"]));
170  }
171  }
172 
173  parent::loadFromDb($question_id);
174  }
$result
Class for answers with a binary state indicator.
setTextRating($a_text_rating)
Sets the rating option for text comparisons.
setId($id=-1)
Sets the 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. ...
setNrOfTries($a_nr_of_tries)
setAdditionalContentEditingMode($additinalContentEditingMode)
setter for additional content editing mode for this question
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...
setAuthor($author="")
Sets the authors name of the assQuestion object.
setCorrectAnswers($a_correct_answers)
Sets the number of correct answers needed to solve the question.
getAdditionalTableName()
Returns the name of the additional question data table in the database.
setPoints($a_points)
Sets the maximum available points for the question.
setQuestion($question="")
Sets the question string of the question object.
global $ilDB
setOriginalId($original_id)
setTitle($title="")
Sets the title string of the assQuestion object.
setObjId($obj_id=0)
Set the object id of the container object.
setComment($comment="")
Sets the comment string of the assQuestion object.
setOwner($owner="")
Sets the creator/owner ID of the assQuestion object.
+ Here is the call graph for this function:

◆ reworkWorkingData()

assTextSubset::reworkWorkingData (   $active_id,
  $pass,
  $obligationsAnswered 
)
protected

Reworks the allready saved working data if neccessary.

protected

Parameters
integer$active_id
integer$pass
boolean$obligationsAnswered

Definition at line 699 of file class.assTextSubset.php.

700  {
701  // nothing to rework!
702  }

◆ saveToDb()

assTextSubset::saveToDb (   $original_id = "")

Saves a assTextSubset object to a database.

Parameters
string$original_id

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

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

107  {
108  global $ilDB;
109 
113 
114  parent::saveToDb($original_id);
115  }
saveAdditionalQuestionDataToDb()
Saves a record to the question types additional data table.
saveAnswerSpecificDataToDb()
Saves the answer specific records into a question types answer table.
saveQuestionDataToDb($original_id="")
global $ilDB
+ Here is the call graph for this function:

◆ saveWorkingData()

assTextSubset::saveWorkingData (   $active_id,
  $pass = NULL 
)

Saves the learners input of the question to the database.

public

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

Definition at line 593 of file class.assTextSubset.php.

References $ilDB, $ilUser, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), getAdditionalTableName(), getCorrectAnswers(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), getTextRating(), assQuestion\logAction(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), and ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb().

594  {
595  global $ilDB;
596  global $ilUser;
597 
598  if (is_null($pass))
599  {
600  include_once "./Modules/Test/classes/class.ilObjTest.php";
601  $pass = ilObjTest::_getPass($active_id);
602  }
603  $entered_values = 0;
604 
605  $solutionSubmit = $this->getSolutionSubmit();
606 
607  $this->getProcessLocker()->requestUserSolutionUpdateLock();
608 
609  $affectedRows = $this->removeCurrentSolution($active_id, $pass);
610 
611  foreach($solutionSubmit as $value)
612  {
613  if (strlen($value))
614  {
615  $this->saveCurrentSolution($active_id, $pass, $value, null);
616  $entered_values++;
617  }
618  }
619 
620  $this->getProcessLocker()->releaseUserSolutionUpdateLock();
621 
622  if ($entered_values)
623  {
624  include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
626  {
627  $this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
628  }
629  }
630  else
631  {
632  include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
634  {
635  $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
636  }
637  }
638 
639  return true;
640  }
getId()
Gets the id of the assQuestion object.
_getPass($active_id)
Retrieves the actual pass of a given user for a given test.
_enabledAssessmentLogging()
check wether assessment logging is enabled or not
_getLogLanguage()
retrieve the log language for assessment logging
global $ilUser
Definition: imgupload.php:15
global $ilDB
logAction($logtext="", $active_id="", $question_id="")
Logs an action into the Test&Assessment log.
+ Here is the call graph for this function:

◆ setCorrectAnswers()

assTextSubset::setCorrectAnswers (   $a_correct_answers)

Sets the number of correct answers needed to solve the question.

Parameters
integer$a_correct_anwersThe number of correct answers public

Definition at line 569 of file class.assTextSubset.php.

Referenced by loadFromDb().

570  {
571  $this->correctanswers = $a_correct_answers;
572  }
+ Here is the caller graph for this function:

◆ setExportDetailsXLS()

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

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
object$format_titleExcel title format
object$format_boldExcel bold format
array$eval_dataCumulated evaluation data public

Definition at line 795 of file class.assTextSubset.php.

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

796  {
797  include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
798  $solutions = $this->getSolutionValues($active_id, $pass);
799  $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
800  $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
801  $i = 1;
802  foreach ($solutions as $solution)
803  {
804  $worksheet->write($startrow + $i, 0, ilExcelUtils::_convert_text($solution["value1"]));
805  $i++;
806  }
807  return $startrow + $i + 1;
808  }
& getSolutionValues($active_id, $pass=NULL)
Loads solutions of a given user from the database an returns it.
_convert_text($a_text, $a_target="has been removed")
getTitle()
Gets the title string of the assQuestion object.
+ Here is the call graph for this function:

◆ setTextRating()

assTextSubset::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 User interface

Definition at line 507 of file class.assTextSubset.php.

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

508  {
509  switch ($a_text_rating)
510  {
518  $this->text_rating = $a_text_rating;
519  break;
520  default:
521  $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
522  break;
523  }
524  }
const TEXTGAP_RATING_LEVENSHTEIN5
const TEXTGAP_RATING_LEVENSHTEIN2
const TEXTGAP_RATING_LEVENSHTEIN1
const TEXTGAP_RATING_LEVENSHTEIN3
const TEXTGAP_RATING_CASESENSITIVE
const TEXTGAP_RATING_LEVENSHTEIN4
const TEXTGAP_RATING_CASEINSENSITIVE
+ Here is the caller graph for this function:

◆ toJSON()

assTextSubset::toJSON ( )

Returns a JSON representation of the question.

Definition at line 818 of file class.assTextSubset.php.

References $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), getCorrectAnswers(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), getTextRating(), and assQuestion\getTitle().

819  {
820  include_once("./Services/RTE/classes/class.ilRTE.php");
821  $result = array();
822  $result['id'] = (int) $this->getId();
823  $result['type'] = (string) $this->getQuestionType();
824  $result['title'] = (string) $this->getTitle();
825  $result['question'] = $this->formatSAQuestion($this->getQuestion());
826  $result['nr_of_tries'] = (int) $this->getNrOfTries();
827  $result['matching_method'] = (string) $this->getTextRating();
828  $result['feedback'] = array(
829  'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
830  'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
831  );
832 
833  $answers = array();
834  foreach ($this->getAnswers() as $key => $answer_obj)
835  {
836  array_push($answers, array(
837  "answertext" => (string) $answer_obj->getAnswertext(),
838  "points" => (float)$answer_obj->getPoints(),
839  "order" => (int)$answer_obj->getOrder()
840  ));
841  }
842  $result['correct_answers'] = $answers;
843 
844  $answers = array();
845  for($loop = 1; $loop <= (int) $this->getCorrectAnswers(); $loop++)
846  {
847  array_push($answers, array(
848  "answernr" => $loop
849  ));
850  }
851  $result['answers'] = $answers;
852 
853  $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
854  $result['mobs'] = $mobs;
855 
856  return json_encode($result);
857  }
getId()
Gets the id of the assQuestion object.
formatSAQuestion($a_q)
Format self assessment question.
getCorrectAnswers()
Returns the number of correct answers needed to solve the question.
$result
getTextRating()
Returns the rating option for text comparisons.
getQuestionType()
Returns the question type of the question.
$mobs
getQuestion()
Gets the question string of the question object.
_getMobsOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
get mobs of object
getTitle()
Gets the title string of the assQuestion object.
+ Here is the call graph for this function:

Field Documentation

◆ $answers

assTextSubset::$answers

Definition at line 35 of file class.assTextSubset.php.

Referenced by getAnswers(), and toJSON().

◆ $correctanswers

assTextSubset::$correctanswers

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

Referenced by getCorrectAnswers().

◆ $text_rating

assTextSubset::$text_rating

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

Referenced by getTextRating().


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