Inheritance diagram for assKprimChoice:

Collaboration diagram for assKprimChoice:

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

	getQuestionType ()

	getAdditionalTableName ()

	getAnswerTableName ()

	setShuffleAnswersEnabled ($shuffleAnswersEnabled)

	isShuffleAnswersEnabled ()

	setAnswerType ($answerType)

	getAnswerType ()

	setThumbSize (int $thumbSize)

	getThumbSize ()

	setScorePartialSolutionEnabled ($scorePartialSolutionEnabled)

	isScorePartialSolutionEnabled ()

	setOptionLabel ($optionLabel)

	getOptionLabel ()

	setCustomTrueOptionLabel ($customTrueOptionLabel)

	getCustomTrueOptionLabel ()

	setCustomFalseOptionLabel ($customFalseOptionLabel)

	getCustomFalseOptionLabel ()

	setSpecificFeedbackSetting ($specificFeedbackSetting)

	getSpecificFeedbackSetting ()

	setAnswers ($answers)

	getAnswers ()

	getAnswer ($position)

	addAnswer (ilAssKprimChoiceAnswer $answer)

	loadFromDb ($questionId)

	saveToDb ($originalId='')

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

	isComplete ()

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

	getValidAnswerTypes ()

	isValidAnswerType ($answerType)

	isSingleLineAnswerType ($answerType)

	getAnswerTypeSelectOptions (ilLanguage $lng)

	getValidOptionLabels ()

	getValidOptionLabelsTranslated (ilLanguage $lng)

	isValidOptionLabel ($optionLabel)

	getTrueOptionLabelTranslation (ilLanguage $lng, $optionLabel)

	getFalseOptionLabelTranslation (ilLanguage $lng, $optionLabel)

	getInstructionTextTranslation (ilLanguage $lng, $optionLabel)

	isCustomOptionLabel ($labelValue)

	handleFileUploads ($answers, $files)

	removeAnswerImage ($position)

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

	createNewOriginalFromThisDuplicate ($target_parent_id, $target_question_title="")

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

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

	getSpecificFeedbackAllCorrectOptionLabel ()

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

	moveAnswerDown ($position)

	moveAnswerUp ($position)

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

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

	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, $pass=null)

	getSolutionValues ($active_id, $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. 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 ()

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	syncWithOriginal ()

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

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

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, int $active_id, int $pass)

	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)

	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="", int $owner=-1, $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 ()

Public Member Functions inherited from assQuestionInterface
	validateSolutionSubmit ()

Static Public Member Functions
static	isObligationPossible (int $questionId)

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

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

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

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

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

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	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled, ?int $test_id=null)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	_needsManualScoring (int $question_id)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	isObligationPossible (int $questionId)

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

Data Fields
const	NUM_REQUIRED_ANSWERS = 4

const	PARTIAL_SCORING_NUM_CORRECT_ANSWERS = 3

const	ANSWER_TYPE_SINGLE_LINE = 'singleLine'

const	ANSWER_TYPE_MULTI_LINE = 'multiLine'

const	OPTION_LABEL_RIGHT_WRONG = 'right_wrong'

const	OPTION_LABEL_PLUS_MINUS = 'plus_minus'

const	OPTION_LABEL_APPLICABLE_OR_NOT = 'applicable_or_not'

const	OPTION_LABEL_ADEQUATE_OR_NOT = 'adequate_or_not'

const	OPTION_LABEL_CUSTOM = 'customlabel'

const	DEFAULT_THUMB_SIZE = 150

const	THUMB_PREFIX = 'thumb.'

Data Fields inherited from assQuestion
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Protected Member Functions
	getSolutionSubmit ()

	calculateReachedPointsForSolution ($found_values, $active_id=0)

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

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

	getRTETextWithMediaObjects ()

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	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)

	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	syncSuggestedSolutions (int $target_question_id, int $target_obj_id)

	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)

	copySuggestedSolutions (int $target_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...

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

Private Member Functions
	loadAnswerData ($questionId)

	handleFileUpload (ilAssKprimChoiceAnswer $answer, $fileData)

	getNumAllowedFailures ()

Private Attributes
	$shuffleAnswersEnabled

	$answerType

	$thumbSize

	$scorePartialSolutionEnabled

	$optionLabel

	$customTrueOptionLabel

	$customFalseOptionLabel

	$specificFeedbackSetting

	$answers

Additional Inherited Members
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS TestQuestionPool QuestionInfoService	$questioninfo

ILIAS Test TestParticipantInfoService	$testParticipantInfo

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS TestQuestionPool QuestionFilesService	$questionFilesService

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

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

SkillUsageService	$skillUsageService

assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Static Protected Attributes inherited from assQuestion
static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

assKprimChoice::__construct	(	$title = `''`,
		$comment = `''`,
		$author = `''`,
		$owner = `-1`,
		$question = `''`
	)

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

References assQuestion\$author, assQuestion\$comment, assQuestion\$owner, assQuestion\$question, assQuestion\$title, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ilAssConfigurableMultiOptionQuestionFeedback\FEEDBACK_SETTING_ALL.

     {
         parent::__construct($title, $comment, $author, $owner, $question);
 
         $this->shuffleAnswersEnabled = true;
         $this->answerType = self::ANSWER_TYPE_SINGLE_LINE;
         $this->thumbSize = self::DEFAULT_THUMB_SIZE;
         $this->scorePartialSolutionEnabled = true;
         $this->optionLabel = self::OPTION_LABEL_RIGHT_WRONG;
         $this->customTrueOptionLabel = '';
         $this->customFalseOptionLabel = '';
 
         $this->specificFeedbackSetting = ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL;
 
         $this->answers = [];
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

assKprimChoice::addAnswer ( ilAssKprimChoiceAnswer $answer )

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

References ilAssKprimChoiceAnswer\getAnswertext(), assQuestion\getHtmlQuestionContentPurifier(), and ilAssKprimChoiceAnswer\setAnswertext().

                                                              : void
     {
         $answer->setAnswertext(
             $this->getHtmlQuestionContentPurifier()->purify($answer->getAnswertext())
         );
         $this->answers[] = $answer;
     }

Here is the call graph for this function:

◆ afterSyncWithOriginal()

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

protected

Definition at line 826 of file class.assKprimChoice.php.

References $DIC, $filename, assQuestion\$ilLog, getAnswers(), and ilFileUtils\makeDirParents().

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

Here is the call graph for this function:

◆ beforeSyncWithOriginal()

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

protected

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

References assQuestion\$question.

                                                                                                                  : void
     {
         parent::beforeSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId);
 
         $question = self::instantiateQuestion($origQuestionId);
 
         foreach ($question->getAnswers() as $answer) {
             $question->removeAnswerImage($answer->getPosition());
         }
     }

◆ calculateReachedPoints()

assKprimChoice::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: float/array $points/$details (array $details is deprecated !!)

Definition at line 464 of file class.assKprimChoice.php.

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

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

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

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

protected

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

References ILIAS\LTI\ToolProvider\$key, assQuestion\$points, getAnswers(), assQuestion\getPoints(), and isScorePartialSolutionEnabled().

Referenced by calculateReachedPoints().

                                                                                        : float
     {
         $numCorrect = 0;
         if ($found_values == null) {
             $found_values = [];
         }
         foreach ($this->getAnswers() as $key => $answer) {
             if (!isset($found_values[$answer->getPosition()])) {
                 continue;
             }
 
             if ($found_values[$answer->getPosition()] == $answer->getCorrectness()) {
                 $numCorrect++;
             }
         }
 
         if ($numCorrect >= self::NUM_REQUIRED_ANSWERS) {
             $points = $this->getPoints();
         } elseif ($this->isScorePartialSolutionEnabled() && $numCorrect >= self::PARTIAL_SCORING_NUM_CORRECT_ANSWERS) {
             $points = $this->getPoints() / 2;
         } else {
             $points = 0;
         }
 
         if ($active_id) {
             if (count($found_values) == 0) {
                 $points = 0;
             }
         }
         return (float) $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyObject()

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

Copies an assMultipleChoice object.

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

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

                                                                     : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
         // duplicate the question in database
         $clone = $this;
 
         $original_id = $this->questioninfo->getOriginalId($this->id);
         $clone->id = -1;
         $source_questionpool_id = $this->getObjId();
         $clone->setObjId($target_questionpool_id);
         if ($title) {
             $clone->setTitle($title);
         }
         $clone->saveToDb();
         // copy question page content
         $clone->copyPageOfQuestion($original_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
         // duplicate the image
         $clone->cloneAnswerImages($original_id, $source_questionpool_id, $clone->getId(), $clone->getObjId());
 
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

assKprimChoice::createNewOriginalFromThisDuplicate	(	$target_parent_id,
		$target_question_title = `""`
	)

Definition at line 752 of file class.assKprimChoice.php.

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

                                                                                                       : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
 
         $source_question_id = $this->id;
         $source_parent_id = $this->getObjId();
 
         // duplicate the question in database
         $clone = $this;
         $clone->id = -1;
 
         $clone->setObjId($target_parent_id);
 
         if ($target_question_title) {
             $clone->setTitle($target_question_title);
         }
 
         $clone->saveToDb();
         // copy question page content
         $clone->copyPageOfQuestion($source_question_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($source_question_id);
         // duplicate the image
         $clone->cloneAnswerImages($source_question_id, $source_parent_id, $clone->getId(), $clone->getObjId());
 
         $clone->onCopy($source_parent_id, $source_question_id, $target_parent_id, $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ duplicate()

assKprimChoice::duplicate	(	bool	$for_test = `true`,
		string	$title = `""`,
		string	$author = `""`,
		int	$owner = `-1`,
			$testObjId = `null`
	)

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

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

                                                                                                                                  : int
     {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return -1;
         }
         // duplicate the question in database
         $this_id = $this->getId();
         $thisObjId = $this->getObjId();
 
         $clone = $this;
 
         $original_id = $this->questioninfo->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();
         }
 
         // copy question page content
         $clone->copyPageOfQuestion($this_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
         // duplicate the images
         $clone->cloneAnswerImages($this_id, $thisObjId, $clone->getId(), $clone->getObjId());
 
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ getAdditionalTableName()

assKprimChoice::getAdditionalTableName ( )

Definition at line 87 of file class.assKprimChoice.php.

Referenced by saveAdditionalQuestionDataToDb().

                                             : string
     {
         return "qpl_qst_kprim";
     }

Here is the caller graph for this function:

◆ getAnswer()

assKprimChoice::getAnswer ( $position )

Definition at line 196 of file class.assKprimChoice.php.

References getAnswers().

Referenced by removeAnswerImage().

     {
         foreach ($this->getAnswers() as $answer) {
             if ($answer->getPosition() == $position) {
                 return $answer;
             }
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAnswers()

assKprimChoice::getAnswers ( )

Definition at line 191 of file class.assKprimChoice.php.

References $answers.

Referenced by afterSyncWithOriginal(), calculateReachedPointsForSolution(), getAnswer(), getRTETextWithMediaObjects(), getSolutionSubmit(), isComplete(), lmMigrateQuestionTypeSpecificContent(), saveAnswerSpecificDataToDb(), setExportDetailsXLSX(), and toJSON().

                                 : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assKprimChoice::getAnswerTableName ( )

Definition at line 92 of file class.assKprimChoice.php.

Referenced by saveAnswerSpecificDataToDb().

                                         : string
     {
         return "qpl_a_kprim";
     }

Here is the caller graph for this function:

◆ getAnswerType()

assKprimChoice::getAnswerType ( )

Definition at line 112 of file class.assKprimChoice.php.

References $answerType.

Referenced by saveAdditionalQuestionDataToDb().

                                    : string
     {
         return $this->answerType;
     }

Here is the caller graph for this function:

◆ getAnswerTypeSelectOptions()

assKprimChoice::getAnswerTypeSelectOptions ( ilLanguage $lng )

Parameters

ilLanguage $lng

Returns: array

Definition at line 509 of file class.assKprimChoice.php.

References ilLanguage\txt().

                                                                : array
     {
         return [
             self::ANSWER_TYPE_SINGLE_LINE => $lng->txt('answers_singleline'),
             self::ANSWER_TYPE_MULTI_LINE => $lng->txt('answers_multiline')
         ];
     }

Here is the call graph for this function:

◆ getCustomFalseOptionLabel()

assKprimChoice::getCustomFalseOptionLabel ( )

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

References $customFalseOptionLabel.

Referenced by getFalseOptionLabelTranslation(), and saveAdditionalQuestionDataToDb().

     {
         return $this->customFalseOptionLabel;
     }

Here is the caller graph for this function:

◆ getCustomTrueOptionLabel()

assKprimChoice::getCustomTrueOptionLabel ( )

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

References $customTrueOptionLabel.

Referenced by getTrueOptionLabelTranslation(), and saveAdditionalQuestionDataToDb().

     {
         return $this->customTrueOptionLabel;
     }

Here is the caller graph for this function:

◆ getFalseOptionLabelTranslation()

assKprimChoice::getFalseOptionLabelTranslation	(	ilLanguage	$lng,
			$optionLabel
	)

Definition at line 566 of file class.assKprimChoice.php.

References $optionLabel, getCustomFalseOptionLabel(), and ilLanguage\txt().

Referenced by getInstructionTextTranslation(), and toJSON().

     {
         switch ($optionLabel) {
             case self::OPTION_LABEL_RIGHT_WRONG:
                 return $lng->txt('option_label_wrong');
 
             case self::OPTION_LABEL_PLUS_MINUS:
                 return $lng->txt('option_label_minus');
 
             case self::OPTION_LABEL_APPLICABLE_OR_NOT:
                 return $lng->txt('option_label_not_applicable');
 
             case self::OPTION_LABEL_ADEQUATE_OR_NOT:
                 return $lng->txt('option_label_not_adequate');
 
             case self::OPTION_LABEL_CUSTOM:
             default:
                 return $this->getCustomFalseOptionLabel();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstructionTextTranslation()

assKprimChoice::getInstructionTextTranslation	(	ilLanguage	$lng,
			$optionLabel
	)

Definition at line 587 of file class.assKprimChoice.php.

References $optionLabel, getFalseOptionLabelTranslation(), getTrueOptionLabelTranslation(), and ilLanguage\txt().

Referenced by toJSON().

                                                                                 : string
     {
         return sprintf(
             $lng->txt('kprim_instruction_text'),
             $this->getTrueOptionLabelTranslation($lng, $optionLabel),
             $this->getFalseOptionLabelTranslation($lng, $optionLabel)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumAllowedFailures()

assKprimChoice::getNumAllowedFailures ( )

private

Definition at line 969 of file class.assKprimChoice.php.

References isScorePartialSolutionEnabled().

Referenced by toJSON().

                                             : int
     {
         if ($this->isScorePartialSolutionEnabled()) {
             return self::NUM_REQUIRED_ANSWERS - self::PARTIAL_SCORING_NUM_CORRECT_ANSWERS;
         }
 
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptionLabel()

assKprimChoice::getOptionLabel ( )

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

References $optionLabel.

Referenced by saveAdditionalQuestionDataToDb(), and toJSON().

                                     : string
     {
         return $this->optionLabel;
     }

Here is the caller graph for this function:

◆ getQuestionType()

assKprimChoice::getQuestionType ( )

Definition at line 82 of file class.assKprimChoice.php.

Referenced by toJSON().

                                      : string
     {
         return 'assKprimChoice';
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assKprimChoice::getRTETextWithMediaObjects ( )

protected

Definition at line 887 of file class.assKprimChoice.php.

References getAnswers().

                                                    : string
     {
         $combinedText = parent::getRTETextWithMediaObjects();
 
         foreach ($this->getAnswers() as $answer) {
             $combinedText .= $answer->getAnswertext();
         }
 
         return $combinedText;
     }

Here is the call graph for this function:

◆ getSolutionSubmit()

assKprimChoice::getSolutionSubmit ( )

protected

Definition at line 651 of file class.assKprimChoice.php.

References Vendor\Package\$a, $post, and getAnswers().

Referenced by isComplete().

                                           : array
     {
         $solutionSubmit = [];
         $post = $this->dic->http()->wrapper()->post();
 
         foreach ($this->getAnswers() as $index => $a) {
             if ($post->has("kprim_choice_result_$index")) {
                 $value = $post->retrieve(
                     "kprim_choice_result_$index",
                     $this->dic->refinery()->kindlyTo()->string()
                 );
                 if (is_numeric($value)) {
                     $solutionSubmit[] = $value;
                 }
             } else {
                 $solutionSubmit[] = null;
             }
         }
         return $solutionSubmit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificFeedbackAllCorrectOptionLabel()

assKprimChoice::getSpecificFeedbackAllCorrectOptionLabel ( )

Implements ilAssSpecificFeedbackOptionLabelProvider.

Definition at line 978 of file class.assKprimChoice.php.

                                                               : string
     {
         return 'feedback_correct_kprim';
     }

◆ getSpecificFeedbackSetting()

assKprimChoice::getSpecificFeedbackSetting ( )

Definition at line 172 of file class.assKprimChoice.php.

References $specificFeedbackSetting.

Referenced by saveAdditionalQuestionDataToDb().

                                                 : int
     {
         return $this->specificFeedbackSetting;
     }

Here is the caller graph for this function:

◆ getThumbSize()

assKprimChoice::getThumbSize ( )

Definition at line 122 of file class.assKprimChoice.php.

References $thumbSize.

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

                                   : int
     {
         return $this->thumbSize;
     }

Here is the caller graph for this function:

◆ getTrueOptionLabelTranslation()

assKprimChoice::getTrueOptionLabelTranslation	(	ilLanguage	$lng,
			$optionLabel
	)

Definition at line 545 of file class.assKprimChoice.php.

References $optionLabel, getCustomTrueOptionLabel(), and ilLanguage\txt().

Referenced by getInstructionTextTranslation(), and toJSON().

     {
         switch ($optionLabel) {
             case self::OPTION_LABEL_RIGHT_WRONG:
                 return $lng->txt('option_label_right');
 
             case self::OPTION_LABEL_PLUS_MINUS:
                 return $lng->txt('option_label_plus');
 
             case self::OPTION_LABEL_APPLICABLE_OR_NOT:
                 return $lng->txt('option_label_applicable');
 
             case self::OPTION_LABEL_ADEQUATE_OR_NOT:
                 return $lng->txt('option_label_adequate');
 
             case self::OPTION_LABEL_CUSTOM:
             default:
                 return $this->getCustomTrueOptionLabel();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidAnswerTypes()

assKprimChoice::getValidAnswerTypes ( )

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

Referenced by isValidAnswerType().

                                          : array
     {
         return [self::ANSWER_TYPE_SINGLE_LINE, self::ANSWER_TYPE_MULTI_LINE];
     }

Here is the caller graph for this function:

◆ getValidOptionLabels()

assKprimChoice::getValidOptionLabels ( )

Definition at line 517 of file class.assKprimChoice.php.

Referenced by isValidOptionLabel().

                                           : array
     {
         return [
             self::OPTION_LABEL_RIGHT_WRONG,
             self::OPTION_LABEL_PLUS_MINUS,
             self::OPTION_LABEL_APPLICABLE_OR_NOT,
             self::OPTION_LABEL_ADEQUATE_OR_NOT,
             self::OPTION_LABEL_CUSTOM
         ];
     }

Here is the caller graph for this function:

◆ getValidOptionLabelsTranslated()

assKprimChoice::getValidOptionLabelsTranslated ( ilLanguage $lng )

Definition at line 528 of file class.assKprimChoice.php.

References ilLanguage\txt().

                                                                    : array
     {
         return [
             self::OPTION_LABEL_RIGHT_WRONG => $lng->txt('option_label_right_wrong'),
             self::OPTION_LABEL_PLUS_MINUS => $lng->txt('option_label_plus_minus'),
             self::OPTION_LABEL_APPLICABLE_OR_NOT => $lng->txt('option_label_applicable_or_not'),
             self::OPTION_LABEL_ADEQUATE_OR_NOT => $lng->txt('option_label_adequate_or_not'),
             self::OPTION_LABEL_CUSTOM => $lng->txt('option_label_custom')
         ];
     }

Here is the call graph for this function:

◆ handleFileUpload()

assKprimChoice::handleFileUpload	(	ilAssKprimChoiceAnswer	$answer,
			$fileData
	)

private

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

References $filename, assQuestion\buildHashedImageFilename(), ilAssKprimChoiceAnswer\getImageFsPath(), assQuestion\getImagePath(), getThumbSize(), ilFileUtils\makeDirParents(), ilFileUtils\moveUploadedFile(), ilAssKprimChoiceAnswer\setImageFile(), and ilAssKprimChoiceAnswer\setImageFsDir().

Referenced by handleFileUploads().

                                                                                 : int
     {
         $imagePath = $this->getImagePath();
 
         if (!file_exists($imagePath)) {
             ilFileUtils::makeDirParents($imagePath);
         }
 
         $filename = $this->buildHashedImageFilename($fileData['name'], true);
 
         $answer->setImageFsDir($imagePath);
         $answer->setImageFile($filename);
 
         if (!ilFileUtils::moveUploadedFile($fileData['tmp_name'], $filename, $answer->getImageFsPath())) {
             return 2;
         }
 
         $this->generateThumbForFile($filename, $this->getImagePath(), $this->getThumbSize());
 
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleFileUploads()

assKprimChoice::handleFileUploads	(	$answers,
		$files
	)

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

References $answers, and handleFileUpload().

                                                        : void
     {
         foreach ($answers as $answer) {
             /* @var ilAssKprimChoiceAnswer $answer */
 
             if (!isset($files[$answer->getPosition()])) {
                 continue;
             }
 
             $this->handleFileUpload($answer, $files[$answer->getPosition()]);
         }
     }

Here is the call graph for this function:

◆ isComplete()

assKprimChoice::isComplete ( )

Definition at line 371 of file class.assKprimChoice.php.

References $GLOBALS, $ilDB, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), getAnswers(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), ILIAS\Repository\lng(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), assQuestion\saveCurrentSolution(), and assQuestion\saveWorkingData().

                                 : bool
     {
         foreach ([$this->title, $this->author, $this->question] as $text) {
             if (!strlen($text)) {
                 return false;
             }
         }
 
         if (!isset($this->points)) {
             return false;
         }
 
         foreach ($this->getAnswers() as $answer) {
             /* @var ilAssKprimChoiceAnswer $answer */
 
             if (is_null($answer->getCorrectness())) {
                 return false;
             }
 
             if (
                 (!is_string($answer->getAnswertext()) || $answer->getAnswertext() === '') &&
                 (!is_string($answer->getImageFile()) || $answer->getImageFile() === '')
             ) {
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ isCustomOptionLabel()

assKprimChoice::isCustomOptionLabel ( $labelValue )

Definition at line 596 of file class.assKprimChoice.php.

                                                     : bool
     {
         return $labelValue == self::OPTION_LABEL_CUSTOM;
     }

◆ isObligationPossible()

static assKprimChoice::isObligationPossible ( int $questionId )

static

Definition at line 983 of file class.assKprimChoice.php.

                                                                 : bool
     {
         return true;
     }

◆ isScorePartialSolutionEnabled()

assKprimChoice::isScorePartialSolutionEnabled ( )

Definition at line 132 of file class.assKprimChoice.php.

References $scorePartialSolutionEnabled.

Referenced by calculateReachedPointsForSolution(), getNumAllowedFailures(), and saveAdditionalQuestionDataToDb().

                                                    : bool
     {
         return $this->scorePartialSolutionEnabled;
     }

Here is the caller graph for this function:

◆ isShuffleAnswersEnabled()

assKprimChoice::isShuffleAnswersEnabled ( )

Definition at line 102 of file class.assKprimChoice.php.

References $shuffleAnswersEnabled.

Referenced by saveAdditionalQuestionDataToDb(), and toJSON().

                                              : bool
     {
         return $this->shuffleAnswersEnabled;
     }

Here is the caller graph for this function:

◆ isSingleLineAnswerType()

assKprimChoice::isSingleLineAnswerType ( $answerType )

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

References $answerType, and ANSWER_TYPE_SINGLE_LINE.

                                                        : bool
     {
         return $answerType == assKprimChoice::ANSWER_TYPE_SINGLE_LINE;
     }

◆ isValidAnswerType()

assKprimChoice::isValidAnswerType ( $answerType )

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

References $answerType, and getValidAnswerTypes().

Referenced by loadFromDb().

                                                   : bool
     {
         $validTypes = $this->getValidAnswerTypes();
         return in_array($answerType, $validTypes);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidOptionLabel()

assKprimChoice::isValidOptionLabel ( $optionLabel )

Definition at line 539 of file class.assKprimChoice.php.

References $optionLabel, and getValidOptionLabels().

Referenced by loadFromDb().

                                                     : bool
     {
         $validLabels = $this->getValidOptionLabels();
         return in_array($optionLabel, $validLabels);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lmMigrateQuestionTypeSpecificContent()

assKprimChoice::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Definition at line 901 of file class.assKprimChoice.php.

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

                                                                                                   : void
     {
         foreach ($this->getAnswers() as $answer) {
             /* @var ilAssKprimChoiceAnswer $answer */
             $answer->setAnswertext($migrator->migrateToLmContent($answer->getAnswertext()));
         }
     }

Here is the call graph for this function:

◆ loadAnswerData()

assKprimChoice::loadAnswerData ( $questionId )

private

Definition at line 282 of file class.assKprimChoice.php.

References $data, $DIC, $ilDB, $res, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\getImagePath(), and assQuestion\getImagePathWeb().

Referenced by loadFromDb().

                                                 : void
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $res = $this->db->queryF(
             "SELECT * FROM {$this->getAnswerTableName()} WHERE question_fi = %s ORDER BY position ASC",
             ['integer'],
             [$questionId]
         );
 
         while ($data = $ilDB->fetchAssoc($res)) {
             $answer = new ilAssKprimChoiceAnswer();
 
             $answer->setPosition($data['position']);
 
             $answer->setAnswertext(ilRTE::_replaceMediaObjectImageSrc($data['answertext'] ?? '', 1));
 
             $answer->setImageFile($data['imagefile']);
             $answer->setThumbPrefix($this->getThumbPrefix());
             $answer->setImageFsDir($this->getImagePath());
             $answer->setImageWebDir($this->getImagePathWeb());
 
             $answer->setCorrectness($data['correctness']);
 
             $this->answers[$answer->getPosition()] = $answer;
         }
 
         for ($i = count($this->answers); $i < self::NUM_REQUIRED_ANSWERS; $i++) {
             $answer = new ilAssKprimChoiceAnswer();
 
             $answer->setPosition($i);
 
             $this->answers[$answer->getPosition()] = $answer;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromDb()

assKprimChoice::loadFromDb ( $questionId )

Definition at line 215 of file class.assKprimChoice.php.

References $data, Vendor\Package\$e, $res, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\buildQuestionDataQuery(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), isValidAnswerType(), isValidOptionLabel(), loadAnswerData(), assQuestion\setAdditionalContentEditingMode(), setAnswerType(), assQuestion\setAuthor(), assQuestion\setComment(), setCustomFalseOptionLabel(), setCustomTrueOptionLabel(), assQuestion\setId(), assQuestion\setLastChange(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), setOptionLabel(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setScorePartialSolutionEnabled(), setShuffleAnswersEnabled(), setSpecificFeedbackSetting(), setThumbSize(), and assQuestion\setTitle().

                                            : void
     {
         $res = $this->db->queryF($this->buildQuestionDataQuery(), ['integer'], [$questionId]);
 
         while ($data = $this->db->fetchAssoc($res)) {
             $this->setId($questionId);
 
             $this->setOriginalId($data['original_id']);
 
             $this->setObjId($data['obj_fi']);
 
             $this->setTitle($data['title'] ?? '');
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setComment($data['description'] ?? '');
             $this->setAuthor($data['author']);
             $this->setPoints($data['points']);
             $this->setOwner($data['owner']);
             $this->setLastChange($data['tstamp']);
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data['question_text'] ?? '', 1));
 
             $this->setShuffleAnswersEnabled((bool) $data['shuffle_answers']);
 
             if ($this->isValidAnswerType($data['answer_type'])) {
                 $this->setAnswerType($data['answer_type']);
             }
 
             if (is_numeric($data['thumb_size'])) {
                 $this->setThumbSize((int) $data['thumb_size']);
             }
 
             if ($this->isValidOptionLabel($data['opt_label'])) {
                 $this->setOptionLabel($data['opt_label']);
             }
 
             if ($data['custom_true'] !== null) {
                 $this->setCustomTrueOptionLabel($data['custom_true']);
             }
 
             if ($data['custom_false'] !== null) {
                 $this->setCustomFalseOptionLabel($data['custom_false']);
             }
 
             if ($data['score_partsol'] !== null) {
                 $this->setScorePartialSolutionEnabled((bool) $data['score_partsol']);
             }
 
             if (isset($data['feedback_setting'])) {
                 $this->setSpecificFeedbackSetting((int) $data['feedback_setting']);
             }
 
             try {
                 $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
             } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                 $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
             }
 
             try {
                 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
             } catch (ilTestQuestionPoolException $e) {
             }
         }
 
         $this->loadAnswerData($questionId);
 
         parent::loadFromDb($questionId);
     }

Here is the call graph for this function:

◆ moveAnswerDown()

assKprimChoice::moveAnswerDown ( $position )

Definition at line 1015 of file class.assKprimChoice.php.

                                              : bool
     {
         if ($position < 0 || $position >= (self::NUM_REQUIRED_ANSWERS - 1)) {
             return false;
         }
 
         for ($i = 0, $max = count($this->answers); $i < $max; $i++) {
             if ($i == $position) {
                 $movingAnswer = $this->answers[$i];
                 $targetAnswer = $this->answers[ $i + 1 ];
 
                 $movingAnswer->setPosition($position + 1);
                 $targetAnswer->setPosition($position);
 
                 $this->answers[ $i + 1 ] = $movingAnswer;
                 $this->answers[$i] = $targetAnswer;
             }
         }
         return true;
     }

◆ moveAnswerUp()

assKprimChoice::moveAnswerUp ( $position )

Definition at line 1036 of file class.assKprimChoice.php.

                                            : bool
     {
         if ($position <= 0 || $position > (self::NUM_REQUIRED_ANSWERS - 1)) {
             return false;
         }
 
         for ($i = 0, $max = count($this->answers); $i < $max; $i++) {
             if ($i == $position) {
                 $movingAnswer = $this->answers[$i];
                 $targetAnswer = $this->answers[ $i - 1 ];
 
                 $movingAnswer->setPosition($position - 1);
                 $targetAnswer->setPosition($position);
 
                 $this->answers[ $i - 1 ] = $movingAnswer;
                 $this->answers[$i] = $targetAnswer;
             }
         }
 
         return true;
     }

◆ removeAnswerImage()

assKprimChoice::removeAnswerImage ( $position )

Definition at line 636 of file class.assKprimChoice.php.

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

                                                 : void
     {
         $answer = $this->getAnswer($position);
 
         if (file_exists($answer->getImageFsPath())) {
             ilFileUtils::delDir($answer->getImageFsPath());
         }
 
         if (file_exists($answer->getThumbFsPath())) {
             ilFileUtils::delDir($answer->getThumbFsPath());
         }
 
         $answer->setImageFile(null);
     }

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assKprimChoice::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

Definition at line 333 of file class.assKprimChoice.php.

References getAdditionalTableName(), getAnswerType(), getCustomFalseOptionLabel(), getCustomTrueOptionLabel(), assQuestion\getId(), getOptionLabel(), getSpecificFeedbackSetting(), getThumbSize(), isScorePartialSolutionEnabled(), and isShuffleAnswersEnabled().

Referenced by saveToDb().

     {
         $this->db->replace(
             $this->getAdditionalTableName(),
             [
                 'question_fi' => ['integer', $this->getId()]
             ],
             [
                 'shuffle_answers' => ['integer', (int) $this->isShuffleAnswersEnabled()],
                 'answer_type' => ['text', $this->getAnswerType()],
                 'thumb_size' => ['integer', $this->getThumbSize()],
                 'opt_label' => ['text', $this->getOptionLabel()],
                 'custom_true' => ['text', $this->getCustomTrueOptionLabel()],
                 'custom_false' => ['text', $this->getCustomFalseOptionLabel()],
                 'score_partsol' => ['integer', (int) $this->isScorePartialSolutionEnabled()],
                 'feedback_setting' => ['integer', $this->getSpecificFeedbackSetting()]
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assKprimChoice::saveAnswerSpecificDataToDb ( )

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

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 353 of file class.assKprimChoice.php.

References getAnswers(), getAnswerTableName(), assQuestion\getId(), and ILIAS\Repository\int().

Referenced by saveToDb().

     {
         foreach ($this->getAnswers() as $answer) {
             $this->db->replace(
                 $this->getAnswerTableName(),
                 [
                     'question_fi' => ['integer', $this->getId()],
                     'position' => ['integer', (int) $answer->getPosition()]
                 ],
                 [
                     'answertext' => ['text', $answer->getAnswertext()],
                     'imagefile' => ['text', $answer->getImageFile()],
                     'correctness' => ['integer', (int) $answer->getCorrectness()]
                 ]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

assKprimChoice::saveToDb ( $originalId = '' )

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

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

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

Here is the call graph for this function:

◆ setAnswers()

assKprimChoice::setAnswers ( $answers )

Definition at line 177 of file class.assKprimChoice.php.

References $answers, and assQuestion\getHtmlQuestionContentPurifier().

                                         : void
     {
         if (is_null($answers)) {
             return;
         }
         $clean_answer_text = function (ilAssKprimChoiceAnswer $answer) {
             $answer->setAnswertext(
                 $this->getHtmlQuestionContentPurifier()->purify($answer->getAnswertext())
             );
             return $answer;
         };
         $this->answers = array_map($clean_answer_text, $answers);
     }

Here is the call graph for this function:

◆ setAnswerType()

assKprimChoice::setAnswerType ( $answerType )

Definition at line 107 of file class.assKprimChoice.php.

References $answerType.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setCustomFalseOptionLabel()

assKprimChoice::setCustomFalseOptionLabel ( $customFalseOptionLabel )

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

References $customFalseOptionLabel.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setCustomTrueOptionLabel()

assKprimChoice::setCustomTrueOptionLabel ( $customTrueOptionLabel )

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

References $customTrueOptionLabel.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setExportDetailsXLSX()

assKprimChoice::setExportDetailsXLSX	(	ilAssExcelFormatHelper	$worksheet,
		int	$startrow,
		int	$col,
		int	$active_id,
		int	$pass
	)

{}

Definition at line 991 of file class.assKprimChoice.php.

References assQuestion\$id, getAnswers(), ilExcel\getColumnCoord(), assQuestion\getSolutionValues(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                                : int
     {
         parent::setExportDetailsXLSX($worksheet, $startrow, $col, $active_id, $pass);
 
         $solution = $this->getSolutionValues($active_id, $pass);
 
         $i = 1;
         foreach ($this->getAnswers() as $id => $answer) {
             $worksheet->setCell($startrow + $i, $col, $answer->getAnswertext());
             $worksheet->setBold($worksheet->getColumnCoord($col) . ($startrow + $i));
             $correctness = false;
             foreach ($solution as $solutionvalue) {
                 if ($id == $solutionvalue['value1']) {
                     $correctness = $solutionvalue['value2'];
                     break;
                 }
             }
             $worksheet->setCell($startrow + $i, $col + 2, $correctness);
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setOptionLabel()

assKprimChoice::setOptionLabel ( $optionLabel )

Definition at line 137 of file class.assKprimChoice.php.

References $optionLabel.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setScorePartialSolutionEnabled()

assKprimChoice::setScorePartialSolutionEnabled ( $scorePartialSolutionEnabled )

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

References $scorePartialSolutionEnabled.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setShuffleAnswersEnabled()

assKprimChoice::setShuffleAnswersEnabled ( $shuffleAnswersEnabled )

Definition at line 97 of file class.assKprimChoice.php.

References $shuffleAnswersEnabled.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assKprimChoice::setSpecificFeedbackSetting ( $specificFeedbackSetting )

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

References $specificFeedbackSetting.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setThumbSize()

assKprimChoice::setThumbSize ( int $thumbSize )

Definition at line 117 of file class.assKprimChoice.php.

References $thumbSize.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ toJSON()

assKprimChoice::toJSON ( )

Returns a JSON representation of the question.

Implements ilAssQuestionLMExportable.

Definition at line 912 of file class.assKprimChoice.php.

References $answers, ILIAS\LTI\ToolProvider\$key, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), getFalseOptionLabelTranslation(), assQuestion\getId(), assQuestion\getImagePathWeb(), getInstructionTextTranslation(), assQuestion\getNrOfTries(), getNumAllowedFailures(), getOptionLabel(), assQuestion\getQuestion(), getQuestionType(), getThumbSize(), assQuestion\getTitleForHTMLOutput(), getTrueOptionLabelTranslation(), ILIAS\Repository\int(), isShuffleAnswersEnabled(), and ILIAS\Repository\lng().

                             : string
     {
         $this->lng->loadLanguageModule('assessment');
 
         $result = [];
         $result['id'] = $this->getId();
         $result['type'] = $this->getQuestionType();
         $result['title'] = $this->getTitleForHTMLOutput();
         $result['question'] = $this->formatSAQuestion($this->getQuestion());
         $result['instruction'] = $this->getInstructionTextTranslation(
             $this->lng,
             $this->getOptionLabel()
         );
         $result['nr_of_tries'] = $this->getNrOfTries();
         $result['shuffle'] = $this->isShuffleAnswersEnabled();
         $result['feedback'] = [
             'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
             'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
         ];
 
         $result['trueOptionLabel'] = $this->getTrueOptionLabelTranslation($this->lng, $this->getOptionLabel());
         $result['falseOptionLabel'] = $this->getFalseOptionLabelTranslation($this->lng, $this->getOptionLabel());
 
         $result['num_allowed_failures'] = $this->getNumAllowedFailures();
 
         $answers = [];
         $has_image = false;
 
         foreach ($this->getAnswers() as $key => $answer) {
             if (strlen((string) $answer->getImageFile())) {
                 $has_image = true;
             }
 
             $answers[] = [
                 'answertext' => $this->formatSAQuestion($answer->getAnswertext() ?? ''),
                 'correctness' => (bool) $answer->getCorrectness(),
                 'order' => (int) $answer->getPosition(),
                 'image' => (string) $answer->getImageFile(),
                 'feedback' => $this->formatSAQuestion(
                     $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                 )
             ];
         }
 
         $result['answers'] = $answers;
 
         if ($has_image) {
             $result['path'] = $this->getImagePathWeb();
             $result['thumb'] = $this->getThumbSize();
         }
 
         $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
         $result['mobs'] = $mobs;
 
         return json_encode($result);
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

assKprimChoice::$answers

private

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

Referenced by getAnswers(), handleFileUploads(), setAnswers(), and toJSON().

◆ $answerType

assKprimChoice::$answerType

private

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

Referenced by getAnswerType(), isSingleLineAnswerType(), isValidAnswerType(), and setAnswerType().

◆ $customFalseOptionLabel

assKprimChoice::$customFalseOptionLabel

private

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

Referenced by getCustomFalseOptionLabel(), and setCustomFalseOptionLabel().

◆ $customTrueOptionLabel

assKprimChoice::$customTrueOptionLabel

private

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

Referenced by getCustomTrueOptionLabel(), and setCustomTrueOptionLabel().

◆ $optionLabel

assKprimChoice::$optionLabel

private

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

Referenced by getFalseOptionLabelTranslation(), getInstructionTextTranslation(), getOptionLabel(), getTrueOptionLabelTranslation(), isValidOptionLabel(), and setOptionLabel().

◆ $scorePartialSolutionEnabled

assKprimChoice::$scorePartialSolutionEnabled

private

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

Referenced by isScorePartialSolutionEnabled(), and setScorePartialSolutionEnabled().

◆ $shuffleAnswersEnabled

assKprimChoice::$shuffleAnswersEnabled

private

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

Referenced by isShuffleAnswersEnabled(), and setShuffleAnswersEnabled().

◆ $specificFeedbackSetting

assKprimChoice::$specificFeedbackSetting

private

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

Referenced by getSpecificFeedbackSetting(), and setSpecificFeedbackSetting().

◆ $thumbSize

assKprimChoice::$thumbSize

private

Definition at line 51 of file class.assKprimChoice.php.

Referenced by getThumbSize(), and setThumbSize().

◆ ANSWER_TYPE_MULTI_LINE

const assKprimChoice::ANSWER_TYPE_MULTI_LINE = 'multiLine'

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

Referenced by assKprimChoiceGUI\handleAnswerTextsSubmit().

◆ ANSWER_TYPE_SINGLE_LINE

const assKprimChoice::ANSWER_TYPE_SINGLE_LINE = 'singleLine'

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

Referenced by isSingleLineAnswerType().

◆ DEFAULT_THUMB_SIZE

const assKprimChoice::DEFAULT_THUMB_SIZE = 150

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

◆ NUM_REQUIRED_ANSWERS

const assKprimChoice::NUM_REQUIRED_ANSWERS = 4

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

◆ OPTION_LABEL_ADEQUATE_OR_NOT

const assKprimChoice::OPTION_LABEL_ADEQUATE_OR_NOT = 'adequate_or_not'

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

◆ OPTION_LABEL_APPLICABLE_OR_NOT

const assKprimChoice::OPTION_LABEL_APPLICABLE_OR_NOT = 'applicable_or_not'

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

◆ OPTION_LABEL_CUSTOM

const assKprimChoice::OPTION_LABEL_CUSTOM = 'customlabel'

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

◆ OPTION_LABEL_PLUS_MINUS

const assKprimChoice::OPTION_LABEL_PLUS_MINUS = 'plus_minus'

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

◆ OPTION_LABEL_RIGHT_WRONG

const assKprimChoice::OPTION_LABEL_RIGHT_WRONG = 'right_wrong'

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

◆ PARTIAL_SCORING_NUM_CORRECT_ANSWERS

const assKprimChoice::PARTIAL_SCORING_NUM_CORRECT_ANSWERS = 3

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

◆ THUMB_PREFIX

const assKprimChoice::THUMB_PREFIX = 'thumb.'

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

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

Modules/TestQuestionPool/classes/class.assKprimChoice.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ afterSyncWithOriginal()

◆ beforeSyncWithOriginal()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ duplicate()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAnswerType()

◆ getAnswerTypeSelectOptions()

◆ getCustomFalseOptionLabel()

◆ getCustomTrueOptionLabel()

◆ getFalseOptionLabelTranslation()

◆ getInstructionTextTranslation()

◆ getNumAllowedFailures()

◆ getOptionLabel()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ getThumbSize()

◆ getTrueOptionLabelTranslation()

◆ getValidAnswerTypes()

◆ getValidOptionLabels()

◆ getValidOptionLabelsTranslated()

◆ handleFileUpload()

◆ handleFileUploads()

◆ isComplete()

◆ isCustomOptionLabel()

◆ isObligationPossible()

◆ isScorePartialSolutionEnabled()

◆ isShuffleAnswersEnabled()

◆ isSingleLineAnswerType()

◆ isValidAnswerType()

◆ isValidOptionLabel()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadAnswerData()

◆ loadFromDb()

◆ moveAnswerDown()

◆ moveAnswerUp()

◆ removeAnswerImage()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ saveToDb()

◆ setAnswers()

◆ setAnswerType()

◆ setCustomFalseOptionLabel()

◆ setCustomTrueOptionLabel()

◆ setExportDetailsXLSX()

◆ setOptionLabel()

◆ setScorePartialSolutionEnabled()

◆ setShuffleAnswersEnabled()

◆ setSpecificFeedbackSetting()

◆ setThumbSize()

◆ toJSON()

Field Documentation

◆ $answers

◆ $answerType

◆ $customFalseOptionLabel

◆ $customTrueOptionLabel

◆ $optionLabel

◆ $scorePartialSolutionEnabled

◆ $shuffleAnswersEnabled

◆ $specificFeedbackSetting