Inheritance diagram for assLongMenu:

Collaboration diagram for assLongMenu:

Public Member Functions
	getAnswerType ()

	setAnswerType (array $answerType)

	getCorrectAnswers ()

	setCorrectAnswers (array $correct_answers)

	getAnswerTableName ()

	setLongMenuTextValue (string $long_menu_text='')

	getLongMenuTextValue ()

	setAnswers (array $answers)

	getAnswers ()

	getJsonStructure ()

	setSpecificFeedbackSetting ($specificFeedbackSetting)

	getSpecificFeedbackSetting ()

	setMinAutoComplete (int $min_auto_complete)

	getMinAutoComplete ()

	isComplete ()

	saveToDb (?int $original_id=null)

	checkQuestionCustomPart ($form=null)

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

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

	saveAnswerSpecificDataToDb ()

	loadFromDb ($question_id)

	getCorrectAnswersForQuestionSolution ($question_id)

	getAnswersObject ()

	getCorrectAnswersAsJson ()

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

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

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

	getQuestionType ()
	Returns the question type of the question. More...

	getAdditionalTableName ()

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

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

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

	isShuffleAnswersEnabled ()

	clearAnswerSpecificDataFromDb (int $question_id)

	delete (int $question_id)

	toJSON ()
	Returns a JSON representation of the question. More...

	getIdenticalScoring ()

	setIdenticalScoring (bool $identical_scoring)

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

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

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	toNormalized (Transformations $transformations, array $context=[])

	fromNormalized (array $normalized, Transformations $transformations)

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)

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

	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)

	updateOriginalId (?int $original_id=null)

	duplicate (bool $set_original_id=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)

	toNormalized (Transformations $transformations, array $context=[])

	fromNormalized (array $normalized, Transformations $transformations)

	validateSolutionSubmit ()

	toLog (AdditionalInformationGenerator $additional_info)

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

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

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

	toJSON ()

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

Data Fields
const	ANSWER_TYPE_SELECT_VAL = 0

const	ANSWER_TYPE_TEXT_VAL = 1

const	GAP_PLACEHOLDER = 'Longmenu'

const	MIN_LENGTH_AUTOCOMPLETE = 3

const	MAX_INPUT_FIELDS = 500

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 (?array $found_values, int $active_id=0)

	getSolutionSubmit ()

	savePreviewData (ilAssQuestionPreviewSession $preview_session)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

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

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

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

	buildFileName ($gap_id)

	setJsonStructure (string $json_structure)

	correctAnswerDoesNotExistInAnswerOptions ($answers, $answer_options)

	createFileFromArray ()

	createArrayFromFile ()

	clearFolder ($let_folder_exists=true)

	assertDirExists ()

	loadCorrectAnswerData ($question_id)

	getCorrectAnswersForGap ($question_id, $gap_id)

	getPointsForGap ($question_id, $gap_id)

	getAnswersForLog (AdditionalInformationGenerator $additional_info)

	getCorrectAnswersForLog (AdditionalInformationGenerator $additional_info)

Private Attributes
array	$answerType = null

string	$long_menu_text = ''

string	$json_structure = ''

int	$specificFeedbackSetting = ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL

int	$minAutoComplete = self::MIN_LENGTH_AUTOCOMPLETE

bool	$identical_scoring = true

array	$correct_answers = []

array	$answers = []

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

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

Definition at line 28 of file class.assLongMenu.php.

Member Function Documentation

◆ assertDirExists()

assLongMenu::assertDirExists ( )

private

Definition at line 347 of file class.assLongMenu.php.

                                      : void
    {
        $folder_name = $this->buildFolderName();
        if (!ilFileUtils::makeDirParents($folder_name)) {
            throw new ilException('Cannot create export directory');
        }
 
        if (
            !is_dir($folder_name) ||
            !is_readable($folder_name) ||
            !is_writable($folder_name)
        ) {
            throw new ilException('Cannot create export directory');
        }
    }

References buildFolderName(), and ilFileUtils\makeDirParents().

Referenced by buildFileName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFileName()

assLongMenu::buildFileName ( $gap_id )

private

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

                                           : ?string
    {
        try {
            $this->assertDirExists();
            return $this->buildFolderName() . $gap_id . '.txt';
        } catch (ilException $e) {
        }
        return null;
    }

References Vendor\Package\$e, assertDirExists(), and buildFolderName().

Referenced by createFileFromArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFolderName()

assLongMenu::buildFolderName ( )

private

Definition at line 73 of file class.assLongMenu.php.

                                      : string
    {
        return ilFileUtils::getDataDir() . '/assessment/longMenuQuestion/' . $this->getId() . '/' ;
    }

References ilFileUtils\getDataDir(), and assQuestion\getId().

Referenced by assertDirExists(), buildFileName(), clearFolder(), and createArrayFromFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPoints()

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

Reimplemented from assQuestion.

Definition at line 483 of file class.assLongMenu.php.

     : float {
        $found_values = [];
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);
        while ($data = $this->db->fetchAssoc($result)) {
            $found_values[(int) $data['value1']] = $data['value2'];
        }
 
        return $this->calculateReachedPointsForSolution($found_values, $active_id);
    }

References assQuestion\getSolutionMaxPass().

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assLongMenu::calculateReachedPointsForSolution	(	?array	$found_values,
		int	$active_id = `0`
	)

protected

Definition at line 500 of file class.assLongMenu.php.

                                                                                                  : float
    {
        if ($found_values == null) {
            $found_values = [];
        }
        $points = 0.0;
        $solution_values_text = [];
        foreach ($found_values as $key => $answer) {
            if ($answer === '') {
                continue;
            }
 
            $correct_answers = $this->getCorrectAnswersForGap($this->id, $key);
            if (!in_array($answer, $correct_answers)) {
                continue;
            }
 
            $points_gap = $this->getPointsForGap($this->id, $key);
            if (!$this->getIdenticalScoring()
                && in_array($answer, $solution_values_text)
                && ($points > 0)) {
                $points_gap = 0;
            }
 
            $points += $points_gap;
            array_push($solution_values_text, $answer);
        }
 
        return $points;
    }

◆ checkQuestionCustomPart()

assLongMenu::checkQuestionCustomPart ( $form = null )

Parameters

ilPropertyFormGUI | null $form

Returns: bool

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

                                                         : bool
    {
        $hidden_text_files = $this->getAnswers();
        $correct_answers = $this->getCorrectAnswers();
        $points = [];
        if ($correct_answers === null
            || $correct_answers === []
            || $hidden_text_files === null
            || $hidden_text_files === []) {
            return false;
        }
        if (sizeof($correct_answers) != sizeof($hidden_text_files)) {
            return false;
        }
        foreach ($correct_answers as $key => $correct_answers_row) {
            if ($this->correctAnswerDoesNotExistInAnswerOptions($correct_answers_row, $hidden_text_files[$key])) {
                return false;
            }
            if (!is_array($correct_answers_row[0]) || $correct_answers_row[0] === []) {
                return false;
            }
            if ($correct_answers_row[1] > 0) {
                array_push($points, $correct_answers_row[1]);
            }
        }
        if (sizeof($correct_answers) != sizeof($points)) {
            return false;
        }
 
        foreach ($points as $row) {
            if ($row <= 0) {
                return false;
            }
        }
        return true;
    }

References $correct_answers, assQuestion\$points, correctAnswerDoesNotExistInAnswerOptions(), getAnswers(), and getCorrectAnswers().

Here is the call graph for this function:

◆ clearAnswerSpecificDataFromDb()

assLongMenu::clearAnswerSpecificDataFromDb ( int $question_id )

Definition at line 677 of file class.assLongMenu.php.

                                                                   : void
    {
        $this->db->manipulateF(
            'DELETE FROM ' . $this->getAnswerTableName() . ' WHERE question_fi = %s',
            [ 'integer' ],
            [ $question_id ]
        );
    }

Referenced by saveAnswerSpecificDataToDb().

Here is the caller graph for this function:

◆ clearFolder()

assLongMenu::clearFolder ( $let_folder_exists = true )

private

Definition at line 342 of file class.assLongMenu.php.

                                                           : void
    {
        ilFileUtils::delDir($this->buildFolderName(), $let_folder_exists);
    }

References buildFolderName(), and ilFileUtils\delDir().

Referenced by createFileFromArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctAnswerDoesNotExistInAnswerOptions()

assLongMenu::correctAnswerDoesNotExistInAnswerOptions	(	$answers,
		$answer_options
	)

private

Parameters

$answers
$answer_options

Returns: bool

Definition at line 217 of file class.assLongMenu.php.

                                                                                        : bool
    {
        foreach ($answers[0] as $key => $answer) {
            if (!in_array($answer, $answer_options)) {
                return true;
            }
        }
        return false;
    }

References $answers.

Referenced by checkQuestionCustomPart().

Here is the caller graph for this function:

◆ createArrayFromFile()

assLongMenu::createArrayFromFile ( )

private

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

                                          : array
    {
        $files = glob($this->buildFolderName() . '*.txt');
 
        if ($files === false) {
            $files = [];
        }
 
        $answers = [];
 
        foreach ($files as $file) {
            $gap = str_replace('.txt', '', basename($file));
            $answers[(int) $gap] = explode("\n", file_get_contents($file));
        }
        // Sort by gap keys, to ensure the numbers are in ascending order.
        // Glob will report the keys in files order like 0, 1, 10, 11, 2,...
        // json_encoding the array with keys in order 0,1,10,11,2,.. will create
        // a json_object instead of a list when keys are numeric, sorted and start with 0
        ksort($answers);
        $this->setAnswers($answers);
        return $answers;
    }

References $answers, $files, buildFolderName(), ILIAS\Repository\int(), and setAnswers().

Referenced by getAnswersObject(), and loadFromDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFileFromArray()

assLongMenu::createFileFromArray ( )

private

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

                                          : void
    {
        $array = $this->getAnswers();
        $this->clearFolder();
        foreach ($array as $gap => $values) {
            $file_content = '';
            if (is_array($values)) {
                foreach ($values as $key => $value) {
                    $file_content .= $value . "\n";
                }
                $file_content = rtrim($file_content, "\n");
                $file = fopen($this->buildFileName($gap), "w");
                fwrite($file, $file_content);
                fclose($file);
            }
        }
    }

References buildFileName(), clearFolder(), and getAnswers().

Referenced by saveAdditionalQuestionDataToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

assLongMenu::delete ( int $question_id )

Reimplemented from assQuestion.

Definition at line 686 of file class.assLongMenu.php.

                                            : void
    {
        parent::delete($question_id);
        $this->clearFolder(false);
    }

◆ fromNormalized()

assLongMenu::fromNormalized	(	array	$normalized,
		Transformations	$transformations
	)

Parameters

array<array-key,mixed> $normalized

Reimplemented from assQuestion.

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

     : static
    {
        $clone = parent::fromNormalized($normalized, $transformations);
        $clone->long_menu_text = $transformations->string($normalized['long_menu_text']);
        $clone->json_structure = $transformations->string($normalized['json_structure']);
        $clone->minAutoComplete = $transformations->int($normalized['min_auto_complete']);
        $clone->identical_scoring = $transformations->bool($normalized['identical_scoring']);
        $clone->correct_answers = $normalized['correct_answers'];
        $clone->answers = $normalized['answers'];
 
        return $clone;
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\bool(), ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\int(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\string().

Here is the call graph for this function:

◆ getAdditionalTableName()

assLongMenu::getAdditionalTableName ( )

Reimplemented from assQuestion.

Definition at line 625 of file class.assLongMenu.php.

                                            : string
    {
        return 'qpl_qst_lome';
    }

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getAnswers()

assLongMenu::getAnswers ( )

Definition at line 108 of file class.assLongMenu.php.

                                : array
    {
        return $this->answers;
    }

References $answers.

Referenced by checkQuestionCustomPart(), and createFileFromArray().

Here is the caller graph for this function:

◆ getAnswersForLog()

assLongMenu::getAnswersForLog ( AdditionalInformationGenerator $additional_info )

private

Definition at line 754 of file class.assLongMenu.php.

                                                                                      : string
    {
        $i = 1;
        return array_reduce(
            $this->getAnswers(),
            static function (string $c, array $v) use ($additional_info, &$i): string {
                return $c . $additional_info->getTagForLangVar('gap')
                    . ' ' . $i++ . ': ' . implode(',', $v) . '; ';
            },
            ''
        );
    }

References Vendor\Package\$c, and ILIAS\Test\Logging\AdditionalInformationGenerator\getTagForLangVar().

Here is the call graph for this function:

◆ getAnswersObject()

assLongMenu::getAnswersObject ( )

Definition at line 472 of file class.assLongMenu.php.

    {
        return json_encode($this->createArrayFromFile());
    }

References createArrayFromFile().

Here is the call graph for this function:

◆ getAnswerTableName()

assLongMenu::getAnswerTableName ( )

Reimplemented from assQuestion.

Definition at line 78 of file class.assLongMenu.php.

                                        : string
    {
        return "qpl_a_lome";
    }

Referenced by getCorrectAnswersForGap(), getCorrectAnswersForQuestionSolution(), getPointsForGap(), and saveAnswerSpecificDataToDb().

Here is the caller graph for this function:

◆ getAnswerType()

assLongMenu::getAnswerType ( )

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

                                   : ?array
    {
        return $this->answerType;
    }

References $answerType.

Referenced by saveAnswerSpecificDataToDb().

Here is the caller graph for this function:

◆ getAvailableAnswerOptions()

assLongMenu::getAvailableAnswerOptions ( $index = null )

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

Parameters

null | int $index

Returns: array|ASS_AnswerSimple

Definition at line 667 of file class.assLongMenu.php.

    {
        return $this->createArrayFromFile();
    }

◆ getCorrectAnswers()

assLongMenu::getCorrectAnswers ( )

Returns: mixed

Definition at line 62 of file class.assLongMenu.php.

    {
        return $this->correct_answers;
    }

References $correct_answers.

Referenced by checkQuestionCustomPart(), getMaximumPoints(), and saveAnswerSpecificDataToDb().

Here is the caller graph for this function:

◆ getCorrectAnswersAsJson()

assLongMenu::getCorrectAnswersAsJson ( )

Definition at line 477 of file class.assLongMenu.php.

    {
        $this->loadCorrectAnswerData($this->getId());
        return $this->getJsonStructure();
    }

References assQuestion\getId(), getJsonStructure(), and loadCorrectAnswerData().

Here is the call graph for this function:

◆ getCorrectAnswersForGap()

assLongMenu::getCorrectAnswersForGap	(	$question_id,
		$gap_id
	)

private

Definition at line 443 of file class.assLongMenu.php.

                                                                   : array
    {
        $correct_answers = [];
        $res = $this->db->queryF(
            'SELECT answer_text FROM  ' . $this->getAnswerTableName() . ' WHERE question_fi = %s AND gap_number = %s',
            ['integer', 'integer'],
            [$question_id, $gap_id]
        );
        while ($data = $this->db->fetchAssoc($res)) {
            $correct_answers[] = rtrim($data['answer_text']);
        }
        return $correct_answers;
    }

References $correct_answers, $data, $res, and getAnswerTableName().

Here is the call graph for this function:

◆ getCorrectAnswersForLog()

assLongMenu::getCorrectAnswersForLog ( AdditionalInformationGenerator $additional_info )

private

Definition at line 767 of file class.assLongMenu.php.

                                                                                             : string
    {
        $answer_types = [
            self::ANSWER_TYPE_SELECT_VAL => $additional_info->getTagForLangVar('answers_select'),
            self::ANSWER_TYPE_TEXT_VAL => $additional_info->getTagForLangVar('answers_text_box')
        ];
 
        $i = 1;
        return array_reduce(
            $this->getCorrectAnswers(),
            static function (string $c, array $v) use ($additional_info, $answer_types, &$i): string {
                return $c . $additional_info->getTagForLangVar('gap')
                    . ' ' . $i++ . ': ' . implode(',', $v[0]) . ', '
                    . $additional_info->getTagForLangVar('points') . ': ' . $v[1] . ', '
                    . $additional_info->getTagForLangVar('type') . ': ' . $answer_types[$v[2]] . '; ';
            },
            ''
        );
    }

References Vendor\Package\$c, and ILIAS\Test\Logging\AdditionalInformationGenerator\getTagForLangVar().

Here is the call graph for this function:

◆ getCorrectAnswersForQuestionSolution()

assLongMenu::getCorrectAnswersForQuestionSolution ( $question_id )

Definition at line 424 of file class.assLongMenu.php.

                                                                      : array
    {
        $correct_answers = [];
        $res = $this->db->queryF(
            'SELECT gap_number, answer_text FROM  ' . $this->getAnswerTableName() . ' WHERE question_fi = %s',
            ['integer'],
            [$question_id]
        );
        while ($data = $this->db->fetchAssoc($res)) {
            if (array_key_exists($data['gap_number'], $correct_answers)) {
                $correct_answers[$data['gap_number']] .= ' ' . $this->lng->txt("or") . ' ';
                $correct_answers[$data['gap_number']] .= rtrim($data['answer_text']);
            } else {
                $correct_answers[$data['gap_number']] = rtrim($data['answer_text']);
            }
        }
        return $correct_answers;
    }

References $correct_answers, $data, $res, getAnswerTableName(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getCorrectSolutionForTextOutput()

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

Reimplemented from assQuestion.

Definition at line 830 of file class.assLongMenu.php.

                                                                              : array
    {
        $correct_answers = [];
        foreach ($this->getCorrectAnswers() as $gap_index => $gap) {
            $correct_answers[] = $this->lng->txt('gap')
                    . ' ' . $gap_index . ': ' . implode(',', $gap[0]);
        }
        return $correct_answers;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getIdenticalScoring()

assLongMenu::getIdenticalScoring ( )

Definition at line 726 of file class.assLongMenu.php.

                                         : bool
    {
        return $this->identical_scoring;
    }

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getJsonStructure()

assLongMenu::getJsonStructure ( )

Returns: mixed

Definition at line 116 of file class.assLongMenu.php.

                                      : string
    {
        return $this->json_structure;
    }

References $json_structure.

Referenced by getCorrectAnswersAsJson().

Here is the caller graph for this function:

◆ getLongMenuTextValue()

assLongMenu::getLongMenuTextValue ( )

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

                                          : string
    {
        return $this->long_menu_text;
    }

References $long_menu_text.

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getMaximumPoints()

assLongMenu::getMaximumPoints ( )

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

@access public

See also: $points

Reimplemented from assQuestion.

Definition at line 234 of file class.assLongMenu.php.

                                      : float
    {
        $sum = 0;
        $points = $this->getCorrectAnswers();
        if ($points) {
            foreach ($points as $add) {
                $sum += (float) $add[1];
            }
        }
        return $sum;
    }

References assQuestion\$points, and getCorrectAnswers().

Here is the call graph for this function:

◆ getMinAutoComplete()

assLongMenu::getMinAutoComplete ( )

Definition at line 144 of file class.assLongMenu.php.

                                        : int
    {
        return $this->minAutoComplete;
    }

References $minAutoComplete.

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getPointsForGap()

assLongMenu::getPointsForGap	(	$question_id,
		$gap_id
	)

private

Definition at line 457 of file class.assLongMenu.php.

                                                           : float
    {
        $points = 0.0;
        $res = $this->db->queryF(
            'SELECT points FROM  ' . $this->getAnswerTableName() . ' WHERE question_fi = %s AND gap_number = %s GROUP BY gap_number, points',
            ['integer', 'integer'],
            [$question_id, $gap_id]
        );
        while ($data = $this->db->fetchAssoc($res)) {
            $points = (float) $data['points'];
        }
        return $points;
    }

References $data, assQuestion\$points, $res, and getAnswerTableName().

Here is the call graph for this function:

◆ getQuestionType()

assLongMenu::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

Reimplemented from assQuestion.

Definition at line 620 of file class.assLongMenu.php.

                                     : string
    {
        return "assLongMenu";
    }

◆ getRTETextWithMediaObjects()

assLongMenu::getRTETextWithMediaObjects ( )

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

Reimplemented from assQuestion.

Definition at line 634 of file class.assLongMenu.php.

                                                : string
    {
        return parent::getRTETextWithMediaObjects() . $this->getLongMenuTextValue();
    }

◆ getSolutionSubmit()

assLongMenu::getSolutionSubmit ( )

protected

Definition at line 600 of file class.assLongMenu.php.

                                          : array
    {
        $solution_submit = [];
        foreach ($this->questionpool_request->strArray('answer') as $key => $value) {
            $solution_submit[$key] = $value;
        }
        return $solution_submit;
    }

◆ getSpecificFeedbackSetting()

assLongMenu::getSpecificFeedbackSetting ( )

Definition at line 134 of file class.assLongMenu.php.

                                                : int
    {
        return $this->specificFeedbackSetting;
    }

References $specificFeedbackSetting.

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getUserQuestionResult()

assLongMenu::getUserQuestionResult	(	$active_id,
		$pass
	)

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

Parameters

int	$active_id
int	$pass

Returns: ilUserQuestionResult

Definition at line 647 of file class.assLongMenu.php.

                                                            : ilUserQuestionResult
    {
        $result = new ilUserQuestionResult($this, $active_id, $pass);
 
        $points = $this->calculateReachedPoints($active_id, $pass);
        $max_points = $this->getMaximumPoints();
 
        $result->setReachedPercentage(($points / $max_points) * 100);
 
        return $result;
    }

◆ isComplete()

assLongMenu::isComplete ( )

Reimplemented from assQuestion.

Definition at line 149 of file class.assLongMenu.php.

                                : bool
    {
        if (strlen($this->title)
            && $this->author
            && $this->long_menu_text
            && sizeof($this->answers) > 0
            && sizeof($this->correct_answers) > 0
            && $this->getPoints() > 0
        ) {
            return true;
        }
        return false;
    }

References assQuestion\getPoints().

Here is the call graph for this function:

◆ isShuffleAnswersEnabled()

assLongMenu::isShuffleAnswersEnabled ( )

Definition at line 672 of file class.assLongMenu.php.

                                             : bool
    {
        return false;
    }

◆ lmMigrateQuestionTypeSpecificContent()

assLongMenu::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Reimplemented from assQuestion.

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

                                                                                                  : void
    {
        $this->setLongMenuTextValue($migrator->migrateToLmContent($this->getLongMenuTextValue()));
    }

References ilAssSelfAssessmentMigrator\migrateToLmContent().

Here is the call graph for this function:

◆ loadCorrectAnswerData()

assLongMenu::loadCorrectAnswerData ( $question_id )

private

Definition at line 406 of file class.assLongMenu.php.

                                                        : void
    {
        $res = $this->db->queryF(
            "SELECT * FROM {$this->getAnswerTableName()} WHERE question_fi = %s ORDER BY gap_number, position ASC",
            ['integer'],
            [$question_id]
        );
 
        $correct_answers = [];
        while ($data = $this->db->fetchAssoc($res)) {
            $correct_answers[$data['gap_number']][0][$data['position']] = rtrim($data['answer_text']);
            $correct_answers[$data['gap_number']][1] = $data['points'];
            $correct_answers[$data['gap_number']][2] = $data['type'];
        }
        $this->setJsonStructure(json_encode($correct_answers));
        $this->setCorrectAnswers($correct_answers);
    }

References $correct_answers, $data, $res, setCorrectAnswers(), and setJsonStructure().

Referenced by getCorrectAnswersAsJson(), and loadFromDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromDb()

assLongMenu::loadFromDb ( $question_id )

Definition at line 363 of file class.assLongMenu.php.

                                            : 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 ($result->numRows() == 1) {
            $data = $this->db->fetchAssoc($result);
            $this->setId($question_id);
            $this->setObjId($data['obj_fi']);
            $this->setNrOfTries($data['nr_of_tries']);
            $this->setTitle((string) $data['title']);
            $this->setComment((string) $data['description']);
            $this->setOriginalId($data['original_id']);
            $this->setAuthor($data['author']);
            $this->setPoints($data['points']);
            $this->setIdenticalScoring((bool) $data['identical_scoring']);
            $this->setOwner($data['owner']);
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data['question_text'], 1));
            $this->setLongMenuTextValue(ilRTE::_replaceMediaObjectImageSrc((string) $data['long_menu_text'], 1));
            $this->setMinAutoComplete($data['min_auto_complete'] ?? self::MIN_LENGTH_AUTOCOMPLETE);
            if (isset($data['feedback_setting'])) {
                $this->setSpecificFeedbackSetting((int) $data['feedback_setting']);
            }
 
            try {
                $this->setLifecycle(new ilAssQuestionLifecycle($data['lifecycle']));
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                $this->setLifecycle(new ilAssQuestionLifecycle());
            }
 
            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
        }
 
        $this->loadCorrectAnswerData($question_id);
        $this->createArrayFromFile();
        parent::loadFromDb($question_id);
    }

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), createArrayFromFile(), getAdditionalTableName(), loadCorrectAnswerData(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), setIdenticalScoring(), assQuestion\setLifecycle(), setLongMenuTextValue(), setMinAutoComplete(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setSpecificFeedbackSetting(), and assQuestion\setTitle().

Here is the call graph for this function:

◆ lookupForExistingSolutions()

assLongMenu::lookupForExistingSolutions	(	int	$activeId,
		int	$pass
	)

Lookup if an authorized or intermediate solution exists.

Returns: array ['authorized' => bool, 'intermediate' => bool]

Reimplemented from assQuestion.

Definition at line 562 of file class.assLongMenu.php.

                                                                        : array
    {
        $return = [
            'authorized' => false,
            'intermediate' => false
        ];
 
        $query = "
                        SELECT authorized, COUNT(*) cnt
                        FROM tst_solutions
                        WHERE active_fi = " . $this->db->quote($activeId, 'integer') . "
                        AND question_fi = " . $this->db->quote($this->getId(), 'integer') . "
                        AND pass = " . $this->db->quote($pass, 'integer') . "
                        AND value2 <> '-1'
                ";
 
        if ($this->getStep() !== null) {
            $query .= " AND step = " . $this->db->quote((int) $this->getStep(), 'integer') . " ";
        }
 
        $query .= "
                        GROUP BY authorized
                ";
 
        $result = $this->db->query($query);
 
        while ($row = $this->db->fetchAssoc($result)) {
            if ($row['authorized']) {
                $return['authorized'] = $row['cnt'] > 0;
            } else {
                $return['intermediate'] = $row['cnt'] > 0;
            }
        }
        return $return;
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assLongMenu::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

Definition at line 246 of file class.assLongMenu.php.

    {
        // save additional data
        $this->db->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            [ "integer" ],
            [ $this->getId() ]
        );
        $this->db->manipulateF(
            "INSERT INTO " . $this->getAdditionalTableName(
            ) . " (question_fi, long_menu_text, feedback_setting, min_auto_complete, identical_scoring) VALUES (%s, %s, %s, %s, %s)",
            [ "integer", "text", "integer", "integer", "integer"],
            [
                $this->getId(),
                $this->getLongMenuTextValue(),
                $this->getSpecificFeedbackSetting(),
                $this->getMinAutoComplete(),
                $this->getIdenticalScoring()
            ]
        );
 
        $this->createFileFromArray();
    }

References createFileFromArray(), getAdditionalTableName(), assQuestion\getId(), getIdenticalScoring(), getLongMenuTextValue(), getMinAutoComplete(), and getSpecificFeedbackSetting().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assLongMenu::saveAnswerSpecificDataToDb ( )

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

                                                : void
    {
        $this->clearAnswerSpecificDataFromDb($this->getId());
        $type_array = $this->getAnswerType();
        $points = 0;
        foreach ($this->getCorrectAnswers() as $gap_number => $gap) {
            foreach ($gap[0] as $position => $answer) {
                if ($type_array == null) {
                    $type = $gap[2];
                } else {
                    $type = $type_array[$gap_number];
                }
                $this->db->replace(
                    $this->getAnswerTableName(),
                    [
                        'question_fi' => ['integer', $this->getId()],
                        'gap_number' => ['integer', (int) $gap_number],
                        'position' => ['integer', (int) $position]
                        ],
                    [
                        'answer_text' => ['text', $answer],
                        'points' => ['float', $gap[1]],
                        'type' => ['integer', (int) $type]
                        ]
                );
            }
            $points += $gap[1];
        }
        $this->setPoints($points);
    }

References assQuestion\$points, clearAnswerSpecificDataFromDb(), getAnswerTableName(), getAnswerType(), getCorrectAnswers(), assQuestion\getId(), and assQuestion\setPoints().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assLongMenu::savePreviewData ( ilAssQuestionPreviewSession $preview_session )

protected

Reimplemented from assQuestion.

Definition at line 609 of file class.assLongMenu.php.

                                                                                    : void
    {
        $answer = $this->questionpool_request->strArray('answer');
        $preview_session->setParticipantsSolution(array_map(static fn($value) => trim($value), $answer));
    }

References ilAssQuestionPreviewSession\setParticipantsSolution().

Here is the call graph for this function:

◆ saveToDb()

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

Reimplemented from assQuestion.

Definition at line 163 of file class.assLongMenu.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

Reimplemented from assQuestion.

Definition at line 531 of file class.assLongMenu.php.

     : bool {
        if (is_null($pass)) {
            $pass = ilObjTest::_getPass($active_id);
        }
 
        $answer = $this->getSolutionSubmit();
        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
            function () use ($answer, $active_id, $pass, $authorized) {
                $this->removeCurrentSolution($active_id, $pass, $authorized);
 
                foreach ($answer as $key => $value) {
                    if ($value === '') {
                        continue;
                    }
                    $this->saveCurrentSolution($active_id, $pass, $key, $value, $authorized);
                }
            }
        );
 
        return true;
    }

References ilObjTest\_getPass().

Here is the call graph for this function:

◆ setAnswers()

assLongMenu::setAnswers ( array $answers )

Definition at line 103 of file class.assLongMenu.php.

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

References $answers.

Referenced by createArrayFromFile().

Here is the caller graph for this function:

◆ setAnswerType()

assLongMenu::setAnswerType ( array $answerType )

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

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

References $answerType.

◆ setCorrectAnswers()

assLongMenu::setCorrectAnswers ( array $correct_answers )

Definition at line 68 of file class.assLongMenu.php.

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

References $correct_answers.

Referenced by loadCorrectAnswerData().

Here is the caller graph for this function:

◆ setIdenticalScoring()

assLongMenu::setIdenticalScoring ( bool $identical_scoring )

Definition at line 731 of file class.assLongMenu.php.

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

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setJsonStructure()

assLongMenu::setJsonStructure ( string $json_structure )

private

Parameters

mixed $json_structure

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

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

References $json_structure.

Referenced by loadCorrectAnswerData().

Here is the caller graph for this function:

◆ setLongMenuTextValue()

assLongMenu::setLongMenuTextValue ( string $long_menu_text = '' )

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

                                                                     : void
    {
        $this->long_menu_text = $this->getHtmlQuestionContentPurifier()->purify($long_menu_text);
    }

References assQuestion\getHtmlQuestionContentPurifier().

Referenced by loadFromDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMinAutoComplete()

assLongMenu::setMinAutoComplete ( int $min_auto_complete )

Definition at line 139 of file class.assLongMenu.php.

                                                              : void
    {
        $this->minAutoComplete = $min_auto_complete;
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assLongMenu::setSpecificFeedbackSetting ( $specificFeedbackSetting )

Definition at line 129 of file class.assLongMenu.php.

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

References $specificFeedbackSetting.

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ solutionValuesToLog()

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

protected

MUST convert the given solution values into an array or a string that can be stored in the log.

Language variables must be generated through the corresponding functions in the AdditionalInformationGenerator. If an array is returned it will be rendered into a line per array entry in the format "key: value". If the key exists as a language variable, it will be translated.

Reimplemented from assQuestion.

Definition at line 787 of file class.assLongMenu.php.

     : array {
        $parsed_solution = [];
        foreach ($this->getCorrectAnswers() as $gap_index => $gap) {
            foreach ($solution_values as $solution) {
                if ($gap_index !== (int) $solution['value1']) {
                    continue;
                }
                $value = $solution['value2'];
                if ($gap[2] === self::ANSWER_TYPE_SELECT_VAL
                    && $value === '-1') {
                    $value = '';
                }
                $parsed_solution[$gap_index + 1] = $value;
                break;
            }
        }
        return $parsed_solution;
    }

◆ solutionValuesToText()

assLongMenu::solutionValuesToText ( array $solution_values )

MUST convert the given solution values into text.

If the text has multiple lines each line MUST be placed as an entry in an array.

Reimplemented from assQuestion.

Definition at line 809 of file class.assLongMenu.php.

                                                                : array
    {
        $parsed_solution = [];
 
        foreach ($this->getCorrectAnswers() as $gap_index => $gap) {
            foreach ($solution_values as $solution) {
                if ($gap_index !== (int) $solution['value1']) {
                    continue;
                }
                $value = $solution['value2'];
                if ($gap[2] === self::ANSWER_TYPE_SELECT_VAL
                    && $value === '-1') {
                    $value = '';
                }
                $parsed_solution[] = $this->lng->txt('gap') . ' ' . $gap_index + 1 . ': ' . $value;
                break;
            }
        }
        return $parsed_solution;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ toJSON()

assLongMenu::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

                            : string
    {
        $result = [];
        $result['id'] = $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = $this->getTitleForHTMLOutput();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $replaced_quesiton_text = $this->getLongMenuTextValue();
        $result['lmtext'] = $this->formatSAQuestion($replaced_quesiton_text);
        $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))
        ];
 
        $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
        $result['answers'] = $this->getAnswers();
        $result['correct_answers'] = $this->getCorrectAnswers();
        $result['mobs'] = $mobs;
        return json_encode($result);
    }

References ilObjMediaObject\_getMobsOfObject(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ toLog()

assLongMenu::toLog ( AdditionalInformationGenerator $additional_info )

MUST return an array of the question settings that can be stored in the log.

Language variables must be generated through the corresponding functions in the AdditionalInformationGenerator. If an array is returned it will be rendered into a line per array entry in the format "key: value". If the key exists as a language variable, it will be translated.

Reimplemented from assQuestion.

Definition at line 736 of file class.assLongMenu.php.

                                                                          : 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_LONGMENU_TEXT => $this->formatSAQuestion($this->getLongMenuTextValue()),
            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))
            ],
            AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTIONS => $this->getAnswersForLog($additional_info),
            AdditionalInformationGenerator::KEY_QUESTION_CORRECT_ANSWER_OPTIONS => $this->getCorrectAnswersForLog($additional_info)
        ];
    }

References ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool().

Here is the call graph for this function:

◆ toNormalized()

assLongMenu::toNormalized	(	Transformations	$transformations,
		array	$context = `[]`
	)

Parameters

array<string,mixed> $context

Returns: array<array-key, mixed>|float|bool|int|string|null

Reimplemented from assQuestion.

Definition at line 841 of file class.assLongMenu.php.

     : array|float|bool|int|string|null
    {
        return [
            ...$transformations->normalize(parent::toNormalized($transformations, $context)),
            'long_menu_text' => $this->long_menu_text,
            'json_structure' => $this->json_structure,
            'min_auto_complete' => $this->minAutoComplete,
            'identical_scoring' => $this->identical_scoring,
            'correct_answers' => $this->correct_answers,
            'answers' => $this->answers,
        ];
    }

Field Documentation

◆ $answers

array assLongMenu::$answers = []

private

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

Referenced by correctAnswerDoesNotExistInAnswerOptions(), createArrayFromFile(), getAnswers(), and setAnswers().

◆ $answerType

array assLongMenu::$answerType = null

private

Definition at line 38 of file class.assLongMenu.php.

Referenced by getAnswerType(), and setAnswerType().

◆ $correct_answers

array assLongMenu::$correct_answers = []

private

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

Referenced by checkQuestionCustomPart(), getCorrectAnswers(), getCorrectAnswersForGap(), getCorrectAnswersForQuestionSolution(), loadCorrectAnswerData(), and setCorrectAnswers().

◆ $identical_scoring

bool assLongMenu::$identical_scoring = true

private

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

◆ $json_structure

string assLongMenu::$json_structure = ''

private

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

Referenced by getJsonStructure(), and setJsonStructure().

◆ $long_menu_text

string assLongMenu::$long_menu_text = ''

private

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

Referenced by getLongMenuTextValue().

◆ $minAutoComplete

int assLongMenu::$minAutoComplete = self::MIN_LENGTH_AUTOCOMPLETE

private

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

Referenced by getMinAutoComplete().

◆ $specificFeedbackSetting

int assLongMenu::$specificFeedbackSetting = ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL

private

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

Referenced by getSpecificFeedbackSetting(), and setSpecificFeedbackSetting().

◆ ANSWER_TYPE_SELECT_VAL

const assLongMenu::ANSWER_TYPE_SELECT_VAL = 0

Definition at line 30 of file class.assLongMenu.php.

Referenced by ILIAS\Questions\AnswerFormTypes\Cloze\Migration\MigrationLongMenu\buildNewGapTypeIdentifierFromOld(), and assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps().

◆ ANSWER_TYPE_TEXT_VAL

const assLongMenu::ANSWER_TYPE_TEXT_VAL = 1

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

Referenced by ILIAS\Questions\AnswerFormTypes\Cloze\Migration\MigrationLongMenu\buildNewGapTypeIdentifierFromOld(), and assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps().

◆ GAP_PLACEHOLDER

const assLongMenu::GAP_PLACEHOLDER = 'Longmenu'

Definition at line 32 of file class.assLongMenu.php.

Referenced by assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps(), assLongMenuGUI\getSpecificFeedbackOutput(), assLongMenuGUI\populateQuestionSpecificFormPart(), assLongMenuExportQti21\toXML(), and assLongMenuGUI\verifyAnswerOptions().

◆ HAS_SPECIFIC_FEEDBACK

const assLongMenu::HAS_SPECIFIC_FEEDBACK = false

protected

Definition at line 36 of file class.assLongMenu.php.

◆ MAX_INPUT_FIELDS

const assLongMenu::MAX_INPUT_FIELDS = 500

Definition at line 34 of file class.assLongMenu.php.

Referenced by assLongMenuGUI\populateQuestionSpecificFormPart().

◆ MIN_LENGTH_AUTOCOMPLETE

const assLongMenu::MIN_LENGTH_AUTOCOMPLETE = 3

Definition at line 33 of file class.assLongMenu.php.

Referenced by assLongMenuGUI\populateQuestionSpecificFormPart(), and assLongMenuGUI\writeQuestionSpecificPostData().

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assertDirExists()

◆ buildFileName()

◆ buildFolderName()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ checkQuestionCustomPart()

◆ clearAnswerSpecificDataFromDb()

◆ clearFolder()

◆ correctAnswerDoesNotExistInAnswerOptions()

◆ createArrayFromFile()

◆ createFileFromArray()

◆ delete()

◆ fromNormalized()

◆ getAdditionalTableName()

◆ getAnswers()

◆ getAnswersForLog()

◆ getAnswersObject()

◆ getAnswerTableName()

◆ getAnswerType()

◆ getAvailableAnswerOptions()

◆ getCorrectAnswers()

◆ getCorrectAnswersAsJson()

◆ getCorrectAnswersForGap()

◆ getCorrectAnswersForLog()

◆ getCorrectAnswersForQuestionSolution()

◆ getCorrectSolutionForTextOutput()

◆ getIdenticalScoring()

◆ getJsonStructure()

◆ getLongMenuTextValue()

◆ getMaximumPoints()

◆ getMinAutoComplete()

◆ getPointsForGap()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getSpecificFeedbackSetting()

◆ getUserQuestionResult()

◆ isComplete()

◆ isShuffleAnswersEnabled()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadCorrectAnswerData()

◆ loadFromDb()

◆ lookupForExistingSolutions()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setAnswerType()

◆ setCorrectAnswers()

◆ setIdenticalScoring()

◆ setJsonStructure()

◆ setLongMenuTextValue()

◆ setMinAutoComplete()

◆ setSpecificFeedbackSetting()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

◆ toNormalized()

Field Documentation

◆ $answers

◆ $answerType

◆ $correct_answers

◆ $identical_scoring

◆ $json_structure

◆ $long_menu_text

◆ $minAutoComplete

◆ $specificFeedbackSetting

◆ ANSWER_TYPE_SELECT_VAL