Inheritance diagram for assLongMenu:

Collaboration diagram for assLongMenu:

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

	getAnswerType ()

	setAnswerType ($answerType)

	getCorrectAnswers ()

	setCorrectAnswers ($correct_answers)

	getAnswerTableName ()
	Returns the name of the answer table in the database. More...

	setLongMenuTextValue ($long_menu_text="")

	getLongMenuTextValue ()

	setAnswers ($answers)

	getAnswers ()

	getJsonStructure ()

	setJsonStructure ($json_structure)

	setSpecificFeedbackSetting ($specificFeedbackSetting)

	getSpecificFeedbackSetting ()

	setMinAutoComplete ($minAutoComplete)

	getMinAutoComplete ()

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

	saveToDb ($original_id="")
	Saves the question to the database. More...

	checkQuestionCustomPart ()

	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)
	Loads the question from the database. More...

	getCorrectAnswersForQuestionSolution ($question_id)

	getAnswersObject ()

	getCorrectAnswersAsJson ()

	duplicate ($for_test=true, $title="", $author="", $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 ($active_id, $pass=NULL, $authorized=true)
	Saves the learners input of the question to the database. More...

	getSolutionSubmit ()

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

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

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

	setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question. 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 ($original_id)
	Deletes a question and all materials from the database. More...

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

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

	getShuffler ()

	setShuffler (ilArrayElementShuffler $shuffler)

	setProcessLocker ($processLocker)

	getProcessLocker ()

	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

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

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

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

	setTitle ($title="")
	Sets the title string of the assQuestion object. More...

	setId ($id=-1)
	Sets the id of the assQuestion object. More...

	setTestId ($id=-1)
	Sets the test id of the assQuestion object. More...

	setComment ($comment="")
	Sets the comment string of the assQuestion object. More...

	setOutputType ($outputType=OUTPUT_HTML)
	Sets the output type. More...

	setShuffle ($shuffle=true)
	Sets the shuffle flag. More...

	setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
	Sets the estimated working time of a question from given hour, minute and second. More...

	setEstimatedWorkingTimeFromDurationString ($durationString)
	Sets the estimated working time of a question from a given datetime string. More...

	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array More...

	setAuthor ($author="")
	Sets the authors name of the assQuestion object. More...

	setOwner ($owner="")
	Sets the creator/owner ID of the assQuestion object. More...

	getTitle ()
	Gets the title string of the assQuestion object. More...

	getId ()
	Gets the id of the assQuestion object. More...

	getShuffle ()
	Gets the shuffle flag. More...

	getTestId ()
	Gets the test id of the assQuestion object. More...

	getComment ()
	Gets the comment string of the assQuestion object. More...

	getOutputType ()
	Gets the output type. More...

	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output. More...

	supportsNonJsOutput ()

	requiresJsSwitch ()

	getEstimatedWorkingTime ()
	Gets the estimated working time of a question. More...

	getAuthor ()
	Gets the authors name of the assQuestion object. More...

	getOwner ()
	Gets the creator/owner ID of the assQuestion object. More...

	getObjId ()
	Get the object id of the container object. More...

	setObjId ($obj_id=0)
	Set the object id of the container object. More...

	setExternalId ($external_id)

	getExternalId ()

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

&	_getQuestionInfo ($question_id)
	Returns question information from the database. More...

	getSuggestedSolutionOutput ()

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

	getSuggestedSolutions ()
	Return the suggested solutions. More...

	_getReachedPoints ($active_id, $question_id, $pass=NULL)
	Returns the points, a learner has reached answering the question. More...

	getReachedPoints ($active_id, $pass=NULL)
	Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...

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

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

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

	persistWorkingState ($active_id, $pass=NULL, $obligationsEnabled=false, $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...

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

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

	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...

	_logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...

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

	getSuggestedSolutionPath ()
	Returns the path for a suggested solution. More...

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

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

	buildImagePath ($questionId, $parentObjectId)

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

	getJavaPathWeb ()
	Returns the web image path for web accessable java applets of a question. More...

	getSuggestedSolutionPathWeb ()
	Returns the web path for a suggested solution. More...

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

	getFlashPathWeb ()
	Returns the web image path for web accessable flash applications of a question. More...

	getUserSolutionPreferingIntermediate ($active_id, $pass=NULL)

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

	isInUse ($question_id="")
	Checks whether the question is in use or not. More...

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

	pcArrayShuffle ($array)
	Shuffles the values of a given array. More...

	getQuestionTypeFromDb ($question_id)
	get question type for question id More...

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

	getAnswerTableName ()
	Returns the name of the answer table in the database. More...

	deleteAnswers ($question_id)
	Deletes datasets from answers tables. More...

	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...

	delete ($question_id)
	Deletes a question and all materials from the database. More...

	getTotalAnswers ()
	get total number of answers More...

	_getTotalAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...

	_getTitle ($a_q_id)
	Returns the title of a question. More...

	_getQuestionText ($a_q_id)
	Returns question text. More...

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()
	create page object of question More...

	copyPageOfQuestion ($a_q_id)

	getPageOfQuestion ()

	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...

	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id. More...

	setOriginalId ($original_id)

	getOriginalId ()

	fixSvgToPng ($imageFilenameContainingString)

	fixUnavailableSkinImageSources ($html)

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

	createNewQuestion ($a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

	saveQuestionDataToDb ($original_id="")

	saveToDb ($original_id="")
	Saves the question to the database. More...

	setNewOriginalId ($newId)

	deleteSuggestedSolutions ()
	Deletes all suggestes solutions in the database. More...

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

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

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

	_resolveInternalLink ($internal_link)

	_resolveIntLinks ($question_id)

	_getInternalLinkHref ($target="")

	syncWithOriginal ()

	createRandomSolution ($test_id, $user_id)

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

	_questionExistsInPool ($question_id)
	Returns true if the question already exists in the database and is assigned to a question pool. More...

	getPoints ()
	Returns the maximum available points for the question. More...

	setPoints ($a_points)
	Sets the maximum available points for the question. More...

	getSolutionMaxPass ($active_id)
	Returns the maximum pass a users question solution. More...

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

	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...

	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not. More...

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

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

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

	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output in tests. More...

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

	addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
	Creates a QTI material tag from a plain text or xhtml text. More...

	createNewImageFileName ($image_filename, $unique=false)

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

	getQuestion ()
	Gets the question string of the question object. More...

	setQuestion ($question="")
	Sets the question string of the question object. More...

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

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

	cleanupMediaObjectUsage ()
	synchronises appearances of media objects in the question with media object usage table More...

&	getInstances ()
	Gets all instances of the question. More...

	_needsManualScoring ($question_id)

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

	setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...

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

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

	getNrOfTries ()

	setNrOfTries ($a_nr_of_tries)

	setExportImagePath ($a_path)

	_questionExistsInTest ($question_id, $test_id)

	formatSAQuestion ($a_q)
	Format self assessment question. More...

	setPreventRteUsage ($a_val)
	Set prevent rte usage. More...

	getPreventRteUsage ()
	Get prevent rte usage. More...

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode. More...

	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode. More...

	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries. More...

	getDefaultNrOfTries ()
	Get Default Nr of Tries. More...

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

	isAnswered ($active_id, $pass=null)
	returns boolean wether the question is answered during test pass or not More...

	isAutosaveable ()

	getAdditionalContentEditingMode ()
	getter for additional content editing mode for this question More...

	setAdditionalContentEditingMode ($additinalContentEditingMode)
	setter for additional content editing mode for this question More...

	isAdditionalContentEditingModePageObject ()
	isser for additional "pageobject" content editing mode More...

	isValidAdditionalContentEditingMode ($additionalContentEditingMode)
	returns the fact wether the passed additional content mode is valid or not More...

	getValidAdditionalContentEditingModes ()
	getter for valid additional content editing modes More...

	addQuestionChangeListener (ilQuestionChangeListener $listener)

	getQuestionChangeListeners ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($lastChange)

	getLastChange ()

	removeIntermediateSolution ($active_id, $pass)

	removeCurrentSolution ($active_id, $pass, $authorized=true, $ignoredSolutionIds=array())

	saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true)

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

	updateCurrentSolutionsAuthorization ($activeId, $pass, $authorized)

	setStep ($step)

	getStep ()

	toJSON ()

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

	authorizedSolutionExists ($active_id, $pass)

	authorizedOrIntermediateSolutionExists ($active_id, $pass)

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

	removeExistingSolutions ($activeId, $pass)

	resetUsersAnswer ($activeId, $pass)

	removeResultRecord ($activeId, $pass)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered ($obligationsToBeConsidered)

	validateSolutionSubmit ()

	updateTimestamp ()

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. 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	IMG_MIME_TYPE_JPG = 'image/jpeg'

const	IMG_MIME_TYPE_PNG = 'image/png'

const	IMG_MIME_TYPE_GIF = 'image/gif'

const	ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
	constant for additional content editing mode "default" More...

const	ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
	constant for additional content editing mode "pageobject" More...

	$feedbackOBJ = null

	$prevent_rte_usage = false

	$selfassessmenteditingmode = false

	$defaultnroftries = 0

	$questionActionCmd = 'handleQuestionAction'

Protected Member Functions
	calculateReachedPointsForSolution ($found_values, $active_id=0)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	Reworks the allready saved working data if neccessary. More...

	reworkWorkingData ($active_id, $pass, $obligationsAnswered)
	Reworks the allready saved working data if neccessary. More...

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

Protected Member Functions inherited from assQuestion
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	Reworks the allready saved working data if neccessary. More...

	deletePageOfQuestion ($question_id)
	Deletes the page object of a question with a given ID. More...

	onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
	Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...

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

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

	onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
	Will be called when a question is copied (into another question pool) More...

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

	syncSuggestedSolutionFiles ($original_id)
	Syncs the files of a suggested solution if the question is synced. More...

	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)

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

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

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

	buildQuestionDataQuery ()

	getCurrentSolutionResultSet ($active_id, $pass, $authorized=true)
	Get a restulset for the current user solution for a this question by active_id and pass. More...

	removeSolutionRecordById ($solutionId)

	getSelfAssessmentFormatter ()

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

	$answers

	$correct_answers

	$json_structure

	$ilDB

	$specificFeedbackSetting

	$minAutoComplete

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier ($contentTypeString)

static	getAllowedFileExtensionsForMimeType ($mimeType)

static	isAllowedImageFileExtension ($mimeType, $fileExtension)

static	getAllowedImageFileExtensions ()

static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question. More...

static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution. More...

static	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...

static	isFileAvailable ($file)

static	_getOriginalId ($question_id)
	Returns the original id of a question. More...

static	originalQuestionExists ($questionId)

static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...

static	_instantiateQuestion ($question_id)

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

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

static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...

static	getGuiClassNameByQuestionType ($questionType)

static	getObjectClassNameByQuestionType ($questionType)

static	getFeedbackClassNameByQuestionType ($questionType)

static	isCoreQuestionType ($questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	includePluginClass ($questionType, $withGuiClass)

static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...

static &	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id. More...

static	instantiateQuestionGUI ($a_question_id)
	Creates an instance of a question gui with a given question id. More...

static	lookupParentObjId ($questionId)
	@global ilDB $ilDB More...

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

static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...

static	setResultGateway ($resultGateway)

static	getResultGateway ()

static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)

static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)

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

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

Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords ($activeId, $pass, $questionId)
	returns the number of existing solution records for the given test active / pass and given question id More...

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$outputType

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

assQuestion constructor

Parameters

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

Reimplemented from assQuestion.

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

        {
                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);
                global $ilDB;
                $this->ilDB = $ilDB;
        }

References assQuestion\$author, assQuestion\$comment, $ilDB, assQuestion\$owner, assQuestion\$question, assQuestion\$title, ilAssConfigurableMultiOptionQuestionFeedback\FEEDBACK_SETTING_ALL, and MIN_LENGTH_AUTOCOMPLETE.

Member Function Documentation

◆ assertDirExists()

assLongMenu::assertDirExists ( )

private

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

        {
                $folder_name = $this->buildFolderName();
                if(!ilUtil::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 ilUtil\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 78 of file class.assLongMenu.php.

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

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

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

References ilUtil\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	(	$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 !!)

Reimplemented from assQuestion.

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

        {
                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'];
                }
 
                $points = $this->calculateReachedPointsForSolution($found_values, $active_id);
 
                return $points;
        }

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

Referenced by getUserQuestionResult().

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

        {
                $points = 0;
                foreach($found_values as $key => $answer)
                {
                        if($answer != '')
                        {
                                $correct_answers = $this->getCorrectAnswersForGap($this->id, $key);
                                if(in_array($answer, $correct_answers))
                                {
                                        $points += $this->getPointsForGap($this->id, $key);
                                }
                        }
                }
                return $points;
        }

References $correct_answers, assQuestion\$points, getCorrectAnswersForGap(), and getPointsForGap().

Referenced by calculateReachedPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkQuestionCustomPart()

assLongMenu::checkQuestionCustomPart ( )

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

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

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

Here is the call graph for this function:

◆ clearAnswerSpecificDataFromDb()

assLongMenu::clearAnswerSpecificDataFromDb ( $question_id )

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

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

References getAnswerTableName(), and ilDB\manipulateF().

Referenced by saveAnswerSpecificDataToDb().

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

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

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

Referenced by createFileFromArray(), and delete().

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

        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // 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;
        }

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

Here is the call graph for this function:

◆ correctAnswerDoesNotExistInAnswerOptions()

assLongMenu::correctAnswerDoesNotExistInAnswerOptions	(	$answers,
		$answer_options
	)

private

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

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

        {
                $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));
                }
                $this->setAnswers($answers);
                return $answers;
        }

References $answers, $file, buildFolderName(), and setAnswers().

Referenced by getAnswersObject(), getAvailableAnswerOptions(), 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.

        {
                $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 $file, buildFileName(), clearFolder(), and getAnswers().

Referenced by saveAdditionalQuestionDataToDb().

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.

        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
 
                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;
        }

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

Here is the call graph for this function:

◆ delete()

assLongMenu::delete ( $question_id )

Deletes a question and all materials from the database.

Parameters

integer $question_id The database id of the question @access private

Reimplemented from assQuestion.

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

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

References assQuestion\$original_id, and clearFolder().

Here is the call graph for this function:

◆ duplicate()

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

Reimplemented from assQuestion.

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

        {
 
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                
                // 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;
        }

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

Here is the call graph for this function:

◆ getAdditionalTableName()

assLongMenu::getAdditionalTableName ( )

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

Returns: string The additional table name

Reimplemented from assQuestion.

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

        {
                return 'qpl_qst_lome';
        }

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getAnswers()

assLongMenu::getAnswers ( )

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

        {
                return $this->answers;
        }

References $answers.

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

Here is the caller graph for this function:

◆ getAnswersObject()

assLongMenu::getAnswersObject ( )

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

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

References createArrayFromFile().

Here is the call graph for this function:

◆ getAnswerTableName()

assLongMenu::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name @access public

Reimplemented from assQuestion.

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

        {
                return "qpl_a_lome";
        }

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

Here is the caller graph for this function:

◆ getAnswerType()

assLongMenu::getAnswerType ( )

Returns: mixed

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

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

        {
                return $this->createArrayFromFile();
        }

References createArrayFromFile().

Here is the call graph for this function:

◆ getCorrectAnswers()

assLongMenu::getCorrectAnswers ( )

Returns: mixed

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

        {
                return $this->correct_answers;
        }

References $correct_answers.

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

Here is the caller graph for this function:

◆ getCorrectAnswersAsJson()

assLongMenu::getCorrectAnswersAsJson ( )

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

        {
                $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;
        }

References $correct_answers, $data, $res, ilDB\fetchAssoc(), and getAnswerTableName().

Referenced by calculateReachedPointsForSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCorrectAnswersForQuestionSolution()

assLongMenu::getCorrectAnswersForQuestionSolution ( $question_id )

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

        {
                $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;
        }

References $correct_answers, $data, $res, ilDB\fetchAssoc(), and getAnswerTableName().

Here is the call graph for this function:

◆ getJsonStructure()

assLongMenu::getJsonStructure ( )

Returns: mixed

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

        {
                return $this->json_structure;
        }

References $json_structure.

Referenced by getCorrectAnswersAsJson().

Here is the caller graph for this function:

◆ getLongMenuTextValue()

assLongMenu::getLongMenuTextValue ( )

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

        {
                return $this->long_menu_text;
        }

References $long_menu_text.

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

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

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

References assQuestion\$points, and getCorrectAnswers().

Referenced by getUserQuestionResult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMinAutoComplete()

assLongMenu::getMinAutoComplete ( )

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

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

References MIN_LENGTH_AUTOCOMPLETE.

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getPointsForGap()

assLongMenu::getPointsForGap	(	$question_id,
		$gap_id
	)

private

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

        {
                $points = 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 = $data['points'];
                }
                return $points;
        }

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

Referenced by calculateReachedPointsForSolution().

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

Reimplemented from assQuestion.

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

        {
                return "assLongMenu";
        }

Referenced by toJSON().

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.

Reimplemented from assQuestion.

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

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

References getLongMenuTextValue().

Here is the call graph for this function:

◆ getSolutionSubmit()

assLongMenu::getSolutionSubmit ( )

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

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

References $_POST, and ilUtil\stripSlashesRecursive().

Referenced by saveWorkingData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificFeedbackSetting()

assLongMenu::getSpecificFeedbackSetting ( )

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

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

        {
                $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;
        }

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

Here is the call graph for this function:

◆ isComplete()

assLongMenu::isComplete ( )

Returns true, if a question is complete for use.

Returns: boolean True, if the question is complete for use, otherwise false @access public

Reimplemented from assQuestion.

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

        {
                if (strlen($this->title)
                        && $this->author
                        && $this->question
                        && 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 849 of file class.assLongMenu.php.

        {
                return false;
        }

◆ lmMigrateQuestionTypeSpecificContent()

assLongMenu::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Reimplemented from assQuestion.

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

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

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

Here is the call graph for this function:

◆ loadCorrectAnswerData()

assLongMenu::loadCorrectAnswerData ( $question_id )

private

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

        {
                $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);
                
        }

References $correct_answers, $data, $res, ilDB\fetchAssoc(), 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 )

Loads the question from the database.

Parameters

integer $question_id A unique key which defines the question in the database @access public

Reimplemented from assQuestion.

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

        {
                $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($data["title"]);
                        $this->setComment($data["description"]);
                        $this->setOriginalId($data["original_id"]);
                        $this->setAuthor($data["author"]);
                        $this->setPoints($data["points"]);
                        $this->setOwner($data["owner"]);
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data['question_text'], 1));
                        $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                        $this->setLongMenuTextValue(ilRTE::_replaceMediaObjectImageSrc($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->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
                        }
                        catch(ilTestQuestionPoolException $e)
                        {
                        }
                }
 
                $this->loadCorrectAnswerData($question_id);
                $this->createArrayFromFile();
                parent::loadFromDb($question_id);
        }

References $data, $result, ilRTE\_replaceMediaObjectImageSrc(), createArrayFromFile(), ilDB\fetchAssoc(), getAdditionalTableName(), loadCorrectAnswerData(), ilDB\queryF(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), 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:

◆ reworkWorkingData()

assLongMenu::reworkWorkingData	(	$active_id,
		$pass,
		$obligationsAnswered
	)

protected

Reworks the allready saved working data if neccessary.

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered

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

        {
                // nothing to rework!
        }

◆ saveAdditionalQuestionDataToDb()

assLongMenu::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

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

        {
                // 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) VALUES (%s, %s, %s, %s)",
                        array( "integer", "text", "integer", "integer"),
                        array(
                                $this->getId(),
                                $this->getLongMenuTextValue(),
                                (int)$this->getSpecificFeedbackSetting(),
                                (int)$this->getMinAutoComplete()
                        )
                );
                $this->createFileFromArray();
        }

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

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

        {
                $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', (int)$this->getId()),
                                                                'gap_number'  => array('integer', (int)$gap_number),
                                                                'position'    => array('integer', (int)$position)
                                                ),
                                                array(
                                                                'answer_text' => array('text', $answer),
                                                                'points'      => array('float', $gap[1]),
                                                                'type'        => array('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 $previewSession )

protected

Reworks the allready saved working data if neccessary.

@abstract @access protected

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered

Reimplemented from assQuestion.

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

        {
                if( array_key_exists('answer',$_POST) )
                {
                        $previewSession->setParticipantsSolution($_POST['answer']);
                }
                else
                {
                        $previewSession->setParticipantsSolution(null);
                }
        }

References $_POST, and ilAssQuestionPreviewSession\setParticipantsSolution().

Here is the call graph for this function:

◆ saveToDb()

assLongMenu::saveToDb ( $original_id = "" )

Saves the question to the database.

Parameters

integer $original_id @access public

Reimplemented from assQuestion.

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

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assLongMenu::saveWorkingData	(	$active_id,
		$pass = `NULL`,
		$authorized = `true`
	)

Saves the learners input of the question to the database.

@access public

Parameters

integer	$active_id	Active id of the user
integer	$pass	Test pass

Returns: boolean $status

Reimplemented from assQuestion.

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

        {
                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }
                $this->getProcessLocker()->requestUserSolutionUpdateLock();
 
                $entered_values = 0;
                $this->removeCurrentSolution($active_id, $pass, $authorized);
 
                foreach($this->getSolutionSubmit() as $val1 => $val2)
                {
                        $value = ilUtil::stripSlashes($val2, FALSE);
                        if (strlen($value))
                        {
                                $this->saveCurrentSolution($active_id,$pass, $val1, $value, $authorized);
                                $entered_values++;
                        }
                }
                $this->getProcessLocker()->releaseUserSolutionUpdateLock();
                
                if ($entered_values)
                {
                        include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                $this->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())
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                }
                return true;
        }

References $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getProcessLocker(), getSolutionSubmit(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), assQuestion\saveCurrentSolution(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ setAnswers()

assLongMenu::setAnswers ( $answers )

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

        {
                $this->answers = $answers;
        }

References $answers.

Referenced by createArrayFromFile().

Here is the caller graph for this function:

◆ setAnswerType()

assLongMenu::setAnswerType ( $answerType )

Parameters

mixed $answerType

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

        {
                $this->answerType = $answerType;
        }

References $answerType.

◆ setCorrectAnswers()

assLongMenu::setCorrectAnswers ( $correct_answers )

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

        {
                $this->correct_answers = $correct_answers;
        }

References $correct_answers.

Referenced by loadCorrectAnswerData().

Here is the caller graph for this function:

◆ setExportDetailsXLS()

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

Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass
object	$format_title	Excel title format
object	$format_bold	Excel bold format

Returns: object

Reimplemented from assQuestion.

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

        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $solution = $this->getSolutionValues($active_id, $pass);
                $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
                $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
                $i = 1;
                foreach ($this->getCorrectAnswers() as $gap_index => $gap)
                {
                        $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($this->lng->txt('assLongMenu') . " $i"), $format_bold);
                        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->writeString($startrow + $i, 1, $value);
                                                        break;
                                                case self::ANSWER_TYPE_TEXT_VAL:
                                                        $worksheet->writeString($startrow + $i, 1, $solutionvalue["value2"]);
                                                        break;
                                        }
                                }
                        }
                        $i++;
                }
                return $startrow + $i + 1;
        }

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

Here is the call graph for this function:

◆ setJsonStructure()

assLongMenu::setJsonStructure ( $json_structure )

Parameters

mixed $json_structure

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

        {
                $this->json_structure = $json_structure;
        }

References $json_structure.

Referenced by loadCorrectAnswerData().

Here is the caller graph for this function:

◆ setLongMenuTextValue()

assLongMenu::setLongMenuTextValue ( $long_menu_text = "" )

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

        {
                $this->long_menu_text = $long_menu_text;
        }

References $long_menu_text.

Referenced by lmMigrateQuestionTypeSpecificContent(), and loadFromDb().

Here is the caller graph for this function:

◆ setMinAutoComplete()

assLongMenu::setMinAutoComplete ( $minAutoComplete )

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

        {
                $this->minAutoComplete = $minAutoComplete;
        }

References $minAutoComplete.

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assLongMenu::setSpecificFeedbackSetting ( $specificFeedbackSetting )

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

        {
                $this->specificFeedbackSetting = $specificFeedbackSetting;
        }

References $specificFeedbackSetting.

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ toJSON()

assLongMenu::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $answers

assLongMenu::$answers

private

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

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

◆ $answerType

assLongMenu::$answerType

private

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

Referenced by getAnswerType(), and setAnswerType().

◆ $correct_answers

assLongMenu::$correct_answers

private

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

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

◆ $ilDB

assLongMenu::$ilDB

private

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

Referenced by __construct().

◆ $json_structure

assLongMenu::$json_structure

private

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

Referenced by getJsonStructure(), and setJsonStructure().

◆ $long_menu_text

assLongMenu::$long_menu_text

private

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

Referenced by getLongMenuTextValue(), and setLongMenuTextValue().

◆ $minAutoComplete

assLongMenu::$minAutoComplete

private

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

Referenced by setMinAutoComplete().

◆ $specificFeedbackSetting

assLongMenu::$specificFeedbackSetting

private

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

Referenced by getSpecificFeedbackSetting(), and setSpecificFeedbackSetting().

◆ ANSWER_TYPE_SELECT_VAL

const assLongMenu::ANSWER_TYPE_SELECT_VAL = 0

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

Referenced by assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps(), and setExportDetailsXLS().

◆ ANSWER_TYPE_TEXT_VAL

const assLongMenu::ANSWER_TYPE_TEXT_VAL = 1

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

Referenced by assLongMenuGUI\getLongMenuTextWithInputFieldsInsteadOfGaps(), and setExportDetailsXLS().

◆ GAP_PLACEHOLDER

const assLongMenu::GAP_PLACEHOLDER = 'Longmenu'

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

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

◆ MAX_INPUT_FIELDS

const assLongMenu::MAX_INPUT_FIELDS = 500

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

Referenced by assLongMenuGUI\populateQuestionSpecificFormPart().

◆ MIN_LENGTH_AUTOCOMPLETE

const assLongMenu::MIN_LENGTH_AUTOCOMPLETE = 3

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

Referenced by __construct(), getMinAutoComplete(), and 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

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

◆ getJsonStructure()

◆ getLongMenuTextValue()

◆ getMaximumPoints()

◆ getMinAutoComplete()

◆ getPointsForGap()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getSpecificFeedbackSetting()

◆ getUserQuestionResult()

◆ isComplete()

◆ isShuffleAnswersEnabled()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadCorrectAnswerData()

◆ loadFromDb()

◆ reworkWorkingData()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setAnswerType()

◆ setCorrectAnswers()

◆ setExportDetailsXLS()

◆ setJsonStructure()

◆ setLongMenuTextValue()

◆ setMinAutoComplete()

◆ setSpecificFeedbackSetting()

◆ toJSON()

Field Documentation

◆ $answers

◆ $answerType

◆ $correct_answers

◆ $ilDB

◆ $json_structure

◆ $long_menu_text

◆ $minAutoComplete

◆ $specificFeedbackSetting

◆ ANSWER_TYPE_SELECT_VAL

◆ ANSWER_TYPE_TEXT_VAL

◆ GAP_PLACEHOLDER

◆ MAX_INPUT_FIELDS

◆ MIN_LENGTH_AUTOCOMPLETE