Inheritance diagram for assKprimChoice:

Collaboration diagram for assKprimChoice:

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

	getQuestionType ()

	getAdditionalTableName ()

	getAnswerTableName ()

	setShuffleAnswersEnabled (bool $shuffle_answers_enabled)

	isShuffleAnswersEnabled ()

	setAnswerType ($answerType)

	getAnswerType ()

	setThumbSize (int $thumbSize)

	getThumbSize ()

	setScorePartialSolutionEnabled ($scorePartialSolutionEnabled)

	isScorePartialSolutionEnabled ()

	setOptionLabel (string $option_label)

	getOptionLabel ()

	setCustomTrueOptionLabel ($customTrueOptionLabel)

	getCustomTrueOptionLabel ()

	setCustomFalseOptionLabel ($customFalseOptionLabel)

	getCustomFalseOptionLabel ()

	setSpecificFeedbackSetting (int $specific_feedback_setting)

	getSpecificFeedbackSetting ()

	setAnswers ($answers)

	getAnswers ()

	getAnswer ($position)

	addAnswer (ilAssKprimChoiceAnswer $answer)

	loadFromDb ($questionId)

	saveToDb (?int $original_id=null)

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

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

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

	getValidAnswerTypes ()

	isValidAnswerType ($answerType)

	isSingleLineAnswerType ($answerType)

	getAnswerTypeSelectOptions (ilLanguage $lng)

	getValidOptionLabels ()

	getValidOptionLabelsTranslated (ilLanguage $lng)

	getLangVarForOptionLabel (string $option_label)

	isValidOptionLabel (?string $option_label)

	getTrueOptionLabelTranslation (ilLanguage $lng, string $option_label)

	getTrueOptionLabel (string $option_label)

	getFalseOptionLabelTranslation (ilLanguage $lng, string $option_label)

	getInstructionTextTranslation (ilLanguage $lng, $option_label)

	isCustomOptionLabel ($labelValue)

	handleFileUploads ($answers, $files)

	removeAnswerImage ($position)

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

	getSpecificFeedbackAllCorrectOptionLabel ()

	moveAnswerDown ($position)

	moveAnswerUp ($position)

	toLog (AdditionalInformationGenerator $additional_info)

	solutionValuesToText (array $solution_values)

	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, array $solutionhints=[])

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

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $preview_session, $reached_points)

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

	cloneHints (int $source_question_id, int $target_question_id)

	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)

	ensureHintPageObjectExists ($pageObjectId)

	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)

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

Protected Member Functions
	getSolutionSubmit ()

	calculateReachedPointsForSolution (?array $found_values, int $active_id=0)

	cloneQuestionTypeSpecificProperties (\assQuestion $target)

	getRTETextWithMediaObjects ()

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)

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)

	duplicateQuestionHints (int $original_question_id, int $duplicate_question_id)

	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)

Private Member Functions
	loadAnswerData (int $question_id)

	getFalseOptionLabel (string $option_label)

	handleFileUpload (ilAssKprimChoiceAnswer $answer, $fileData)

	getNumAllowedFailures ()

Private Attributes
bool	$shuffle_answers_enabled = true

string	$answerType = self::ANSWER_TYPE_SINGLE_LINE

int	$thumbSize = self::DEFAULT_THUMB_SIZE

bool	$scorePartialSolutionEnabled = true

string	$option_label = self::OPTION_LABEL_RIGHT_WRONG

string	$customTrueOptionLabel = ''

string	$customFalseOptionLabel = ''

int	$specific_feedback_setting = ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL

	$answers = []

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

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

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

Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = false

static	$imageSourceFixReplaceMap

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

     {
         parent::__construct($title, $comment, $author, $owner, $question);
 
         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:

Member Function Documentation

◆ addAnswer()

assKprimChoice::addAnswer ( ilAssKprimChoiceAnswer $answer )

Definition at line 202 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:

◆ calculateReachedPoints()

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

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

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

      : float {
         $found_values = [];
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
 
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);
 
         while ($data = $this->db->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	(	?array	$found_values,
		int	$active_id = `0`
	)

protected

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

References assQuestion\$points, getAnswers(), assQuestion\getPoints(), isScorePartialSolutionEnabled(), and null.

Referenced by calculateReachedPoints().

                                                                                                   : float
     {
         $numCorrect = 0;
         if ($found_values === null) {
             $found_values = [];
         }
         foreach ($this->getAnswers() as $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:

◆ cloneQuestionTypeSpecificProperties()

assKprimChoice::cloneQuestionTypeSpecificProperties ( \assQuestion $target )

protected

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

References getAnswers(), assQuestion\getId(), and assQuestion\getObjId().

      : \assQuestion {
         $this->cloneImages(
             $this->getId(),
             $this->getObjId(),
             $target->getId(),
             $target->getObjId(),
             $this->getAnswers()
         );
         return $target;
     }

Here is the call graph for this function:

◆ getAdditionalTableName()

assKprimChoice::getAdditionalTableName ( )

Definition at line 79 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 191 of file class.assKprimChoice.php.

References getAnswers(), and null.

Referenced by removeAnswerImage().

                                         : ?ilAssKprimChoiceAnswer
     {
         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 ( )

Returns: array<ilAssKprimChoiceAnswer>

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

References $answers.

Referenced by calculateReachedPointsForSolution(), cloneQuestionTypeSpecificProperties(), getAnswer(), getCorrectSolutionForTextOutput(), getRTETextWithMediaObjects(), getSolutionSubmit(), isComplete(), lmMigrateQuestionTypeSpecificContent(), saveAnswerSpecificDataToDb(), solutionValuesToLog(), solutionValuesToText(), toJSON(), and toLog().

                                 : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assKprimChoice::getAnswerTableName ( )

Definition at line 84 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 104 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 445 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:

◆ getCorrectSolutionForTextOutput()

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

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

References getAnswers(), ilAssKprimChoiceAnswer\getAnswertext(), ilAssKprimChoiceAnswer\getCorrectness(), getFalseOptionLabelTranslation(), getOptionLabel(), getTrueOptionLabelTranslation(), and ILIAS\Repository\lng().

                                                                               : array
     {
         $true_option_label = $this->getTrueOptionLabelTranslation($this->lng, $this->getOptionLabel());
         $false_option_label = $this->getFalseOptionLabelTranslation($this->lng, $this->getOptionLabel());
         return array_map(
             fn(ilAssKprimChoiceAnswer $v): string => $v->getAnswertext()
                 . ' (' . $v->getCorrectness() ? $true_option_label : $false_option_label . ')',
             $this->getAnswers()
         );
     }

Here is the call graph for this function:

◆ getCustomFalseOptionLabel()

assKprimChoice::getCustomFalseOptionLabel ( )

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

References $customFalseOptionLabel.

Referenced by getFalseOptionLabelTranslation(), saveAdditionalQuestionDataToDb(), and solutionValuesToLog().

     {
         return $this->customFalseOptionLabel;
     }

Here is the caller graph for this function:

◆ getCustomTrueOptionLabel()

assKprimChoice::getCustomTrueOptionLabel ( )

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

References $customTrueOptionLabel.

Referenced by getTrueOptionLabelTranslation(), saveAdditionalQuestionDataToDb(), and solutionValuesToLog().

     {
         return $this->customTrueOptionLabel;
     }

Here is the caller graph for this function:

◆ getFalseOptionLabel()

assKprimChoice::getFalseOptionLabel ( string $option_label )

private

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

Referenced by getFalseOptionLabelTranslation(), and solutionValuesToLog().

                                                               : string
     {
         switch ($option_label) {
             case self::OPTION_LABEL_RIGHT_WRONG:
                 return 'option_label_wrong';
 
             case self::OPTION_LABEL_PLUS_MINUS:
                 return 'option_label_minus';
 
             case self::OPTION_LABEL_APPLICABLE_OR_NOT:
                 return 'option_label_not_applicable';
 
             case self::OPTION_LABEL_ADEQUATE_OR_NOT:
                 return 'option_label_not_adequate';
 
             default:
                 throw new \ErrorException('Invalide  Option Label');
         }
     }

Here is the caller graph for this function:

◆ getFalseOptionLabelTranslation()

assKprimChoice::getFalseOptionLabelTranslation	(	ilLanguage	$lng,
		string	$option_label
	)

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

References getCustomFalseOptionLabel(), getFalseOptionLabel(), and ilLanguage\txt().

Referenced by getCorrectSolutionForTextOutput(), getInstructionTextTranslation(), solutionValuesToText(), and toJSON().

                                                                                          : string
     {
         if ($option_label === self::OPTION_LABEL_CUSTOM) {
             return $this->getCustomFalseOptionLabel();
         }
 
         return $lng->txt(
             $this->getFalseOptionLabel($option_label)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstructionTextTranslation()

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

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

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

Referenced by toJSON().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLangVarForOptionLabel()

assKprimChoice::getLangVarForOptionLabel ( string $option_label )

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

Referenced by getValidOptionLabelsTranslated(), and toLog().

                                                                   : string
     {
         return match ($option_label) {
             self::OPTION_LABEL_RIGHT_WRONG => 'option_label_right_wrong',
             self::OPTION_LABEL_PLUS_MINUS => 'option_label_plus_minus',
             self::OPTION_LABEL_APPLICABLE_OR_NOT => 'option_label_applicable_or_not',
             self::OPTION_LABEL_ADEQUATE_OR_NOT => 'option_label_adequate_or_not',
             self::OPTION_LABEL_CUSTOM => 'option_label_custom'
         };
     }

Here is the caller graph for this function:

◆ getNumAllowedFailures()

assKprimChoice::getNumAllowedFailures ( )

private

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

References isScorePartialSolutionEnabled().

Referenced by toJSON(), and toLog().

                                             : 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 134 of file class.assKprimChoice.php.

References $option_label.

Referenced by getCorrectSolutionForTextOutput(), saveAdditionalQuestionDataToDb(), solutionValuesToLog(), solutionValuesToText(), toJSON(), and toLog().

                                     : string
     {
         return $this->option_label;
     }

Here is the caller graph for this function:

◆ getQuestionType()

assKprimChoice::getQuestionType ( )

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

Referenced by toJSON(), and toLog().

                                      : string
     {
         return 'assKprimChoice';
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assKprimChoice::getRTETextWithMediaObjects ( )

protected

Definition at line 685 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 619 of file class.assKprimChoice.php.

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

Referenced by saveWorkingData().

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

                                                               : string
     {
         return 'feedback_correct_kprim';
     }

◆ getSpecificFeedbackSetting()

assKprimChoice::getSpecificFeedbackSetting ( )

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

References $specific_feedback_setting.

Referenced by saveAdditionalQuestionDataToDb().

                                                 : int
     {
         return $this->specific_feedback_setting;
     }

Here is the caller graph for this function:

◆ getThumbSize()

assKprimChoice::getThumbSize ( )

Definition at line 114 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:

◆ getTrueOptionLabel()

assKprimChoice::getTrueOptionLabel ( string $option_label )

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

Referenced by getTrueOptionLabelTranslation(), and solutionValuesToLog().

                                                             : string
     {
         switch ($option_label) {
             case self::OPTION_LABEL_RIGHT_WRONG:
                 return 'option_label_right';
 
             case self::OPTION_LABEL_PLUS_MINUS:
                 return 'option_label_plus';
 
             case self::OPTION_LABEL_APPLICABLE_OR_NOT:
                 return 'option_label_applicable';
 
             case self::OPTION_LABEL_ADEQUATE_OR_NOT:
                 return 'option_label_adequate';
 
             default:
                 throw new \ErrorException('Invalide  Option Label');
         }
     }

Here is the caller graph for this function:

◆ getTrueOptionLabelTranslation()

assKprimChoice::getTrueOptionLabelTranslation	(	ilLanguage	$lng,
		string	$option_label
	)

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

References getCustomTrueOptionLabel(), getTrueOptionLabel(), and ilLanguage\txt().

Referenced by getCorrectSolutionForTextOutput(), getInstructionTextTranslation(), solutionValuesToText(), and toJSON().

                                                                                         : string
     {
         if ($option_label === self::OPTION_LABEL_CUSTOM) {
             return $this->getCustomTrueOptionLabel();
         }
 
         return $lng->txt(
             $this->getTrueOptionLabel($option_label)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidAnswerTypes()

assKprimChoice::getValidAnswerTypes ( )

Definition at line 425 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 453 of file class.assKprimChoice.php.

Referenced by getValidOptionLabelsTranslated(), and 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 464 of file class.assKprimChoice.php.

References $c, $option_label, getLangVarForOptionLabel(), getValidOptionLabels(), and ilLanguage\txt().

                                                                    : array
     {
         return array_reduce(
             $this->getValidOptionLabels(),
             function (array $c, string $option_label) use ($lng): array {
                 $c[$option_label] = $lng->txt($this->getLangVarForOptionLabel($option_label));
                 return $c;
             },
             []
         );
     }

Here is the call graph for this function:

◆ handleFileUpload()

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

private

Definition at line 582 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 569 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 350 of file class.assKprimChoice.php.

References getAnswers().

                                 : 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 564 of file class.assKprimChoice.php.

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

◆ isScorePartialSolutionEnabled()

assKprimChoice::isScorePartialSolutionEnabled ( )

Definition at line 124 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 94 of file class.assKprimChoice.php.

References $shuffle_answers_enabled.

Referenced by saveAdditionalQuestionDataToDb(), and toJSON().

                                              : bool
     {
         return $this->shuffle_answers_enabled;
     }

Here is the caller graph for this function:

◆ isSingleLineAnswerType()

assKprimChoice::isSingleLineAnswerType ( $answerType )

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

References ANSWER_TYPE_SINGLE_LINE.

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

◆ isValidAnswerType()

assKprimChoice::isValidAnswerType ( $answerType )

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

References 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 ( ?string $option_label )

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

References getValidOptionLabels().

Referenced by loadFromDb().

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

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 699 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 ( int $question_id )

private

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

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

Referenced by loadFromDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromDb()

assKprimChoice::loadFromDb ( $questionId )

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

References $data, Vendor\Package\$e, $res, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\buildQuestionDataQuery(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), isValidAnswerType(), isValidOptionLabel(), loadAnswerData(), null, 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 781 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 802 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 604 of file class.assKprimChoice.php.

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

                                                 : 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 312 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 332 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 ( ?int $original_id = null )

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

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

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

References ilObjTest\_getPass(), assQuestion\getProcessLocker(), getSolutionSubmit(), null, assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

      : bool {
         if ($pass === null) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $answer = $this->getSolutionSubmit();
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use ($answer, $active_id, $pass, $authorized) {
                 $this->removeCurrentSolution($active_id, $pass, $authorized);
                 foreach ($answer as $index => $value) {
                     if ($value !== null) {
                         $this->saveCurrentSolution($active_id, $pass, (int) $index, (int) $value, $authorized);
                     }
                 }
             }
         );
 
         return true;
     }

Here is the call graph for this function:

◆ setAnswers()

assKprimChoice::setAnswers ( $answers )

Definition at line 169 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 99 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 149 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 139 of file class.assKprimChoice.php.

References $customTrueOptionLabel.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setOptionLabel()

assKprimChoice::setOptionLabel ( string $option_label )

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

References $option_label.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setScorePartialSolutionEnabled()

assKprimChoice::setScorePartialSolutionEnabled ( $scorePartialSolutionEnabled )

Definition at line 119 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 ( bool $shuffle_answers_enabled )

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

References $shuffle_answers_enabled.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assKprimChoice::setSpecificFeedbackSetting ( int $specific_feedback_setting )

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

References $specific_feedback_setting.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setThumbSize()

assKprimChoice::setThumbSize ( int $thumbSize )

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

References $thumbSize.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ solutionValuesToLog()

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

protected

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

References assQuestion\$id, getAnswers(), getCustomFalseOptionLabel(), getCustomTrueOptionLabel(), getFalseOptionLabel(), ILIAS\Test\Logging\AdditionalInformationGenerator\getNoneTag(), getOptionLabel(), and getTrueOptionLabel().

      : array {
         $parsed_solution = [];
         $true_option_label = $this->getOptionLabel() === self::OPTION_LABEL_CUSTOM
             ? $this->getCustomTrueOptionLabel()
             : $this->getTrueOptionLabel($this->getOptionLabel());
         $false_option_label = $this->getOptionLabel() === self::OPTION_LABEL_CUSTOM
             ? $this->getCustomFalseOptionLabel()
             : $this->getFalseOptionLabel($this->getOptionLabel());
         foreach ($this->getAnswers() as $id => $answer) {
             $value = $additional_info->getNoneTag();
             foreach ($solution_values as $solution) {
                 if ($solution['value1'] !== (string) $id) {
                     continue;
                 }
 
                 $value = $false_option_label;
                 if ($solution['value2'] === '1') {
                     $value = $true_option_label;
                 }
                 break;
             }
             $parsed_solution[$answer->getAnswertext()] = $value;
         }
         return $parsed_solution;
     }

Here is the call graph for this function:

◆ solutionValuesToText()

assKprimChoice::solutionValuesToText ( array $solution_values )

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

References assQuestion\$id, getAnswers(), getFalseOptionLabelTranslation(), getOptionLabel(), getTrueOptionLabelTranslation(), and ILIAS\Repository\lng().

                                                                 : array
     {
         $parsed_solution = [];
         $true_option_label = $this->getTrueOptionLabelTranslation($this->lng, $this->getOptionLabel());
         $false_option_label = $this->getFalseOptionLabelTranslation($this->lng, $this->getOptionLabel());
         foreach ($this->getAnswers() as $id => $answer) {
             $value = $this->lng->txt('none');
             foreach ($solution_values as $solution) {
                 if ($solution['value1'] !== (string) $id) {
                     continue;
                 }
 
                 $value = $false_option_label;
                 if ($solution['value2'] === '1') {
                     $value = $true_option_label;
                 }
                 break;
             }
             $parsed_solution[] = "{$answer->getAnswertext()} ({$value})";
         }
         return $parsed_solution;
     }

Here is the call graph for this function:

◆ toJSON()

assKprimChoice::toJSON ( )

Returns a JSON representation of the question.

Implements ILIAS\TestQuestionPool\Questions\QuestionLMExportable.

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

References $answers, 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:

◆ toLog()

assKprimChoice::toLog ( AdditionalInformationGenerator $additional_info )

Implements ILIAS\TestQuestionPool\Questions\Question.

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

References $answers, assQuestion\formatSAQuestion(), getAnswers(), ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool(), getLangVarForOptionLabel(), getNumAllowedFailures(), getOptionLabel(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), ILIAS\Test\Logging\AdditionalInformationGenerator\getTagForLangVar(), assQuestion\getTitleForHTMLOutput(), and ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool().

                                                                           : array
     {
         $result = [
             AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
             AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
             AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
             AdditionalInformationGenerator::KEY_QUESTION_KPRIM_OPTION_LABEL => $additional_info
                 ->getTagForLangVar($this->getLangVarForOptionLabel($this->getOptionLabel())),
             AdditionalInformationGenerator::KEY_QUESTION_SHUFFLE_ANSWER_OPTIONS => $additional_info
                 ->getTrueFalseTagForBool($this->getShuffle()),
             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))
             ]
         ];
 
         $result[AdditionalInformationGenerator::KEY_QUESTION_KPRIM_SCORE_PARTIAL_SOLUTION_ENABLED] = $additional_info
             ->getEnabledDisabledTagForBool($this->getNumAllowedFailures() > 0);
 
         $answers = [];
         foreach ($this->getAnswers() as $key => $answer) {
             $answers[$key + 1] = [
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION => $this->formatSAQuestion($answer->getAnswertext()),
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_CORRECTNESS => $additional_info->getTrueFalseTagForBool((bool) $answer->getCorrectness()),
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_ORDER => (int) $answer->getPosition(),
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_IMAGE => (string) $answer->getImageFile(),
                 AdditionalInformationGenerator::KEY_FEEDBACK => $this->formatSAQuestion(
                     $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                 )
             ];
         }
 
         $result[AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTIONS] = $answers;
 
         return $result;
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

assKprimChoice::$answers = []

private

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

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

◆ $answerType

string assKprimChoice::$answerType = self::ANSWER_TYPE_SINGLE_LINE

private

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

Referenced by getAnswerType(), and setAnswerType().

◆ $customFalseOptionLabel

string assKprimChoice::$customFalseOptionLabel = ''

private

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

Referenced by getCustomFalseOptionLabel(), and setCustomFalseOptionLabel().

◆ $customTrueOptionLabel

string assKprimChoice::$customTrueOptionLabel = ''

private

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

Referenced by getCustomTrueOptionLabel(), and setCustomTrueOptionLabel().

◆ $option_label

string assKprimChoice::$option_label = self::OPTION_LABEL_RIGHT_WRONG

private

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

Referenced by getOptionLabel(), getValidOptionLabelsTranslated(), and setOptionLabel().

◆ $scorePartialSolutionEnabled

bool assKprimChoice::$scorePartialSolutionEnabled = true

private

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

Referenced by isScorePartialSolutionEnabled(), and setScorePartialSolutionEnabled().

◆ $shuffle_answers_enabled

bool assKprimChoice::$shuffle_answers_enabled = true

private

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

Referenced by isShuffleAnswersEnabled(), and setShuffleAnswersEnabled().

◆ $specific_feedback_setting

int assKprimChoice::$specific_feedback_setting = ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL

private

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

Referenced by getSpecificFeedbackSetting(), and setSpecificFeedbackSetting().

◆ $thumbSize

int assKprimChoice::$thumbSize = self::DEFAULT_THUMB_SIZE

private

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

Referenced by getThumbSize(), and setThumbSize().

◆ ANSWER_TYPE_MULTI_LINE

const assKprimChoice::ANSWER_TYPE_MULTI_LINE = 'multiLine'

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

Referenced by assKprimChoiceGUI\handleAnswerTextsSubmit().

◆ ANSWER_TYPE_SINGLE_LINE

const assKprimChoice::ANSWER_TYPE_SINGLE_LINE = 'singleLine'

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

Referenced by isSingleLineAnswerType().

◆ DEFAULT_THUMB_SIZE

const assKprimChoice::DEFAULT_THUMB_SIZE = 150

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

◆ NUM_REQUIRED_ANSWERS

const assKprimChoice::NUM_REQUIRED_ANSWERS = 4

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

◆ OPTION_LABEL_ADEQUATE_OR_NOT

const assKprimChoice::OPTION_LABEL_ADEQUATE_OR_NOT = 'adequate_or_not'

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

◆ OPTION_LABEL_APPLICABLE_OR_NOT

const assKprimChoice::OPTION_LABEL_APPLICABLE_OR_NOT = 'applicable_or_not'

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

◆ OPTION_LABEL_CUSTOM

const assKprimChoice::OPTION_LABEL_CUSTOM = 'customlabel'

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

◆ OPTION_LABEL_PLUS_MINUS

const assKprimChoice::OPTION_LABEL_PLUS_MINUS = 'plus_minus'

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

◆ OPTION_LABEL_RIGHT_WRONG

const assKprimChoice::OPTION_LABEL_RIGHT_WRONG = 'right_wrong'

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

◆ PARTIAL_SCORING_NUM_CORRECT_ANSWERS

const assKprimChoice::PARTIAL_SCORING_NUM_CORRECT_ANSWERS = 3

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

◆ THUMB_PREFIX

const assKprimChoice::THUMB_PREFIX = 'thumb.'

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

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

components/ILIAS/TestQuestionPool/classes/class.assKprimChoice.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ cloneQuestionTypeSpecificProperties()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAnswerType()

◆ getAnswerTypeSelectOptions()

◆ getCorrectSolutionForTextOutput()

◆ getCustomFalseOptionLabel()

◆ getCustomTrueOptionLabel()

◆ getFalseOptionLabel()

◆ getFalseOptionLabelTranslation()

◆ getInstructionTextTranslation()

◆ getLangVarForOptionLabel()

◆ getNumAllowedFailures()

◆ getOptionLabel()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ getThumbSize()

◆ getTrueOptionLabel()

◆ getTrueOptionLabelTranslation()

◆ getValidAnswerTypes()

◆ getValidOptionLabels()

◆ getValidOptionLabelsTranslated()

◆ handleFileUpload()

◆ handleFileUploads()

◆ isComplete()

◆ isCustomOptionLabel()

◆ isScorePartialSolutionEnabled()

◆ isShuffleAnswersEnabled()

◆ isSingleLineAnswerType()

◆ isValidAnswerType()

◆ isValidOptionLabel()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadAnswerData()

◆ loadFromDb()

◆ moveAnswerDown()

◆ moveAnswerUp()

◆ removeAnswerImage()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setAnswerType()

◆ setCustomFalseOptionLabel()

◆ setCustomTrueOptionLabel()

◆ setOptionLabel()

◆ setScorePartialSolutionEnabled()

◆ setShuffleAnswersEnabled()

◆ setSpecificFeedbackSetting()

◆ setThumbSize()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

Field Documentation

◆ $answers

◆ $answerType

◆ $customFalseOptionLabel

◆ $customTrueOptionLabel

◆ $option_label

◆ $scorePartialSolutionEnabled

◆ $shuffle_answers_enabled