This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for assLongMenu:

Collaboration diagram for assLongMenu:

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

	getAnswerType ()

	setAnswerType ($answerType)

	getCorrectAnswers ()

	setCorrectAnswers ($correct_answers)

	getAnswerTableName ()

	setLongMenuTextValue ($long_menu_text="")

	getLongMenuTextValue ()

	setAnswers ($answers)

	getAnswers ()

	getJsonStructure ()

	setJsonStructure ($json_structure)

	setSpecificFeedbackSetting ($specificFeedbackSetting)

	getSpecificFeedbackSetting ()

	setMinAutoComplete ($minAutoComplete)

	getMinAutoComplete ()

	isComplete ()

	saveToDb (int $original_id=-1)

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

	duplicate (bool $for_test=true, string $title="", string $author="", string $owner="", $testObjId=null)

	copyObject ($target_questionpool_id, $title="")

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

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

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

	getSolutionSubmit ()

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

	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	{} 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 ($question_id)

	delete (int $question_id)

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

	getIdenticalScoring ()

	setIdenticalScoring ($a_identical_scoring)

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

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

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

	isComplete ()
	Returns true, if a question is complete for use. More...

	questionTitleExists (int $questionpool_id, string $title)
	Returns TRUE if the question title exists in a question pool in the database. More...

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setOutputType (int $outputType=OUTPUT_HTML)

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

	getOutputType ()

	supportsJavascriptOutput ()

	supportsNonJsOutput ()

	requiresJsSwitch ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	_getSuggestedSolution (int $question_id, int $subquestion_index=0)

	loadSuggestedSolution (int $question_id, int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorizedSolution=true)
	returns the reached points ... More...

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

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

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

	validateSolutionSubmit ()

	saveWorkingData (int $active_id, int $pass, bool $authorized=true)
	Saves the learners input of the question to the database. More...

	moveUploadedMediaFile (string $file, string $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...

	getSuggestedSolutionPath ()

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

	buildImagePath ($questionId, $parentObjectId)

	getFlashPath ()
	Returns the image path for web accessable flash files of a question. More...

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)

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

	isInUse (int $question_id=0)
	Checks whether the question is in use or not in pools or tests. More...

	usageNumber (int $question_id=0)
	Returns the number of place the question is in use in pools or tests. More...

	isClone (int $question_id=0)
	Checks whether the question is a clone of another question or not. More...

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (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=-1)

	saveToDb ()

	setNewOriginalId (int $newId)

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...

	getSuggestedSolutionTitle (int $subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...

	setSuggestedSolution (string $solution_id="", int $subquestion_index=0, bool $is_import=false)
	Sets a suggested solution for the question. More...

	updateSuggestedSolutions (int $original_id=-1, int $original_obj_id=-1)

	_resolveInternalLink (string $internal_link)

	_resolveIntLinks (int $question_id)

	syncWithOriginal ()

	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...

	_questionExistsInPool (int $question_id)

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...

	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)

	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag and creates a text or XHTML string. More...

	addQTIMaterial (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true)

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

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

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

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)

	__get ($value)
	Object getter. More...

	__set ($key, $value)
	Object setter. More...

	__isset ($key)
	Object issetter. More...

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	isAutosaveable ()

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

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

	duplicate (bool $for_test=true, string $title="", string $author="", string $owner="", $testObjId=null)

	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 $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

	savePartial ()

	isInActiveTest ()

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	IMG_MIME_TYPE_JPG = 'image/jpeg'

const	IMG_MIME_TYPE_PNG = 'image/png'

const	IMG_MIME_TYPE_GIF = 'image/gif'

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

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

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

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	ensureCurrentTestPass (int $active_id, int $pass)

	lookupCurrentTestPass (int $active_id, int $pass)

	lookupTestId (int $active_id)
	Move to ilObjTest or similar More...

	log (int $active_id, string $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion (int $question_id)

	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)

	beforeSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)

	afterSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)

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

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

	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)

	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)

	ensureNonNegativePoints ($points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)

	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 ()
	build basic test question configuration instance More...

Protected Attributes
const	HAS_SPECIFIC_FEEDBACK = false

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS DI LoggingServices	$ilLog

int	$id

string	$title

string	$comment

string	$owner

string	$author

int	$thumb_size

string	$question
	The question text. More...

float	$points
	The maximum available points for the question. More...

bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...

int	$test_id
	The database id of a test in which the question is contained. More...

int	$obj_id = 0
	Object id of the container object. More...

	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

Container	$dic

int	$outputType = OUTPUT_JAVASCRIPT
	Contains the output type of a question. More...

array	$suggested_solutions

int	$original_id = null

	$page

string	$external_id = null

ilAssQuestionProcessLocker	$processLocker

	$step

	$lastChange

Transformation	$shuffler

ilTestQuestionConfig	$testQuestionConfig

ilAssQuestionLifecycle	$lifecycle

ilObjUser	$current_user

Private Member Functions
	buildFolderName ()

	buildFileName ($gap_id)

	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)

Private Attributes
	$answerType

	$long_menu_text

	$json_structure

	$ilDB

	$specificFeedbackSetting

	$minAutoComplete

	$identical_scoring

	$correct_answers = []

	$answers = []

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $forcePassResultsUpdateEnabled)

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier (string $contentType)

static	getAllowedFileExtensionsForMimeType (string $mimeType)

static	isAllowedImageFileExtension (string $mimeType, string $fileExtension)

static	getAllowedImageMaterialFileExtensions ()

static	_getMaximumPoints (int $question_id)
	Returns the maximum points, a learner can reach answering the question. More...

static	_getQuestionInfo (int $question_id)

static	_getSuggestedSolutionCount (int $question_id)

static	_getSuggestedSolutionOutput (int $question_id)

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

static	_updateTestResultCache (int $active_id, ilAssQuestionProcessLocker $processLocker=null)
	Move this to a proper place. More...

static	logAction (string $logtext, int $active_id, int $question_id)

static	getQuestionTypeFromDb (int $question_id)

static	_getTotalRightAnswers (int $a_q_id)

static	_getTitle (int $a_q_id)

static	_getQuestionText (int $a_q_id)

static	isFileAvailable (string $file)

static	_getQuestionType (int $question_id)

static	_getQuestionTitle (int $question_id)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

static	_getOriginalId (int $question_id)

static	originalQuestionExists (int $questionId)

static	_instanciateQuestion (int $question_id)

static	_instantiateQuestion (int $question_id)

static	instantiateQuestion (int $question_id)

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

static	_isWriteable (int $question_id, int $user_id)

static	_isUsedInRandomTest (int $question_id)

static	_isWorkedThrough (int $active_id, int $question_id, int $pass)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...

static	_areAnswered (int $a_user_id, array $a_question_ids)
	Checks if an array of question ids is answered by a user or not. More...

static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	_needsManualScoring (int $question_id)

static	_includeClass (string $question_type, int $gui=0)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	isCoreQuestionType (string $questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	_getQuestionTypeName ($type_tag)

static	_instanciateQuestionGUI (int $question_id)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	lookupOriginalParentObjId (int $originalQuestionId)
	returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...

static	isObligationPossible (int $questionId)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

static	missingResultRecordExists (int $activeId, int $pass, array $questionIds)

static	getQuestionsMissingResultRecord (int $activeId, int $pass, array $questionIds)

static	lookupResultRecordExist (int $activeId, int $questionId, int $pass)

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

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

       {
         global $DIC;
         require_once 'Modules/TestQuestionPool/classes/feedback/class.ilAssConfigurableMultiOptionQuestionFeedback.php';
         $this->specificFeedbackSetting = ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL;
         $this->minAutoComplete = self::MIN_LENGTH_AUTOCOMPLETE;
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->ilDB = $DIC->database();
         $this->identical_scoring = 1;
     }

Here is the call graph for this function:

Member Function Documentation

◆ assertDirExists()

assLongMenu::assertDirExists ( )

private

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

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

Referenced by buildFileName().

                                       : 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');
         }
     }

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 101 of file class.assLongMenu.php.

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

Referenced by createFileFromArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFolderName()

assLongMenu::buildFolderName ( )

private

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPoints()

assLongMenu::calculateReachedPoints	(	$active_id,
		$pass = `null`,
		$authorizedSolution = `true`,
		$returndetails = `false`
	)

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

The points are calculated from the given answers.

Parameters

integer	$active_id
integer	$pass
boolean	$returndetails	(deprecated !!)

Exceptions

ilTestException

Returns: integer/array $points/$details (array $details is deprecated !!)

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

References $data, calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), assQuestion\getSolutionMaxPass(), and ILIAS\Repository\int().

Referenced by getUserQuestionResult().

     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
 
         $found_values = array();
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
         while ($data = $this->ilDB->fetchAssoc($result)) {
             $found_values[(int) $data['value1']] = $data['value2'];
         }
 
         return $this->calculateReachedPointsForSolution($found_values, $active_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsForSolution()

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

protected

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

References $correct_answers, ILIAS\LTI\ToolProvider\$key, assQuestion\$points, getCorrectAnswersForGap(), getIdenticalScoring(), and getPointsForGap().

Referenced by calculateReachedPoints().

     {
         if ($found_values == null) {
             $found_values = [];
         }
         $points = 0.0;
         $solution_values_text = array();
         foreach ($found_values as $key => $answer) {
             if ($answer != '') {
                 $correct_answers = $this->getCorrectAnswersForGap($this->id, $key);
                 if (in_array($answer, $correct_answers)) {
                     $points_gap = $this->getPointsForGap($this->id, $key);
                     if (!$this->getIdenticalScoring()) {
                         // check if the same solution text was already entered
                         if ((in_array($answer, $solution_values_text)) && ($points > 0)) {
                             $points_gap = 0;
                         }
                     }
                     $points += $points_gap;
                     array_push($solution_values_text, $answer);
                 }
             }
         }
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkQuestionCustomPart()

assLongMenu::checkQuestionCustomPart ( $form = null )

Parameters

ilPropertyFormGUI | null $form

Returns: bool

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

References $correct_answers, ILIAS\LTI\ToolProvider\$key, assQuestion\$points, correctAnswerDoesNotExistInAnswerOptions(), getAnswers(), and getCorrectAnswers().

                                                          : bool
     {
         $hidden_text_files = $this->getAnswers();
         $correct_answers = $this->getCorrectAnswers();
         $points = array();
         if ($correct_answers === null || sizeof($correct_answers) == 0 || $hidden_text_files === null || sizeof($hidden_text_files) == 0) {
             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]) || sizeof($correct_answers_row[0]) == 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;
     }

Here is the call graph for this function:

◆ clearAnswerSpecificDataFromDb()

assLongMenu::clearAnswerSpecificDataFromDb ( $question_id )

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

References getAnswerTableName().

Referenced by saveAnswerSpecificDataToDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearFolder()

assLongMenu::clearFolder ( $let_folder_exists = true )

private

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

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

Referenced by createFileFromArray(), and delete().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyObject()

assLongMenu::copyObject	(	$target_questionpool_id,
		$title = `""`
	)

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

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

                                                                     : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
         // duplicate the question in database
         $clone = $this;
         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
         $original_id = assQuestion::_getOriginalId($this->id);
         $clone->id = -1;
         $source_questionpool_id = $this->getObjId();
         $clone->setObjId($target_questionpool_id);
         if ($title) {
             $clone->setTitle($title);
         }
         $clone->saveToDb();
 
         $clone->copyPageOfQuestion($original_id);
         $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
 
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ correctAnswerDoesNotExistInAnswerOptions()

assLongMenu::correctAnswerDoesNotExistInAnswerOptions	(	$answers,
		$answer_options
	)

private

Parameters

$answers
$answer_options

Returns: bool

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

References $answers, and ILIAS\LTI\ToolProvider\$key.

Referenced by checkQuestionCustomPart().

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

Here is the caller graph for this function:

◆ createArrayFromFile()

assLongMenu::createArrayFromFile ( )

private

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

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

Referenced by getAnswersObject(), getAvailableAnswerOptions(), and loadFromDb().

                                           : array
     {
         $files = glob($this->buildFolderName() . '*.txt');
 
         if ($files === false) {
             $files = array();
         }
 
         $answers = array();
 
         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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFileFromArray()

assLongMenu::createFileFromArray ( )

private

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

References ILIAS\LTI\ToolProvider\$key, buildFileName(), clearFolder(), and getAnswers().

Referenced by saveAdditionalQuestionDataToDb().

                                           : 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);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNewOriginalFromThisDuplicate()

assLongMenu::createNewOriginalFromThisDuplicate	(	$targetParentId,
		$targetQuestionTitle = `""`
	)

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

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

                                                                                                   : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
 
         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
 
         $sourceQuestionId = $this->id;
         $sourceParentId = $this->getObjId();
 
         // duplicate the question in database
         $clone = $this;
         $clone->id = -1;
 
         $clone->setObjId($targetParentId);
 
         if ($targetQuestionTitle) {
             $clone->setTitle($targetQuestionTitle);
         }
 
         $clone->saveToDb();
         $clone->copyPageOfQuestion($sourceQuestionId);
         $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
 
         $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ delete()

assLongMenu::delete ( int $question_id )

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

References clearFolder().

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

Here is the call graph for this function:

◆ duplicate()

assLongMenu::duplicate	(	bool	$for_test = `true`,
		string	$title = `""`,
		string	$author = `""`,
		string	$owner = `""`,
			$testObjId = `null`
	)

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

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

                                                                                                                                     : int
     {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return -1;
         }
 
         // duplicate the question in database
         $this_id = $this->getId();
         $thisObjId = $this->getObjId();
 
         $clone = $this;
         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
         $original_id = assQuestion::_getOriginalId($this->id);
         $clone->id = -1;
 
         if ((int) $testObjId > 0) {
             $clone->setObjId($testObjId);
         }
 
         if ($title) {
             $clone->setTitle($title);
         }
 
         if ($author) {
             $clone->setAuthor($author);
         }
         if ($owner) {
             $clone->setOwner($owner);
         }
 
         if ($for_test) {
             $clone->saveToDb($original_id);
         } else {
             $clone->saveToDb();
         }
 
         $clone->copyPageOfQuestion($this_id);
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ getAdditionalTableName()

assLongMenu::getAdditionalTableName ( )

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

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                             : string
     {
         return 'qpl_qst_lome';
     }

Here is the caller graph for this function:

◆ getAnswers()

assLongMenu::getAnswers ( )

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

References $answers.

Referenced by checkQuestionCustomPart(), createFileFromArray(), and toJSON().

                                 : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswersObject()

assLongMenu::getAnswersObject ( )

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

References createArrayFromFile().

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

Here is the call graph for this function:

◆ getAnswerTableName()

assLongMenu::getAnswerTableName ( )

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

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

                                         : string
     {
         return "qpl_a_lome";
     }

Here is the caller graph for this function:

◆ getAnswerType()

assLongMenu::getAnswerType ( )

Returns: mixed

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

References $answerType.

Referenced by saveAnswerSpecificDataToDb().

     {
         return $this->answerType;
     }

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 854 of file class.assLongMenu.php.

References createArrayFromFile().

     {
         return $this->createArrayFromFile();
     }

Here is the call graph for this function:

◆ getCorrectAnswers()

assLongMenu::getCorrectAnswers ( )

Returns: mixed

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

References $correct_answers.

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

     {
         return $this->correct_answers;
     }

Here is the caller graph for this function:

◆ getCorrectAnswersAsJson()

assLongMenu::getCorrectAnswersAsJson ( )

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

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

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

Here is the call graph for this function:

◆ getCorrectAnswersForGap()

assLongMenu::getCorrectAnswersForGap	(	$question_id,
		$gap_id
	)

private

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

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

Referenced by calculateReachedPointsForSolution().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCorrectAnswersForQuestionSolution()

assLongMenu::getCorrectAnswersForQuestionSolution ( $question_id )

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

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

                                                                       : array
     {
         $correct_answers = array();
         $res = $this->db->queryF(
             'SELECT gap_number, answer_text FROM  ' . $this->getAnswerTableName() . ' WHERE question_fi = %s',
             array('integer'),
             array($question_id)
         );
         while ($data = $this->ilDB->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;
     }

Here is the call graph for this function:

◆ getIdenticalScoring()

assLongMenu::getIdenticalScoring ( )

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

Referenced by calculateReachedPointsForSolution(), and saveAdditionalQuestionDataToDb().

                                          : int
     {
         return ($this->identical_scoring) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ getJsonStructure()

assLongMenu::getJsonStructure ( )

Returns: mixed

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

References $json_structure.

Referenced by getCorrectAnswersAsJson().

     {
         return $this->json_structure;
     }

Here is the caller graph for this function:

◆ getLongMenuTextValue()

assLongMenu::getLongMenuTextValue ( )

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

References $long_menu_text.

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

     {
         return $this->long_menu_text;
     }

Here is the caller graph for this function:

◆ getMaximumPoints()

assLongMenu::getMaximumPoints ( )

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

public

See also: $points

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

References assQuestion\$points, and getCorrectAnswers().

Referenced by getUserQuestionResult().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMinAutoComplete()

assLongMenu::getMinAutoComplete ( )

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

Referenced by saveAdditionalQuestionDataToDb().

                                         : int
     {
         return $this->minAutoComplete ? $this->minAutoComplete : self::MIN_LENGTH_AUTOCOMPLETE;
     }

Here is the caller graph for this function:

◆ getPointsForGap()

assLongMenu::getPointsForGap	(	$question_id,
		$gap_id
	)

private

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

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

Referenced by calculateReachedPointsForSolution().

                                                            : 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',
             array('integer', 'integer'),
             array($question_id, $gap_id)
         );
         while ($data = $this->ilDB->fetchAssoc($res)) {
             $points = (float) $data['points'];
         }
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionType()

assLongMenu::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

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

Referenced by toJSON().

                                      : string
     {
         return "assLongMenu";
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assLongMenu::getRTETextWithMediaObjects ( )

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

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

References getLongMenuTextValue().

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

Here is the call graph for this function:

◆ getSolutionSubmit()

assLongMenu::getSolutionSubmit ( )

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

References ILIAS\LTI\ToolProvider\$key, and ilArrayUtil\stripSlashesRecursive().

Referenced by saveWorkingData().

                                        : array
     {
         $solutionSubmit = array();
         $answer = ilArrayUtil::stripSlashesRecursive($_POST['answer']);
 
         foreach ($answer as $key => $value) {
             $solutionSubmit[$key] = $value;
         }
 
         return $solutionSubmit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificFeedbackSetting()

assLongMenu::getSpecificFeedbackSetting ( )

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

References $specificFeedbackSetting.

Referenced by saveAdditionalQuestionDataToDb().

                                                 : int
     {
         return $this->specificFeedbackSetting;
     }

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 834 of file class.assLongMenu.php.

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

                                                             : 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;
     }

Here is the call graph for this function:

◆ isComplete()

assLongMenu::isComplete ( )

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

References assQuestion\getPoints().

                                 : 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;
     }

Here is the call graph for this function:

◆ isShuffleAnswersEnabled()

assLongMenu::isShuffleAnswersEnabled ( )

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

                                              : bool
     {
         return false;
     }

◆ lmMigrateQuestionTypeSpecificContent()

assLongMenu::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

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

References ilAssSelfAssessmentMigrator\migrateToLmContent(), and setLongMenuTextValue().

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

Here is the call graph for this function:

◆ loadCorrectAnswerData()

assLongMenu::loadCorrectAnswerData ( $question_id )

private

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

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

Referenced by getCorrectAnswersAsJson(), and loadFromDb().

                                                         : void
     {
         $res = $this->db->queryF(
             "SELECT * FROM {$this->getAnswerTableName()} WHERE question_fi = %s ORDER BY gap_number, position ASC",
             array('integer'),
             array($question_id)
         );
 
         $correct_answers = array();
         while ($data = $this->ilDB->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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromDb()

assLongMenu::loadFromDb ( $question_id )

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

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), createArrayFromFile(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), 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().

                                             : void
     {
         $result = $this->ilDB->queryF(
             "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
             array("integer"),
             array($question_id)
         );
         if ($result->numRows() == 1) {
             $data = $this->ilDB->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($data["identical_scoring"]);
             $this->setOwner($data["owner"]);
             include_once("./Services/RTE/classes/class.ilRTE.php");
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data['question_text'], 1));
             $this->setLongMenuTextValue(ilRTE::_replaceMediaObjectImageSrc((string) $data['long_menu_text'], 1));
             $this->loadCorrectAnswerData($question_id);
             $this->setMinAutoComplete($data["min_auto_complete"]);
             if (isset($data['feedback_setting'])) {
                 $this->setSpecificFeedbackSetting((int) $data['feedback_setting']);
             }
 
             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) {
             }
         }
 
         $this->loadCorrectAnswerData($question_id);
         $this->createArrayFromFile();
         parent::loadFromDb($question_id);
     }

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]

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

References $DIC, $ilDB, $query, assQuestion\getId(), and assQuestion\getStep().

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

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 261 of file class.assLongMenu.php.

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

Referenced by saveToDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assLongMenu::saveAnswerSpecificDataToDb ( )

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

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

Referenced by saveToDb().

                                                 : 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(),
                     array(
                         'question_fi' => array('integer', $this->getId()),
                         'gap_number' => array('integer', (int) $gap_number),
                         'position' => array('integer', (int) $position)
                         ),
                     array(
                         'answer_text' => array('text', $answer),
                         'points' => array('float', (float) str_replace(',', '.', $gap[1])),
                         'type' => array('integer', (int) $type)
                         )
                 );
             }
             $points += (float) str_replace(',', '.', $gap[1]);
         }
         $this->setPoints($points);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assLongMenu::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

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

References ilAssQuestionPreviewSession\setParticipantsSolution().

                                                                                    : void
     {
         $answer = $_POST['answer'] ?? null;
         if (is_array($answer)) {
             $answer = array_map(function ($value) {
                 return trim($value);
             }, $answer);
         }
         $previewSession->setParticipantsSolution($answer);
     }

Here is the call graph for this function:

◆ saveToDb()

assLongMenu::saveToDb ( int $original_id = -1 )

Definition at line 181 of file class.assLongMenu.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()

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

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

References ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), ILIAS\Repository\lng(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), assQuestion\saveCurrentSolution(), and ilUtil\stripSlashes().

                                                                                               : bool
     {
         if (is_null($pass)) {
             include_once "./Modules/Test/classes/class.ilObjTest.php";
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $entered_values = 0;
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $active_id, $pass, $authorized) {
             $this->removeCurrentSolution($active_id, $pass, $authorized);
 
             foreach ($this->getSolutionSubmit() as $val1 => $val2) {
                 $value = ilUtil::stripSlashes(trim($val2), false);
                 if (strlen($value)) {
                     $this->saveCurrentSolution($active_id, $pass, $val1, $value, $authorized);
                     $entered_values++;
                 }
             }
         });
 
         if ($entered_values) {
             include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
             if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                 assQuestion::logAction($this->lng->txtlng(
                     "assessment",
                     "log_user_entered_values",
                     ilObjAssessmentFolder::_getLogLanguage()
                 ), $active_id, $this->getId());
             }
         } else {
             include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
             if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                 assQuestion::logAction($this->lng->txtlng(
                     "assessment",
                     "log_user_not_entered_values",
                     ilObjAssessmentFolder::_getLogLanguage()
                 ), $active_id, $this->getId());
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ setAnswers()

assLongMenu::setAnswers ( $answers )

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

References $answers.

Referenced by createArrayFromFile().

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

Here is the caller graph for this function:

◆ setAnswerType()

assLongMenu::setAnswerType ( $answerType )

Parameters

mixed $answerType

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

References $answerType.

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

◆ setCorrectAnswers()

assLongMenu::setCorrectAnswers ( $correct_answers )

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

References $correct_answers.

Referenced by loadCorrectAnswerData().

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

Here is the caller graph for this function:

◆ setExportDetailsXLS()

assLongMenu::setExportDetailsXLS	(	ilAssExcelFormatHelper	$worksheet,
		int	$startrow,
		int	$active_id,
		int	$pass
	)

{}

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

References $i, ilExcel\getColumnCoord(), getCorrectAnswers(), assQuestion\getSolutionValues(), ILIAS\Repository\lng(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                     : int
     {
         parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
         $solution = $this->getSolutionValues($active_id, $pass);
 
         $i = 1;
         foreach ($this->getCorrectAnswers() as $gap_index => $gap) {
             $worksheet->setCell($startrow + $i, 0, $this->lng->txt('assLongMenu') . " $i");
             $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
             foreach ($solution as $solutionvalue) {
                 if ($gap_index == $solutionvalue["value1"]) {
                     switch ($gap[2]) {
                         case self::ANSWER_TYPE_SELECT_VAL:
                             $value = $solutionvalue["value2"];
                             if ($value == -1) {
                                 $value = '';
                             }
                             $worksheet->setCell($startrow + $i, 2, $value);
                             break;
                         case self::ANSWER_TYPE_TEXT_VAL:
                             $worksheet->setCell($startrow + $i, 2, $solutionvalue["value2"]);
                             break;
                     }
                 }
             }
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setIdenticalScoring()

assLongMenu::setIdenticalScoring ( $a_identical_scoring )

Parameters

$a_identical_scoring

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

Referenced by loadFromDb().

                                                              : void
     {
         $this->identical_scoring = ($a_identical_scoring) ? 1 : 0;
     }

Here is the caller graph for this function:

◆ setJsonStructure()

assLongMenu::setJsonStructure ( $json_structure )

Parameters

mixed $json_structure

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

References $json_structure.

Referenced by loadCorrectAnswerData().

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

Here is the caller graph for this function:

◆ setLongMenuTextValue()

assLongMenu::setLongMenuTextValue ( $long_menu_text = "" )

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

References $long_menu_text, and assQuestion\getHtmlQuestionContentPurifier().

Referenced by lmMigrateQuestionTypeSpecificContent(), and loadFromDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMinAutoComplete()

assLongMenu::setMinAutoComplete ( $minAutoComplete )

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

References $minAutoComplete.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assLongMenu::setSpecificFeedbackSetting ( $specificFeedbackSetting )

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

References $specificFeedbackSetting.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ toJSON()

assLongMenu::toJSON ( )

Returns a JSON representation of the question.

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

References $mobs, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), getCorrectAnswers(), assQuestion\getId(), getLongMenuTextValue(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitleForHTMLOutput().

                             : string
     {
         include_once("./Services/RTE/classes/class.ilRTE.php");
         $result = array();
         $result['id'] = $this->getId();
         $result['type'] = (string) $this->getQuestionType();
         $result['title'] = $this->getTitleForHTMLOutput();
         $replaced_quesiton_text = $this->getLongMenuTextValue();
         $result['question'] = $this->formatSAQuestion($this->getQuestion());
         $result['lmtext'] = $this->formatSAQuestion($replaced_quesiton_text);
         $result['nr_of_tries'] = $this->getNrOfTries();
         $result['shuffle'] = $this->getShuffle();
         $result['feedback'] = array(
             '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);
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

assLongMenu::$answers = []

private

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

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

◆ $answerType

assLongMenu::$answerType

private

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

Referenced by getAnswerType(), and setAnswerType().

◆ $correct_answers

assLongMenu::$correct_answers = []

private

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

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

◆ $identical_scoring

assLongMenu::$identical_scoring

private

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

◆ $ilDB

assLongMenu::$ilDB

private

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

Referenced by lookupForExistingSolutions().

◆ $json_structure

assLongMenu::$json_structure

private

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

Referenced by getJsonStructure(), and setJsonStructure().

◆ $long_menu_text

assLongMenu::$long_menu_text

private

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

Referenced by getLongMenuTextValue(), and setLongMenuTextValue().

◆ $minAutoComplete

assLongMenu::$minAutoComplete

private

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

Referenced by setMinAutoComplete().

◆ $specificFeedbackSetting

assLongMenu::$specificFeedbackSetting

private

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

Referenced by getSpecificFeedbackSetting(), and setSpecificFeedbackSetting().

◆ ANSWER_TYPE_SELECT_VAL

const assLongMenu::ANSWER_TYPE_SELECT_VAL = 0

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

Referenced by assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps().

◆ ANSWER_TYPE_TEXT_VAL

const assLongMenu::ANSWER_TYPE_TEXT_VAL = 1

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

Referenced by assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps().

◆ GAP_PLACEHOLDER

const assLongMenu::GAP_PLACEHOLDER = 'Longmenu'

Definition at line 33 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 37 of file class.assLongMenu.php.

◆ MAX_INPUT_FIELDS

const assLongMenu::MAX_INPUT_FIELDS = 500

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

Referenced by assLongMenuGUI\populateQuestionSpecificFormPart().

◆ MIN_LENGTH_AUTOCOMPLETE

const assLongMenu::MIN_LENGTH_AUTOCOMPLETE = 3

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

Referenced by assLongMenuGUI\populateQuestionSpecificFormPart().

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

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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assertDirExists()

◆ buildFileName()

◆ buildFolderName()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ checkQuestionCustomPart()

◆ clearAnswerSpecificDataFromDb()

◆ clearFolder()

◆ copyObject()

◆ correctAnswerDoesNotExistInAnswerOptions()

◆ createArrayFromFile()

◆ createFileFromArray()

◆ createNewOriginalFromThisDuplicate()

◆ delete()

◆ duplicate()

◆ getAdditionalTableName()

◆ getAnswers()

◆ getAnswersObject()

◆ getAnswerTableName()

◆ getAnswerType()

◆ getAvailableAnswerOptions()

◆ getCorrectAnswers()

◆ getCorrectAnswersAsJson()

◆ getCorrectAnswersForGap()

◆ getCorrectAnswersForQuestionSolution()

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

◆ setExportDetailsXLS()

◆ setIdenticalScoring()

◆ setJsonStructure()

◆ setLongMenuTextValue()

◆ setMinAutoComplete()

◆ setSpecificFeedbackSetting()

◆ toJSON()

Field Documentation

◆ $answers

◆ $answerType

◆ $correct_answers

◆ $identical_scoring

◆ $ilDB

◆ $json_structure

◆ $long_menu_text

◆ $minAutoComplete

◆ $specificFeedbackSetting

◆ ANSWER_TYPE_SELECT_VAL

◆ ANSWER_TYPE_TEXT_VAL