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

Inheritance diagram for assOrderingQuestion:

Collaboration diagram for assOrderingQuestion:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="", $ordering_type=self::OQ_TERMS)
	assOrderingQuestion constructor More...

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

	saveToDb ($original_id="")
	Saves a assOrderingQuestion object to a database. More...

	loadFromDb ($question_id)
	Loads a assOrderingQuestion object from a database. More...

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

	copyObject ($target_questionpool_id, $title="")
	Copies an assOrderingQuestion object. More...

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	duplicateImages ($src_question_id, $src_object_id, $dest_question_id, $dest_object_id)

	copyImages ($question_id, $source_questionpool)

	setOrderingType ($ordering_type=self::OQ_TERMS)

	getOrderingType ()

	isOrderingTypeNested ()

	isImageOrderingType ()

	setContentType ($ct)

	setNestingType (bool $nesting)

	hasOrderingTypeUploadSupport ()

	getOrderingElementListForSolutionOutput ($forceCorrectSolution, $activeId, $passIndex)

	getSolutionOrderingElementListForTestOutput (ilAssNestedOrderingElementsInputGUI $inputGUI, $lastPost, $activeId, $pass)

	getSolutionOrderingElementList ($indexedSolutionValues)

	getShuffledOrderingElementList ()

	getOrderingElementList ()

	setOrderingElementList (ilAssOrderingElementList $list)

	getAnswer ($index=0)
	Returns the ordering element from the given position. More...

	deleteAnswer ($randomIdentifier)
	Deletes an answer with a given index. More...

	getAnswerCount ()

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

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

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

	getEncryptedFilename ($filename)

	dropImageFile ($imageFilename)

	isImageFileStored ($imageFilename)

	isImageReplaced (ilAssOrderingElement $newElement, ilAssOrderingElement $oldElement)

	storeImageFile (string $upload_file, string $upload_name)

	updateImageFile (string $existing_image_name)

	validateSolutionSubmit ()

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

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

	getQuestionType ()

	getAdditionalTableName ()

	getAnswerTableName ()
	Returns the name of the answer 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...

	getOrderElements ()
	Returns the answers array. More...

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

	supportsNonJsOutput ()

	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	{} More...

	getElementHeight ()

	setElementHeight (?int $a_height)

	rebuildThumbnails ()

	getThumbPrefix ()

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

	buildOrderingElementInputGui ()

	initOrderingElementAuthoringProperties (ilFormPropertyGUI $formField)

	initOrderingElementFormFieldLabels (ilFormPropertyGUI $formField)

	buildOrderingTextsInputGui ()

	buildOrderingImagesInputGui ()

	buildNestedOrderingElementInputGui ()

	fetchSolutionListFromFormSubmissionData ($userSolutionPost)

	getSolutionListFromPostSubmit ()

	getSolutionPostSubmit ()

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

	getExpressionTypes ()
	Get all available expression types for a specific question. 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...

	buildTestPresentationConfig ()

	fetchSolutionSubmit ($formSubmissionDataStructure)

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

Public Member Functions inherited from ilObjQuestionScoringAdjustable
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

Public Member Functions inherited from iQuestionCondition
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

Data Fields
const	ORDERING_ELEMENT_FORM_FIELD_POSTVAR = 'order_elems'

const	ORDERING_ELEMENT_FORM_CMD_UPLOAD_IMG = 'uploadElementImage'

const	ORDERING_ELEMENT_FORM_CMD_REMOVE_IMG = 'removeElementImage'

const	OQ_PICTURES = 0

const	OQ_TERMS = 1

const	OQ_NESTED_PICTURES = 2

const	OQ_NESTED_TERMS = 3

const	OQ_CT_PICTURES = 'pics'

const	OQ_CT_TERMS = 'terms'

const	VALID_UPLOAD_SUFFIXES = ["jpg", "jpeg", "png", "gif"]

int	$element_height = null

	$old_ordering_depth = array()

	$leveled_ordering = array()

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 = ':'

Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

const	OrderingResultExpression = '$n,m,o,p$'

const	NumberOfResultExpression = '+n+'

const	ExclusiveResultExpression = 'n,m,o,p'

const	EmptyAnswerExpression = "?"

Protected Member Functions
	getRepository ()

	getValidOrderingTypes ()

	getSolutionValuePairBrandedOrderingElementByRandomIdentifier ($value1, $value2)

	getSolutionValuePairBrandedOrderingElementBySolutionIdentifier ($value1, $value2)

	cleanImagefiles ()

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	getQuestionRepository ()

	generateThumbForFile ($path, $file)

	calculateReachedPointsForSolution (ilAssOrderingElementList $solutionOrderingElementList)

	afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	{} More...

	ensureImagePathExists ()

	buildOrderingElementFormDataConverter ()

	buildOrderingImagesFormDataConverter ()

	buildOrderingTextsFormDataConverter ()

	buildNestedOrderingFormDataConverter ()

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

	$orderingElementList

	$ordering_type

	$oq_repository = null

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 Attributes
	$postSolutionOrderingElementList = null

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 Class for ordering questions

assOrderingQuestion is a class for ordering questions.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m; Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de; Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

assOrderingQuestion::__construct	(	$title = `""`,
		$comment = `""`,
		$author = `""`,
		$owner = `-1`,
		$question = `""`,
		$ordering_type = `self::OQ_TERMS`
	)

assOrderingQuestion constructor

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

Parameters

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

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

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

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->orderingElementList = new ilAssOrderingElementList();
         $this->ordering_type = $ordering_type;
     }

Here is the call graph for this function:

Member Function Documentation

◆ afterSyncWithOriginal()

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

protected

{}

Definition at line 1406 of file class.assOrderingQuestion.php.

References duplicateImages().

                                                                                                                 : void
     {
         parent::afterSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId);
         $this->duplicateImages($dupQuestionId, $dupParentObjId, $origQuestionId, $origParentObjId);
     }

Here is the call graph for this function:

◆ buildNestedOrderingElementInputGui()

assOrderingQuestion::buildNestedOrderingElementInputGui ( )

Returns: ilAssNestedOrderingElementsInputGUI

Definition at line 1208 of file class.assOrderingQuestion.php.

References buildNestedOrderingFormDataConverter(), assQuestion\getId(), assQuestion\getImagePathWeb(), getOrderingType(), getThumbPrefix(), and initOrderingElementFormFieldLabels().

Referenced by fetchSolutionListFromFormSubmissionData().

                                                         : ilAssNestedOrderingElementsInputGUI
     {
         $formDataConverter = $this->buildNestedOrderingFormDataConverter();
 
         $orderingElementInput = new ilAssNestedOrderingElementsInputGUI(
             $formDataConverter,
             self::ORDERING_ELEMENT_FORM_FIELD_POSTVAR
         );
 
         $orderingElementInput->setUniquePrefix($this->getId());
         $orderingElementInput->setOrderingType($this->getOrderingType());
         $orderingElementInput->setElementImagePath($this->getImagePathWeb());
         $orderingElementInput->setThumbPrefix($this->getThumbPrefix());
 
         $this->initOrderingElementFormFieldLabels($orderingElementInput);
 
         return $orderingElementInput;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildNestedOrderingFormDataConverter()

assOrderingQuestion::buildNestedOrderingFormDataConverter ( )

protected

Definition at line 1510 of file class.assOrderingQuestion.php.

References buildOrderingElementFormDataConverter(), ilAssOrderingFormValuesObjectsConverter\CONTEXT_MAINTAIN_HIERARCHY, assQuestion\getImagePathWeb(), getOrderingType(), getThumbPrefix(), and OQ_NESTED_PICTURES.

Referenced by buildNestedOrderingElementInputGui().

                                                              : ilAssOrderingFormValuesObjectsConverter
     {
         $formDataConverter = $this->buildOrderingElementFormDataConverter();
         $formDataConverter->setContext(ilAssOrderingFormValuesObjectsConverter::CONTEXT_MAINTAIN_HIERARCHY);
 
         if ($this->getOrderingType() == OQ_NESTED_PICTURES) {
             $formDataConverter->setImageRemovalCommand(self::ORDERING_ELEMENT_FORM_CMD_REMOVE_IMG);
             $formDataConverter->setImageUrlPath($this->getImagePathWeb());
             $formDataConverter->setThumbnailPrefix($this->getThumbPrefix());
         }
 
         return $formDataConverter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrderingElementFormDataConverter()

assOrderingQuestion::buildOrderingElementFormDataConverter ( )

protected

Definition at line 1479 of file class.assOrderingQuestion.php.

Referenced by buildNestedOrderingFormDataConverter(), buildOrderingImagesFormDataConverter(), and buildOrderingTextsFormDataConverter().

                                                               : ilAssOrderingFormValuesObjectsConverter
     {
         require_once 'Modules/TestQuestionPool/classes/forms/class.ilAssOrderingFormValuesObjectsConverter.php';
         $converter = new ilAssOrderingFormValuesObjectsConverter();
         $converter->setPostVar(self::ORDERING_ELEMENT_FORM_FIELD_POSTVAR);
 
         return $converter;
     }

Here is the caller graph for this function:

◆ buildOrderingElementInputGui()

assOrderingQuestion::buildOrderingElementInputGui ( )

Returns: ilAssNestedOrderingElementsInputGUI|ilAssOrderingImagesInputGUI|ilAssOrderingTextsInputGUI

Exceptions

ilTestQuestionPoolException

Definition at line 1143 of file class.assOrderingQuestion.php.

References buildOrderingImagesInputGui(), buildOrderingTextsInputGui(), and isImageOrderingType().

Referenced by ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput().

     {
         if ($this->isImageOrderingType()) {
             return $this->buildOrderingImagesInputGui();
         }
         return $this->buildOrderingTextsInputGui();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrderingImagesFormDataConverter()

assOrderingQuestion::buildOrderingImagesFormDataConverter ( )

protected

Definition at line 1488 of file class.assOrderingQuestion.php.

References buildOrderingElementFormDataConverter(), ilAssOrderingFormValuesObjectsConverter\CONTEXT_MAINTAIN_ELEMENT_IMAGE, assQuestion\getImagePath(), assQuestion\getImagePathWeb(), and getThumbPrefix().

Referenced by buildOrderingImagesInputGui().

                                                              : ilAssOrderingFormValuesObjectsConverter
     {
         $formDataConverter = $this->buildOrderingElementFormDataConverter();
         $formDataConverter->setContext(ilAssOrderingFormValuesObjectsConverter::CONTEXT_MAINTAIN_ELEMENT_IMAGE);
 
         $formDataConverter->setImageRemovalCommand(self::ORDERING_ELEMENT_FORM_CMD_REMOVE_IMG);
         $formDataConverter->setImageUrlPath($this->getImagePathWeb());
         $formDataConverter->setImageFsPath($this->getImagePath());
 
         if ($this->getThumbPrefix()) {
             $formDataConverter->setThumbnailPrefix($this->getThumbPrefix());
         }
         return $formDataConverter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrderingImagesInputGui()

assOrderingQuestion::buildOrderingImagesInputGui ( )

Definition at line 1188 of file class.assOrderingQuestion.php.

References buildOrderingImagesFormDataConverter(), and initOrderingElementFormFieldLabels().

Referenced by buildOrderingElementInputGui().

                                                  : ilAssOrderingImagesInputGUI
     {
         $formDataConverter = $this->buildOrderingImagesFormDataConverter();
 
         $orderingElementInput = new ilAssOrderingImagesInputGUI(
             $formDataConverter,
             self::ORDERING_ELEMENT_FORM_FIELD_POSTVAR
         );
 
         $orderingElementInput->setImageUploadCommand(self::ORDERING_ELEMENT_FORM_CMD_UPLOAD_IMG);
         $orderingElementInput->setImageRemovalCommand(self::ORDERING_ELEMENT_FORM_CMD_REMOVE_IMG);
 
         $this->initOrderingElementFormFieldLabels($orderingElementInput);
 
         return $orderingElementInput;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrderingTextsFormDataConverter()

assOrderingQuestion::buildOrderingTextsFormDataConverter ( )

protected

Definition at line 1503 of file class.assOrderingQuestion.php.

References buildOrderingElementFormDataConverter(), and ilAssOrderingFormValuesObjectsConverter\CONTEXT_MAINTAIN_ELEMENT_TEXT.

Referenced by buildOrderingTextsInputGui().

                                                             : ilAssOrderingFormValuesObjectsConverter
     {
         $formDataConverter = $this->buildOrderingElementFormDataConverter();
         $formDataConverter->setContext(ilAssOrderingFormValuesObjectsConverter::CONTEXT_MAINTAIN_ELEMENT_TEXT);
         return $formDataConverter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrderingTextsInputGui()

assOrderingQuestion::buildOrderingTextsInputGui ( )

Definition at line 1174 of file class.assOrderingQuestion.php.

References buildOrderingTextsFormDataConverter(), and initOrderingElementFormFieldLabels().

Referenced by buildOrderingElementInputGui().

                                                 : ilAssOrderingTextsInputGUI
     {
         $formDataConverter = $this->buildOrderingTextsFormDataConverter();
 
         $orderingElementInput = new ilAssOrderingTextsInputGUI(
             $formDataConverter,
             self::ORDERING_ELEMENT_FORM_FIELD_POSTVAR
         );
 
         $this->initOrderingElementFormFieldLabels($orderingElementInput);
 
         return $orderingElementInput;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTestPresentationConfig()

assOrderingQuestion::buildTestPresentationConfig ( )

Definition at line 1412 of file class.assOrderingQuestion.php.

References ILIAS\Repository\lng(), and ilTestQuestionConfig\setIsUnchangedAnswerPossible().

                                                  : ilTestQuestionConfig
     {
         return parent::buildTestPresentationConfig()
             ->setIsUnchangedAnswerPossible(true)
             ->setUseUnchangedAnswerLabel($this->lng->txt('tst_unchanged_order_is_correct'));
     }

Here is the call graph for this function:

◆ calculateReachedPoints()

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

public

Parameters

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

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

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

References calculateReachedPointsForSolution(), assQuestion\fetchIndexedValuesFromValuePairs(), assQuestion\getSolutionMaxPass(), getSolutionOrderingElementList(), and assQuestion\getSolutionValues().

Referenced by getExpressionTypes().

     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
 
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
 
         $solutionValuePairs = $this->getSolutionValues($active_id, $pass, $authorizedSolution);
 
         if (!count($solutionValuePairs)) {
             return 0;
         }
 
         $indexedSolutionValues = $this->fetchIndexedValuesFromValuePairs($solutionValuePairs);
         $solutionOrderingElementList = $this->getSolutionOrderingElementList($indexedSolutionValues);
 
         return $this->calculateReachedPointsForSolution($solutionOrderingElementList);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsForSolution()

assOrderingQuestion::calculateReachedPointsForSolution ( ilAssOrderingElementList $solutionOrderingElementList )

protected

Definition at line 1288 of file class.assOrderingQuestion.php.

References ilAssOrderingElementList\getElementByPosition(), getOrderingElementList(), and assQuestion\getPoints().

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

                                                                                                                : float
     {
         $reachedPoints = $this->getPoints();
 
         foreach ($this->getOrderingElementList() as $correctElement) {
             $userElement = $solutionOrderingElementList->getElementByPosition($correctElement->getPosition());
 
             if (!$correctElement->isSameElement($userElement)) {
                 $reachedPoints = 0;
                 break;
             }
         }
 
         return $reachedPoints;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assOrderingQuestion::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Definition at line 699 of file class.assOrderingQuestion.php.

References calculateReachedPointsForSolution(), assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), ilAssQuestionPreviewSession\getParticipantsSolution(), and ilAssQuestionPreviewSession\hasParticipantSolution().

     {
         if (!$previewSession->hasParticipantSolution()) {
             return 0;
         }
 
         $solutionOrderingElementList = unserialize(
             $previewSession->getParticipantsSolution(),
             ["allowed_classes" => true]
         );
 
         $reachedPoints = $this->calculateReachedPointsForSolution($solutionOrderingElementList);
         $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $reachedPoints);
 
         return $this->ensureNonNegativePoints($reachedPoints);
     }

Here is the call graph for this function:

◆ cleanImagefiles()

assOrderingQuestion::cleanImagefiles ( )

protected

Definition at line 742 of file class.assOrderingQuestion.php.

References Vendor\Package\$f, ilFileUtils\delDir(), ilFileUtils\getDir(), assQuestion\getImagePath(), getOrderingElementList(), getOrderingType(), getThumbPrefix(), and OQ_PICTURES.

                                         : void
     {
         if ($this->getOrderingType() == self::OQ_PICTURES) {
             if (@file_exists($this->getImagePath())) {
                 $contents = ilFileUtils::getDir($this->getImagePath());
                 foreach ($contents as $f) {
                     if (strcmp($f['type'], 'file') == 0) {
                         $found = false;
                         foreach ($this->getOrderingElementList() as $orderElement) {
                             if (strcmp($f['entry'], $orderElement->getContent()) == 0) {
                                 $found = true;
                             }
                             if (strcmp($f['entry'], $this->getThumbPrefix() . $orderElement->getContent()) == 0) {
                                 $found = true;
                             }
                         }
                         if (!$found) {
                             if (@file_exists($this->getImagePath() . $f['entry'])) {
                                 @unlink($this->getImagePath() . $f['entry']);
                             }
                         }
                     }
                 }
             }
         } else {
             if (@file_exists($this->getImagePath())) {
                 ilFileUtils::delDir($this->getImagePath());
             }
         }
     }

Here is the call graph for this function:

◆ copyImages()

assOrderingQuestion::copyImages	(	$question_id,
		$source_questionpool
	)

Deprecated:: (!) simply use the working method duplicateImages(), we do not search the difference here and we will delete this soon (!) currently no usage found, remove for il5.3

Definition at line 375 of file class.assOrderingQuestion.php.

References $DIC, $filename, assQuestion\$ilLog, assQuestion\getImagePath(), getOrderingElementList(), getOrderingType(), getThumbPrefix(), ilFileUtils\makeDirParents(), and OQ_PICTURES.

                                                                   : void
     {
         global $DIC;
         $ilLog = $DIC['ilLog'];
         if ($this->getOrderingType() == OQ_PICTURES) {
             $imagepath = $this->getImagePath();
             $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
             $imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
             if (!file_exists($imagepath)) {
                 ilFileUtils::makeDirParents($imagepath);
             }
             foreach ($this->getOrderingElementList() as $element) {
                 $filename = $element->getContent();
                 if (!@copy($imagepath_original . $filename, $imagepath . $filename)) {
                     $ilLog->write("Ordering Question image could not be copied: ${imagepath_original}${filename}");
                 }
                 if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename)) {
                     if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                         $ilLog->write("Ordering Question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ copyObject()

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

Copies an assOrderingQuestion object.

public

Definition at line 265 of file class.assOrderingQuestion.php.

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

                                                                     : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
         // duplicate the question in database
         $clone = clone $this;
         $this_id = $this->getId();
         $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();
 
         $list = $this->getRepository()->getOrderingList($this_id)
             ->withQuestionId($clone->getId());
         $list->distributeNewRandomIdentifiers();
         $clone->setOrderingElementList($list);
         $clone->saveToDb();
 
         $clone->copyPageOfQuestion($original_id);
         $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
         $clone->duplicateImages($original_id, $source_questionpool_id, $clone->getId(), $target_questionpool_id);
 
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
 
         return $clone->getId();
     }

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 297 of file class.assOrderingQuestion.php.

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

                                                                                                   : 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 = clone $this;
         $clone->id = -1;
 
         $clone->setObjId($targetParentId);
 
         if ($targetQuestionTitle) {
             $clone->setTitle($targetQuestionTitle);
         }
 
         $clone->saveToDb();
 
         $list = $this->getRepository()->getOrderingList($this->getId())
             ->withQuestionId($clone->getId());
         $list->distributeNewRandomIdentifiers();
         $clone->setOrderingElementList($list);
         $clone->saveToDb();
 
         // copy question page content
         $clone->copyPageOfQuestion($sourceQuestionId);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
         // duplicate the image
         $clone->duplicateImages($sourceQuestionId, $sourceParentId, $clone->getId(), $clone->getObjId());
 
         $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ deleteAnswer()

assOrderingQuestion::deleteAnswer ( $randomIdentifier )

Deletes an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters

integer $index A nonnegative index of the n-th answer public

See also: $answers

Definition at line 654 of file class.assOrderingQuestion.php.

References getOrderingElementList().

                                                    : void
     {
         $this->getOrderingElementList()->removeElement(
             $this->getOrderingElementList()->getElementByRandomIdentifier($randomIdentifier)
         );
         $this->getOrderingElementList()->saveToDb();
     }

Here is the call graph for this function:

◆ dropImageFile()

assOrderingQuestion::dropImageFile ( $imageFilename )

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

References assQuestion\getImagePath(), and getThumbPrefix().

     {
         if (!strlen($imageFilename)) {
             return false;
         }
 
         $result = @unlink($this->getImagePath() . $imageFilename);
         $result = $result && @unlink($this->getImagePath() . $this->getThumbPrefix() . $imageFilename);
 
         return $result;
     }

Here is the call graph for this function:

◆ duplicate()

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

Definition at line 207 of file class.assOrderingQuestion.php.

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

      : 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 = clone $this;
         $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();
         }
 
         //$list = $this->getRepository()->getOrderingList($original_id)
         $list = $this->getRepository()->getOrderingList($this_id)
             ->withQuestionId($clone->getId());
         $list->distributeNewRandomIdentifiers();
         $clone->setOrderingElementList($list);
         $clone->saveToDb();
 
         $clone->copyPageOfQuestion($this_id);
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
         $clone->duplicateImages($this_id, $thisObjId, $clone->getId(), $testObjId);
 
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
         return $clone->getId();
     }

Here is the call graph for this function:

◆ duplicateImages()

assOrderingQuestion::duplicateImages	(	$src_question_id,
		$src_object_id,
		$dest_question_id,
		$dest_object_id
	)

Definition at line 338 of file class.assOrderingQuestion.php.

References $DIC, $filename, assQuestion\$ilLog, assQuestion\getImagePath(), getOrderingElementList(), getThumbPrefix(), isImageOrderingType(), and ilFileUtils\makeDirParents().

Referenced by afterSyncWithOriginal().

                                                                                                          : void
     {
         global $DIC;
         $ilLog = $DIC['ilLog'];
         if ($this->isImageOrderingType()) {
             $imagepath_original = $this->getImagePath($src_question_id, $src_object_id);
             $imagepath = $this->getImagePath($dest_question_id, $dest_object_id);
 
             if (!file_exists($imagepath)) {
                 ilFileUtils::makeDirParents($imagepath);
             }
             foreach ($this->getOrderingElementList() as $element) {
                 $filename = $element->getContent();
 
                 if ($filename === '') {
                     continue;
                 }
 
                 if (!file_exists($imagepath_original . $filename)
                     || !copy($imagepath_original . $filename, $imagepath . $filename)) {
                     $ilLog->write("image could not be duplicated!!!!");
                     $ilLog->write($imagepath_original . $filename);
                     $ilLog->write($imagepath . $filename);
                 }
                 if (file_exists($imagepath_original . $this->getThumbPrefix() . $filename)
                     && !copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                     $ilLog->write("image thumbnail could not be duplicated!!!!");
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureImagePathExists()

assOrderingQuestion::ensureImagePathExists ( )

protected

Definition at line 1419 of file class.assOrderingQuestion.php.

References assQuestion\getImagePath(), and ilFileUtils\makeDirParents().

Referenced by storeImageFile().

                                               : void
     {
         if (!file_exists($this->getImagePath())) {
             ilFileUtils::makeDirParents($this->getImagePath());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchSolutionListFromFormSubmissionData()

assOrderingQuestion::fetchSolutionListFromFormSubmissionData ( $userSolutionPost )

Parameters

array $userSolutionPost

Definition at line 1231 of file class.assOrderingQuestion.php.

References ilAssOrderingElementList\buildInstance(), buildNestedOrderingElementInputGui(), ilAssNestedOrderingElementsInputGUI\CONTEXT_USER_SOLUTION_SUBMISSION, assQuestion\getId(), getOrderingElementList(), and isOrderingTypeNested().

Referenced by getSolutionListFromPostSubmit(), and getSolutionOrderingElementListForTestOutput().

                                                                               : ilAssOrderingElementList
     {
         $orderingGUI = $this->buildNestedOrderingElementInputGui();
         $orderingGUI->setContext(ilAssNestedOrderingElementsInputGUI::CONTEXT_USER_SOLUTION_SUBMISSION);
         $orderingGUI->setValueByArray($userSolutionPost);
 
         if (!$orderingGUI->checkInput()) {
             throw new ilTestException('error on validating user solution post');
         }
 
         $solutionOrderingElementList = ilAssOrderingElementList::buildInstance($this->getId());
 
         $storedElementList = $this->getOrderingElementList();
 
         foreach ($orderingGUI->getElementList($this->getId()) as $submittedElement) {
             $solutionElement = $storedElementList->getElementByRandomIdentifier(
                 $submittedElement->getRandomIdentifier()
             )->getClone();
 
             $solutionElement->setPosition($submittedElement->getPosition());
 
             if ($this->isOrderingTypeNested()) {
                 $solutionElement->setIndentation($submittedElement->getIndentation());
             }
 
             $solutionOrderingElementList->addElement($solutionElement);
         }
 
         return $solutionOrderingElementList;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchSolutionSubmit()

assOrderingQuestion::fetchSolutionSubmit ( $formSubmissionDataStructure )

Definition at line 1426 of file class.assOrderingQuestion.php.

References $index, ILIAS\LTI\ToolProvider\$key, getOrderingElementList(), getOrderingType(), OQ_NESTED_PICTURES, and OQ_NESTED_TERMS.

Referenced by getSolutionPostSubmit().

                                                                      : array
     {
         $solutionSubmit = array();
 
         if (isset($formSubmissionDataStructure['orderresult'])) {
             $orderresult = $formSubmissionDataStructure['orderresult'];
 
             if (strlen($orderresult)) {
                 $orderarray = explode(":", $orderresult);
                 $ordervalue = 1;
                 foreach ($orderarray as $index) {
                     $idmatch = null;
                     if (preg_match("/id_(\\d+)/", $index, $idmatch)) {
                         $randomid = $idmatch[1];
                         foreach ($this->getOrderingElementList() as $answeridx => $answer) {
                             if ($answer->getRandomIdentifier() == $randomid) {
                                 $solutionSubmit[$answeridx] = $ordervalue;
                                 $ordervalue++;
                             }
                         }
                     }
                 }
             }
         } elseif ($this->getOrderingType() == OQ_NESTED_TERMS || $this->getOrderingType() == OQ_NESTED_PICTURES) {
             $index = 0;
             foreach ($formSubmissionDataStructure['content'] as $randomId => $content) {
                 $indentation = $formSubmissionDataStructure['indentation'];
 
                 $value1 = $index++;
                 $value2 = implode(':', array($randomId, $indentation));
 
                 $solutionSubmit[$value1] = $value2;
             }
         } else {
             foreach ($formSubmissionDataStructure as $key => $value) {
                 $matches = null;
                 if (preg_match("/^order_(\d+)/", $key, $matches)) {
                     if (!(preg_match("/initial_value_\d+/", $value))) {
                         if (strlen($value)) {
                             foreach ($this->getOrderingElementList() as $answeridx => $answer) {
                                 if ($answer->getRandomIdentifier() == $matches[1]) {
                                     $solutionSubmit[$answeridx] = $value;
                                 }
                             }
                         }
                     }
                 }
             }
         }
 
         return $solutionSubmit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateThumbForFile()

assOrderingQuestion::generateThumbForFile	(	$path,
		$file
	)

protected

Definition at line 1073 of file class.assOrderingQuestion.php.

References $filename, $path, ilShellUtil\convertImage(), getThumbPrefix(), and assQuestion\getThumbSize().

Referenced by rebuildThumbnails().

                                                          : void
     {
         $filename = $path . $file;
         if (@file_exists($filename)) {
             $thumbpath = $path . $this->getThumbPrefix() . $file;
             $path_info = @pathinfo($filename);
             $ext = "";
             switch (strtoupper($path_info['extension'])) {
                 case 'PNG':
                     $ext = 'PNG';
                     break;
                 case 'GIF':
                     $ext = 'GIF';
                     break;
                 default:
                     $ext = 'JPEG';
                     break;
             }
             ilShellUtil::convertImage($filename, $thumbpath, $ext, (string) $this->getThumbSize());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalTableName()

assOrderingQuestion::getAdditionalTableName ( )

Definition at line 957 of file class.assOrderingQuestion.php.

Referenced by loadFromDb(), and savePreviewData().

                                             : string
     {
         return "qpl_qst_ordering";
     }

Here is the caller graph for this function:

◆ getAnswer()

assOrderingQuestion::getAnswer ( $index = 0 )

Returns the ordering element from the given position.

Parameters

int $position

Returns: ilAssOrderingElement|null

Definition at line 637 of file class.assOrderingQuestion.php.

References $index, and getOrderingElementList().

                                          : ?ilAssOrderingElement
     {
         if (!$this->getOrderingElementList()->elementExistByPosition($index)) {
             return null;
         }
 
         return $this->getOrderingElementList()->getElementByPosition($index);
     }

Here is the call graph for this function:

◆ getAnswerCount()

assOrderingQuestion::getAnswerCount ( )

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

References getOrderingElementList().

                                     : int
     {
         return $this->getOrderingElementList()->countElements();
     }

Here is the call graph for this function:

◆ getAnswerTableName()

assOrderingQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name public

Definition at line 968 of file class.assOrderingQuestion.php.

                                         : string
     {
         return "qpl_a_ordering";
     }

◆ getAvailableAnswerOptions()

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

Implements iQuestionCondition.

Definition at line 1394 of file class.assOrderingQuestion.php.

References $index, and getOrderingElementList().

     {
         if ($index !== null) {
             return $this->getOrderingElementList()->getElementByPosition($index);
         }
 
         return $this->getOrderingElementList()->getElements();
     }

Here is the call graph for this function:

◆ getElementHeight()

assOrderingQuestion::getElementHeight ( )

Definition at line 1044 of file class.assOrderingQuestion.php.

References $element_height.

Referenced by savePreviewData().

                                       : ?int
     {
         return $this->element_height;
     }

Here is the caller graph for this function:

◆ getEncryptedFilename()

assOrderingQuestion::getEncryptedFilename ( $filename )

Definition at line 733 of file class.assOrderingQuestion.php.

References $filename.

                                                    : string
     {
         $extension = "";
         if (preg_match("/.*\\.(\\w+)$/", $filename, $matches)) {
             $extension = $matches[1];
         }
         return md5($filename) . "." . $extension;
     }

◆ getExpressionTypes()

assOrderingQuestion::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 1314 of file class.assOrderingQuestion.php.

References $data, $DIC, $ilDB, assQuestion\$points, calculateReachedPoints(), iQuestionCondition\EmptyAnswerExpression, assQuestion\getId(), getMaximumPoints(), getOrderingElementList(), iQuestionCondition\getUserQuestionResult(), isOrderingTypeNested(), assQuestion\lookupMaxStep(), iQuestionCondition\NumericResultExpression, iQuestionCondition\OrderingResultExpression, and iQuestionCondition\PercentageResultExpression.

                                         : array
     {
         return array(
             iQuestionCondition::PercentageResultExpression,
             iQuestionCondition::NumericResultExpression,
             iQuestionCondition::OrderingResultExpression,
             iQuestionCondition::EmptyAnswerExpression,
         );
     }

Here is the call graph for this function:

◆ getMaximumPoints()

assOrderingQuestion::getMaximumPoints ( )

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

See also: $points

Definition at line 720 of file class.assOrderingQuestion.php.

References assQuestion\getPoints().

Referenced by getExpressionTypes(), and isComplete().

                                       : float
     {
         return $this->getPoints();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOperators()

assOrderingQuestion::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

string $expression

Implements iQuestionCondition.

Definition at line 1309 of file class.assOrderingQuestion.php.

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Here is the call graph for this function:

◆ getOrderElements()

assOrderingQuestion::getOrderElements ( )

Returns the answers array.

Deprecated:: seriously, stop looking for this kind data at this point (!) look where it comes from and learn (!)

Definition at line 992 of file class.assOrderingQuestion.php.

References getOrderingElementList().

Referenced by rebuildThumbnails().

                                       : array
     {
         return $this->getOrderingElementList()->getRandomIdentifierIndexedElements();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrderingElementList()

assOrderingQuestion::getOrderingElementList ( )

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

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

Referenced by calculateReachedPointsForSolution(), cleanImagefiles(), copyImages(), deleteAnswer(), duplicateImages(), fetchSolutionListFromFormSubmissionData(), fetchSolutionSubmit(), getAnswer(), getAnswerCount(), getAvailableAnswerOptions(), getExpressionTypes(), getOrderElements(), getOrderingElementListForSolutionOutput(), getRTETextWithMediaObjects(), getShuffledOrderingElementList(), getSolutionOrderingElementList(), getSolutionValuePairBrandedOrderingElementByRandomIdentifier(), getSolutionValuePairBrandedOrderingElementBySolutionIdentifier(), isComplete(), setExportDetailsXLS(), toJSON(), and validateSolutionSubmit().

                                             : ilAssOrderingElementList
     {
         return $this->getRepository()->getOrderingList($this->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrderingElementListForSolutionOutput()

assOrderingQuestion::getOrderingElementListForSolutionOutput	(	$forceCorrectSolution,
		$activeId,
		$passIndex
	)

Parameters

$forceCorrectSolution
$activeId
$passIndex

Returns: ilAssOrderingElementList

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

References assQuestion\fetchIndexedValuesFromValuePairs(), getOrderingElementList(), getShuffledOrderingElementList(), getSolutionOrderingElementList(), and assQuestion\getSolutionValues().

                                                                                                          : ilAssOrderingElementList
     {
         if ($forceCorrectSolution || !$activeId || $passIndex === null) {
             return $this->getOrderingElementList();
         }
 
         $solutionValues = $this->getSolutionValues($activeId, $passIndex);
 
         if (!count($solutionValues)) {
             return $this->getShuffledOrderingElementList();
         }
 
         return $this->getSolutionOrderingElementList($this->fetchIndexedValuesFromValuePairs($solutionValues));
     }

Here is the call graph for this function:

◆ getOrderingType()

assOrderingQuestion::getOrderingType ( )

Definition at line 418 of file class.assOrderingQuestion.php.

References $ordering_type.

Referenced by buildNestedOrderingElementInputGui(), buildNestedOrderingFormDataConverter(), cleanImagefiles(), copyImages(), fetchSolutionSubmit(), isImageOrderingType(), isOrderingTypeNested(), saveWorkingData(), and toJSON().

                                      : int
     {
         return $this->ordering_type;
     }

Here is the caller graph for this function:

◆ getQuestionRepository()

assOrderingQuestion::getQuestionRepository ( )

protected

Definition at line 941 of file class.assOrderingQuestion.php.

References $DIC, and $ilDB.

                                               : ILIAS\TA\Questions\Ordering\assOrderingQuestionDatabaseRepository
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         return new \ILIAS\TA\Questions\Ordering\assOrderingQuestionDatabaseRepository($ilDB);
     }

◆ getQuestionType()

assOrderingQuestion::getQuestionType ( )

Definition at line 952 of file class.assOrderingQuestion.php.

Referenced by toJSON().

                                      : string
     {
         return "assOrderingQuestion";
     }

Here is the caller graph for this function:

◆ getRepository()

assOrderingQuestion::getRepository ( )

protected

Definition at line 127 of file class.assOrderingQuestion.php.

References $DIC, $ilDB, and $oq_repository.

Referenced by copyObject(), createNewOriginalFromThisDuplicate(), duplicate(), getOrderingElementList(), and setOrderingElementList().

                                       : ILIAS\TA\Questions\Ordering\assOrderingQuestionDatabaseRepository
     {
         if (is_null($this->oq_repository)) {
             global $DIC;
             $ilDB = $DIC['ilDB'];
             $this->oq_repository = new OQRepository($ilDB);
         }
         return $this->oq_repository;
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assOrderingQuestion::getRTETextWithMediaObjects ( )

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

Definition at line 977 of file class.assOrderingQuestion.php.

References getOrderingElementList().

                                                 : string
     {
         $text = parent::getRTETextWithMediaObjects();
 
         foreach ($this->getOrderingElementList() as $orderingElement) {
             $text .= $orderingElement->getContent();
         }
 
         return $text;
     }

Here is the call graph for this function:

◆ getShuffledOrderingElementList()

assOrderingQuestion::getShuffledOrderingElementList ( )

Definition at line 601 of file class.assOrderingQuestion.php.

References getOrderingElementList(), and assQuestion\getShuffler().

Referenced by getOrderingElementListForSolutionOutput(), and getSolutionOrderingElementListForTestOutput().

                                                     : ilAssOrderingElementList
     {
         $shuffledRandomIdentifierIndex = $this->getShuffler()->transform(
             $this->getOrderingElementList()->getRandomIdentifierIndex()
         );
 
         $shuffledElementList = $this->getOrderingElementList()->getClone();
         $shuffledElementList->reorderByRandomIdentifiers($shuffledRandomIdentifierIndex);
         $shuffledElementList->resetElementsIndentations();
 
         return $shuffledElementList;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionListFromPostSubmit()

assOrderingQuestion::getSolutionListFromPostSubmit ( )

Definition at line 1267 of file class.assOrderingQuestion.php.

References $DIC, $post_array, $postSolutionOrderingElementList, and fetchSolutionListFromFormSubmissionData().

Referenced by savePreviewData(), saveWorkingData(), and validateSolutionSubmit().

                                                    : ilAssOrderingElementList
     {
         if ($this->postSolutionOrderingElementList === null) {
             $post_array = $_POST;
             if (!is_array($post_array)) {
                 global $DIC;
                 $request = $DIC->http()->request();
                 $post_array = $request->getParsedBody();
             }
             $list = $this->fetchSolutionListFromFormSubmissionData($post_array);
             $this->postSolutionOrderingElementList = $list;
         }
 
         return $this->postSolutionOrderingElementList;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionOrderingElementList()

assOrderingQuestion::getSolutionOrderingElementList ( $indexedSolutionValues )

Parameters

array $valuePairs

Returns: ilAssOrderingElementList

Exceptions

ilTestQuestionPoolException

Definition at line 579 of file class.assOrderingQuestion.php.

References assQuestion\getId(), getOrderingElementList(), getSolutionValuePairBrandedOrderingElementByRandomIdentifier(), getSolutionValuePairBrandedOrderingElementBySolutionIdentifier(), and isOrderingTypeNested().

Referenced by calculateReachedPoints(), getOrderingElementListForSolutionOutput(), and getSolutionOrderingElementListForTestOutput().

                                                                           : ilAssOrderingElementList
     {
         $solutionOrderingList = new ilAssOrderingElementList();
         $solutionOrderingList->setQuestionId($this->getId());
 
         foreach ($indexedSolutionValues as $value1 => $value2) {
             if ($this->isOrderingTypeNested()) {
                 $element = $this->getSolutionValuePairBrandedOrderingElementByRandomIdentifier($value1, $value2);
             } else {
                 $element = $this->getSolutionValuePairBrandedOrderingElementBySolutionIdentifier($value1, $value2);
             }
 
             $solutionOrderingList->addElement($element);
         }
 
         if (!$this->getOrderingElementList()->hasSameElementSetByRandomIdentifiers($solutionOrderingList)) {
             throw new ilTestQuestionPoolException('inconsistent solution values given');
         }
 
         return $solutionOrderingList;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionOrderingElementListForTestOutput()

assOrderingQuestion::getSolutionOrderingElementListForTestOutput	(	ilAssNestedOrderingElementsInputGUI	$inputGUI,
			$lastPost,
			$activeId,
			$pass
	)

Parameters

ilAssNestedOrderingElementsInputGUI	$inputGUI
array	$lastPost
integer	$activeId
integer	$pass

Returns: ilAssOrderingElementList

Exceptions

ilTestException
ilTestQuestionPoolException

Definition at line 518 of file class.assOrderingQuestion.php.

References assQuestion\fetchIndexedValuesFromValuePairs(), fetchSolutionListFromFormSubmissionData(), getShuffledOrderingElementList(), getSolutionOrderingElementList(), assQuestion\getTestOutputSolutions(), and ilAssNestedOrderingElementsInputGUI\isPostSubmit().

                                                                                                                                            : ilAssOrderingElementList
     {
         if ($inputGUI->isPostSubmit($lastPost)) {
             return $this->fetchSolutionListFromFormSubmissionData($lastPost);
         }
         $indexedSolutionValues = $this->fetchIndexedValuesFromValuePairs(
             // hey: prevPassSolutions - obsolete due to central check
             $this->getTestOutputSolutions($activeId, $pass)
             // hey.
         );
 
         if (count($indexedSolutionValues)) {
             return $this->getSolutionOrderingElementList($indexedSolutionValues);
         }
 
         return $this->getShuffledOrderingElementList();
     }

Here is the call graph for this function:

◆ getSolutionPostSubmit()

assOrderingQuestion::getSolutionPostSubmit ( )

Definition at line 1283 of file class.assOrderingQuestion.php.

References fetchSolutionSubmit().

                                            : array
     {
         return $this->fetchSolutionSubmit($_POST);
     }

Here is the call graph for this function:

◆ getSolutionValuePairBrandedOrderingElementByRandomIdentifier()

assOrderingQuestion::getSolutionValuePairBrandedOrderingElementByRandomIdentifier	(	$value1,
		$value2
	)

protected

Parameters

string	$value1
string	$value2

Definition at line 540 of file class.assOrderingQuestion.php.

References getOrderingElementList().

Referenced by getSolutionOrderingElementList().

                                                                                                      : ilAssOrderingElement
     {
         $value2 = explode(':', $value2);
 
         $randomIdentifier = $value2[0];
         $selectedPosition = $value1;
         $selectedIndentation = $value2[1];
 
         $element = $this->getOrderingElementList()->getElementByRandomIdentifier($randomIdentifier)->getClone();
 
         $element->setPosition($selectedPosition);
         $element->setIndentation($selectedIndentation);
 
         return $element;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionValuePairBrandedOrderingElementBySolutionIdentifier()

assOrderingQuestion::getSolutionValuePairBrandedOrderingElementBySolutionIdentifier	(	$value1,
		$value2
	)

protected

Parameters

string	$value1
string	$value2

Definition at line 560 of file class.assOrderingQuestion.php.

References getOrderingElementList().

Referenced by getSolutionOrderingElementList().

                                                                                                        : ilAssOrderingElement
     {
         $solutionIdentifier = $value1;
         $selectedPosition = ($value2 - 1);
         $selectedIndentation = 0;
 
         $element = $this->getOrderingElementList()->getElementBySolutionIdentifier($solutionIdentifier)->getClone();
 
         $element->setPosition($selectedPosition);
         $element->setIndentation($selectedIndentation);
 
         return $element;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbPrefix()

assOrderingQuestion::getThumbPrefix ( )

Definition at line 1068 of file class.assOrderingQuestion.php.

Referenced by buildNestedOrderingElementInputGui(), buildNestedOrderingFormDataConverter(), buildOrderingImagesFormDataConverter(), cleanImagefiles(), copyImages(), dropImageFile(), duplicateImages(), generateThumbForFile(), storeImageFile(), and updateImageFile().

                                     : string
     {
         return "thumb.";
     }

Here is the caller graph for this function:

◆ getValidOrderingTypes()

assOrderingQuestion::getValidOrderingTypes ( )

protected

Definition at line 400 of file class.assOrderingQuestion.php.

References OQ_NESTED_PICTURES, OQ_NESTED_TERMS, OQ_PICTURES, and OQ_TERMS.

Referenced by setOrderingType().

                                               : array
     {
         return [
             self::OQ_PICTURES,
             self::OQ_TERMS,
             self::OQ_NESTED_PICTURES,
             self::OQ_NESTED_TERMS
         ];
     }

Here is the caller graph for this function:

◆ hasOrderingTypeUploadSupport()

assOrderingQuestion::hasOrderingTypeUploadSupport ( )

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

References isImageOrderingType().

Referenced by isImageReplaced().

                                                   : bool
     {
         return $this->isImageOrderingType();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initOrderingElementAuthoringProperties()

assOrderingQuestion::initOrderingElementAuthoringProperties ( ilFormPropertyGUI $formField )

Definition at line 1151 of file class.assOrderingQuestion.php.

References isOrderingTypeNested().

Referenced by ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput().

                                                                                         : void
     {
         switch (true) {
             case $formField instanceof ilAssNestedOrderingElementsInputGUI:
                 $formField->setInteractionEnabled(true);
                 $formField->setNestingEnabled($this->isOrderingTypeNested());
                 break;
 
             case $formField instanceof ilAssOrderingTextsInputGUI:
             case $formField instanceof ilAssOrderingImagesInputGUI:
             default:
 
                 $formField->setEditElementOccuranceEnabled(true);
                 $formField->setEditElementOrderEnabled(true);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initOrderingElementFormFieldLabels()

assOrderingQuestion::initOrderingElementFormFieldLabels ( ilFormPropertyGUI $formField )

Definition at line 1168 of file class.assOrderingQuestion.php.

References ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setTitle().

Referenced by buildNestedOrderingElementInputGui(), buildOrderingImagesInputGui(), and buildOrderingTextsInputGui().

                                                                                     : void
     {
         $formField->setInfo($this->lng->txt('ordering_answer_sequence_info'));
         $formField->setTitle($this->lng->txt('answers'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isComplete()

assOrderingQuestion::isComplete ( )

Returns true, if a ordering question is complete for use.

Returns: boolean True, if the ordering question is complete for use, otherwise false

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

References assQuestion\getAuthor(), getMaximumPoints(), getOrderingElementList(), assQuestion\getQuestion(), and assQuestion\getTitle().

                                 : bool
     {
         $elements = array_filter(
             $this->getOrderingElementList()->getElements(),
             fn ($element) => trim($element->getContent()) != ''
         );
         $has_at_least_two_elements = count($elements) > 1;
 
         $complete = $this->getAuthor()
             && $this->getTitle()
             && $this->getQuestion()
             && $this->getMaximumPoints()
             && $has_at_least_two_elements;
 
         return $complete;
     }

Here is the call graph for this function:

◆ isImageFileStored()

assOrderingQuestion::isImageFileStored ( $imageFilename )

Definition at line 789 of file class.assOrderingQuestion.php.

References assQuestion\getImagePath().

                                                      : bool
     {
         if (!strlen($imageFilename)) {
             return false;
         }
 
         if (!file_exists($this->getImagePath() . $imageFilename)) {
             return false;
         }
 
         return is_file($this->getImagePath() . $imageFilename);
     }

Here is the call graph for this function:

◆ isImageOrderingType()

assOrderingQuestion::isImageOrderingType ( )

Definition at line 432 of file class.assOrderingQuestion.php.

References getOrderingType(), OQ_NESTED_PICTURES, and OQ_PICTURES.

Referenced by ilAssOrderingQuestionAuthoringFormGUI\addSpecificOrderingQuestionCommandButtons(), buildOrderingElementInputGui(), duplicateImages(), hasOrderingTypeUploadSupport(), rebuildThumbnails(), and setNestingType().

                                          : bool
     {
         $with_images = [
             self::OQ_PICTURES,
             self::OQ_NESTED_PICTURES
         ];
         return in_array($this->getOrderingType(), $with_images);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isImageReplaced()

assOrderingQuestion::isImageReplaced	(	ilAssOrderingElement	$newElement,
		ilAssOrderingElement	$oldElement
	)

Definition at line 802 of file class.assOrderingQuestion.php.

References ilAssOrderingElement\getContent(), and hasOrderingTypeUploadSupport().

                                                                                                        : bool
     {
         if (!$this->hasOrderingTypeUploadSupport()) {
             return false;
         }
 
         if (!$newElement->getContent()) {
             return false;
         }
 
         return $newElement->getContent() != $oldElement->getContent();
     }

Here is the call graph for this function:

◆ isOrderingTypeNested()

assOrderingQuestion::isOrderingTypeNested ( )

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

References getOrderingType(), OQ_NESTED_PICTURES, and OQ_NESTED_TERMS.

Referenced by fetchSolutionListFromFormSubmissionData(), getExpressionTypes(), getSolutionOrderingElementList(), initOrderingElementAuthoringProperties(), and setContentType().

                                           : bool
     {
         $nested = [
             self::OQ_NESTED_TERMS,
             self::OQ_NESTED_PICTURES
         ];
         return in_array($this->getOrderingType(), $nested);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromDb()

assOrderingQuestion::loadFromDb ( $question_id )

Loads a assOrderingQuestion object from a database.

Parameters

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

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

References $data, $DIC, Vendor\Package\$e, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\getMinimumThumbSize(), ILIAS\Repository\int(), OQ_TERMS, assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setThumbSize(), and assQuestion\setTitle().

                                             : void
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $result = $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 = $ilDB->fetchAssoc($result);
             $this->setId($question_id);
             $this->setObjId($data["obj_fi"]);
             $this->setTitle((string) $data["title"]);
             $this->setComment((string) $data["description"]);
             $this->setOriginalId($data["original_id"]);
             $this->setAuthor($data["author"]);
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setPoints($data["points"]);
             $this->setOwner($data["owner"]);
             include_once("./Services/RTE/classes/class.ilRTE.php");
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));
             $this->ordering_type = $data["ordering_type"] !== null ? (int) $data["ordering_type"] : OQ_TERMS;
             if ($data['thumb_geometry'] !== null && $data['thumb_geometry'] >= $this->getMinimumThumbSize()) {
                 $this->setThumbSize($data['thumb_geometry']);
             }
             $this->element_height = $data["element_height"] ? (int) $data['element_height'] : null;
 
             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) {
             }
         }
 
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ rebuildThumbnails()

assOrderingQuestion::rebuildThumbnails ( )

Definition at line 1057 of file class.assOrderingQuestion.php.

References generateThumbForFile(), assQuestion\getImagePath(), getOrderElements(), and isImageOrderingType().

                                        : void
     {
         if ($this->isImageOrderingType()) {
             foreach ($this->getOrderElements() as $orderingElement) {
                 if ($orderingElement->getContent() !== '') {
                     $this->generateThumbForFile($this->getImagePath(), $orderingElement->getContent());
                 }
             }
         }
     }

Here is the call graph for this function:

◆ saveAnswerSpecificDataToDb()

assOrderingQuestion::saveAnswerSpecificDataToDb ( )

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

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 948 of file class.assOrderingQuestion.php.

949 {

950 }

◆ savePreviewData()

assOrderingQuestion::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Definition at line 908 of file class.assOrderingQuestion.php.

References $DIC, $ilDB, getAdditionalTableName(), getElementHeight(), assQuestion\getId(), getSolutionListFromPostSubmit(), assQuestion\getThumbSize(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilAssQuestionPreviewSession\setParticipantsSolution(), and validateSolutionSubmit().

                                                                                    : void
     {
         if ($this->validateSolutionSubmit()) {
             $previewSession->setParticipantsSolution(serialize($this->getSolutionListFromPostSubmit()));
         }
     }

Here is the call graph for this function:

◆ saveToDb()

assOrderingQuestion::saveToDb ( $original_id = "" )

Saves a assOrderingQuestion object to a database.

Parameters

string $original_id

Definition at line 145 of file class.assOrderingQuestion.php.

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

                                                : void
     {
         if ($original_id == '') {
             $this->saveQuestionDataToDb();
         } else {
             $this->saveQuestionDataToDb((int) $original_id);
         }
         $this->saveAdditionalQuestionDataToDb();
         parent::saveToDb();
     }

Here is the call graph for this function:

◆ saveWorkingData()

assOrderingQuestion::saveWorkingData	(	$active_id,
		$pass = `null`,
		$authorized = `true`
	)

Saves the learners input of the question to the database.

public

Parameters

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

Returns: boolean $status

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

References $DIC, ilObjTest\_getPass(), getOrderingType(), assQuestion\getProcessLocker(), getSolutionListFromPostSubmit(), assQuestion\log(), assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

                                                                                  : bool
     {
         global $DIC;
         if ($DIC->testQuestionPool()->internal()->request()->raw('test_answer_changed') === null) {
             return true;
         }
 
         $entered_values = 0;
 
         if (is_null($pass)) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use (&$entered_values, $active_id, $pass, $authorized) {
                 $this->removeCurrentSolution($active_id, $pass, $authorized);
 
                 foreach ($this->getSolutionListFromPostSubmit() as $orderingElement) {
                     $value1 = $orderingElement->getStorageValue1($this->getOrderingType());
                     $value2 = $orderingElement->getStorageValue2($this->getOrderingType());
 
                     $this->saveCurrentSolution($active_id, $pass, $value1, trim($value2), $authorized);
 
                     $entered_values++;
                 }
             }
         );
 
         if ($entered_values) {
             $this->log($active_id, 'log_user_entered_values');
         } else {
             $this->log($active_id, 'log_user_not_entered_values');
         }
 
         return true;
     }

Here is the call graph for this function:

◆ setContentType()

assOrderingQuestion::setContentType ( $ct )

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

References assQuestion\getThumbSize(), isOrderingTypeNested(), OQ_NESTED_PICTURES, OQ_NESTED_TERMS, OQ_PICTURES, OQ_TERMS, setOrderingType(), and assQuestion\setThumbSize().

     {
         if (!in_array($ct, [
             self::OQ_CT_PICTURES,
             self::OQ_CT_TERMS
         ])) {
             throw new \InvalidArgumentException("use OQ content-type", 1);
         }
         if ($ct == self::OQ_CT_PICTURES) {
             if ($this->isOrderingTypeNested()) {
                 $this->setOrderingType(self::OQ_NESTED_PICTURES);
             } else {
                 $this->setOrderingType(self::OQ_PICTURES);
             }
             $this->setThumbSize($this->getThumbSize());
         }
         if ($ct == self::OQ_CT_TERMS) {
             if ($this->isOrderingTypeNested()) {
                 $this->setOrderingType(self::OQ_NESTED_TERMS);
             } else {
                 $this->setOrderingType(self::OQ_TERMS);
             }
         }
     }

Here is the call graph for this function:

◆ setElementHeight()

assOrderingQuestion::setElementHeight ( ?int $a_height )

Definition at line 1049 of file class.assOrderingQuestion.php.

                                                     : void
     {
         $this->element_height = ($a_height < 20) ? null : $a_height;
     }

◆ setExportDetailsXLS()

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

{}

Definition at line 1016 of file class.assOrderingQuestion.php.

References $i, ilExcel\getColumnCoord(), getOrderingElementList(), assQuestion\getSolutionValues(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                     : int
     {
         parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
         $solutions = $this->getSolutionValues($active_id, $pass);
         $sol = array();
         foreach ($solutions as $solution) {
             $sol[$solution["value1"]] = $solution["value2"];
         }
         asort($sol);
         $sol = array_keys($sol);
 
         $i = 1;
         foreach ($sol as $idx) {
             foreach ($solutions as $solution) {
                 if ($solution["value1"] == $idx) {
                     $worksheet->setCell($startrow + $i, 0, $solution["value2"]);
                     $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
                 }
             }
             $element = $this->getOrderingElementList()->getElementBySolutionIdentifier($idx);
             $worksheet->setCell($startrow + $i, 2, $element->getContent());
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setNestingType()

assOrderingQuestion::setNestingType ( bool $nesting )

Definition at line 466 of file class.assOrderingQuestion.php.

References isImageOrderingType(), OQ_NESTED_PICTURES, OQ_NESTED_TERMS, OQ_PICTURES, OQ_TERMS, and setOrderingType().

     {
         if ($nesting) {
             if ($this->isImageOrderingType()) {
                 $this->setOrderingType(self::OQ_NESTED_PICTURES);
             } else {
                 $this->setOrderingType(self::OQ_NESTED_TERMS);
             }
         } else {
             if ($this->isImageOrderingType()) {
                 $this->setOrderingType(self::OQ_PICTURES);
             } else {
                 $this->setOrderingType(self::OQ_TERMS);
             }
         }
     }

Here is the call graph for this function:

◆ setOrderingElementList()

assOrderingQuestion::setOrderingElementList ( ilAssOrderingElementList $list )

Definition at line 619 of file class.assOrderingQuestion.php.

References Vendor\Package\$e, ilAssOrderingElementList\ensureValidIdentifiers(), ilAssOrderingElementList\getElements(), assQuestion\getId(), getRepository(), ilAssOrderingElementList\withElements(), and ilAssOrderingElementList\withQuestionId().

                                                                           : void
     {
         $list = $list->withQuestionId($this->getId());
         $elements = $list->getElements();
         $nu = [];
         foreach ($elements as $e) {
             $nu[] = $list->ensureValidIdentifiers($e);
         }
         $list = $list->withElements($nu);
         $this->getRepository()->updateOrderingList($list);
     }

Here is the call graph for this function:

◆ setOrderingType()

assOrderingQuestion::setOrderingType ( $ordering_type = self::OQ_TERMS )

Definition at line 410 of file class.assOrderingQuestion.php.

References $ordering_type, and getValidOrderingTypes().

Referenced by setContentType(), and setNestingType().

     {
         if (!in_array($ordering_type, $this->getValidOrderingTypes())) {
             throw new \InvalidArgumentException('Must be valid ordering type.');
         }
         $this->ordering_type = $ordering_type;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeImageFile()

assOrderingQuestion::storeImageFile	(	string	$upload_file,
		string	$upload_name
	)

Definition at line 815 of file class.assOrderingQuestion.php.

References assQuestion\buildHashedImageFilename(), ilShellUtil\convertImage(), ensureImagePathExists(), assQuestion\getImagePath(), getThumbPrefix(), assQuestion\getThumbSize(), and ilFileUtils\moveUploadedFile().

                                                                             : ?string
     {
         $name_parts = explode(".", $upload_name);
         $suffix = strtolower(array_pop($name_parts));
         if (!in_array($suffix, self::VALID_UPLOAD_SUFFIXES)) {
             return null;
         }
 
         $this->ensureImagePathExists();
         $target_filename = $this->buildHashedImageFilename($upload_name, true);
         $target_filepath = $this->getImagePath() . $target_filename;
         if (ilFileUtils::moveUploadedFile($upload_file, $target_filename, $target_filepath)) {
             $thumb_path = $this->getImagePath() . $this->getThumbPrefix() . $target_filename;
             ilShellUtil::convertImage($target_filepath, $thumb_path, "JPEG", (string) $this->getThumbSize());
 
             return $target_filename;
         }
 
         return null;
     }

Here is the call graph for this function:

◆ supportsJavascriptOutput()

assOrderingQuestion::supportsJavascriptOutput ( )

Returns true if the question type supports JavaScript output.

Returns: boolean TRUE if the question type supports JavaScript output, FALSE otherwise public

Definition at line 1003 of file class.assOrderingQuestion.php.

                                               : bool
     {
         return true;
     }

◆ supportsNonJsOutput()

assOrderingQuestion::supportsNonJsOutput ( )

Definition at line 1008 of file class.assOrderingQuestion.php.

                                          : bool
     {
         return false;
     }

◆ toJSON()

assOrderingQuestion::toJSON ( )

Returns a JSON representation of the question.

Definition at line 1098 of file class.assOrderingQuestion.php.

References $mobs, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), assQuestion\getId(), assQuestion\getImagePathWeb(), assQuestion\getNrOfTries(), getOrderingElementList(), getOrderingType(), assQuestion\getPoints(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffler(), assQuestion\getTitleForHTMLOutput(), and OQ_PICTURES.

                             : string
     {
         include_once("./Services/RTE/classes/class.ilRTE.php");
         $result = array();
         $result['id'] = $this->getId();
         $result['type'] = (string) $this->getQuestionType();
         $result['title'] = $this->getTitleForHTMLOutput();
         $result['question'] = $this->formatSAQuestion($this->getQuestion());
         $result['nr_of_tries'] = $this->getNrOfTries();
         $result['shuffle'] = true;
         $result['points'] = $this->getPoints();
         $result['feedback'] = array(
             'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
             'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
         );
         if ($this->getOrderingType() == self::OQ_PICTURES) {
             $result['path'] = $this->getImagePathWeb();
         }
 
         $counter = 1;
         $answers = array();
         foreach ($this->getOrderingElementList() as $orderingElement) {
             $answers[$counter] = $orderingElement->getContent();
             $counter++;
         }
         $answers = $this->getShuffler()->transform($answers);
         $arr = array();
         foreach ($answers as $order => $answer) {
             array_push($arr, array(
                 "answertext" => (string) $answer,
                 "order" => (int) $order
             ));
         }
         $result['answers'] = $arr;
 
         $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
         $result['mobs'] = $mobs;
 
         return json_encode($result);
     }

Here is the call graph for this function:

◆ updateImageFile()

assOrderingQuestion::updateImageFile ( string $existing_image_name )

Definition at line 836 of file class.assOrderingQuestion.php.

References assQuestion\buildHashedImageFilename(), ilShellUtil\convertImage(), assQuestion\getImagePath(), getThumbPrefix(), assQuestion\getThumbSize(), and ilFileUtils\rename().

                                                                 : ?string
     {
         $existing_image_path = $this->getImagePath() . $existing_image_name;
         $target_filename = $this->buildHashedImageFilename($existing_image_name, true);
         $target_filepath = $this->getImagePath() . $target_filename;
         if (ilFileUtils::rename($existing_image_path, $target_filepath)) {
             unlink($this->getImagePath() . $this->getThumbPrefix() . $existing_image_name);
             $thumb_path = $this->getImagePath() . $this->getThumbPrefix() . $target_filename;
             ilShellUtil::convertImage($target_filepath, $thumb_path, "JPEG", (string) $this->getThumbSize());
 
             return $target_filename;
         }
 
         return $existing_image_name;
     }

Here is the call graph for this function:

◆ validateSolutionSubmit()

assOrderingQuestion::validateSolutionSubmit ( )

Definition at line 852 of file class.assOrderingQuestion.php.

References getOrderingElementList(), and getSolutionListFromPostSubmit().

Referenced by savePreviewData().

                                             : bool
     {
         $submittedSolutionList = $this->getSolutionListFromPostSubmit();
 
         if (!$submittedSolutionList->hasElements()) {
             return true;
         }
 
         return $this->getOrderingElementList()->hasSameElementSetByRandomIdentifiers($submittedSolutionList);
     }