Class for single choice questions. More...

Inheritance diagram for assSingleChoice:

Collaboration diagram for assSingleChoice:

Public Member Functions
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="", int $output_type=self::OUTPUT_ORDER)

	isComplete ()

	saveToDb (?int $original_id=null)

	loadFromDb (int $question_id)

	addAnswer (string $answertext='', float $points=0.0, int $order=0, ?string $answerimage=null, int $answer_id=-1)

	getAnswerCount ()
	Returns the number of answers. More...

	getAnswer (int $index=0)
	Returns an answer with a given index. More...

	deleteAnswer (int $index=0)
	Deletes an answer with a given index. More...

	flushAnswers ()
	Deletes all answers. More...

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

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

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

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

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

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

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

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

	setImageFile (string $image_filename, string $image_tempfilename='')
	Sets the image file and uploads the image to the object's image directory. More...

	getRTETextWithMediaObjects ()

	getAnswers ()
	Returns a reference to the answers array. More...

	setAnswers (array $answers)

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

	removeAnswerImage (int $index)

	getMultilineAnswerSetting ()

	setMultilineAnswerSetting ($setting='0')

	setSpecificFeedbackSetting (int $feedback_setting)
	Sets the feedback settings in effect for the question. More...

	getSpecificFeedbackSetting ()

	getSpecificFeedbackAllCorrectOptionLabel ()

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

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...

	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...

	isSingleline ()

	setIsSingleline (bool $is_singleline)

	getFeedbackSetting ()

	setFeedbackSetting (int $feedback_setting)

	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...

	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	toNormalized (Transformations $transformations, array $context=[])

	fromNormalized (array $normalized, Transformations $transformations)

Public Member Functions inherited from assQuestion
	getQuestionType ()

	isComplete ()

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

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

	getAdditionalTableName ()

	getAnswerTableName ()

	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...

	getCurrentUser ()

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping)

	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorized_solution=true)

	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...

	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...

	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...

	validateSolutionSubmit ()

	getSuggestedSolutionPath ()

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

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, ?int $pass=null)

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

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)

	createPageObject ()

	clonePageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

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

	saveQuestionDataToDb (?int $original_id=null)

	updateOriginalId (?int $original_id=null)

	duplicate (bool $set_original_id=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)

	copyObject (int $target_parent_id, string $title='')

	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')

	saveToDb (?int $original_id=null)

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	getInternalLinkHref (string $target)

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

	isWriteable ()

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)

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

	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

	getQuestionTypeID ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	isAnswered (int $active_id, int $pass)

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange (int $lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)

	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)

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

	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)

	setStep ($step)

	getStep ()

	toJSON ()

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

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

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $value_pairs)

	updateTimestamp ()

	getTestPresentationConfig ()

	hasWritableOriginalInQuestionPool ()

	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)

	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)

	getSolutionForTextOutput (int $active_id, int $pass)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	getVariablesAsTextArray (int $active_id, int $pass)

	toNormalized (Transformations $transformations, array $context=[])

	fromNormalized (array $normalized, Transformations $transformations)

	validateSolutionSubmit ()

	toLog (AdditionalInformationGenerator $additional_info)

	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)

	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_id, TestQuestionAdministrationInteractionTypes $interaction_type)

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

Public Member Functions inherited from ilObjAnswerScoringAdjustable
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

Public Member Functions inherited from iQuestionCondition
	getOperators (string $expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...

	getAvailableAnswerOptions (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...

	getSpecificFeedbackAllCorrectOptionLabel ()

	toJSON ()

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

Data Fields
array	$answers = []

int	$output_type

Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

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

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

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

const	NumberOfResultExpression = '+n+'

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

const	EmptyAnswerExpression = "?"

Protected Member Functions
	cloneQuestionTypeSpecificProperties (\assQuestion $target)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)
	{} More...

	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...

Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...

	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...

	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $post_submission_field_name)

	savePreviewData (ilAssQuestionPreviewSession $preview_session)

	deletePageOfQuestion (int $question_id)

	cloneQuestionTypeSpecificProperties (self $target)

	removeAllImageFiles (string $image_target_path)

	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)

	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)

	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)

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

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)

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

	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints (float $points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

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

	buildQuestionDataQuery ()

	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)

	lookupMaxStep (int $active_id, int $pass)

	buildTestPresentationConfig ()

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
const	OUTPUT_ORDER = 0

const	OUTPUT_RANDOM = 1

const	FEEDBACK_MODE_ALL_ANSWERS = 1

const	FEEDBACK_MODE_SELECTED_ANSWERS = 2

const	FEEDBACK_MODE_CORRECT_ANSWERS = 3

int	$feedback_setting = self::FEEDBACK_MODE_SELECTED_ANSWERS

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

GeneralQuestionPropertiesRepository	$questionrepository

RequestDataCollector	$questionpool_request

QuestionFiles	$question_files

ilAssQuestionProcessLocker	$processLocker

ilTestQuestionConfig	$testQuestionConfig

SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo

ILIAS	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

ilObjUser	$current_user

SkillUsageService	$skillUsageService

HTTPServices	$http

Refinery	$refinery

Transformation	$shuffler

LoggingServices	$log

Container	$dic

ilAssQuestionLifecycle	$lifecycle

ilAssQuestionPage	$page

TestResultRepository	$test_result_repository

int	$id

string	$title

string	$comment

int	$owner

string	$author

int	$thumb_size

string	$question

float	$points = 0.0

bool	$shuffle = true

int	$test_id

int	$obj_id = 0

int	$original_id = null

int	$lastChange = null

string	$external_id = null

int	$step = null

array	$suggested_solutions

Private Attributes
bool	$is_singleline = true

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

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

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

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	instantiateQuestion (int $question_id)

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

static	getFeedbackClassNameByQuestionType (string $questionType)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $question_id)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...

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

Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = false

static	$imageSourceFixReplaceMap

Detailed Description

Class for single choice questions.

assSingleChoice is a class for single choice questions.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m; Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

assSingleChoice::__construct	(	string	$title = `""`,
		string	$comment = `""`,
		string	$author = `""`,
		int	$owner = `-1`,
		string	$question = `""`,
		int	$output_type = `self::OUTPUT_ORDER`
	)

Definition at line 62 of file class.assSingleChoice.php.

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->output_type = $output_type;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

assSingleChoice::addAnswer	(	string	$answertext = `''`,
		float	$points = `0.0`,
		int	$order = `0`,
		?string	$answerimage = `null`,
		int	$answer_id = `-1`
	)

Definition at line 183 of file class.assSingleChoice.php.

     : void {
        if (array_key_exists($order, $this->answers)) {
            // insert answer
            $answer = new ASS_AnswerBinaryStateImage(
                $this->getHtmlQuestionContentPurifier()->purify($answertext),
                $points,
                $order,
                true,
                $answerimage,
                $answer_id
            );
            $newchoices = [];
            for ($i = 0; $i < $order; $i++) {
                $newchoices[] = $this->answers[$i];
            }
            $newchoices[] = $answer;
            for ($i = $order, $iMax = count($this->answers); $i < $iMax; $i++) {
                $changed = $this->answers[$i];
                $changed->setOrder($i + 1);
                $newchoices[] = $changed;
            }
            $this->answers = $newchoices;
            return;
        }
 
        $answer = new ASS_AnswerBinaryStateImage(
            $this->getHtmlQuestionContentPurifier()->purify($answertext),
            $points,
            count($this->answers),
            true,
            $answerimage,
            $answer_id
        );
        $this->answers[] = $answer;
    }

References ILIAS\Questions\AnswerFormTypes\Cloze\Migration\getHtmlQuestionContentPurifier().

Here is the call graph for this function:

◆ afterSyncWithOriginal()

assSingleChoice::afterSyncWithOriginal	(	int	$original_question_id,
		int	$clone_question_id,
		int	$original_parent_id,
		int	$clone_parent_id
	)

protected

{}

Reimplemented from assQuestion.

Definition at line 845 of file class.assSingleChoice.php.

     : void {
        parent::afterSyncWithOriginal($original_question_id, $clone_question_id, $original_parent_id, $clone_parent_id);
 
        $original_image_path = $this->question_files->buildImagePath($original_question_id, $original_parent_id);
        $clone_image_path = $this->question_files->buildImagePath($clone_question_id, $clone_parent_id);
 
        ilFileUtils::delDir($original_image_path);
        if (is_dir($clone_image_path)) {
            ilFileUtils::makeDirParents($original_image_path);
            ilFileUtils::rCopy($clone_image_path, $original_image_path);
        }
    }

◆ calculateReachedPoints()

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

Reimplemented from assQuestion.

Definition at line 321 of file class.assSingleChoice.php.

     : 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)) {
            if ($data['value1'] !== '') {
                array_push($found_values, $data['value1']);
            }
        }
        $points = 0.0;
        foreach ($this->answers as $key => $answer) {
            if ($found_values !== []
                && in_array($key, $found_values)) {
                $points += $answer->getPoints();
            }
        }
 
        return $points;
    }

◆ calculateReachedPointsFromPreviewSession()

assSingleChoice::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $preview_session )

Reimplemented from assQuestion.

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

     : float {
        $participant_solution = $preview_session->getParticipantsSolution();
 
        $points = 0.0;
        foreach ($this->answers as $key => $answer) {
            if (is_numeric($participant_solution)
                && $key === (int) $participant_solution) {
                $points = $answer->getPoints();
            }
        }
 
        return $this->ensureNonNegativePoints($points);
    }

◆ cloneQuestionTypeSpecificProperties()

assSingleChoice::cloneQuestionTypeSpecificProperties ( \assQuestion $target )

protected

Definition at line 170 of file class.assSingleChoice.php.

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

◆ deleteAnswer()

assSingleChoice::deleteAnswer ( int $index = 0 )

Deletes an answer with a given index.

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

Parameters

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

See also: $answers

Definition at line 269 of file class.assSingleChoice.php.

                                                : void
    {
        if ($index < 0) {
            return;
        }
        if (count($this->answers) < 1) {
            return;
        }
        if ($index >= count($this->answers)) {
            return;
        }
        $answer = $this->answers[$index];
        if ($answer->hasImage()) {
            $this->deleteImage($answer->getImage());
        }
        unset($this->answers[$index]);
        $this->answers = array_values($this->answers);
        for ($i = 0, $iMax = count($this->answers); $i < $iMax; $i++) {
            if ($this->answers[$i]->getOrder() > $index) {
                $this->answers[$i]->setOrder($i);
            }
        }
    }

References ILIAS\UI\Implementation\Component\Table\getOrder().

Here is the call graph for this function:

◆ flushAnswers()

assSingleChoice::flushAnswers ( )

Deletes all answers.

@access public

See also: $answers

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

                                  : void
    {
        $this->answers = [];
    }

◆ fromNormalized()

assSingleChoice::fromNormalized	(	array	$normalized,
		Transformations	$transformations
	)

Parameters

array<array-key,mixed> $normalized

Reimplemented from assQuestion.

Definition at line 965 of file class.assSingleChoice.php.

     : static
    {
        $clone = parent::fromNormalized($normalized, $transformations);
        $clone->is_singleline = $transformations->bool($normalized['is_singleline']);
        $clone->feedback_setting = $transformations->int($normalized['feedback_setting']);
        $clone->answers = array_map(
            static fn(array $answer): ASS_AnswerBinaryStateImage => $transformations->denormalize($answer, new ASS_AnswerBinaryStateImage()),
            $normalized['answers']
        );
        return $clone;
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\bool(), ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\denormalize(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\int().

Here is the call graph for this function:

◆ getAdditionalTableName()

assSingleChoice::getAdditionalTableName ( )

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

Returns: string The additional table name @access public

Reimplemented from assQuestion.

Definition at line 585 of file class.assSingleChoice.php.

                                            : string
    {
        return "qpl_qst_sc";
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ getAnswer()

assSingleChoice::getAnswer ( int $index = 0 )

Returns an answer with a given index.

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

Parameters

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

Returns: object ASS_AnswerBinaryStateImage-Object containing the answer @access public

See also: $answers

Definition at line 246 of file class.assSingleChoice.php.

                                             : ?ASS_AnswerBinaryStateImage
    {
        if ($index < 0) {
            return null;
        }
        if (count($this->answers) < 1) {
            return null;
        }
        if ($index >= count($this->answers)) {
            return null;
        }
 
        return $this->answers[$index];
    }

◆ getAnswerCount()

assSingleChoice::getAnswerCount ( )

Returns the number of answers.

Returns: integer The number of answers of the multiple choice question @access public

See also: $answers

Definition at line 232 of file class.assSingleChoice.php.

                                    : int
    {
        return count($this->answers);
    }

◆ getAnswers()

assSingleChoice::getAnswers ( )

Returns a reference to the answers array.

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

                                : array
    {
        return $this->answers;
    }

◆ getAnswerTableName()

assSingleChoice::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name @access public

Reimplemented from assQuestion.

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

                                        : string
    {
        return "qpl_a_sc";
    }

◆ getAvailableAnswerOptions()

assSingleChoice::getAvailableAnswerOptions ( $index = null )

If index is null, the function returns an array with all anwser options Else it returns the specific answer option.

Parameters

null | int $index

Definition at line 833 of file class.assSingleChoice.php.

    {
        if ($index !== null) {
            return $this->getAnswer($index);
        } else {
            return $this->getAnswers();
        }
    }

◆ getCorrectSolutionForTextOutput()

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

Reimplemented from assQuestion.

Definition at line 936 of file class.assSingleChoice.php.

                                                                              : array
    {
        return array_reduce(
            $this->getAnswers(),
            function (array $c, ASS_AnswerBinaryStateImage $v): array {
                if ($v->getPoints() > 0.0) {
                    $c[] = $v->getAnswertext()
                        . "({$this->lng->txt('points')}: {$v->getPoints()})";
                }
                return $c;
            },
            []
        );
    }

References Vendor\Package\$c, and ASS_AnswerSimple\getPoints().

Here is the call graph for this function:

◆ getExpressionTypes()

assSingleChoice::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 782 of file class.assSingleChoice.php.

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

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\NumberOfResultExpression, and iQuestionCondition\PercentageResultExpression.

◆ getFeedbackSetting()

assSingleChoice::getFeedbackSetting ( )

Definition at line 873 of file class.assSingleChoice.php.

                                        : int
    {
        return $this->feedback_setting;
    }

◆ getMaximumPoints()

assSingleChoice::getMaximumPoints ( )

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

@access public

See also: $points

Reimplemented from assQuestion.

Definition at line 310 of file class.assSingleChoice.php.

                                      : float
    {
        $points = 0;
        foreach ($this->answers as $key => $value) {
            if ($value->getPoints() > $points) {
                $points = $value->getPoints();
            }
        }
        return $points;
    }

Referenced by isComplete().

Here is the caller graph for this function:

◆ getMultilineAnswerSetting()

assSingleChoice::getMultilineAnswerSetting ( )

Definition at line 745 of file class.assSingleChoice.php.

                                               : int
    {
        return $this->current_user->getPref('tst_multiline_answers') === '1' ? 1 : 0;
    }

◆ getOperators()

assSingleChoice::getOperators ( string $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

Here is the call graph for this function:

◆ getQuestionType()

assSingleChoice::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question @access public

Reimplemented from assQuestion.

Definition at line 574 of file class.assSingleChoice.php.

                                     : string
    {
        return "assSingleChoice";
    }

◆ getRTETextWithMediaObjects()

assSingleChoice::getRTETextWithMediaObjects ( )

Reimplemented from assQuestion.

Definition at line 648 of file class.assSingleChoice.php.

                                                : string
    {
        $text = parent::getRTETextWithMediaObjects();
        foreach (array_keys($this->answers) as $index) {
            $text .= $this->feedbackOBJ->getSpecificAnswerFeedbackContent($this->getId(), 0, $index);
            $answer_obj = $this->answers[$index];
            $text .= $answer_obj->getAnswertext();
        }
        return $text;
    }

References $text, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ getSpecificFeedbackAllCorrectOptionLabel()

assSingleChoice::getSpecificFeedbackAllCorrectOptionLabel ( )

Implements ilAssSpecificFeedbackOptionLabelProvider.

Definition at line 772 of file class.assSingleChoice.php.

                                                              : string
    {
        return 'feedback_correct_sc_mc';
    }

◆ getSpecificFeedbackSetting()

assSingleChoice::getSpecificFeedbackSetting ( )

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

                                                : int
    {
        return $this->feedback_setting;
    }

◆ getUserQuestionResult()

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

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

Implements iQuestionCondition.

Definition at line 791 of file class.assSingleChoice.php.

     : ilUserQuestionResult {
        $result = new ilUserQuestionResult($this, $active_id, $pass);
 
        $maxStep = $this->lookupMaxStep($active_id, $pass);
        if ($maxStep > 0) {
            $data = $this->db->queryF(
                "SELECT * FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = %s",
                ["integer", "integer", "integer","integer"],
                [$active_id, $pass, $this->getId(), $maxStep]
            );
        } else {
            $data = $this->db->queryF(
                "SELECT * FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s",
                ["integer", "integer", "integer"],
                [$active_id, $pass, $this->getId()]
            );
        }
 
        $row = $this->db->fetchAssoc($data);
 
        if ($row != null) {
            ++$row["value1"];
            $result->addKeyValue($row["value1"], $row["value1"]);
        }
 
        $points = $this->calculateReachedPoints($active_id, $pass);
        $max_points = $this->getMaximumPoints();
 
        $result->setReachedPercentage(($points / $max_points) * 100);
 
        return $result;
    }

◆ isComplete()

assSingleChoice::isComplete ( )

Reimplemented from assQuestion.

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

                                : bool
    {
        if (
            $this->title !== ''
            && $this->author !== null && $this->author !== ''
            && $this->question !== null && $this->question !== ''
            && $this->answers !== []
            && $this->getMaximumPoints() > 0
        ) {
            foreach ($this->answers as $answer) {
                if ($answer->getAnswertext() === '' && $answer->getImage() === '') {
                    return false;
                }
            }
            return true;
        }
        return false;
    }

References getMaximumPoints().

Here is the call graph for this function:

◆ isSingleline()

assSingleChoice::isSingleline ( )

Definition at line 863 of file class.assSingleChoice.php.

                                  : bool
    {
        return $this->is_singleline;
    }

◆ lmMigrateQuestionTypeSpecificContent()

assSingleChoice::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Reimplemented from assQuestion.

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

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

References ilAssSelfAssessmentMigrator\migrateToLmContent().

Here is the call graph for this function:

◆ loadFromDb()

assSingleChoice::loadFromDb ( int $question_id )

Reimplemented from assQuestion.

Definition at line 101 of file class.assSingleChoice.php.

                                                : void
    {
        $result = $this->db->queryF(
            "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
            ["integer"],
            [$question_id]
        );
        if ($result->numRows() == 1) {
            $data = $this->db->fetchAssoc($result);
            $this->setId($question_id);
            $this->setObjId($data["obj_fi"]);
            $this->setTitle($data["title"] ?? '');
            $this->setNrOfTries($data['nr_of_tries']);
            $this->setComment($data["description"] ?? '');
            $this->setOriginalId($data["original_id"]);
            $this->setAuthor($data["author"]);
            $this->setPoints($data["points"]);
            $this->setOwner($data["owner"]);
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"] ?? '', 1));
            $shuffle = (is_null($data['shuffle'])) ? true : $data['shuffle'];
            $this->setShuffle((bool) $shuffle);
            if ($data['thumb_size'] !== null && $data['thumb_size'] >= $this->getMinimumThumbSize()) {
                $this->setThumbSize($data['thumb_size']);
            }
            $this->is_singleline = $data['allow_images'] === null || $data['allow_images'] === '0';
            $this->lastChange = $data['tstamp'];
            $this->feedback_setting = $data['feedback_setting'] ?? self::FEEDBACK_MODE_SELECTED_ANSWERS;
 
            try {
                $this->setLifecycle(new ilAssQuestionLifecycle($data['lifecycle']));
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                $this->setLifecycle(new ilAssQuestionLifecycle());
            }
 
            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
        }
 
        $result = $this->db->queryF(
            "SELECT * FROM qpl_a_sc WHERE question_fi = %s ORDER BY aorder ASC",
            ['integer'],
            [$question_id]
        );
 
        if ($result->numRows() > 0) {
            while ($data = $this->db->fetchAssoc($result)) {
                $imagefilename = $this->getImagePath() . $data["imagefile"];
                if (!file_exists($imagefilename)) {
                    $data["imagefile"] = null;
                }
 
                $data["answertext"] = ilRTE::_replaceMediaObjectImageSrc($data["answertext"] ?? '', 1);
                $image = new ASS_AnswerBinaryStateImage(
                    $data["answertext"],
                    $data["points"],
                    $data["aorder"],
                    true,
                    $data["imagefile"] ? $data["imagefile"] : null,
                    $data["answer_id"]
                );
                $this->answers[] = $image;
            }
        }
 
        parent::loadFromDb($question_id);
    }

References $data, Vendor\Package\$e, assQuestion\$shuffle, ilRTE\_replaceMediaObjectImageSrc(), FEEDBACK_MODE_SELECTED_ANSWERS, getAdditionalTableName(), assQuestion\getImagePath(), assQuestion\getMinimumThumbSize(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), assQuestion\setThumbSize(), and assQuestion\setTitle().

Here is the call graph for this function:

◆ removeAnswerImage()

assSingleChoice::removeAnswerImage ( int $index )

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

                                                 : void
    {
        $answer = $this->answers[$index];
        if (is_object($answer)) {
            $this->deleteImage($answer->getImage());
            $answer->setImage(null);
        }
    }

◆ saveAdditionalQuestionDataToDb()

assSingleChoice::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

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

                                                    : void
    {
        // save additional data
        $this->db->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            [ "integer" ],
            [ $this->getId() ]
        );
 
        $this->db->manipulateF(
            "INSERT INTO " . $this->getAdditionalTableName(
            ) . " (question_fi, shuffle, allow_images, thumb_size) VALUES (%s, %s, %s, %s)",
            [ "integer", "text", "text", "integer" ],
            [
                                $this->getId(),
                                $this->getShuffle(),
                                $this->is_singleline ? '0' : '1',
                                $this->getThumbSize()
                            ]
        );
    }

References ILIAS\Survey\Mode\getId().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assSingleChoice::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Reimplemented from assQuestion.

Definition at line 406 of file class.assSingleChoice.php.

                                                                                   : void
    {
        $mc_result_key = 'multiple_choice_result' . $this->getId() . 'ID';
        if (
            $this->http->wrapper()->post()->has($mc_result_key) &&
            ($mc_result = $this->http->wrapper()->post()->retrieve($mc_result_key, $this->refinery->kindlyTo()->string())) !== ''
        ) {
            $previewSession->setParticipantsSolution($mc_result);
        } else {
            $previewSession->setParticipantsSolution(null);
        }
    }

References ILIAS\Survey\Mode\getId(), ILIAS\FileDelivery\http(), and ilAssQuestionPreviewSession\setParticipantsSolution().

Here is the call graph for this function:

◆ saveToDb()

assSingleChoice::saveToDb ( ?int $original_id = null )

Reimplemented from assQuestion.

Definition at line 93 of file class.assSingleChoice.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

Reimplemented from assQuestion.

Definition at line 363 of file class.assSingleChoice.php.

     : bool {
        if (is_null($pass)) {
            $pass = ilObjTest::_getPass($active_id);
        }
 
        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
            function () use ($active_id, $pass, $authorized) {
                $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized);
 
                $update = -1;
                if ($this->db->numRows($result)) {
                    $row = $this->db->fetchAssoc($result);
                    $update = $row["solution_id"];
                }
 
                $multiple_choice_result = $this->http->wrapper()->post()->has('multiple_choice_result') ?
                    $this->http->wrapper()->post()->retrieve('multiple_choice_result', $this->refinery->kindlyTo()->string()) :
                    '';
 
                if ($update !== -1
                    && $multiple_choice_result === '') {
                    $this->removeSolutionRecordById($update);
                    return;
                }
 
                if ($update !== -1) {
                    $this->updateCurrentSolution($update, $multiple_choice_result, null, $authorized);
                    return;
                }
 
                if ($multiple_choice_result !== '') {
                    $this->saveCurrentSolution($active_id, $pass, $multiple_choice_result, null, $authorized);
                }
            }
        );
 
        return true;
    }

References ilObjTest\_getPass().

Here is the call graph for this function:

◆ setAnswers()

assSingleChoice::setAnswers ( array $answers )

Definition at line 667 of file class.assSingleChoice.php.

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

◆ setFeedbackSetting()

assSingleChoice::setFeedbackSetting ( int $feedback_setting )

Definition at line 878 of file class.assSingleChoice.php.

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

◆ setImageFile()

assSingleChoice::setImageFile	(	string	$image_filename,
		string	$image_tempfilename = `''`
	)

Sets the image file and uploads the image to the object's image directory.

Parameters

string	$image_filename	Name of the original image file
string	$image_tempfilename	Name of the temporary uploaded image file

Returns: integer An errorcode if the image upload fails, 0 otherwise @access public

Definition at line 609 of file class.assSingleChoice.php.

     : int {
        if (empty($image_tempfilename)) {
            return 0;
        }
 
        $cleaned_image_filename = str_replace(" ", "_", $image_filename);
        $imagepath = $this->getImagePath();
        if (!file_exists($imagepath)) {
            ilFileUtils::makeDirParents($imagepath);
        }
 
        if (!ilFileUtils::moveUploadedFile($image_tempfilename, $cleaned_image_filename, $imagepath . $cleaned_image_filename)) {
            return 2;
        }
 
        $mimetype = ilObjMediaObject::getMimeType($imagepath . $cleaned_image_filename);
        if (!preg_match("/^image/", $mimetype)) {
            unlink($imagepath . $cleaned_image_filename);
            return 1;
        }
 
        if ($this->is_singleline && $this->getThumbSize()) {
            $this->generateThumbForFile(
                $cleaned_image_filename,
                $this->getImagePath(),
                $this->getThumbSize()
            );
        }
 
        return 0;
    }

◆ setIsSingleline()

assSingleChoice::setIsSingleline ( bool $is_singleline )

Definition at line 868 of file class.assSingleChoice.php.

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

◆ setMultilineAnswerSetting()

assSingleChoice::setMultilineAnswerSetting ( $setting = '0' )

Definition at line 750 of file class.assSingleChoice.php.

                                                             : void
    {
        $this->current_user->writePref('tst_multiline_answers', (string) $setting);
    }

◆ setSpecificFeedbackSetting()

assSingleChoice::setSpecificFeedbackSetting ( int $feedback_setting )

Sets the feedback settings in effect for the question.

Options are: 1 - Feedback is shown for all answer options. 2 - Feedback is shown for all checked/selected options. 3 - Feedback is shown for all correct options.

Definition at line 762 of file class.assSingleChoice.php.

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

◆ solutionValuesToLog()

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

protected

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

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

Reimplemented from assQuestion.

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

     : string {
        if ($solution_values === []
            || !array_key_exists(0, $solution_values)
            || !is_array($solution_values[0])) {
            return $additional_info->getNoneTag();
        }
 
        return $this->getAnswer((int) $solution_values[0]['value1'])->getAnswertext();
    }

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

Here is the call graph for this function:

◆ solutionValuesToText()

assSingleChoice::solutionValuesToText ( array $solution_values )

MUST convert the given solution values into text.

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

Reimplemented from assQuestion.

Definition at line 925 of file class.assSingleChoice.php.

                                                                : string
    {
        if ($solution_values === []
            || !array_key_exists(0, $solution_values)
            || !is_array($solution_values[0])) {
            return '';
        }
 
        return $this->getAnswer((int) $solution_values[0]['value1'])->getAnswertext();
    }

◆ toJSON()

assSingleChoice::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

Definition at line 684 of file class.assSingleChoice.php.

                            : string
    {
        $result = [];
        $result['id'] = $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = $this->getTitleForHTMLOutput();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['nr_of_tries'] = $this->getNrOfTries();
        $result['shuffle'] = $this->getShuffle();
 
        $result['feedback'] = [
            'onenotcorrect' => $this->formatSAQuestion(
                $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)
            ),
            'allcorrect' => $this->formatSAQuestion(
                $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true)
            )
        ];
 
        $answers = [];
        $has_image = false;
        foreach ($this->getAnswers() as $key => $answer_obj) {
            if ((string) $answer_obj->getImage()) {
                $has_image = true;
            }
            array_push($answers, [
                "answertext" => $this->formatSAQuestion($answer_obj->getAnswertext()),
                'html_id' => $this->getId() . '_' . $key,
                "points" => (float) $answer_obj->getPoints(),
                "order" => (int) $answer_obj->getOrder(),
                "image" => (string) $answer_obj->getImage(),
                "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);
    }

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

Here is the call graph for this function:

◆ toLog()

assSingleChoice::toLog ( AdditionalInformationGenerator $additional_info )

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

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

Reimplemented from assQuestion.

Definition at line 883 of file class.assSingleChoice.php.

                                                                          : 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_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))
            ]
        ];
 
        foreach ($this->getAnswers() as $key => $answer_obj) {
            $result[AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTIONS][$key + 1] = [
                AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION => $this->formatSAQuestion($answer_obj->getAnswertext()),
                AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => (float) $answer_obj->getPoints(),
                AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_ORDER => (int) $answer_obj->getOrder(),
                AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_IMAGE => (string) $answer_obj->getImage(),
                AdditionalInformationGenerator::KEY_FEEDBACK => $this->formatSAQuestion(
                    $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                )
            ];
        }
 
        return $result;
    }

References ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ toNormalized()

assSingleChoice::toNormalized	(	Transformations	$transformations,
		array	$context = `[]`
	)

Parameters

array<string,mixed> $context

Returns: array<array-key, mixed>|float|bool|int|string|null

Reimplemented from assQuestion.

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

     : array|float|bool|int|string|null
    {
        $normalized = $transformations->normalize(parent::toNormalized($transformations, $context));
        $normalized['is_singleline'] = $this->is_singleline;
        $normalized['feedback_setting'] = $this->feedback_setting;
        $normalized['answers'] = $transformations->normalize($this->answers, ['question_id' => $this->getId()]);
        return $normalized;
    }

References ILIAS\Survey\Mode\getId(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\normalize().

Here is the call graph for this function:

Field Documentation

◆ $answers

array assSingleChoice::$answers = []

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

◆ $feedback_setting

int assSingleChoice::$feedback_setting = self::FEEDBACK_MODE_SELECTED_ANSWERS

protected

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

◆ $is_singleline

bool assSingleChoice::$is_singleline = true

private

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

◆ $output_type

int assSingleChoice::$output_type

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

Referenced by __construct().

◆ FEEDBACK_MODE_ALL_ANSWERS

const assSingleChoice::FEEDBACK_MODE_ALL_ANSWERS = 1

protected

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

◆ FEEDBACK_MODE_CORRECT_ANSWERS

const assSingleChoice::FEEDBACK_MODE_CORRECT_ANSWERS = 3

protected

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

◆ FEEDBACK_MODE_SELECTED_ANSWERS

const assSingleChoice::FEEDBACK_MODE_SELECTED_ANSWERS = 2

protected

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

Referenced by loadFromDb().

◆ OUTPUT_ORDER

const assSingleChoice::OUTPUT_ORDER = 0

protected

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

◆ OUTPUT_RANDOM

const assSingleChoice::OUTPUT_RANDOM = 1

protected

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ afterSyncWithOriginal()

◆ calculateReachedPoints()

◆ calculateReachedPointsFromPreviewSession()

◆ cloneQuestionTypeSpecificProperties()

◆ deleteAnswer()

◆ flushAnswers()

◆ fromNormalized()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getCorrectSolutionForTextOutput()

◆ getExpressionTypes()

◆ getFeedbackSetting()

◆ getMaximumPoints()

◆ getMultilineAnswerSetting()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ getUserQuestionResult()

◆ isComplete()

◆ isSingleline()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadFromDb()

◆ removeAnswerImage()

◆ saveAdditionalQuestionDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setFeedbackSetting()

◆ setImageFile()

◆ setIsSingleline()

◆ setMultilineAnswerSetting()

◆ setSpecificFeedbackSetting()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

◆ toNormalized()

Field Documentation

◆ $answers

◆ $feedback_setting

◆ $is_singleline

◆ $output_type

◆ FEEDBACK_MODE_ALL_ANSWERS

◆ FEEDBACK_MODE_CORRECT_ANSWERS

◆ FEEDBACK_MODE_SELECTED_ANSWERS

◆ OUTPUT_ORDER

◆ OUTPUT_RANDOM