Class for error text questions. More...

Inheritance diagram for assErrorText:

Collaboration diagram for assErrorText:

Public Member Functions
	__construct (string $title='', string $comment='', string $author='', int $owner=-1, string $question='')

	isComplete ()

	saveToDb (?int $original_id=null)

	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

	saveAdditionalQuestionDataToDb ()
	Saves the data for the additional data table. More...

	loadFromDb ($question_id)
	Loads the object from the database. More...

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

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

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

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

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	getQuestionType ()

	getAdditionalTableName ()

	getAnswerTableName ()

	setErrorsFromParsedErrorText ()

	setErrorData (array $errors)

	removeErrorDataWithoutPosition ()

	assembleErrorTextOutput (array $selections, bool $graphical_output=false, bool $show_correct_solution=false, bool $use_link_tags=true, array $correctness_icons=[])

	createErrorTextExport (array $selections)

	getBestSelection (bool $with_positive_points_only=true)

	flushErrorData ()

	getErrorData ()

	getErrorText ()

	setErrorText (?string $text)

	getParsedErrorText ()

	setParsedErrorText (array $parsed_errortext)

	getTextSize ()

	setTextSize ($a_value)

	getPointsWrong ()

	setPointsWrong ($a_value)

	toJSON ()

	getOperators (string $expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...

	parseErrorText ()

	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...

	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)

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

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

	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)

	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 iQuestionCondition
	getAvailableAnswerOptions (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...

Protected Member Functions
	getPointsForSelectedPositions (array $selected_word_positions)

	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)

	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	ERROR_TYPE_WORD = 1

const	ERROR_TYPE_PASSAGE = 2

const	DEFAULT_TEXT_SIZE = 100.0

const	ERROR_MAX_LENGTH = 150

const	PARAGRAPH_SPLIT_REGEXP = '/[\n\r]+/'

const	WORD_SPLIT_REGEXP = '/\s+/'

const	FIND_PUNCTUATION_REGEXP = '/\p{P}/'

const	ERROR_WORD_MARKER = '#'

const	ERROR_PARAGRAPH_DELIMITERS

const string	$errortext = ''

array	$parsed_errortext = []

array	$errordata = []

float	$textsize

float	$points_wrong = null

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

TestResultRepository	$test_result_repository

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

	getAnswersFromRequest ()

	addPositionToErrorAnswer (assAnswerErrorText $error)

	completeParsedErrorTextFromErrorData ()

	getAdditionalInformationFromExistingErrorDataByErrorText (array $current_error_data, string $text_wrong)

	generateOutputStringFromPosition (int $position, array $selections, array $paragraph, bool $graphical_output, bool $show_correct_solution, bool $use_link_tags, array $correctness_icons)

	getTextForPosition (int $position, array $paragraph, bool $show_correct_solution)

	getClassForPosition (int $position, bool $show_correct_solution, array $selections)

	getCorrectnessIconForPosition (int $position, bool $graphical_output, array $selections, array $correctness_icons)

	getErrorDataAsArrayForJS ()

	getParsedErrorTextForJS ()

	addErrorInformationToTextParagraphArray (array $paragraph, int $offset)

	parsePassageEndWord (string $word)

	generateArrayByPositionFromErrorData ()

	getErrorTokenHtml ($item, $class, $useLinkTags)

Additional Inherited Members
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 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 = ':'

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 = "?"

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 error 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; Grégory Saive gsaiv.nosp@m.e@da.nosp@m.tabay.nosp@m..de; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 37 of file class.assErrorText.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 60 of file class.assErrorText.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->textsize = self::DEFAULT_TEXT_SIZE;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addErrorInformationToTextParagraphArray()

assErrorText::addErrorInformationToTextParagraphArray	(	array	$paragraph,
		int	$offset
	)

private

Parameters

list<string> $paragraph

Returns: array<string|array>

Definition at line 812 of file class.assErrorText.php.

References getPointsWrong(), null, and parsePassageEndWord().

Referenced by parseErrorText().

                                                                                            : array
     {
         $paragraph_with_error_info = [];
         $passage_start = null;
         foreach ($paragraph as $position => $word) {
             $actual_position = $position + $offset;
             if ($passage_start !== null
                 && (mb_strrpos($word, self::ERROR_PARAGRAPH_DELIMITERS['end']) === mb_strlen($word) - 2
                 || mb_strrpos($word, self::ERROR_PARAGRAPH_DELIMITERS['end']) === mb_strlen($word) - 3
                     && preg_match(self::FIND_PUNCTUATION_REGEXP, mb_substr($word, -1)) === 1)) {
                 $actual_word = $this->parsePassageEndWord($word);
 
                 $paragraph_with_error_info[$passage_start]['text_wrong'] .=
                     ' ' . $actual_word;
                 $paragraph_with_error_info[$actual_position] = [
                     'text' => $actual_word,
                     'error_type' => 'passage_end'
                 ];
                 $passage_start = null;
                 continue;
             }
             if ($passage_start !== null) {
                 $paragraph_with_error_info[$passage_start]['text_wrong'] .= ' ' . $word;
                 $paragraph_with_error_info[$actual_position] = [
                     'text' => $word,
                     'error_type' => 'in_passage'
                 ];
                 continue;
             }
             if (mb_strpos($word, self::ERROR_PARAGRAPH_DELIMITERS['start']) === 0) {
                 $paragraph_with_error_info[$actual_position] = [
                     'text' => substr($word, 2),
                     'text_wrong' => substr($word, 2),
                     'error_type' => 'passage_start',
                     'error_position' => $actual_position,
                 ];
                 $passage_start = $actual_position;
                 continue;
             }
             if (mb_strpos($word, self::ERROR_WORD_MARKER) === 0) {
                 $paragraph_with_error_info[$actual_position] = [
                     'text' => substr($word, 1),
                     'text_wrong' => substr($word, 1),
                     'error_type' => 'word',
                     'error_position' => $actual_position,
                 ];
                 continue;
             }
 
             $paragraph_with_error_info[$actual_position] = [
                 'text' => $word,
                 'error_type' => 'none',
                 'points' => $this->getPointsWrong()
             ];
         }
 
         return $paragraph_with_error_info;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPositionToErrorAnswer()

assErrorText::addPositionToErrorAnswer ( assAnswerErrorText $error )

private

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

References generateArrayByPositionFromErrorData(), getParsedErrorText(), assAnswerErrorText\getTextWrong(), and assAnswerErrorText\withPosition().

Referenced by correctDataAfterParserUpdate(), and setErrorData().

                                                                         : assAnswerErrorText
     {
         foreach ($this->getParsedErrorText() as $paragraph) {
             foreach ($paragraph as $position => $word) {
                 if (isset($word['text_wrong'])
                     && ($word['text_wrong'] === $error->getTextWrong()
                         || mb_substr($word['text_wrong'], 0, -1) === $error->getTextWrong()
                             && preg_match(self::FIND_PUNCTUATION_REGEXP, mb_substr($word['text_wrong'], -1)) === 1)
                     && !array_key_exists($position, $this->generateArrayByPositionFromErrorData())
                 ) {
                     return $error->withPosition($position);
                 }
             }
         }
 
         return $error;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assembleErrorTextOutput()

assErrorText::assembleErrorTextOutput	(	array	$selections,
		bool	$graphical_output = `false`,
		bool	$show_correct_solution = `false`,
		bool	$use_link_tags = `true`,
		array	$correctness_icons = `[]`
	)

Definition at line 437 of file class.assErrorText.php.

References generateOutputStringFromPosition(), and getParsedErrorText().

      : string {
         $output_array = [];
         foreach ($this->getParsedErrorText() as $paragraph) {
             $array_reduce_function = fn(?string $carry, int $position)
                 => $carry . $this->generateOutputStringFromPosition(
                     $position,
                     $selections,
                     $paragraph,
                     $graphical_output,
                     $show_correct_solution,
                     $use_link_tags,
                     $correctness_icons
                 );
             $output_array[] = '<p>' . trim(array_reduce(array_keys($paragraph), $array_reduce_function)) . '</p>';
         }
 
         return implode("\n", $output_array);
     }

Here is the call graph for this function:

◆ calculateReachedPoints()

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

Definition at line 249 of file class.assErrorText.php.

References assQuestion\$points, assQuestion\getCurrentSolutionResultSet(), getPointsForSelectedPositions(), assQuestion\getSolutionMaxPass(), and null.

Referenced by getUserQuestionResult().

      : float {
         if ($pass === null) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);
 
         $positions = [];
         while ($row = $this->db->fetchAssoc($result)) {
             $positions[] = $row['value1'];
         }
         $points = $this->getPointsForSelectedPositions($positions);
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assErrorText::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $preview_session )

Definition at line 267 of file class.assErrorText.php.

References assQuestion\ensureNonNegativePoints(), ilAssQuestionPreviewSession\getParticipantsSolution(), and getPointsForSelectedPositions().

     {
         $reached_points = $this->getPointsForSelectedPositions($preview_session->getParticipantsSolution() ?? []);
         return $this->ensureNonNegativePoints($reached_points);
     }

Here is the call graph for this function:

◆ completeParsedErrorTextFromErrorData()

assErrorText::completeParsedErrorTextFromErrorData ( )

private

Definition at line 376 of file class.assErrorText.php.

References getParsedErrorText().

Referenced by correctDataAfterParserUpdate(), and setErrorData().

                                                            : void
     {
         foreach ($this->errordata as $error) {
             $position = $error->getPosition();
             foreach ($this->getParsedErrorText() as $key => $paragraph) {
                 if (array_key_exists($position, $paragraph)) {
                     $this->parsed_errortext[$key][$position]['text_correct'] =
                         $error->getTextCorrect();
                     $this->parsed_errortext[$key][$position]['points'] =
                         $error->getPoints();
                     break;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctDataAfterParserUpdate()

assErrorText::correctDataAfterParserUpdate ( )

private

Definition at line 208 of file class.assErrorText.php.

References addPositionToErrorAnswer(), completeParsedErrorTextFromErrorData(), getErrorText(), getParsedErrorText(), null, parseErrorText(), saveAdditionalQuestionDataToDb(), and saveAnswerSpecificDataToDb().

Referenced by loadFromDb().

                                                    : void
     {
         if ($this->getErrorText() === '') {
             return;
         }
         $needs_finalizing = false;
         if ($this->getParsedErrorText() === []) {
             $needs_finalizing = true;
             $this->parseErrorText();
         }
 
         if (isset($this->errordata[0])
             && $this->errordata[0]->getPosition() === null) {
             foreach ($this->errordata as $key => $error) {
                 $this->errordata[$key] = $this->addPositionToErrorAnswer($error);
             }
             $this->saveAnswerSpecificDataToDb();
         }
 
         if ($needs_finalizing) {
             $this->completeParsedErrorTextFromErrorData();
             $this->saveAdditionalQuestionDataToDb();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createErrorTextExport()

assErrorText::createErrorTextExport ( array $selections )

Definition at line 544 of file class.assErrorText.php.

References getParsedErrorText().

Referenced by getCorrectSolutionForTextOutput(), solutionValuesToLog(), and solutionValuesToText().

                                                             : string
     {
         if (!is_array($selections)) {
             $selections = [];
         }
 
         foreach ($this->getParsedErrorText() as $paragraph) {
             $array_reduce_function = function ($carry, $k) use ($paragraph, $selections) {
                 $text = $paragraph[$k]['text'];
                 if (in_array($k, $selections)) {
                     $text = self::ERROR_WORD_MARKER . $paragraph[$k]['text'] . self::ERROR_WORD_MARKER;
                 }
                 return $carry . ' ' . $text;
             };
             $output_array[] = trim(array_reduce(array_keys($paragraph), $array_reduce_function));
         }
         return implode("\n", $output_array);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flushErrorData()

assErrorText::flushErrorData ( )

Definition at line 631 of file class.assErrorText.php.

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

◆ generateArrayByPositionFromErrorData()

assErrorText::generateArrayByPositionFromErrorData ( )

private

Definition at line 904 of file class.assErrorText.php.

Referenced by addPositionToErrorAnswer(), getBestSelection(), and getPointsForSelectedPositions().

                                                            : array
     {
         $array_by_position = [];
         foreach ($this->errordata as $error) {
             $array_by_position[$error->getPosition()] = [
                 'length' => $error->getLength(),
                 'points' => $error->getPoints(),
                 'text' => $error->getTextWrong(),
                 'text_correct' => $error->getTextCorrect()
             ];
         }
         ksort($array_by_position);
         return $array_by_position;
     }

Here is the caller graph for this function:

◆ generateOutputStringFromPosition()

assErrorText::generateOutputStringFromPosition	(	int	$position,
		array	$selections,
		array	$paragraph,
		bool	$graphical_output,
		bool	$show_correct_solution,
		bool	$use_link_tags,
		array	$correctness_icons
	)

private

Definition at line 462 of file class.assErrorText.php.

References getClassForPosition(), getCorrectnessIconForPosition(), getErrorTokenHtml(), and getTextForPosition().

Referenced by assembleErrorTextOutput().

      : string {
         $text = $this->getTextForPosition($position, $paragraph, $show_correct_solution);
         if ($text === '') {
             return '';
         }
         $class = $this->getClassForPosition($position, $show_correct_solution, $selections);
         $img = $this->getCorrectnessIconForPosition(
             $position,
             $graphical_output,
             $selections,
             $correctness_icons
         );
 
         return ' ' . $this->getErrorTokenHtml($text, $class, $use_link_tags) . $img;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalInformationFromExistingErrorDataByErrorText()

assErrorText::getAdditionalInformationFromExistingErrorDataByErrorText	(	array	$current_error_data,
		string	$text_wrong
	)

private

Parameters

array<assAnswerErrorText> $current_error_data

Returns: array<mixed>

Definition at line 422 of file class.assErrorText.php.

Referenced by setErrorsFromParsedErrorText().

      : array {
         foreach ($current_error_data as $answer_object) {
             if (strcmp($answer_object->getTextWrong(), $text_wrong) === 0) {
                 return[
                     $answer_object->getTextCorrect(),
                     $answer_object->getPoints()
                 ];
             }
         }
         return ['', 0.0];
     }

Here is the caller graph for this function:

◆ getAdditionalTableName()

assErrorText::getAdditionalTableName ( )

Definition at line 314 of file class.assErrorText.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                             : string
     {
         return 'qpl_qst_errortext';
     }

Here is the caller graph for this function:

◆ getAnswersFromRequest()

assErrorText::getAnswersFromRequest ( )

private

Definition at line 301 of file class.assErrorText.php.

Referenced by savePreviewData(), and saveWorkingData().

                                             : array
     {
         return explode(
             ',',
             $this->questionpool_request->string('qst_' . $this->getId())
         );
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assErrorText::getAnswerTableName ( )

Definition at line 319 of file class.assErrorText.php.

                                         : string
     {
         return 'qpl_a_errortext';
     }

◆ getAvailableAnswerOptions()

assErrorText::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

Definition at line 886 of file class.assErrorText.php.

References $c, and null.

                                                             : ?int
     {
         $error_text_array = array_reduce(
             $this->parsed_errortext,
             fn($c, $v) => $c + $v
         );
 
         if ($index === null) {
             return $error_text_array;
         }
 
         if (array_key_exists($index, $error_text_array)) {
             return $error_text_array[$index];
         }
 
         return null;
     }

◆ getBestSelection()

assErrorText::getBestSelection ( bool $with_positive_points_only = true )

Definition at line 563 of file class.assErrorText.php.

References generateArrayByPositionFromErrorData().

Referenced by getCorrectSolutionForTextOutput().

                                                                             : array
     {
         $positions_array = $this->generateArrayByPositionFromErrorData();
         $selections = [];
         foreach ($positions_array as $position => $position_data) {
             if ($position === ''
                 || $with_positive_points_only && $position_data['points'] <= 0) {
                 continue;
             }
 
             $selections[] = $position;
             if ($position_data['length'] > 1) {
                 for ($i = 1;$i < $position_data['length'];$i++) {
                     $selections[] = $position + $i;
                 }
             }
         }
 
         return $selections;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassForPosition()

assErrorText::getClassForPosition	(	int	$position,
		bool	$show_correct_solution,
		array	$selections
	)

private

Definition at line 506 of file class.assErrorText.php.

Referenced by generateOutputStringFromPosition().

      : string {
         if ($show_correct_solution !== true
             && in_array($position, $selections['user'])) {
             return 'ilc_qetitem_ErrorTextSelected';
         }
 
         if ($show_correct_solution === true
             && in_array($position, $selections['best'])) {
             return 'ilc_qetitem_ErrorTextSelected';
         }
 
         return 'ilc_qetitem_ErrorTextItem';
     }

Here is the caller graph for this function:

◆ getCorrectnessIconForPosition()

assErrorText::getCorrectnessIconForPosition	(	int	$position,
		bool	$graphical_output,
		array	$selections,
		array	$correctness_icons
	)

private

Definition at line 524 of file class.assErrorText.php.

Referenced by generateOutputStringFromPosition().

      : string {
         if ($graphical_output === true
              && (in_array($position, $selections['user']) && !in_array($position, $selections['best'])
              || !in_array($position, $selections['user']) && in_array($position, $selections['best']))) {
             return $correctness_icons['not_correct'];
         }
 
         if ($graphical_output === true
             && in_array($position, $selections['user']) && in_array($position, $selections['best'])) {
             return $correctness_icons['correct'];
         }
 
         return '';
     }

Here is the caller graph for this function:

◆ getCorrectSolutionForTextOutput()

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

Definition at line 991 of file class.assErrorText.php.

References createErrorTextExport(), and getBestSelection().

                                                                               : string
     {
         return $this->createErrorTextExport($this->getBestSelection());
     }

Here is the call graph for this function:

◆ getErrorData()

assErrorText::getErrorData ( )

Returns: array<assAnswerErrorText>

Definition at line 640 of file class.assErrorText.php.

References $errordata.

Referenced by getErrorDataAsArrayForJS(), removeErrorDataWithoutPosition(), setErrorsFromParsedErrorText(), and toLog().

                                   : array
     {
         return $this->errordata;
     }

Here is the caller graph for this function:

◆ getErrorDataAsArrayForJS()

assErrorText::getErrorDataAsArrayForJS ( )

private

Returns: array<mixed>

Definition at line 649 of file class.assErrorText.php.

References getErrorData(), and assQuestion\getId().

Referenced by toJSON().

                                                : array
     {
         $correct_answers = [];
         foreach ($this->getErrorData() as $index => $answer_obj) {
             $correct_answers[] = [
                 'answertext_wrong' => $answer_obj->getTextWrong(),
                 'answertext_correct' => $answer_obj->getTextCorrect(),
                 'points' => $answer_obj->getPoints(),
                 'length' => $answer_obj->getLength(),
                 'pos' => $this->getId() . '_' . $answer_obj->getPosition()
             ];
         }
         return $correct_answers;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getErrorText()

assErrorText::getErrorText ( )

Definition at line 664 of file class.assErrorText.php.

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

                                   : string
     {
         return $this->errortext ?? '';
     }

Here is the caller graph for this function:

◆ getErrorTokenHtml()

assErrorText::getErrorTokenHtml	(	$item,
		$class,
		$useLinkTags
	)

private

Parameters

$item
$class

Returns: string

Definition at line 924 of file class.assErrorText.php.

References ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by generateOutputStringFromPosition().

                                                                    : string
     {
         if ($useLinkTags) {
             return '<a class="' . $class . '" href="#">' . ($item == '&nbsp;' ? $item : ilLegacyFormElementsUtil::prepareFormOutput(
                 $item
             )) . '</a>';
         }
 
         return '<span class="' . $class . '">' . ($item == '&nbsp;' ? $item : ilLegacyFormElementsUtil::prepareFormOutput(
             $item
         )) . '</span>';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExpressionTypes()

assErrorText::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 756 of file class.assErrorText.php.

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\ExclusiveResultExpression, iQuestionCondition\NumberOfResultExpression, and iQuestionCondition\PercentageResultExpression.

                                         : array
     {
         return [
             iQuestionCondition::PercentageResultExpression,
             iQuestionCondition::NumberOfResultExpression,
             iQuestionCondition::EmptyAnswerExpression,
             iQuestionCondition::ExclusiveResultExpression
         ];
     }

◆ getMaximumPoints()

assErrorText::getMaximumPoints ( )

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

See also: $points

Definition at line 238 of file class.assErrorText.php.

Referenced by getUserQuestionResult(), and isComplete().

                                       : float
     {
         $maxpoints = 0.0;
         foreach ($this->errordata as $error) {
             if ($error->getPoints() > 0) {
                 $maxpoints += $error->getPoints();
             }
         }
         return $maxpoints;
     }

Here is the caller graph for this function:

◆ getOperators()

assErrorText::getOperators ( string $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 751 of file class.assErrorText.php.

                                                     : array
     {
         return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
     }

◆ getParsedErrorText()

assErrorText::getParsedErrorText ( )

Definition at line 674 of file class.assErrorText.php.

References $parsed_errortext.

Referenced by addPositionToErrorAnswer(), assembleErrorTextOutput(), completeParsedErrorTextFromErrorData(), correctDataAfterParserUpdate(), createErrorTextExport(), saveAdditionalQuestionDataToDb(), and setErrorsFromParsedErrorText().

                                         : array
     {
         return $this->parsed_errortext;
     }

Here is the caller graph for this function:

◆ getParsedErrorTextForJS()

assErrorText::getParsedErrorTextForJS ( )

private

Definition at line 679 of file class.assErrorText.php.

References assQuestion\getId().

Referenced by toJSON().

                                               : array
     {
         $answers = [];
         foreach ($this->parsed_errortext as $paragraph) {
             foreach ($paragraph as $position => $word) {
                 $answers[] = [
                     'answertext' => $word['text'],
                     'order' => $this->getId() . '_' . $position
                 ];
             }
             $answers[] = [
                 'answertext' => '###'
             ];
         }
         array_pop($answers);
 
         return $answers;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPointsForSelectedPositions()

assErrorText::getPointsForSelectedPositions ( array $selected_word_positions )

protected

Parameters

list<string>|null $selected_words Positions of Selected Words Counting from 0

Definition at line 588 of file class.assErrorText.php.

References assQuestion\$points, generateArrayByPositionFromErrorData(), and getPointsWrong().

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

                                                                                     : float
     {
         $points = 0;
         $correct_positions = $this->generateArrayByPositionFromErrorData();
 
         foreach ($correct_positions as $correct_position => $correct_position_data) {
             $selected_word_key = array_search($correct_position, $selected_word_positions);
             if ($selected_word_key === false) {
                 continue;
             }
 
             if ($correct_position_data['length'] === 1) {
                 $points += $correct_position_data['points'];
                 unset($selected_word_positions[$selected_word_key]);
                 continue;
             }
 
             $passage_complete = true;
             for ($i = 1;$i < $correct_position_data['length'];$i++) {
                 $selected_passage_element_key = array_search($correct_position + $i, $selected_word_positions);
                 if ($selected_passage_element_key === false) {
                     $passage_complete = false;
                     continue;
                 }
                 unset($selected_word_positions[$selected_passage_element_key]);
             }
 
             if ($passage_complete) {
                 $points += $correct_position_data['points'];
                 unset($selected_word_positions[$selected_word_key]);
             }
         }
 
         foreach ($selected_word_positions as $word_position) {
             if (!array_key_exists($word_position, $correct_positions)) {
                 $points += $this->getPointsWrong();
                 continue;
             }
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPointsWrong()

assErrorText::getPointsWrong ( )

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

References $points_wrong.

Referenced by addErrorInformationToTextParagraphArray(), getPointsForSelectedPositions(), and saveAdditionalQuestionDataToDb().

                                     : ?float
     {
         return $this->points_wrong;
     }

Here is the caller graph for this function:

◆ getQuestionType()

assErrorText::getQuestionType ( )

Definition at line 309 of file class.assErrorText.php.

Referenced by toJSON(), and toLog().

                                      : string
     {
         return 'assErrorText';
     }

Here is the caller graph for this function:

◆ getTextForPosition()

assErrorText::getTextForPosition	(	int	$position,
		array	$paragraph,
		bool	$show_correct_solution
	)

private

Definition at line 486 of file class.assErrorText.php.

Referenced by generateOutputStringFromPosition().

      : string {
         $v = $paragraph[$position];
         if ($show_correct_solution === true
             && ($v['error_type'] === 'in_passage'
             || $v['error_type'] === 'passage_end')) {
             return '';
         }
         if ($show_correct_solution
             && ($v['error_type'] === 'passage_start'
             || $v['error_type'] === 'word')) {
             return $v['text_correct'] ?? '';
         }
 
         return $v['text'];
     }

Here is the caller graph for this function:

◆ getTextSize()

assErrorText::getTextSize ( )

Definition at line 703 of file class.assErrorText.php.

References $textsize.

Referenced by saveAdditionalQuestionDataToDb().

                                  : float
     {
         return $this->textsize;
     }

Here is the caller graph for this function:

◆ getUserQuestionResult()

assErrorText::getUserQuestionResult	(	int	$active_id,
		int	$pass
	)

Get the user solution for a question by active_id and the test pass.

Implements iQuestionCondition.

Definition at line 766 of file class.assErrorText.php.

References $data, assQuestion\$points, calculateReachedPoints(), assQuestion\getId(), and getMaximumPoints().

      : ilUserQuestionResult {
         $result = new ilUserQuestionResult($this, $active_id, $pass);
 
         $data = $this->db->queryF(
             "SELECT value1+1 as value1 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = (
                                 SELECT MAX(step) FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s
                         )",
             ["integer", "integer", "integer","integer", "integer", "integer"],
             [$active_id, $pass, $this->getId(), $active_id, $pass, $this->getId()]
         );
 
         while ($row = $this->db->fetchAssoc($data)) {
             $result->addKeyValue($row["value1"], $row["value1"]);
         }
 
         $points = $this->calculateReachedPoints($active_id, $pass);
         $max_points = $this->getMaximumPoints();
 
         $result->setReachedPercentage(($points / $max_points) * 100);
 
         return $result;
     }

Here is the call graph for this function:

◆ isComplete()

assErrorText::isComplete ( )

Definition at line 71 of file class.assErrorText.php.

References getMaximumPoints().

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

Here is the call graph for this function:

◆ loadFromDb()

assErrorText::loadFromDb ( $question_id )

Loads the object from the database.

Parameters

object	$db	A pear DB object
integer	$question_id	A unique key which defines the multiple choice test in the database

Definition at line 150 of file class.assErrorText.php.

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), correctDataAfterParserUpdate(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), setErrorText(), assQuestion\setId(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), setParsedErrorText(), assQuestion\setPoints(), setPointsWrong(), assQuestion\setQuestion(), setTextSize(), and assQuestion\setTitle().

                                             : void
     {
         $db_question = $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 ($db_question->numRows() === 1) {
             $data = $this->db->fetchAssoc($db_question);
             $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($data["points"]);
             $this->setOwner($data["owner"]);
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));
             $this->setErrorText((string) $data["errortext"]);
             $this->setParsedErrorText(json_decode($data['parsed_errortext'] ?? json_encode([]), true));
             $this->setTextSize($data["textsize"]);
             $this->setPointsWrong($data["points_wrong"]);
 
             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) {
             }
         }
 
         $db_error_text = $this->db->queryF(
             "SELECT * FROM qpl_a_errortext WHERE question_fi = %s ORDER BY sequence ASC",
             ['integer'],
             [$question_id]
         );
 
         if ($db_error_text->numRows() > 0) {
             while ($data = $this->db->fetchAssoc($db_error_text)) {
                 $this->errordata[] = new assAnswerErrorText(
                     (string) $data['text_wrong'],
                     (string) $data['text_correct'],
                     (float) $data['points'],
                     $data['position']
                 );
             }
         }
 
         $this->correctDataAfterParserUpdate();
 
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ parseErrorText()

assErrorText::parseErrorText ( )

Definition at line 792 of file class.assErrorText.php.

References addErrorInformationToTextParagraphArray(), getErrorText(), and setParsedErrorText().

Referenced by correctDataAfterParserUpdate().

                                     : void
     {
         $text_by_paragraphs = preg_split(self::PARAGRAPH_SPLIT_REGEXP, $this->getErrorText());
         $text_array = [];
         $offset = 0;
         foreach ($text_by_paragraphs as $paragraph) {
             $text_array[] = $this->addErrorInformationToTextParagraphArray(
                 preg_split(self::WORD_SPLIT_REGEXP, trim($paragraph)),
                 $offset
             );
             $offset += count(end($text_array));
         }
         $this->setParsedErrorText($text_array);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parsePassageEndWord()

assErrorText::parsePassageEndWord ( string $word )

private

Definition at line 871 of file class.assErrorText.php.

Referenced by addErrorInformationToTextParagraphArray().

                                                       : string
     {
         if (mb_substr($word, -2) === self::ERROR_PARAGRAPH_DELIMITERS['end']) {
             return mb_substr($word, 0, -2);
         }
         return mb_substr($word, 0, -3) . mb_substr($word, -1);
     }

Here is the caller graph for this function:

◆ removeErrorDataWithoutPosition()

assErrorText::removeErrorDataWithoutPosition ( )

Definition at line 407 of file class.assErrorText.php.

References getErrorData(), and null.

                                                     : void
     {
         foreach ($this->getErrorData() as $index => $error) {
             if ($error->getPosition() === null) {
                 unset($this->errordata[$index]);
             }
         }
         $this->errordata = array_values($this->errordata);
     }

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assErrorText::saveAdditionalQuestionDataToDb ( )

Saves the data for the additional data table.

This method uses the ugly DELETE-INSERT. Here, this does no harm.

Implements ilObjQuestionScoringAdjustable.

Definition at line 123 of file class.assErrorText.php.

References getAdditionalTableName(), getErrorText(), assQuestion\getId(), getParsedErrorText(), getPointsWrong(), and getTextSize().

Referenced by correctDataAfterParserUpdate(), and saveToDb().

     {
         $this->db->manipulateF(
             "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
             ["integer"],
             [$this->getId()]
         );
 
         $this->db->manipulateF(
             "INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, errortext, parsed_errortext, textsize, points_wrong) VALUES (%s, %s, %s, %s, %s)",
             ["integer", "text", "text", "float", "float"],
             [
                 $this->getId(),
                 $this->getErrorText(),
                 json_encode($this->getParsedErrorText()),
                 $this->getTextSize(),
                 $this->getPointsWrong()
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assErrorText::saveAnswerSpecificDataToDb ( )

Saves the answer specific records into a question types answer table.

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 91 of file class.assErrorText.php.

References assQuestion\getId().

Referenced by correctDataAfterParserUpdate(), and saveToDb().

     {
         $this->db->manipulateF(
             "DELETE FROM qpl_a_errortext WHERE question_fi = %s",
             ['integer'],
             [$this->getId()]
         );
 
         $sequence = 0;
         foreach ($this->errordata as $error) {
             $next_id = $this->db->nextId('qpl_a_errortext');
             $this->db->manipulateF(
                 "INSERT INTO qpl_a_errortext (answer_id, question_fi, text_wrong, text_correct, points, sequence, position) VALUES (%s, %s, %s, %s, %s, %s, %s)",
                 ['integer', 'integer', 'text', 'text', 'float', 'integer', 'integer'],
                 [
                     $next_id,
                     $this->getId(),
                     $error->getTextWrong(),
                     $error->getTextCorrect(),
                     $error->getPoints(),
                     $sequence++,
                     $error->getPosition()
                 ]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assErrorText::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

Definition at line 295 of file class.assErrorText.php.

References getAnswersFromRequest(), and ilAssQuestionPreviewSession\setParticipantsSolution().

                                                                                 : void
     {
         $selection = $this->getAnswersFromRequest();
         $previewSession->setParticipantsSolution($selection);
     }

Here is the call graph for this function:

◆ saveToDb()

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

Definition at line 83 of file class.assErrorText.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

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

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

      : bool {
         if (is_null($pass)) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use ($active_id, $pass, $authorized) {
                 $selected = $this->getAnswersFromRequest();
                 $this->removeCurrentSolution($active_id, $pass, $authorized);
                 foreach ($selected as $position) {
                     $this->saveCurrentSolution($active_id, $pass, $position, null, $authorized);
                 }
             }
         );
 
         return true;
     }

Here is the call graph for this function:

◆ setErrorData()

assErrorText::setErrorData ( array $errors )

Parameters

array<assAnswerErrorText> $errors

Definition at line 396 of file class.assErrorText.php.

References addPositionToErrorAnswer(), and completeParsedErrorTextFromErrorData().

                                                : void
     {
         $this->errordata = [];
 
         foreach ($errors as $error) {
             $answer = $this->addPositionToErrorAnswer($error);
             $this->errordata[] = $answer;
         }
         $this->completeParsedErrorTextFromErrorData();
     }

Here is the call graph for this function:

◆ setErrorsFromParsedErrorText()

assErrorText::setErrorsFromParsedErrorText ( )

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

References assQuestion\$points, getAdditionalInformationFromExistingErrorDataByErrorText(), getErrorData(), getParsedErrorText(), and ILIAS\Repository\lng().

                                                   : void
     {
         $current_error_data = $this->getErrorData();
         $this->errordata = [];
 
         $has_too_long_errors = false;
         foreach ($this->getParsedErrorText() as $paragraph) {
             foreach ($paragraph as $position => $word) {
                 if ($word['error_type'] === 'in_passage'
                     || $word['error_type'] === 'passage_end'
                     || $word['error_type'] === 'none') {
                     continue;
                 }
 
                 $text_wrong = $word['text_wrong'];
                 if (mb_strlen($text_wrong) > self::ERROR_MAX_LENGTH) {
                     $has_too_long_errors = true;
                     continue;
                 }
 
                 list($text_correct, $points) =
                     $this->getAdditionalInformationFromExistingErrorDataByErrorText($current_error_data, $text_wrong);
                 $this->errordata[] = new assAnswerErrorText($text_wrong, $text_correct, $points, $position);
             }
         }
 
         if ($has_too_long_errors) {
             $this->tpl->setOnScreenMessage(
                 'failure',
                 $this->lng->txt('qst_error_text_too_long')
             );
         }
     }

Here is the call graph for this function:

◆ setErrorText()

assErrorText::setErrorText ( ?string $text )

Definition at line 669 of file class.assErrorText.php.

Referenced by loadFromDb().

                                                : void
     {
         $this->errortext = $text ?? '';
     }

Here is the caller graph for this function:

◆ setParsedErrorText()

assErrorText::setParsedErrorText ( array $parsed_errortext )

Definition at line 698 of file class.assErrorText.php.

References $parsed_errortext.

Referenced by loadFromDb(), and parseErrorText().

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

Here is the caller graph for this function:

◆ setPointsWrong()

assErrorText::setPointsWrong ( $a_value )

Definition at line 722 of file class.assErrorText.php.

Referenced by loadFromDb().

                                             : void
     {
         $this->points_wrong = $a_value;
     }

Here is the caller graph for this function:

◆ setTextSize()

assErrorText::setTextSize ( $a_value )

Definition at line 708 of file class.assErrorText.php.

References null.

Referenced by loadFromDb().

                                          : void
     {
         // in self-assesment-mode value should always be set (and must not be null)
         if ($a_value === null) {
             $a_value = 100;
         }
         $this->textsize = $a_value;
     }

Here is the caller graph for this function:

◆ solutionValuesToLog()

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

protected

Definition at line 969 of file class.assErrorText.php.

References createErrorTextExport().

      : string {
         return $this->createErrorTextExport(
             array_map(
                 static fn(array $v): string => $v['value1'],
                 $solution_values
             )
         );
     }

Here is the call graph for this function:

◆ solutionValuesToText()

assErrorText::solutionValuesToText ( array $solution_values )

Definition at line 981 of file class.assErrorText.php.

References createErrorTextExport().

                                                                 : string
     {
         return $this->createErrorTextExport(
             array_map(
                 static fn(array $v): string => $v['value1'],
                 $solution_values
             )
         );
     }

Here is the call graph for this function:

◆ toJSON()

assErrorText::toJSON ( )

Implements ILIAS\TestQuestionPool\Questions\QuestionLMExportable.

Definition at line 727 of file class.assErrorText.php.

References ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), assQuestion\formatSAQuestion(), getErrorDataAsArrayForJS(), getErrorText(), assQuestion\getId(), assQuestion\getNrOfTries(), getParsedErrorTextForJS(), 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['text'] = ilRTE::_replaceMediaObjectImageSrc($this->getErrorText(), 0);
         $result['nr_of_tries'] = $this->getNrOfTries();
         $result['shuffle'] = $this->getShuffle();
         $result['feedback'] = [
             'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
             'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
         ];
 
         $result['correct_answers'] = $this->getErrorDataAsArrayForJS();
         $result['answers'] = $this->getParsedErrorTextForJS();
 
         $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
         $result['mobs'] = $mobs;
 
         return json_encode($result);
     }

Here is the call graph for this function:

◆ toLog()

assErrorText::toLog ( AdditionalInformationGenerator $additional_info )

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 937 of file class.assErrorText.php.

References $c, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\formatSAQuestion(), getErrorData(), getErrorText(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), assQuestion\getTitleForHTMLOutput(), and ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool().

                                                                           : array
     {
         $result = [
             AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
             AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
             AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
             AdditionalInformationGenerator::KEY_QUESTION_ERRORTEXT_ERRORTEXT => ilRTE::_replaceMediaObjectImageSrc($this->getErrorText(), 0),
             AdditionalInformationGenerator::KEY_QUESTION_SHUFFLE_ANSWER_OPTIONS => $additional_info
                 ->getTrueFalseTagForBool($this->getShuffle()),
             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))
             ]
         ];
 
         $error_data = $this->getErrorData();
         $result[AdditionalInformationGenerator::KEY_QUESTION_CORRECT_ANSWER_OPTIONS] = array_reduce(
             array_keys($error_data),
             static function (array $c, int $k) use ($error_data): array {
                 $c[$k + 1] = [
                     'text_wrong' => $error_data[$k]->getTextWrong(),
                     'text_correct' => $error_data[$k]->getTextCorrect(),
                     'points' => $error_data[$k]->getPoints()
                 ];
                 return $c;
             },
             []
         );
 
         return $result;
     }

Here is the call graph for this function:

Field Documentation

◆ $errordata

array assErrorText::$errordata = []

protected

Definition at line 56 of file class.assErrorText.php.

Referenced by getErrorData().

◆ $errortext

const string assErrorText::$errortext = ''

protected

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

◆ $parsed_errortext

array assErrorText::$parsed_errortext = []

protected

Definition at line 54 of file class.assErrorText.php.

Referenced by getParsedErrorText(), and setParsedErrorText().

◆ $points_wrong

float assErrorText::$points_wrong = null

protected

Definition at line 58 of file class.assErrorText.php.

Referenced by getPointsWrong().

◆ $textsize

float assErrorText::$textsize

protected

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

Referenced by getTextSize().

◆ DEFAULT_TEXT_SIZE

const assErrorText::DEFAULT_TEXT_SIZE = 100.0

protected

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

◆ ERROR_MAX_LENGTH

const assErrorText::ERROR_MAX_LENGTH = 150

protected

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

◆ ERROR_PARAGRAPH_DELIMITERS

const assErrorText::ERROR_PARAGRAPH_DELIMITERS

protected

Initial value:

= [

'start' => '(('

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

◆ ERROR_TYPE_PASSAGE

const assErrorText::ERROR_TYPE_PASSAGE = 2

protected

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

◆ ERROR_TYPE_WORD

const assErrorText::ERROR_TYPE_WORD = 1

protected

Definition at line 39 of file class.assErrorText.php.

◆ ERROR_WORD_MARKER

const assErrorText::ERROR_WORD_MARKER = '#'

protected

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

◆ FIND_PUNCTUATION_REGEXP

const assErrorText::FIND_PUNCTUATION_REGEXP = '/\p{P}/'

protected

Definition at line 46 of file class.assErrorText.php.

◆ PARAGRAPH_SPLIT_REGEXP

const assErrorText::PARAGRAPH_SPLIT_REGEXP = '/[\n\r]+/'

protected

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

◆ WORD_SPLIT_REGEXP

const assErrorText::WORD_SPLIT_REGEXP = '/\s+/'

protected

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addErrorInformationToTextParagraphArray()

◆ addPositionToErrorAnswer()

◆ assembleErrorTextOutput()

◆ calculateReachedPoints()

◆ calculateReachedPointsFromPreviewSession()

◆ completeParsedErrorTextFromErrorData()

◆ correctDataAfterParserUpdate()

◆ createErrorTextExport()

◆ flushErrorData()

◆ generateArrayByPositionFromErrorData()

◆ generateOutputStringFromPosition()

◆ getAdditionalInformationFromExistingErrorDataByErrorText()

◆ getAdditionalTableName()

◆ getAnswersFromRequest()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getBestSelection()

◆ getClassForPosition()

◆ getCorrectnessIconForPosition()

◆ getCorrectSolutionForTextOutput()

◆ getErrorData()

◆ getErrorDataAsArrayForJS()

◆ getErrorText()

◆ getErrorTokenHtml()

◆ getExpressionTypes()

◆ getMaximumPoints()

◆ getOperators()

◆ getParsedErrorText()

◆ getParsedErrorTextForJS()

◆ getPointsForSelectedPositions()

◆ getPointsWrong()

◆ getQuestionType()

◆ getTextForPosition()

◆ getTextSize()

◆ getUserQuestionResult()

◆ isComplete()

◆ loadFromDb()

◆ parseErrorText()

◆ parsePassageEndWord()

◆ removeErrorDataWithoutPosition()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setErrorData()

◆ setErrorsFromParsedErrorText()

◆ setErrorText()

◆ setParsedErrorText()

◆ setPointsWrong()

◆ setTextSize()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

Field Documentation

◆ $errordata

◆ $errortext

◆ $parsed_errortext

◆ $points_wrong

◆ $textsize

◆ DEFAULT_TEXT_SIZE

◆ ERROR_MAX_LENGTH

◆ ERROR_PARAGRAPH_DELIMITERS

◆ ERROR_TYPE_PASSAGE

◆ ERROR_TYPE_WORD

◆ ERROR_WORD_MARKER

◆ FIND_PUNCTUATION_REGEXP

◆ PARAGRAPH_SPLIT_REGEXP

◆ WORD_SPLIT_REGEXP