assOrderingQuestion Class Reference

Class for ordering questions. More...

Inheritance diagram for assOrderingQuestion:

Collaboration diagram for assOrderingQuestion:

Public Member Functions
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="", protected int $ordering_type=self::OQ_TERMS)
	isComplete ()
	saveToDb (?int $original_id=null)
	loadFromDb ($question_id)
	Loads a assOrderingQuestion object from a database. More...
	cloneImages (int $source_question_id, int $source_parent_id, int $target_question_id, int $target_parent_id)
	setOrderingType (int $ordering_type=self::OQ_TERMS)
	getOrderingType ()
	isOrderingTypeNested ()
	isImageOrderingType ()
	setContentType ($ct)
	setNestingType (bool $nesting)
	hasOrderingTypeUploadSupport ()
	getOrderingElementListForSolutionOutput (bool $force_correct_solution, int $active_id, ?int $pass_index)
	getSolutionOrderingElementListForTestOutput (ilAssNestedOrderingElementsInputGUI $input_gui, array $last_post, int $active_id, int $pass)
	getSolutionOrderingElementList (array $indexed_solution_values)
	getShuffledOrderingElementList ()
	getOrderingElementList ()
	setOrderingElementList (ilAssOrderingElementList $list)
	getAnswer (int $index=0)
	Returns the ordering element from the given position. More...
	deleteAnswer (int $random_identifier)
	getAnswerCount ()
	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)
	getMaximumPoints ()
	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 (int $active_id, ?int $pass=null, bool $authorized=true)
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...
	getQuestionType ()
	Returns the question type of the question. More...
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getAnswerTableName ()
	Returns the name of the answer table in the database. More...
	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...
	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 (array $user_solution_post)
	getSolutionListFromPostSubmit ()
	getOperators (string $expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. More...
	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...
	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 ()
	Get the test question configuration. More...
	fetchSolutionSubmit (array $form_submission_data_structure)
	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...
	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...
	getCorrectSolutionForTextOutput (int $active_id, int $pass)
Public Member Functions inherited from assQuestion
	getQuestionType ()
	isComplete ()
	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)
	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)
	getAdditionalTableName ()
	getAnswerTableName ()
	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...
	getCurrentUser ()
	getShuffler ()
	setShuffler (Transformation $shuffler)
	setProcessLocker (ilAssQuestionProcessLocker $processLocker)
	getProcessLocker ()
	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping)
	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...
	setTitle (string $title="")
	setId (int $id=-1)
	setTestId (int $id=-1)
	setComment (string $comment="")
	setShuffle (?bool $shuffle=true)
	setAuthor (string $author="")
	setOwner (int $owner=-1)
	getTitle ()
	getTitleForHTMLOutput ()
	getTitleFilenameCompliant ()
	getId ()
	getShuffle ()
	getTestId ()
	getComment ()
	getDescriptionForHTMLOutput ()
	getThumbSize ()
	setThumbSize (int $a_size)
	getMinimumThumbSize ()
	getMaximumThumbSize ()
	getAuthor ()
	getAuthorForHTMLOutput ()
	getOwner ()
	getObjId ()
	setObjId (int $obj_id=0)
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId (?string $external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
	getSuggestedSolutions ()
	getReachedPoints (int $active_id, int $pass)
	getMaximumPoints ()
	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorized_solution=true)
	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	getSuggestedSolutionPath ()
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	getSuggestedSolutionPathWeb ()
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getTestOutputSolutions (int $activeId, int $pass)
	getUserSolutionPreferingIntermediate (int $active_id, ?int $pass=null)
	getSolutionValues (int $active_id, ?int $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	deleteAnswers (int $question_id)
	deleteAdditionalTableData (int $question_id)
	delete (int $question_id)
	getTotalAnswers ()
	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)
	createPageObject ()
	clonePageOfQuestion (int $a_q_id)
	getPageOfQuestion ()
	setOriginalId (?int $original_id)
	getOriginalId ()
	fixSvgToPng (string $imageFilenameContainingString)
	fixUnavailableSkinImageSources (string $html)
	loadFromDb (int $question_id)
	createNewQuestion (bool $a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
	saveQuestionDataToDb (?int $original_id=null)
	duplicate (bool $for_test=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)
	copyObject (int $target_parent_id, string $title='')
	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')
	saveToDb (?int $original_id=null)
	deleteSuggestedSolutions ()
	getSuggestedSolution (int $subquestion_index=0)
	resolveInternalLink (string $internal_link)
	resolveSuggestedSolutionLinks ()
	getInternalLinkHref (string $target)
	syncWithOriginal ()
	getPoints ()
	setPoints (float $points)
	getSolutionMaxPass (int $active_id)
	isWriteable ()
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)
	adjustReachedPointsByScoringOptions (float $points, int $active_id)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)
	getQuestion ()
	getQuestionForHTMLOutput ()
	setQuestion (string $question="")
	getQuestionTypeID ()
	cleanupMediaObjectUsage ()
	getInstances ()
	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...
	hasSpecificFeedback ()
	getNrOfTries ()
	setNrOfTries (int $a_nr_of_tries)
	setExportImagePath (string $path)
	formatSAQuestion ($a_q)
	setPreventRteUsage (bool $prevent_rte_usage)
	getPreventRteUsage ()
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)
	getSelfAssessmentEditingMode ()
	setDefaultNrOfTries (int $defaultnroftries)
	getDefaultNrOfTries ()
	syncSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	isAnswered (int $active_id, int $pass)
	getAdditionalContentEditingMode ()
	setAdditionalContentEditingMode (?string $additionalContentEditingMode)
	isAdditionalContentEditingModePageObject ()
	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)
	getValidAdditionalContentEditingModes ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange (int $lastChange)
	getLastChange ()
	removeIntermediateSolution (int $active_id, int $pass)
	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)
	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)
	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)
	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)
	setStep ($step)
	getStep ()
	toJSON ()
	intermediateSolutionExists (int $active_id, int $pass)
	authorizedSolutionExists (int $active_id, ?int $pass)
	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)
	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...
	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)
	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)
	removeAllExistingSolutions ()
	removeExistingSolutions (int $activeId, int $pass)
	resetUsersAnswer (int $activeId, int $pass)
	removeResultRecord (int $activeId, int $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $value_pairs)
	updateTimestamp ()
	getTestPresentationConfig ()
	hasWritableOriginalInQuestionPool ()
	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)
	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)
	getSolutionForTextOutput (int $active_id, int $pass)
	getCorrectSolutionForTextOutput (int $active_id, int $pass)
	getVariablesAsTextArray (int $active_id, int $pass)
	validateSolutionSubmit ()
	toLog (AdditionalInformationGenerator $additional_info)
	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)
	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_id, TestQuestionAdministrationInteractionTypes $interaction_type)
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...
Public Member Functions inherited from iQuestionCondition
	getOperators (string $expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. More...
	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...
	getAvailableAnswerOptions (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...
	toJSON ()

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 = []
	$leveled_ordering = []
Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+|[\p{C}\p{Z}]+$/u'
ilAssQuestionFeedback	$feedbackOBJ
bool	$prevent_rte_usage = false
bool	$selfassessmenteditingmode = false
int	$defaultnroftries = 0
string	$questionActionCmd = 'handleQuestionAction'
const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'
Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'
const	PercentageResultExpression = '%n%'
const	NumericResultExpression = '#n#'
const	MatchingResultExpression = ';n:m;'
const	OrderingResultExpression = '$n,m,o,p$'
const	NumberOfResultExpression = '+n+'
const	ExclusiveResultExpression = '*n,m,o,p*'
const	EmptyAnswerExpression = "?"

Protected Member Functions
	getRepository ()
	cloneQuestionTypeSpecificProperties (\assQuestion $target)
	getValidOrderingTypes ()
	getSolutionValuePairBrandedOrderingElementByRandomIdentifier (int $value1, string $value2)
	getSolutionValuePairBrandedOrderingElementBySolutionIdentifier (int $value1, string $value2)
	cleanImagefiles ()
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	getQuestionRepository ()
	generateThumbForFile ($path, $file)
	calculateReachedPointsForSolution (ilAssOrderingElementList $solution_ordering_element_list)
	ensureImagePathExists ()
	buildOrderingElementFormDataConverter ()
	buildOrderingImagesFormDataConverter ()
	buildOrderingTextsFormDataConverter ()
	buildNestedOrderingFormDataConverter ()
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...
Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...
	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...
	getQuestionAction ()
	isNonEmptyItemListPostSubmission (string $post_submission_field_name)
	savePreviewData (ilAssQuestionPreviewSession $preview_session)
	deletePageOfQuestion (int $question_id)
	cloneQuestionTypeSpecificProperties (self $target)
	removeAllImageFiles (string $image_target_path)
	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)
	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)
	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)
	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)
	deleteComments ()
	getNotesManager ()
	getNotesDataService ()
	getNotesRepo ()
	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)
	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)
	copySuggestedSolutions (int $target_question_id)
	ensureNonNegativePoints (float $points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)
	removeSolutionRecordById (int $solutionId)
	getSolutionRecordById (int $solutionId)
	deleteDummySolutionRecord (int $activeId, int $passIndex)
	isDummySolutionRecord (array $solutionRecord)
	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)
	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)
	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)
	lookupMaxStep (int $active_id, int $pass)
	buildTestPresentationConfig ()
	getSuggestedSolutionsRepo ()
	loadSuggestedSolutions ()
	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
const	HAS_SPECIFIC_FEEDBACK = false
OQRepository	$oq_repository = null
ilAssOrderingElementList	$element_list_for_deferred_saving = null
Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true
GeneralQuestionPropertiesRepository	$questionrepository
RequestDataCollector	$questionpool_request
QuestionFiles	$question_files
ilAssQuestionProcessLocker	$processLocker
ilTestQuestionConfig	$testQuestionConfig
SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo
ILIAS	$ilias
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
ilDBInterface	$db
ilObjUser	$current_user
SkillUsageService	$skillUsageService
HTTPServices	$http
Refinery	$refinery
Transformation	$shuffler
LoggingServices	$log
Container	$dic
ilAssQuestionLifecycle	$lifecycle
ilAssQuestionPage	$page
TestResultRepository	$test_result_repository
int	$id
string	$title
string	$comment
int	$owner
string	$author
int	$thumb_size
string	$question
float	$points = 0.0
bool	$shuffle = true
int	$test_id
int	$obj_id = 0
int	$original_id = null
int	$lastChange = null
string	$external_id = null
int	$step = null
array	$suggested_solutions

Private Member Functions
	getOrderingTypeLangVars (int $ordering_type)
	getSolutionOutputForLog ()
	getElementArrayWithIdentationsForTextOutput (array $elements)

Private Attributes
ilAssOrderingElementList	$postSolutionOrderingElementList = null

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $force_pass_results_update_enabled)
static	isForcePassResultUpdateEnabled ()
static	_getSuggestedSolutionOutput (int $question_id)
static	_getReachedPoints (int $active_id, int $question_id, int $pass)
static	isFileAvailable (string $file)
static	saveOriginalId (int $questionId, int $originalId)
static	resetOriginalId (int $questionId)
static	instantiateQuestion (int $question_id)
static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...
static	getFeedbackClassNameByQuestionType (string $questionType)
static	_questionExistsInTest (int $question_id, int $test_id)
static	lookupParentObjId (int $question_id)
static	implodeKeyValues (array $keyValues)
static	explodeKeyValues (string $keyValues)
static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)
static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)
Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = false
static	$imageSourceFixReplaceMap

Detailed Description

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 40 of file class.assOrderingQuestion.php.

Constructor & Destructor Documentation

__construct()

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

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

      {
        parent::__construct($title, $comment, $author, $owner, $question);
    }

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

Here is the call graph for this function:

Member Function Documentation

buildNestedOrderingElementInputGui()

assOrderingQuestion::buildNestedOrderingElementInputGui

(

)

Returns

ilAssNestedOrderingElementsInputGUI

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

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

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

buildNestedOrderingFormDataConverter()

assOrderingQuestion::buildNestedOrderingFormDataConverter ( )

protected

Returns

ilAssOrderingFormValuesObjectsConverter

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

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

References ilAssOrderingFormValuesObjectsConverter\CONTEXT_MAINTAIN_HIERARCHY.

buildOrderingElementFormDataConverter()

assOrderingQuestion::buildOrderingElementFormDataConverter ( )

protected

Returns

ilAssOrderingFormValuesObjectsConverter

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

                                                              : ilAssOrderingFormValuesObjectsConverter
    {
        $converter = new ilAssOrderingFormValuesObjectsConverter();
        $converter->setPostVar(self::ORDERING_ELEMENT_FORM_FIELD_POSTVAR);
 
        return $converter;
    }

buildOrderingElementInputGui()

assOrderingQuestion::buildOrderingElementInputGui

(

)

Returns

ilAssNestedOrderingElementsInputGUI|ilAssOrderingImagesInputGUI|ilAssOrderingTextsInputGUI

Exceptions

ilTestQuestionPoolException

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

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

Referenced by ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput().

Here is the caller graph for this function:

buildOrderingImagesFormDataConverter()

assOrderingQuestion::buildOrderingImagesFormDataConverter ( )

protected

Returns

ilAssOrderingFormValuesObjectsConverter

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

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

References ilAssOrderingFormValuesObjectsConverter\CONTEXT_MAINTAIN_ELEMENT_IMAGE.

buildOrderingImagesInputGui()

assOrderingQuestion::buildOrderingImagesInputGui

(

)

Returns

ilAssOrderingImagesInputGUI

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

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

buildOrderingTextsFormDataConverter()

assOrderingQuestion::buildOrderingTextsFormDataConverter ( )

protected

Returns

ilAssOrderingFormValuesObjectsConverter

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

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

References ilAssOrderingFormValuesObjectsConverter\CONTEXT_MAINTAIN_ELEMENT_TEXT.

buildOrderingTextsInputGui()

assOrderingQuestion::buildOrderingTextsInputGui

(

)

Returns

ilAssOrderingTextsInputGUI

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

                                                : ilAssOrderingTextsInputGUI
    {
        $formDataConverter = $this->buildOrderingTextsFormDataConverter();
 
        $orderingElementInput = new ilAssOrderingTextsInputGUI(
            $formDataConverter,
            self::ORDERING_ELEMENT_FORM_FIELD_POSTVAR
        );
 
        $this->initOrderingElementFormFieldLabels($orderingElementInput);
        $orderingElementInput->setInfo($orderingElementInput->getInfo() . ' ' . $this->lng->txt('latex_edit_info'));
 
        return $orderingElementInput;
    }

buildTestPresentationConfig()

assOrderingQuestion::buildTestPresentationConfig

(

)

Get the test question configuration.

Returns

ilTestQuestionConfig

Reimplemented from assQuestion.

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

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

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

Here is the call graph for this function:

calculateReachedPoints()

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

Reimplemented from assQuestion.

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

     : float {
        if ($pass === null) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
 
        $solution_value_pairs = $this->getSolutionValues($active_id, $pass, $authorized_solution);
 
        if ($solution_value_pairs === []) {
            return 0.0;
        }
 
        $solution_ordering_element_list = $this->getSolutionOrderingElementList(
            $this->fetchIndexedValuesFromValuePairs($solution_value_pairs)
        );
 
        return $this->calculateReachedPointsForSolution($solution_ordering_element_list);
    }

calculateReachedPointsForSolution()

assOrderingQuestion::calculateReachedPointsForSolution ( ilAssOrderingElementList  $solution_ordering_element_list )

protected

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

                                                                                                                  : float
    {
        $reached_points = $this->getPoints();
 
        foreach ($this->getOrderingElementList() as $correct_element) {
            $user_element = $solution_ordering_element_list->getElementByPosition($correct_element->getPosition());
            if (!$correct_element->isSameElement($user_element)) {
                $reached_points = 0;
                break;
            }
        }
 
        return $reached_points;
    }

References ilAssOrderingElementList\getElementByPosition().

Here is the call graph for this function:

calculateReachedPointsFromPreviewSession()

assOrderingQuestion::calculateReachedPointsFromPreviewSession

(

ilAssQuestionPreviewSession

$preview_session

)

Reimplemented from assQuestion.

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

                                                                                                          : float
    {
        if (!$preview_session->hasParticipantSolution()) {
            return 0.0;
        }
 
        $solution_ordering_element_list = unserialize(
            $preview_session->getParticipantsSolution(),
            ['allowed_classes' => true]
        );
 
        $reached_points = $this->calculateReachedPointsForSolution($solution_ordering_element_list);
 
        return $this->ensureNonNegativePoints($reached_points);
    }

References ilAssQuestionPreviewSession\getParticipantsSolution(), and ilAssQuestionPreviewSession\hasParticipantSolution().

Here is the call graph for this function:

cleanImagefiles()

assOrderingQuestion::cleanImagefiles ( )

protected

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

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

References Vendor\Package\$f, ilFileUtils\delDir(), and ilFileUtils\getDir().

Here is the call graph for this function:

cloneImages()

assOrderingQuestion::cloneImages	(	int	$source_question_id,
		int	$source_parent_id,
		int	$target_question_id,
		int	$target_parent_id
	)

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

     : void {
        if (!$this->isImageOrderingType()) {
            return;
        }
 
        $image_source_path = $this->getImagePath($source_question_id, $source_parent_id);
        $image_target_path = $this->getImagePath($target_question_id, $target_parent_id);
 
        if (!file_exists($image_target_path)) {
            ilFileUtils::makeDirParents($image_target_path);
        } else {
            $this->removeAllImageFiles($image_target_path);
        }
        foreach ($this->getOrderingElementList() as $element) {
            $filename = $element->getContent();
 
            if ($filename === '') {
                continue;
            }
 
            if (!file_exists($image_source_path . $filename)
                || !copy($image_source_path . $filename, $image_target_path . $filename)) {
                $this->log->root()->warning('Image could not be cloned for object for question: ' . $target_question_id);
            }
            if (!file_exists($image_source_path . $this->getThumbPrefix() . $filename)
                || !copy($image_source_path . $this->getThumbPrefix() . $filename, $image_target_path . $this->getThumbPrefix() . $filename)) {
                $this->log->root()->warning('Image thumbnails could not be cloned for object for question: ' . $target_question_id);
            }
        }
    }

cloneQuestionTypeSpecificProperties()

assOrderingQuestion::cloneQuestionTypeSpecificProperties ( \assQuestion  $target )

protected

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

     : \assQuestion {
        $list = $this->getRepository()->getOrderingList($this->getId())
            ->withQuestionId($target->getId());
        $list->distributeNewRandomIdentifiers();
        $target->setOrderingElementList($list);
        $this->cloneImages($this->getId(), $this->getObjId(), $target->getId(), $target->getObjId());
        $target->saveToDb();
        return $target;
    }

deleteAnswer()

assOrderingQuestion::deleteAnswer

(

int

$random_identifier

)

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

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

dropImageFile()

assOrderingQuestion::dropImageFile

(

$imageFilename

)

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

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

ensureImagePathExists()

assOrderingQuestion::ensureImagePathExists ( )

protected

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

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

References ilFileUtils\makeDirParents().

Here is the call graph for this function:

fetchSolutionListFromFormSubmissionData()

assOrderingQuestion::fetchSolutionListFromFormSubmissionData

(

array

$user_solution_post

)

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

                                                                                      : ilAssOrderingElementList
    {
        $ordering_gui = $this->buildNestedOrderingElementInputGui();
        $ordering_gui->setContext(ilAssNestedOrderingElementsInputGUI::CONTEXT_USER_SOLUTION_SUBMISSION);
        $ordering_gui->setValueByArray($user_solution_post);
 
        if (!$ordering_gui->checkInput()) {
            throw new ilTestException('error on validating user solution post');
        }
 
        $solution_ordering_element_list = ilAssOrderingElementList::buildInstance($this->getId());
 
        $stored_element_list = $this->getOrderingElementList();
 
        foreach ($ordering_gui->getElementList($this->getId()) as $submitted_element) {
            $solution_element = $stored_element_list->getElementByRandomIdentifier(
                $submitted_element->getRandomIdentifier()
            )?->getClone();
 
            if ($solution_element === null) {
                continue;
            }
 
            $solution_element->setPosition($submitted_element->getPosition());
 
            if ($this->isOrderingTypeNested()) {
                $solution_element->setIndentation($submitted_element->getIndentation());
            }
 
            $solution_ordering_element_list->addElement($solution_element);
        }
 
        return $solution_ordering_element_list;
    }

References ilAssOrderingElementList\buildInstance(), ilAssNestedOrderingElementsInputGUI\CONTEXT_USER_SOLUTION_SUBMISSION, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

fetchSolutionSubmit()

assOrderingQuestion::fetchSolutionSubmit

(

array

$form_submission_data_structure

)

Returns

array

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

                                                                              : array
    {
        $solution_submit = [];
 
        if (isset($form_submission_data_structure['orderresult'])) {
            $orderresult = $form_submission_data_structure['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) {
                                $solution_submit[$answeridx] = $ordervalue;
                                $ordervalue++;
                            }
                        }
                    }
                }
            }
        } elseif ($this->getOrderingType() == self::OQ_NESTED_TERMS || $this->getOrderingType() == self::OQ_NESTED_PICTURES) {
            $index = 0;
            foreach ($form_submission_data_structure['content'] as $randomId => $content) {
                $indentation = $form_submission_data_structure['indentation'];
 
                $value1 = $index++;
                $value2 = implode(':', [$randomId, $indentation]);
 
                $solution_submit[$value1] = $value2;
            }
        } else {
            foreach ($form_submission_data_structure 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]) {
                                    $solution_submit[$answeridx] = $value;
                                }
                            }
                        }
                    }
                }
            }
        }
 
        return $solution_submit;
    }

generateThumbForFile()

assOrderingQuestion::generateThumbForFile (   $path,   $file  )

protected

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

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

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

Here is the call graph for this function:

getAdditionalTableName()

assOrderingQuestion::getAdditionalTableName

(

)

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

Returns

string The additional table name @access public

Reimplemented from assQuestion.

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

                                            : string
    {
        return "qpl_qst_ordering";
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

getAnswer()

assOrderingQuestion::getAnswer

(

int

$index = 0

)

Returns the ordering element from the given position.

Parameters

int

$position

Returns

ilAssOrderingElement|null

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

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

getAnswerCount()

assOrderingQuestion::getAnswerCount

(

)

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

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

getAnswerTableName()

assOrderingQuestion::getAnswerTableName

(

)

Returns the name of the answer table in the database.

Returns

string The answer table name @access public

Reimplemented from assQuestion.

Definition at line 752 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

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

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

getCorrectSolutionForTextOutput()

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

Reimplemented from assQuestion.

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

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

getElementArrayWithIdentationsForTextOutput()

assOrderingQuestion::getElementArrayWithIdentationsForTextOutput ( array  $elements )

private

Parameters

array<ilAssOrderingElement>

$elements

Returns

array

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

                                                                                 : array
    {
        usort(
            $elements,
            static fn(ilAssOrderingElement $a, ilAssOrderingElement $b): int
                => $a->getPosition() - $b->getPosition()
        );
 
        return array_map(
            function (ilAssOrderingElement $v): string {
                $indentation = '';
                for ($i = 0;$i < $v->getIndentation();$i++) {
                    $indentation .= ' |';
                }
                return $indentation . $v->getContent();
            },
            $elements
        );
    }

References Vendor\Package\$a, Vendor\Package\$b, ilAssOrderingElement\getContent(), and ilAssOrderingElement\getIndentation().

Here is the call graph for this function:

getElementHeight()

assOrderingQuestion::getElementHeight

(

)

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

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

getEncryptedFilename()

assOrderingQuestion::getEncryptedFilename

(

$filename

)

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

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

References $filename.

getExpressionTypes()

assOrderingQuestion::getExpressionTypes

(

)

Get all available expression types for a specific question.

Returns

array

Implements iQuestionCondition.

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

                                        : array
    {
        return [
            iQuestionCondition::PercentageResultExpression,
            iQuestionCondition::NumericResultExpression,
            iQuestionCondition::OrderingResultExpression,
            iQuestionCondition::EmptyAnswerExpression,
        ];
    }

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\NumericResultExpression, iQuestionCondition\OrderingResultExpression, and iQuestionCondition\PercentageResultExpression.

getMaximumPoints()

assOrderingQuestion::getMaximumPoints

(

)

Reimplemented from assQuestion.

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

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

Referenced by isComplete().

Here is the caller graph for this function:

getOperators()

assOrderingQuestion::getOperators

(

string

$expression

)

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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 776 of file class.assOrderingQuestion.php.

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

getOrderingElementList()

assOrderingQuestion::getOrderingElementList

(

)

Returns

ilAssOrderingElementList

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

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

References ILIAS\Survey\Mode\getId().

Referenced by isComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

getOrderingElementListForSolutionOutput()

assOrderingQuestion::getOrderingElementListForSolutionOutput	(	bool	$force_correct_solution,
		int	$active_id,
		?int	$pass_index
	)

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

     : ilAssOrderingElementList {
        if ($force_correct_solution || !$active_id || $pass_index === null) {
            return $this->getOrderingElementList();
        }
 
        $solution_values = $this->getSolutionValues($active_id, $pass_index);
 
        if (!count($solution_values)) {
            return $this->getShuffledOrderingElementList();
        }
 
        return $this->getSolutionOrderingElementList($this->fetchIndexedValuesFromValuePairs($solution_values));
    }

getOrderingType()

assOrderingQuestion::getOrderingType

(

)

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

                                     : int
    {
        return $this->ordering_type;
    }

getOrderingTypeLangVars()

assOrderingQuestion::getOrderingTypeLangVars ( int  $ordering_type )

private

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

                                                                : array
    {
        switch ($ordering_type) {
            case self::OQ_PICTURES:
                return ['qst_nested_nested_answers_off', 'oq_btn_use_order_pictures'];
            case self::OQ_TERMS:
                return ['qst_nested_nested_answers_off', 'oq_btn_use_order_terms'];
            case self::OQ_NESTED_PICTURES:
                return ['qst_nested_nested_answers_on', 'oq_btn_use_order_pictures'];
            case self::OQ_NESTED_TERMS:
                return ['qst_nested_nested_answers_on', 'oq_btn_use_order_terms'];
            default:
                return ['', ''];
        }
    }

getQuestionRepository()

assOrderingQuestion::getQuestionRepository ( )

protected

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

                                              : OQRepository
    {
        return new OQRepository($this->db);
    }

getQuestionType()

assOrderingQuestion::getQuestionType

(

)

Returns the question type of the question.

Returns

integer The question type of the question @access public

Reimplemented from assQuestion.

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

                                     : string
    {
        return "assOrderingQuestion";
    }

getRepository()

assOrderingQuestion::getRepository ( )

protected

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

                                      : OQRepository
    {
        if (is_null($this->oq_repository)) {
            $this->oq_repository = new OQRepository($this->db);
        }
        return $this->oq_repository;
    }

References $oq_repository.

getRTETextWithMediaObjects()

assOrderingQuestion::getRTETextWithMediaObjects

(

)

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

Reimplemented from assQuestion.

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

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

getShuffledOrderingElementList()

assOrderingQuestion::getShuffledOrderingElementList

(

)

Parameters

$active_id
$pass

Returns

ilAssOrderingElementList

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

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

References ilAssOrderingElementList\getClone().

Here is the call graph for this function:

getSolutionListFromPostSubmit()

assOrderingQuestion::getSolutionListFromPostSubmit

(

)

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

                                                   : ilAssOrderingElementList
    {
        if ($this->postSolutionOrderingElementList === null) {
            $list = $this->fetchSolutionListFromFormSubmissionData(
                $this->http->request()->getParsedBody()
            );
            $this->postSolutionOrderingElementList = $list;
        }
 
        return $this->postSolutionOrderingElementList;
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

getSolutionOrderingElementList()

assOrderingQuestion::getSolutionOrderingElementList

(

array

$indexed_solution_values

)

Exceptions

ilTestQuestionPoolException

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

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

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getSolutionOrderingElementListForTestOutput()

assOrderingQuestion::getSolutionOrderingElementListForTestOutput	(	ilAssNestedOrderingElementsInputGUI	$input_gui,
		array	$last_post,
		int	$active_id,
		int	$pass
	)

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

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

getSolutionOutputForLog()

assOrderingQuestion::getSolutionOutputForLog ( )

private

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

                                              : string
    {
        $solution_ordering_list = $this->getOrderingElementList();
 
        $answers_gui = $this->buildNestedOrderingElementInputGui();
        $answers_gui->setContext(ilAssNestedOrderingElementsInputGUI::CONTEXT_CORRECT_SOLUTION_PRESENTATION);
        $answers_gui->setInteractionEnabled(false);
        $answers_gui->setElementList($solution_ordering_list);
 
        return $answers_gui->getHTML();
    }

References ilAssNestedOrderingElementsInputGUI\CONTEXT_CORRECT_SOLUTION_PRESENTATION.

getSolutionValuePairBrandedOrderingElementByRandomIdentifier()

assOrderingQuestion::getSolutionValuePairBrandedOrderingElementByRandomIdentifier ( int  $value1, string  $value2  )

protected

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

     : ilAssOrderingElement {
        $value = explode(':', $value2);
 
        $random_identifier = (int) $value[0];
        $selected_position = $value1;
        $selected_indentation = (int) $value[1];
 
        $element = $this->getOrderingElementList()->getElementByRandomIdentifier($random_identifier)->getClone();
 
        $element->setPosition($selected_position);
        $element->setIndentation($selected_indentation);
 
        return $element;
    }

getSolutionValuePairBrandedOrderingElementBySolutionIdentifier()

assOrderingQuestion::getSolutionValuePairBrandedOrderingElementBySolutionIdentifier ( int  $value1, string  $value2  )

protected

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

     : ilAssOrderingElement {
        $solution_identifier = $value1;
        $selected_position = ($value2 - 1);
        $selected_indentation = 0;
 
        $element = $this->getOrderingElementList()->getElementBySolutionIdentifier($solution_identifier)->getClone();
 
        $element->setPosition($selected_position);
        $element->setIndentation($selected_indentation);
 
        return $element;
    }

getThumbPrefix()

assOrderingQuestion::getThumbPrefix

(

)

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

                                    : string
    {
        return "thumb.";
    }

getUserQuestionResult()

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

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

Implements iQuestionCondition.

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

     : ilUserQuestionResult {
        $result = new ilUserQuestionResult($this, $active_id, $pass);
 
        $maxStep = $this->lookupMaxStep($active_id, $pass);
        if ($maxStep > 0) {
            $data = $this->db->queryF(
                "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = %s ORDER BY value1 ASC ",
                ["integer", "integer", "integer","integer"],
                [$active_id, $pass, $this->getId(), $maxStep]
            );
        } else {
            $data = $this->db->queryF(
                "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s ORDER BY value1 ASC ",
                ["integer", "integer", "integer"],
                [$active_id, $pass, $this->getId()]
            );
        }
 
        $elements = [];
        while ($row = $this->db->fetchAssoc($data)) {
            $newKey = explode(":", $row["value2"]);
 
            foreach ($this->getOrderingElementList() as $answer) {
                // Images not supported
                if (!$this->isOrderingTypeNested()) {
                    if ($answer->getSolutionIdentifier() == $row["value1"]) {
                        $elements[$row["value2"]] = $answer->getSolutionIdentifier() + 1;
                        break;
                    }
                } else {
                    if ($answer->getRandomIdentifier() == $newKey[0]) {
                        $elements[$row["value1"]] = $answer->getSolutionIdentifier() + 1;
                        break;
                    }
                }
            }
        }
 
        ksort($elements);
 
        foreach (array_values($elements) as $element) {
            $result->addKeyValue($element, $element);
        }
 
        $points = $this->calculateReachedPoints($active_id, $pass);
        $max_points = $this->getMaximumPoints();
 
        $result->setReachedPercentage(($points / $max_points) * 100);
 
        return $result;
    }

getValidOrderingTypes()

assOrderingQuestion::getValidOrderingTypes ( )

protected

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

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

hasOrderingTypeUploadSupport()

assOrderingQuestion::hasOrderingTypeUploadSupport

(

)

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

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

initOrderingElementAuthoringProperties()

assOrderingQuestion::initOrderingElementAuthoringProperties

(

ilFormPropertyGUI

$formField

)

Parameters

ilAssOrderingTextsInputGUI | ilAssOrderingImagesInputGUI | ilAssNestedOrderingElementsInputGUI

$formField

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

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

Referenced by ilAssOrderingQuestionAuthoringFormGUI\renewOrderingElementInput().

Here is the caller graph for this function:

initOrderingElementFormFieldLabels()

assOrderingQuestion::initOrderingElementFormFieldLabels

(

ilFormPropertyGUI

$formField

)

Parameters

ilFormPropertyGUI

$formField

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

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

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

Here is the call graph for this function:

isComplete()

assOrderingQuestion::isComplete

(

)

Reimplemented from assQuestion.

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

                                : bool
    {
        $elements_list = $this->getOrderingElementList()->getElements();
        if ($elements_list === [] && $this->element_list_for_deferred_saving !== null) {
            $elements_list = $this->element_list_for_deferred_saving->getElements();
        }
        $elements = array_filter(
            $elements_list,
            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;
    }

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

Here is the call graph for this function:

isImageFileStored()

assOrderingQuestion::isImageFileStored

(

$imageFilename

)

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

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

isImageOrderingType()

assOrderingQuestion::isImageOrderingType

(

)

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

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

Referenced by ilAssOrderingQuestionAuthoringFormGUI\addSpecificOrderingQuestionCommandButtons().

Here is the caller graph for this function:

isImageReplaced()

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

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

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

References ilAssOrderingElement\getContent().

Here is the call graph for this function:

isOrderingTypeNested()

assOrderingQuestion::isOrderingTypeNested

(

)

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

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

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 @access public

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

                                            : void
    {
        $result = $this->db->queryF(
            "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
            ["integer"],
            [$question_id]
        );
        if ($result->numRows() == 1) {
            $data = $this->db->fetchAssoc($result);
            $this->setId($question_id);
            $this->setObjId($data["obj_fi"]);
            $this->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"]);
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));
            $this->ordering_type = $data["ordering_type"] !== null ? (int) $data["ordering_type"] : self::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);
    }

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

Here is the call graph for this function:

rebuildThumbnails()

assOrderingQuestion::rebuildThumbnails

(

)

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

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

saveAdditionalQuestionDataToDb()

assOrderingQuestion::saveAdditionalQuestionDataToDb

(

)

Saves a record to the question types additional data table.

Returns

mixed

Implements ilObjQuestionScoringAdjustable.

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

    {
        // save additional data
        $this->db->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            ["integer"],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            "INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, ordering_type, thumb_geometry, element_height)
                            VALUES (%s, %s, %s, %s)",
            ["integer", "text", "integer", "integer"],
            [
                $this->getId(),
                $this->ordering_type,
                $this->getThumbSize(),
                ($this->getElementHeight() > 20) ? $this->getElementHeight() : null
            ]
        );
    }

References ILIAS\Survey\Mode\getId().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller 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 720 of file class.assOrderingQuestion.php.

    {
    }

savePreviewData()

assOrderingQuestion::savePreviewData ( ilAssQuestionPreviewSession  $previewSession )

protected

Reimplemented from assQuestion.

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

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

References ilAssQuestionPreviewSession\setParticipantsSolution().

Here is the call graph for this function:

saveToDb()

assOrderingQuestion::saveToDb

(

?int

$original_id = null

)

Reimplemented from assQuestion.

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

                                                      : void
    {
        $this->saveQuestionDataToDb($original_id);
        $this->saveAdditionalQuestionDataToDb();
        parent::saveToDb();
        if ($this->element_list_for_deferred_saving !== null) {
            $this->setOrderingElementList($this->element_list_for_deferred_saving);
        }
    }

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

Here is the call graph for this function:

saveWorkingData()

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

Reimplemented from assQuestion.

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

     : bool {
        if ($this->questionpool_request->raw('test_answer_changed') === null) {
            return true;
        }
 
        if (is_null($pass)) {
            $pass = ilObjTest::_getPass($active_id);
        }
 
        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
            function () use ($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((string) $value2), $authorized);
                }
            }
        );
 
        return true;
    }

setContentType()

assOrderingQuestion::setContentType

(

$ct

)

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

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

setElementHeight()

assOrderingQuestion::setElementHeight

(

?int

$a_height

)

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

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

setNestingType()

assOrderingQuestion::setNestingType

(

bool

$nesting

)

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

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

setOrderingElementList()

assOrderingQuestion::setOrderingElementList

(

ilAssOrderingElementList

$list

)

Parameters

ilAssOrderingElementList

$orderingElementList

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

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

References Vendor\Package\$e, ilAssOrderingElementList\ensureValidIdentifiers(), ilAssOrderingElementList\getElements(), ILIAS\Survey\Mode\getId(), ilAssOrderingElementList\withElements(), and ilAssOrderingElementList\withQuestionId().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

setOrderingType()

assOrderingQuestion::setOrderingType

(

int

$ordering_type = self::OQ_TERMS

)

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

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

solutionValuesToLog()

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

protected

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

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

Reimplemented from assQuestion.

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

     : array {
        if ($solution_values === []) {
            return [];
        }
        return $this->getElementArrayWithIdentationsForTextOutput(
            $this->getSolutionOrderingElementList(
                $this->fetchIndexedValuesFromValuePairs($solution_values)
            )->getElements()
        );
    }

solutionValuesToText()

assOrderingQuestion::solutionValuesToText

(

array

$solution_values

)

MUST convert the given solution values into text.

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

Reimplemented from assQuestion.

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

                                                                : array
    {
        if ($solution_values === []) {
            return [];
        }
        return $this->getElementArrayWithIdentationsForTextOutput(
            $this->getSolutionOrderingElementList(
                $this->fetchIndexedValuesFromValuePairs($solution_values)
            )->getElements()
        );
    }

storeImageFile()

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

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

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

References ilShellUtil\convertImage(), and ilFileUtils\moveUploadedFile().

Here is the call graph for this function:

toJSON()

assOrderingQuestion::toJSON

(

)

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

                            : string
    {
        $result = [];
        $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'] = [
            '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 = [];
        foreach ($this->getOrderingElementList() as $orderingElement) {
            $answers[$counter] = $orderingElement->getContent();
            $counter++;
        }
        $answers = $this->getShuffler()->transform($answers);
        $arr = [];
        foreach ($answers as $order => $answer) {
            array_push($arr, [
                "answertext" => (string) $answer,
                "order" => (int) $order
            ]);
        }
        $result['answers'] = $arr;
 
        $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
        $result['mobs'] = $mobs;
 
        return json_encode($result);
    }

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

Here is the call graph for this function:

toLog()

assOrderingQuestion::toLog

(

AdditionalInformationGenerator

$additional_info

)

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

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

Reimplemented from assQuestion.

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

                                                                          : array
    {
        return [
            AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
            AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
            AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
            AdditionalInformationGenerator::KEY_QUESTION_ORDERING_NESTING_TYPE => array_reduce(
                $this->getOrderingTypeLangVars($this->getOrderingType()),
                static fn(string $string, string $lang_var) => $string . $additional_info->getTagForLangVar($lang_var),
                ''
            ),
            AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => $this->getPoints(),
            AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION => $this->getSolutionOutputForLog(),
            AdditionalInformationGenerator::KEY_FEEDBACK => [
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_INCOMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_COMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
            ]
        ];
    }

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

Here is the call graph for this function:

updateImageFile()

assOrderingQuestion::updateImageFile

(

string

$existing_image_name

)

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

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

References ilShellUtil\convertImage(), and ilFileUtils\rename().

Here is the call graph for this function:

validateSolutionSubmit()

assOrderingQuestion::validateSolutionSubmit

(

)

Reimplemented from assQuestion.

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

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

Field Documentation

$element_height

int assOrderingQuestion::$element_height = null

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

$element_list_for_deferred_saving

ilAssOrderingElementList assOrderingQuestion::$element_list_for_deferred_saving = null

protected

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

$leveled_ordering

assOrderingQuestion::$leveled_ordering = []

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

$old_ordering_depth

assOrderingQuestion::$old_ordering_depth = []

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

$oq_repository

OQRepository assOrderingQuestion::$oq_repository = null

protected

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

Referenced by getRepository().

$postSolutionOrderingElementList

ilAssOrderingElementList assOrderingQuestion::$postSolutionOrderingElementList = null

private

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

HAS_SPECIFIC_FEEDBACK

const assOrderingQuestion::HAS_SPECIFIC_FEEDBACK = false

protected

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

OQ_CT_PICTURES

const assOrderingQuestion::OQ_CT_PICTURES = 'pics'

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

OQ_CT_TERMS

const assOrderingQuestion::OQ_CT_TERMS = 'terms'

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

OQ_NESTED_PICTURES

const assOrderingQuestion::OQ_NESTED_PICTURES = 2

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

Referenced by assOrderingQuestionImport\fromXML(), ilAssNestedOrderingElementsInputGUI\getItemHtml(), ilAssOrderingElement\getStorageValue1(), ilAssOrderingElement\getStorageValue2(), and assOrderingQuestionExport\toXML().

OQ_NESTED_TERMS

const assOrderingQuestion::OQ_NESTED_TERMS = 3

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

Referenced by assOrderingQuestionImport\fromXML(), ilAssNestedOrderingElementsInputGUI\getItemHtml(), ilAssOrderingElement\getStorageValue1(), ilAssOrderingElement\getStorageValue2(), and assOrderingQuestionExport\toXML().

OQ_PICTURES

const assOrderingQuestion::OQ_PICTURES = 0

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

Referenced by ilQuestionExporter\assOrderingQuestion(), assOrderingQuestionImport\fromXML(), ilAssNestedOrderingElementsInputGUI\getItemHtml(), ilAssOrderingElement\getStorageValue1(), ilAssOrderingElement\getStorageValue2(), and assOrderingQuestionExport\toXML().

OQ_TERMS

const assOrderingQuestion::OQ_TERMS = 1

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

Referenced by assOrderingQuestionImport\fromXML(), ilAssNestedOrderingElementsInputGUI\getItemHtml(), ilAssOrderingElement\getStorageValue1(), ilAssOrderingElement\getStorageValue2(), and assOrderingQuestionExport\toXML().

ORDERING_ELEMENT_FORM_CMD_REMOVE_IMG

const assOrderingQuestion::ORDERING_ELEMENT_FORM_CMD_REMOVE_IMG = 'removeElementImage'

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

ORDERING_ELEMENT_FORM_CMD_UPLOAD_IMG

const assOrderingQuestion::ORDERING_ELEMENT_FORM_CMD_UPLOAD_IMG = 'uploadElementImage'

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

ORDERING_ELEMENT_FORM_FIELD_POSTVAR

const assOrderingQuestion::ORDERING_ELEMENT_FORM_FIELD_POSTVAR = 'order_elems'

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

Referenced by assOrderingQuestionGUI\buildEditFormAfterTypeChange(), assOrderingQuestionGUI\fetchSolutionListFromSubmittedForm(), ilAssOrderingQuestionAuthoringFormGUI\getOrderingElementInputField(), and assOrderingQuestionGUI\prepareReprintableCorrectionsForm().

VALID_UPLOAD_SUFFIXES

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

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

Referenced by assOrderingQuestionImport\handleUploadedFile().

---

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

• components/ILIAS/TestQuestionPool/classes/class.assOrderingQuestion.php