Class for text questions. More...

Inheritance diagram for assTextQuestion:

Collaboration diagram for assTextQuestion:

Public Member Functions
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assTextQuestion constructor More...

	getMatchcondition ()

	setMatchcondition (int $matchcondition)

	isComplete ()

	saveToDb (?int $original_id=null)

	loadFromDb (int $question_id)

	getMaxNumOfChars ()

	setMaxNumOfChars (int $maxchars=0)

	isWordCounterEnabled ()

	setWordCounterEnabled (bool $word_counter_enabled)

	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...

	getMinimumPoints ()

	isKeywordMatching ($answertext, $a_keyword)
	Checks if one of the keywords matches the answertext. More...

	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)

	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

	getQuestionType ()

	getTextRating ()

	setTextRating ($a_text_rating)

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

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

	flushAnswers ()
	Deletes all answers. More...

	setAnswers ($answers)

	duplicateAnswers ($original_id)

	getKeywordRelation ()

	setKeywordRelation (?string $relation)
	This method implements a default behaviour. More...

	countLetters ($text)

	countWords ($text)

	getLatestAutosaveContent (int $active_id, int $pass)

	toLog (AdditionalInformationGenerator $additional_info)

	solutionValuesToText (array $solution_values)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

Public Member Functions inherited from assQuestion
	getQuestionType ()

	isComplete ()

	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)

	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)

	getAdditionalTableName ()

	getAnswerTableName ()

	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...

	getCurrentUser ()

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping, array $solutionhints=[])

	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorized_solution=true)

	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...

	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...

	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...

	validateSolutionSubmit ()

	getSuggestedSolutionPath ()

	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...

	getSuggestedSolutionPathWeb ()

	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, ?int $pass=null)

	getSolutionValues (int $active_id, ?int $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)

	createPageObject ()

	clonePageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

static	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

	createNewQuestion (bool $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 (?int $original_id=null)

	duplicate (bool $for_test=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)

	copyObject (int $target_parent_id, string $title='')

	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')

	saveToDb (?int $original_id=null)

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	getInternalLinkHref (string $target)

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

	isWriteable ()

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $preview_session, $reached_points)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)

	adjustReachedPointsByScoringOptions (float $points, int $active_id)
	Adjust the given reached points by checks for all special scoring options in the test container. More...

	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

	getQuestionTypeID ()

	cloneHints (int $source_question_id, int $target_question_id)

	cleanupMediaObjectUsage ()

	getInstances ()

	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...

	hasSpecificFeedback ()

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

	syncSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange (int $lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)

	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)

	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)

	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)

	setStep ($step)

	getStep ()

	toJSON ()

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $value_pairs)

	updateTimestamp ()

	getTestPresentationConfig ()

	hasWritableOriginalInQuestionPool ()

	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)

	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)

	getSolutionForTextOutput (int $active_id, int $pass)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	getVariablesAsTextArray (int $active_id, int $pass)

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 Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $force_pass_results_update_enabled)

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

static	_getReachedPoints (int $active_id, int $question_id, int $pass)

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	instantiateQuestion (int $question_id)

static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...

static	getFeedbackClassNameByQuestionType (string $questionType)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $question_id)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...

Data Fields
const	SCORING_MODE_KEYWORD_RELATION_NONE = 'non'

const	SCORING_MODE_KEYWORD_RELATION_ANY = 'any'

const	SCORING_MODE_KEYWORD_RELATION_ALL = 'all'

const	SCORING_MODE_KEYWORD_RELATION_ONE = 'one'

array	$keywords

array	$answers = []

Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Protected Member Functions
	calculateReachedPointsForSolution (string $solution)

	getSolutionSubmit ()

	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)

Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...

	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...

	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $post_submission_field_name)

	savePreviewData (ilAssQuestionPreviewSession $preview_session)

	deletePageOfQuestion (int $question_id)

	cloneQuestionTypeSpecificProperties (self $target)

	removeAllImageFiles (string $image_target_path)

	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)

	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)

	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)

	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)

	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...

	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints (float $points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $original_question_id, int $duplicate_question_id)

	duplicateSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)

	buildQuestionDataQuery ()

	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)

	lookupMaxStep (int $active_id, int $pass)

	buildTestPresentationConfig ()

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
const	HAS_SPECIFIC_FEEDBACK = false

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

GeneralQuestionPropertiesRepository	$questionrepository

RequestDataCollector	$questionpool_request

QuestionFiles	$question_files

ilAssQuestionProcessLocker	$processLocker

ilTestQuestionConfig	$testQuestionConfig

SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo

ILIAS	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

ilObjUser	$current_user

SkillUsageService	$skillUsageService

HTTPServices	$http

Refinery	$refinery

Transformation	$shuffler

LoggingServices	$log

Container	$dic

ilAssQuestionLifecycle	$lifecycle

ilAssQuestionPage	$page

int	$id

string	$title

string	$comment

int	$owner

string	$author

int	$thumb_size

string	$question

float	$points = 0.0

bool	$shuffle = true

int	$test_id

int	$obj_id = 0

int	$original_id = null

int	$lastChange = null

string	$external_id = null

int	$step = null

array	$suggested_solutions

Private Member Functions
	isValidTextRating ($textRating)

	getScoringModeLangVar (string $scoring_mode)

Private Attributes
int	$max_num_of_chars = 0

bool	$word_counter_enabled = false

string	$text_rating = assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE

int	$matchcondition = 0

string	$keyword_relation = self::SCORING_MODE_KEYWORD_RELATION_NONE

Additional Inherited Members
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)

Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = 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 38 of file class.assTextQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

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

assTextQuestion constructor

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

Parameters

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

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

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

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->points = 1;
     }

Here is the call graph for this function:

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	$answertext	The answer text
double	$points	The points for selecting the answer (even negative points can be used)
boolean	$state	Defines the answer as correct (TRUE) or incorrect (FALSE)
integer	$order	A possible display order of the answer
double	$points	The points for not selecting the answer (even negative points can be used) public

See also: $answers; ASS_AnswerBinaryStateImage

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

References assQuestion\$points.

Referenced by loadFromDb(), and setAnswers().

      : void {
         $this->answers[] = new ASS_AnswerMultipleResponseImage($answertext, $points);
     }

Here is the caller graph for this function:

◆ calculateReachedPoints()

assTextQuestion::calculateReachedPoints	(	int	$active_id,
		?int	$pass = `null`,
		bool	$authorized_solution = `true`
	)

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

References calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), getMinimumPoints(), and assQuestion\getSolutionMaxPass().

      : float {
         if ($pass === null) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
 
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);
 
         // Return min points when no answer was given.
         if ($this->db->numRows($result) === 0) {
             return $this->getMinimumPoints();
         }
 
         // Return points of points are already on the row.
         $row = $this->db->fetchAssoc($result);
         if ($row['points'] !== null) {
             return (float) $row["points"];
         }
 
         return $this->calculateReachedPointsForSolution($row['value1']);
     }

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assTextQuestion::calculateReachedPointsForSolution ( string $solution )

protected

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

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

Referenced by calculateReachedPoints().

                                                                           : float
     {
         $decoded_solution = html_entity_decode($solution);
         // Return min points when keyword relation is NON KEYWORDS
         if ($this->getKeywordRelation() === self::SCORING_MODE_KEYWORD_RELATION_NONE) {
             return $this->getMinimumPoints();
         }
 
         // Return min points if there are no answers present.
         $answers = $this->getAnswers();
 
         if ($answers === []) {
             return $this->getMinimumPoints();
         }
 
         switch ($this->getKeywordRelation()) {
             case 'any':
                 $points = 0.0;
                 foreach ($answers as $answer) {
                     $qst_answer = $answer->getAnswertext();
                     $user_answer = '  ' . $decoded_solution;
                     if ($this->isKeywordMatching($user_answer, $qst_answer)) {
                         $points += $answer->getPoints();
                     }
                 }
                 return $points;
 
             case 'all':
                 foreach ($answers as $answer) {
                     $qst_answer = $answer->getAnswertext();
                     $user_answer = '  ' . $decoded_solution;
                     if (!$this->isKeywordMatching($user_answer, $qst_answer)) {
                         return 0.0;
                     }
                 }
                 return $this->getMaximumPoints();
 
             case 'one':
                 foreach ($answers as $answer) {
                     $qst_answer = $answer->getAnswertext();
                     $user_answer = '  ' . $decoded_solution;
                     if ($this->isKeywordMatching($user_answer, $qst_answer)) {
                         return $this->getMaximumPoints();
                     }
                 }
         }
 
         return 0.0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countLetters()

assTextQuestion::countLetters ( $text )

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

References $text, and ilStr\strLen().

                                        : int
     {
         $text = strip_tags($text);
 
         $text = str_replace('&gt;', '>', $text);
         $text = str_replace('&lt;', '<', $text);
         $text = str_replace('&nbsp;', ' ', $text);
         $text = str_replace('&amp;', '&', $text);
 
         $text = str_replace("\r\n", "\n", $text);
         $text = str_replace("\n", "", $text);
 
         return ilStr::strLen($text);
     }

Here is the call graph for this function:

◆ countWords()

assTextQuestion::countWords ( $text )

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

References $text.

                                      : int
     {
         if ($text === '') {
             return 0;
         }
         $text = str_replace('&nbsp;', ' ', $text);
 
         $text = preg_replace('/[.,:;!?\-_#\'"+*\\/=()&%§$]/m', '', $text);
 
         $text = preg_replace('/^\s*/m', '', $text);
         $text = preg_replace('/\s*$/m', '', $text);
         $text = preg_replace('/\s+/m', ' ', $text);
 
         return count(explode(' ', $text));
     }

◆ 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 $index A nonnegative index of the n-th answer public

See also: $answers

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

References ILIAS\UI\Implementation\Component\Table\getOrder().

                                             : void
     {
         if ($index < 0) {
             return;
         }
         if (count($this->answers) < 1) {
             return;
         }
         if ($index >= count($this->answers)) {
             return;
         }
         $answer = $this->answers[$index];
         //if (strlen($answer->getImage())) {
         //    $this->deleteImage($answer->getImage());
         //}
         unset($this->answers[$index]);
         $this->answers = array_values($this->answers);
         for ($i = 0, $iMax = count($this->answers); $i < $iMax; $i++) {
             if ($this->answers[$i]->getOrder() > $index) {
                 $this->answers[$i]->setOrder($i);
             }
         }
     }

Here is the call graph for this function:

◆ duplicateAnswers()

assTextQuestion::duplicateAnswers ( $original_id )

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

References assQuestion\$original_id, and assQuestion\getId().

                                                   : void
     {
         $result = $this->db->queryF(
             "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
             ['integer'],
             [$original_id]
         );
         if ($result->numRows()) {
             while ($row = $this->db->fetchAssoc($result)) {
                 $next_id = $this->db->nextId('qpl_a_essay');
                 $affectedRows = $this->db->manipulateF(
                     "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points)
                                          VALUES (%s, %s, %s, %s)",
                     ['integer','integer','text','float'],
                     [$next_id, $this->getId(), $row["answertext"], $row["points"]]
                 );
             }
         }
     }

Here is the call graph for this function:

◆ flushAnswers()

assTextQuestion::flushAnswers ( )

Deletes all answers.

public

See also: $answers

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

Referenced by loadFromDb(), and setAnswers().

                                   : void
     {
         $this->answers = [];
     }

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 public

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

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                             : string
     {
         return "qpl_qst_essay";
     }

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 $index A nonnegative index of the n-th answer

Returns: object ASS_AnswerBinaryStateImage-Object containing the answer public

See also: $answers

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

                                          : ?ASS_AnswerMultipleResponseImage
     {
         if ($index < 0) {
             return null;
         }
         if (count($this->answers) < 1) {
             return null;
         }
         if ($index >= count($this->answers)) {
             return null;
         }
 
         return $this->answers[$index];
     }

◆ getAnswerCount()

assTextQuestion::getAnswerCount ( )

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

                                     : int
     {
         return count($this->answers);
     }

◆ getAnswers()

assTextQuestion::getAnswers ( )

Returns: array<ASS_AnswerMultipleResponseImage>

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

References $answers.

Referenced by calculateReachedPointsForSolution(), getCorrectSolutionForTextOutput(), and toLog().

                                 : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assTextQuestion::getAnswerTableName ( )

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

                                         : string
     {
         return 'qpl_a_essay';
     }

◆ getCorrectSolutionForTextOutput()

assTextQuestion::getCorrectSolutionForTextOutput	(	int	$active_id,
		int	$pass
	)

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

References getAnswers(), ASS_AnswerSimple\getAnswertext(), and getKeywordRelation().

                                                                               : array|string
     {
         switch ($this->getKeywordRelation()) {
             case self::SCORING_MODE_KEYWORD_RELATION_NONE:
                 return '';
             default:
                 return array_map(
                     static fn(ASS_AnswerMultipleResponseImage $v): string => $v->getAnswertext(),
                     $this->getAnswers()
                 );
         }
     }

Here is the call graph for this function:

◆ getKeywordRelation()

assTextQuestion::getKeywordRelation ( )

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

References $keyword_relation.

Referenced by calculateReachedPointsForSolution(), getCorrectSolutionForTextOutput(), getMaximumPoints(), getMinimumPoints(), saveAdditionalQuestionDataToDb(), and toLog().

     {
         return $this->keyword_relation;
     }

Here is the caller graph for this function:

◆ getLatestAutosaveContent()

assTextQuestion::getLatestAutosaveContent	(	int	$active_id,
		int	$pass
	)

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

References assQuestion\getId().

                                                                        : ?string
     {
         $question_fi = $this->getId();
 
         // Do we have an unauthorized result?
         $cntresult = $this->db->query(
             '
             SELECT count(solution_id) cnt
             FROM tst_solutions
             WHERE active_fi = ' . $this->db->quote($active_id, 'int') . '
             AND question_fi = ' . $this->db->quote($this->getId(), 'int') . '
             AND authorized = ' . $this->db->quote(0, 'int')
             . ' AND pass = ' . $this->db->quote($pass, 'int')
         );
         $row = $this->db->fetchAssoc($cntresult);
         if ($row['cnt'] > 0) {
             $tresult = $this->db->query(
                 '
             SELECT value1
             FROM tst_solutions
             WHERE active_fi = ' . $this->db->quote($active_id, 'int') . '
             AND question_fi = ' . $this->db->quote($this->getId(), 'int') . '
             AND authorized = ' . $this->db->quote(0, 'int')
             . ' AND pass = ' . $this->db->quote($pass, 'int')
             );
             $trow = $this->db->fetchAssoc($tresult);
             return $trow['value1'];
         }
         return null;
     }

Here is the call graph for this function:

◆ getMatchcondition()

assTextQuestion::getMatchcondition ( )

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

References $matchcondition.

Referenced by saveAdditionalQuestionDataToDb().

                                        : int
     {
         return $this->matchcondition;
     }

Here is the caller graph for this function:

◆ getMaximumPoints()

assTextQuestion::getMaximumPoints ( )

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

public

See also: $points

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

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPointsForSolution(), isComplete(), and toLog().

                                       : float
     {
         if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
             return parent::getPoints();
         }
 
         $points = 0;
 
         foreach ($this->answers as $answer) {
             if ($answer->getPoints() > 0) {
                 $points = $points + $answer->getPoints();
             }
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxNumOfChars()

assTextQuestion::getMaxNumOfChars ( )

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

References $max_num_of_chars.

Referenced by saveAdditionalQuestionDataToDb(), toJSON(), and toLog().

                                       : int
     {
         return $this->max_num_of_chars;
     }

Here is the caller graph for this function:

◆ getMinimumPoints()

assTextQuestion::getMinimumPoints ( )

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

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPoints(), and calculateReachedPointsForSolution().

     {
         if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
             return 0;
         }
 
         $points = 0;
 
         foreach ($this->answers as $answer) {
             if ($answer->getPoints() < 0) {
                 $points = $points + $answer->getPoints();
             }
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionType()

assTextQuestion::getQuestionType ( )

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

Referenced by toJSON(), and toLog().

                                      : string
     {
         return "assTextQuestion";
     }

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.

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

                                                 : string
     {
         return parent::getRTETextWithMediaObjects();
     }

◆ getScoringModeLangVar()

assTextQuestion::getScoringModeLangVar ( string $scoring_mode )

private

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

References SCORING_MODE_KEYWORD_RELATION_ALL, SCORING_MODE_KEYWORD_RELATION_ANY, SCORING_MODE_KEYWORD_RELATION_NONE, and SCORING_MODE_KEYWORD_RELATION_ONE.

Referenced by toLog().

                                                                 : string
     {
         switch ($scoring_mode) {
             case assTextQuestion::SCORING_MODE_KEYWORD_RELATION_NONE:
                 return 'essay_scoring_mode_without_keywords';
             case assTextQuestion::SCORING_MODE_KEYWORD_RELATION_ANY:
                 return 'essay_scoring_mode_keyword_relation_any';
             case assTextQuestion::SCORING_MODE_KEYWORD_RELATION_ALL:
                 return 'essay_scoring_mode_keyword_relation_all';
             case assTextQuestion::SCORING_MODE_KEYWORD_RELATION_ONE:
                 return 'essay_scoring_mode_keyword_relation_one';
             default:
                 return '';
         }
     }

Here is the caller graph for this function:

◆ getScoringModesWithPointsByKeyword()

static assTextQuestion::getScoringModesWithPointsByKeyword ( )

static

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

Referenced by assTextQuestionGUI\getBestAnswer().

                                                                : array
     {
         return [
             self::SCORING_MODE_KEYWORD_RELATION_ANY
         ];
     }

Here is the caller graph for this function:

◆ getScoringModesWithPointsByQuestion()

static assTextQuestion::getScoringModesWithPointsByQuestion ( )

static

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

                                                                 : array
     {
         return [
             self::SCORING_MODE_KEYWORD_RELATION_NONE,
             self::SCORING_MODE_KEYWORD_RELATION_ALL,
             self::SCORING_MODE_KEYWORD_RELATION_ONE
         ];
     }

◆ getSolutionSubmit()

assTextQuestion::getSolutionSubmit ( )

protected

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

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

Referenced by saveWorkingData().

                                           : string
     {
         $text = $this->questionpool_request->string('TEXT', '');
 
         $text = ilObjAdvancedEditing::_getRichTextEditor() === 'tinymce'
             ? ilUtil::stripSlashes($text, false)
             : htmlentities($text);
 
         return ilUtil::isHTML($text) ? $this->getHtmlUserSolutionPurifier()->purify($text) : $text;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextRating()

assTextQuestion::getTextRating ( )

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

References $text_rating.

Referenced by isKeywordMatching(), and saveAdditionalQuestionDataToDb().

                                    : string
     {
         return $this->text_rating;
     }

Here is the caller graph for this function:

◆ getValidScoringModes()

static assTextQuestion::getValidScoringModes ( )

static

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

                                                  : array
     {
         return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
     }

◆ isComplete()

assTextQuestion::isComplete ( )

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

References getMaximumPoints().

                                 : bool
     {
         if (strlen($this->title)
             && $this->author
             && $this->question
             && $this->getMaximumPoints() > 0
         ) {
             return true;
         }
         return false;
     }

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	$answertext	The answertext of the user
string	$a_keyword	The keyword which should be checked

Returns: boolean TRUE if the keyword matches, FALSE otherwise private

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

References $DIC, assQuestion\$refinery, getTextRating(), ilStr\strPos(), ilStr\strToLower(), assClozeGap\TEXTGAP_RATING_CASEINSENSITIVE, assClozeGap\TEXTGAP_RATING_CASESENSITIVE, assClozeGap\TEXTGAP_RATING_LEVENSHTEIN1, assClozeGap\TEXTGAP_RATING_LEVENSHTEIN2, assClozeGap\TEXTGAP_RATING_LEVENSHTEIN3, assClozeGap\TEXTGAP_RATING_LEVENSHTEIN4, and assClozeGap\TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by calculateReachedPointsForSolution().

                                                               : bool
     {
         global $DIC;
         $refinery = $DIC->refinery();
         $result = false;
         $textrating = $this->getTextRating();
 
         switch ($textrating) {
             case assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE:
                 if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword), 0) !== false) {
                     return true;
                 }
                 break;
             case assClozeGap::TEXTGAP_RATING_CASESENSITIVE:
                 if (ilStr::strPos($answertext, $a_keyword) !== false) {
                     return true;
                 }
                 break;
         }
 
         // "<p>red</p>" would not match "red" even with distance of 5
         $answertext = strip_tags($answertext);
         $answerwords = [];
         if (preg_match_all("/([^\s.]+)/", $answertext, $matches)) {
             foreach ($matches[1] as $answerword) {
                 array_push($answerwords, trim($answerword));
             }
         }
 
         // create correct transformation
         switch ($textrating) {
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN1:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 1);
                 break;
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN2:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 2);
                 break;
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN3:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 3);
                 break;
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN4:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 4);
                 break;
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN5:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 5);
                 break;
         }
 
         // run answers against Levenshtein methods
         foreach ($answerwords as $a_original) {
             if (isset($transformation) && $transformation->transform($a_original) >= 0) {
                 return true;
             }
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidTextRating()

assTextQuestion::isValidTextRating ( $textRating )

private

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

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

Referenced by loadFromDb().

                                                    : bool
     {
         switch ($textRating) {
             case assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE:
             case assClozeGap::TEXTGAP_RATING_CASESENSITIVE:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN1:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN2:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN3:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN4:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN5:
                 return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ isWordCounterEnabled()

assTextQuestion::isWordCounterEnabled ( )

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

References $word_counter_enabled.

Referenced by saveAdditionalQuestionDataToDb(), and toLog().

                                           : bool
     {
         return $this->word_counter_enabled;
     }

Here is the caller graph for this function:

◆ loadFromDb()

assTextQuestion::loadFromDb ( int $question_id )

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

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), addAnswer(), flushAnswers(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getId(), ilAssQuestionLifecycle\getInstance(), isValidTextRating(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), setKeywordRelation(), assQuestion\setLifecycle(), setMaxNumOfChars(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), setTextRating(), assQuestion\setTitle(), setWordCounterEnabled(), and assClozeGap\TEXTGAP_RATING_CASEINSENSITIVE.

                                                 : void
     {
         $result = $this->db->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",
             ["integer"],
             [$question_id]
         );
         if ($this->db->numRows($result) == 1) {
             $data = $this->db->fetchAssoc($result);
             $this->setId($question_id);
             $this->setObjId($data["obj_fi"]);
             $this->setTitle((string) $data["title"]);
             $this->setComment((string) $data["description"]);
             $this->setOriginalId($data["original_id"]);
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setAuthor($data["author"]);
             $this->setPoints((float) $data["points"]);
             $this->setOwner($data["owner"]);
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));
             $this->setShuffle(false);
             $this->setWordCounterEnabled((bool) $data['word_cnt_enabled']);
             $this->setMaxNumOfChars($data["maxnumofchars"] ?? 0);
             $this->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE);
             $this->matchcondition = (isset($data['matchcondition'])) ? (int) $data['matchcondition'] : 0;
             $this->setKeywordRelation(($data['keyword_relation']));
 
             try {
                 $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
             } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                 $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
             }
 
             try {
                 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
             } catch (ilTestQuestionPoolException $e) {
             }
         }
 
         $result = $this->db->queryF(
             'SELECT * FROM qpl_a_essay WHERE question_fi = %s',
             ['integer'],
             [$this->getId()]
         );
 
         $this->flushAnswers();
         while ($row = $this->db->fetchAssoc($result)) {
             $this->addAnswer($row['answertext'] ?? '', $row['points'] ?? 0.0);
         }
 
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assTextQuestion::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

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

References getAdditionalTableName(), assQuestion\getId(), getKeywordRelation(), getMatchcondition(), getMaxNumOfChars(), getTextRating(), ILIAS\Repository\int(), isWordCounterEnabled(), and ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb().

Referenced by saveToDb().

     {
         $this->db->manipulateF(
             "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
             ['integer'],
             [$this->getId()]
         );
 
         $fields = [
             'question_fi' => ['integer', $this->getId()],
             'maxnumofchars' => ['integer', $this->getMaxNumOfChars()],
             'word_cnt_enabled' => ['integer', (int) $this->isWordCounterEnabled()],
             'keywords' => ['text', null],
             'textgap_rating' => ['text', $this->getTextRating()],
             'matchcondition' => ['integer', $this->getMatchcondition()],
             'keyword_relation' => ['text', $this->getKeywordRelation()]
         ];
 
         $this->db->insert($this->getAdditionalTableName(), $fields);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

assTextQuestion::saveToDb ( ?int $original_id = null )

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

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

                                                       : void
     {
         $this->saveQuestionDataToDb($original_id);
         $this->saveAdditionalQuestionDataToDb();
         $this->saveAnswerSpecificDataToDb();
         parent::saveToDb();
     }

Here is the call graph for this function:

◆ saveWorkingData()

assTextQuestion::saveWorkingData	(	int	$active_id,
		?int	$pass = `null`,
		bool	$authorized = `true`
	)

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

References ilObjTest\_getPass(), assQuestion\getProcessLocker(), getSolutionSubmit(), assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

      : bool {
         if ($pass === null) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $answer = $this->getSolutionSubmit();
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use ($answer, $active_id, $pass, $authorized) {
                 $this->removeCurrentSolution($active_id, $pass, $authorized);
 
                 if ($answer !== '') {
                     $this->saveCurrentSolution($active_id, $pass, $answer, null, $authorized);
                 }
             }
         );
 
         return true;
     }

Here is the call graph for this function:

◆ setAnswers()

assTextQuestion::setAnswers ( $answers )

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

References assQuestion\$points, addAnswer(), flushAnswers(), and ILIAS\Repository\refinery().

                                         : void
     {
         if (isset($answers['answer'])) {
             $count = count($answers['answer']);
             $withPoints = true;
         } else {
             $count = count($answers);
             $withPoints = false;
         }
 
         $this->flushAnswers();
 
         for ($i = 0; $i < $count; $i++) {
             if ($withPoints) {
                 $points = $this->refinery->kindlyTo()->float()->transform($answers['points'][$i]);
                 $this->addAnswer($answers['answer'][$i], $points);
             } else {
                 $this->addAnswer($answers[$i], 0);
             }
         }
     }

Here is the call graph for this function:

◆ setKeywordRelation()

assTextQuestion::setKeywordRelation ( ?string $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 689 of file class.assTextQuestion.php.

References $relation.

Referenced by loadFromDb().

                                                          : void
     {
         if ($relation !== null) {
             $this->keyword_relation = $relation;
         }
     }

Here is the caller graph for this function:

◆ setMatchcondition()

assTextQuestion::setMatchcondition ( int $matchcondition )

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

References $matchcondition.

                                                           : void
     {
         $this->matchcondition = $matchcondition;
     }

◆ setMaxNumOfChars()

assTextQuestion::setMaxNumOfChars ( int $maxchars = 0 )

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

Referenced by loadFromDb().

                                                        : void
     {
         $this->max_num_of_chars = $maxchars;
     }

Here is the caller graph for this function:

◆ setTextRating()

assTextQuestion::setTextRating ( $a_text_rating )

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

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

Referenced by loadFromDb().

                                                  : void
     {
         switch ($a_text_rating) {
             case assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE:
             case assClozeGap::TEXTGAP_RATING_CASESENSITIVE:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN1:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN2:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN3:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN4:
             case assClozeGap::TEXTGAP_RATING_LEVENSHTEIN5:
                 $this->text_rating = $a_text_rating;
                 break;
             default:
                 $this->text_rating = assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE;
                 break;
         }
     }

Here is the caller graph for this function:

◆ setWordCounterEnabled()

assTextQuestion::setWordCounterEnabled ( bool $word_counter_enabled )

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

References $word_counter_enabled.

Referenced by loadFromDb().

                                                                      : void
     {
         $this->word_counter_enabled = $word_counter_enabled;
     }

Here is the caller graph for this function:

◆ solutionValuesToLog()

assTextQuestion::solutionValuesToLog	(	AdditionalInformationGenerator	$additional_info,
		array	$solution_values
	)

protected

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

References ILIAS\Repository\refinery().

      : string {
         if (!array_key_exists(0, $solution_values)
             || !array_key_exists('value1', $solution_values[0])) {
             return '';
         }
         return $this->refinery->string()->stripTags()->transform(
             html_entity_decode($solution_values[0]['value1'])
         );
     }

Here is the call graph for this function:

◆ solutionValuesToText()

assTextQuestion::solutionValuesToText ( array $solution_values )

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

                                                                 : string
     {
         if (!array_key_exists(0, $solution_values)
             || !array_key_exists('value1', $solution_values[0])) {
             return '';
         }
         return $solution_values[0]['value1'];
     }

◆ toJSON()

assTextQuestion::toJSON ( )

Returns a JSON representation of the question.

Implements ILIAS\TestQuestionPool\Questions\QuestionLMExportable.

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

References assQuestion\formatSAQuestion(), assQuestion\getId(), getMaxNumOfChars(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitleForHTMLOutput().

                             : string
     {
         $result = [];
         $result['id'] = $this->getId();
         $result['type'] = (string) $this->getQuestionType();
         $result['title'] = $this->getTitleForHTMLOutput();
         $result['question'] = $this->formatSAQuestion($this->getQuestion());
         $result['nr_of_tries'] = $this->getNrOfTries();
         $result['shuffle'] = $this->getShuffle();
         $result['maxlength'] = $this->getMaxNumOfChars();
         return json_encode($result);
     }

Here is the call graph for this function:

◆ toLog()

assTextQuestion::toLog ( AdditionalInformationGenerator $additional_info )

Implements ILIAS\TestQuestionPool\Questions\Question.

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

References assQuestion\formatSAQuestion(), getAnswers(), ASS_AnswerSimple\getAnswertext(), ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool(), getKeywordRelation(), getMaximumPoints(), getMaxNumOfChars(), ASS_AnswerSimple\getPoints(), assQuestion\getQuestion(), getQuestionType(), getScoringModeLangVar(), ILIAS\Test\Logging\AdditionalInformationGenerator\getTagForLangVar(), assQuestion\getTitleForHTMLOutput(), and isWordCounterEnabled().

                                                                           : array
     {
         return [
             AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
             AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
             AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
             AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => $this->getMaximumPoints(),
             AdditionalInformationGenerator::KEY_QUESTION_TEXT_WORDCOUNT_ENABLED => $additional_info
             ->getEnabledDisabledTagForBool($this->isWordCounterEnabled()),
             AdditionalInformationGenerator::KEY_QUESTION_MAXCHARS => $this->getMaxNumOfChars(),
             AdditionalInformationGenerator::KEY_QUESTION_TEXT_SCORING_MODE => $additional_info->getTagForLangVar(
                 $this->getScoringModeLangVar($this->getKeywordRelation())
             ),
             AdditionalInformationGenerator::KEY_QUESTION_CORRECT_ANSWER_OPTIONS => array_map(
                 fn(ASS_AnswerMultipleResponseImage $answer) => [
                     AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION => $answer->getAnswertext(),
                     AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => $answer->getPoints() === 0.0 ? '' : $answer->getPoints()
                 ],
                 $this->getAnswers()
             ),
             AdditionalInformationGenerator::KEY_FEEDBACK => [
                 AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_INCOMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                 AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_COMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
             ]
         ];
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

array assTextQuestion::$answers = []

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

Referenced by getAnswers().

◆ $keyword_relation

string assTextQuestion::$keyword_relation = self::SCORING_MODE_KEYWORD_RELATION_NONE

private

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

Referenced by getKeywordRelation().

◆ $keywords

array assTextQuestion::$keywords

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

◆ $matchcondition

int assTextQuestion::$matchcondition = 0

private

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

Referenced by getMatchcondition(), and setMatchcondition().

◆ $max_num_of_chars

int assTextQuestion::$max_num_of_chars = 0

private

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

Referenced by getMaxNumOfChars().

◆ $text_rating

string assTextQuestion::$text_rating = assClozeGap::TEXTGAP_RATING_CASEINSENSITIVE

private

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

Referenced by getTextRating().

◆ $word_counter_enabled

bool assTextQuestion::$word_counter_enabled = false

private

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

Referenced by isWordCounterEnabled(), and setWordCounterEnabled().

◆ HAS_SPECIFIC_FEEDBACK

const assTextQuestion::HAS_SPECIFIC_FEEDBACK = false

protected

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

◆ SCORING_MODE_KEYWORD_RELATION_ALL

const assTextQuestion::SCORING_MODE_KEYWORD_RELATION_ALL = 'all'

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

Referenced by assTextQuestionGUI\getBestAnswer(), getScoringModeLangVar(), assTextQuestionGUI\populateAnswerSpecificFormPart(), and assTextQuestionGUI\writeAnswerSpecificPostData().

◆ SCORING_MODE_KEYWORD_RELATION_ANY

const assTextQuestion::SCORING_MODE_KEYWORD_RELATION_ANY = 'any'

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

Referenced by assTextQuestionGUI\getBestAnswer(), getScoringModeLangVar(), assTextQuestionGUI\populateAnswerSpecificFormPart(), and assTextQuestionGUI\writeAnswerSpecificPostData().

◆ SCORING_MODE_KEYWORD_RELATION_NONE

const assTextQuestion::SCORING_MODE_KEYWORD_RELATION_NONE = 'non'

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

Referenced by getScoringModeLangVar(), assTextQuestionGUI\populateAnswerSpecificFormPart(), and assTextQuestionGUI\writeAnswerSpecificPostData().

◆ SCORING_MODE_KEYWORD_RELATION_ONE

const assTextQuestion::SCORING_MODE_KEYWORD_RELATION_ONE = 'one'

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

Referenced by assTextQuestionGUI\getBestAnswer(), getScoringModeLangVar(), assTextQuestionGUI\populateAnswerSpecificFormPart(), and assTextQuestionGUI\writeAnswerSpecificPostData().

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

components/ILIAS/TestQuestionPool/classes/class.assTextQuestion.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ countLetters()

◆ countWords()

◆ deleteAnswer()

◆ duplicateAnswers()

◆ flushAnswers()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getCorrectSolutionForTextOutput()

◆ getKeywordRelation()

◆ getLatestAutosaveContent()

◆ getMatchcondition()

◆ getMaximumPoints()

◆ getMaxNumOfChars()

◆ getMinimumPoints()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getScoringModeLangVar()

◆ getScoringModesWithPointsByKeyword()

◆ getScoringModesWithPointsByQuestion()

◆ getSolutionSubmit()

◆ getTextRating()

◆ getValidScoringModes()

◆ isComplete()

◆ isKeywordMatching()

◆ isValidTextRating()

◆ isWordCounterEnabled()

◆ loadFromDb()

◆ saveAdditionalQuestionDataToDb()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setKeywordRelation()

◆ setMatchcondition()

◆ setMaxNumOfChars()

◆ setTextRating()

◆ setWordCounterEnabled()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

Field Documentation

◆ $answers

◆ $keyword_relation

◆ $keywords

◆ $matchcondition

◆ $max_num_of_chars

◆ $text_rating

◆ $word_counter_enabled

◆ HAS_SPECIFIC_FEEDBACK

◆ SCORING_MODE_KEYWORD_RELATION_ALL

◆ SCORING_MODE_KEYWORD_RELATION_ANY

◆ SCORING_MODE_KEYWORD_RELATION_NONE

◆ SCORING_MODE_KEYWORD_RELATION_ONE