Class for single choice questions. More...

Inheritance diagram for assSingleChoice:

Collaboration diagram for assSingleChoice:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="", $output_type=OUTPUT_ORDER)
	assSingleChoice constructor More...

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

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

	duplicate (bool $for_test=true, string $title="", string $author="", int $owner=-1, $testObjId=null)
	Duplicates an assSingleChoiceQuestion. More...

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

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	addAnswer ( $answertext="", $points=0.0, $order=0, $answerimage=null, $answer_id=-1)
	Adds a possible answer for a single choice question. More...

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

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

	deleteAnswer ($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 ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	saveWorkingData ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. 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 ($image_filename, $image_tempfilename="")
	Sets the image file and uploads the image to the object's image directory. More...

	deleteImage ($image_filename)
	Deletes an image file. More...

	duplicateImages ($question_id, $objectId=null)

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

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

	setAnswers (array $answers)

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

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

	removeAnswerImage ($index)

	getMultilineAnswerSetting ()

	setMultilineAnswerSetting ($a_setting=0)

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

	getSpecificFeedbackSetting ()
	Gets the current feedback settings in effect for the question. More...

	getSpecificFeedbackAllCorrectOptionLabel ()

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

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

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

	isSingleline ()

	setIsSingleline (bool $isSingleline)

	getFeedbackSetting ()

	setFeedbackSetting (int $feedback_setting)

Public Member Functions inherited from assQuestion
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...

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

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorizedSolution=true)
	returns the reached points ... More...

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

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

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

	validateSolutionSubmit ()

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

	getSuggestedSolutionPath ()

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

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)

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

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

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

	saveQuestionDataToDb (int $original_id=-1)

	saveToDb ()

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

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

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

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

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

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

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

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

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

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

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

	setStep ($step)

	getStep ()

	toJSON ()

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

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

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

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

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

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

Public Member Functions inherited from ilObjQuestionScoringAdjustable
	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
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

Public Member Functions inherited from assQuestionInterface
	validateSolutionSubmit ()

Static Public Member Functions
static	isObligationPossible (int $questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...

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

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

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

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

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

static	instantiateQuestion (int $question_id)

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

static	_isWriteable (int $question_id, int $user_id)

static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled, ?int $test_id=null)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	_needsManualScoring (int $question_id)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	isObligationPossible (int $questionId)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

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

Data Fields
	$answers

	$output_type

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

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

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
	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	syncImages ()
	Sync images of a MC question on synchronisation with the original question. More...

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

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

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	log (int $active_id, string $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion (int $question_id)

	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)

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

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

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

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

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	syncSuggestedSolutions (int $target_question_id, int $target_obj_id)

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

	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)

	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints ($points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)

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

	buildQuestionDataQuery ()

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

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

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

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

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

	lookupMaxStep (int $active_id, int $pass)

	buildTestPresentationConfig ()
	build basic test question configuration instance More...

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

Protected Attributes
	$feedback_setting

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS TestQuestionPool QuestionInfoService	$questioninfo

ILIAS Test TestParticipantInfoService	$testParticipantInfo

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS TestQuestionPool QuestionFilesService	$questionFilesService

ILIAS DI LoggingServices	$ilLog

int	$id

string	$title

string	$comment

string	$owner

string	$author

int	$thumb_size

string	$question
	The question text. More...

float	$points
	The maximum available points for the question. More...

bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...

int	$test_id
	The database id of a test in which the question is contained. More...

int	$obj_id = 0
	Object id of the container object. More...

	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

Container	$dic

array	$suggested_solutions

int	$original_id = null

	$page

string	$external_id = null

ilAssQuestionProcessLocker	$processLocker

	$step

	$lastChange

Transformation	$shuffler

ilTestQuestionConfig	$testQuestionConfig

ilAssQuestionLifecycle	$lifecycle

ilObjUser	$current_user

SkillUsageService	$skillUsageService

assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Private Attributes
bool	$isSingleline = true

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

Static Protected Attributes inherited from assQuestion
static	$forcePassResultsUpdateEnabled = 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 36 of file class.assSingleChoice.php.

Constructor & Destructor Documentation

◆ __construct()

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

assSingleChoice constructor

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

Parameters

string	$title	A title string to describe the question
string	$comment	A comment string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator
string	$question	The question string of the single choice question
int \| string	$output_type	The output order of the single choice answers

See also: assQuestion:assQuestion()

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

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

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->output_type = $output_type;
         $this->answers = [];
         $this->shuffle = 1;
         $this->feedback_setting = 2;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

assSingleChoice::addAnswer	(	$answertext = `""`,
		$points = `0.0`,
		$order = `0`,
		$answerimage = `null`,
		$answer_id = `-1`
	)

Adds a possible answer for a single choice question.

A ASS_AnswerBinaryStateImage object will be created and assigned to the array $this->answers.

Parameters

string	$answertext	The answer text
double	$points	The points for selecting the answer (even negative points can be used)
boolean	$state	Defines the answer as correct (TRUE) or incorrect (FALSE)
integer	$order	A possible display order of the answer
double	$points	The points for not selecting the answer (even negative points can be used) public

See also: $answers; ASS_AnswerBinaryStateImage

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

References assQuestion\$points, and assQuestion\getHtmlQuestionContentPurifier().

      : void {
         $answertext = $this->getHtmlQuestionContentPurifier()->purify($answertext);
         if (array_key_exists($order, $this->answers)) {
             // insert answer
             $answer = new ASS_AnswerBinaryStateImage($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;
         } else {
             $answer = new ASS_AnswerBinaryStateImage(
                 $answertext,
                 $points,
                 count($this->answers),
                 true,
                 $answerimage,
                 $answer_id
             );
             $this->answers[] = $answer;
         }
     }

Here is the call graph for this function:

◆ afterSyncWithOriginal()

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

protected

{}

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

References ilFileUtils\delDir(), ilFileUtils\makeDirParents(), and ilFileUtils\rCopy().

                                                                                                                 : void
     {
         parent::afterSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId);
 
         $origImagePath = $this->questionFilesService->buildImagePath($origQuestionId, $origParentObjId);
         $dupImagePath = $this->questionFilesService->buildImagePath($dupQuestionId, $dupParentObjId);
 
         ilFileUtils::delDir($origImagePath);
         if (is_dir($dupImagePath)) {
             ilFileUtils::makeDirParents($origImagePath);
             ilFileUtils::rCopy($dupImagePath, $origImagePath);
         }
     }

Here is the call graph for this function:

◆ calculateReachedPoints()

assSingleChoice::calculateReachedPoints	(	$active_id,
		$pass = `null`,
		$authorizedSolution = `true`,
		$returndetails = `false`
	)

Returns the points, a learner has reached answering the question.

The points are calculated from the given answers.

public

Parameters

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

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

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

References $data, $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, assQuestion\$points, assQuestion\getCurrentSolutionResultSet(), and assQuestion\getSolutionMaxPass().

Referenced by getExpressionTypes().

                                                                                                                         : float
     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
 
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $found_values = [];
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
         while ($data = $ilDB->fetchAssoc($result)) {
             if (strcmp($data["value1"], "") != 0) {
                 array_push($found_values, $data["value1"]);
             }
         }
         $points = 0;
         foreach ($this->answers as $key => $answer) {
             if (count($found_values) > 0) {
                 if (in_array($key, $found_values)) {
                     $points += $answer->getPoints();
                 }
             }
         }
 
         return (float) $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assSingleChoice::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

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

References ILIAS\LTI\ToolProvider\$key, assQuestion\$points, assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), and ilAssQuestionPreviewSession\getParticipantsSolution().

     {
         $participantSolution = $previewSession->getParticipantsSolution();
 
         $points = 0;
 
         foreach ($this->answers as $key => $answer) {
             if (is_numeric($participantSolution) && $key == $participantSolution) {
                 $points = $answer->getPoints();
             }
         }
 
         $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $points);
 
         return $this->ensureNonNegativePoints($reachedPoints);
     }

Here is the call graph for this function:

◆ copyObject()

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

Copies an assSingleChoice object.

public

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

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

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

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

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

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

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

Here is the call graph for this function:

◆ deleteAnswer()

assSingleChoice::deleteAnswer ( $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 public

See also: $answers

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

References deleteImage(), and ILIAS\UI\Implementation\Component\Table\getOrder().

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

Here is the call graph for this function:

◆ deleteImage()

assSingleChoice::deleteImage ( $image_filename )

Deletes an image file.

Parameters

string $image_filename Name of the image file to delete private

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

References assQuestion\getImagePath().

Referenced by deleteAnswer(), and removeAnswerImage().

                                                 : void
     {
         $imagepath = $this->getImagePath();
         @unlink($imagepath . $image_filename);
         $thumbpath = $imagepath . $this->getThumbPrefix() . $image_filename;
         @unlink($thumbpath);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicate()

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

Duplicates an assSingleChoiceQuestion.

public

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

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

                                                                                                                                  : int
     {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return -1;
         }
         // duplicate the question in database
         $this_id = $this->getId();
         $thisObjId = $this->getObjId();
 
         $clone = $this;
         $original_id = $this->questioninfo->getOriginalId($this->id);
         $clone->id = -1;
 
         if ((int) $testObjId > 0) {
             $clone->setObjId($testObjId);
         }
 
         if ($title) {
             $clone->setTitle($title);
         }
 
         if ($author) {
             $clone->setAuthor($author);
         }
         if ($owner) {
             $clone->setOwner($owner);
         }
         if ($for_test) {
             $clone->saveToDb($original_id);
         } else {
             $clone->saveToDb();
         }
 
         // copy question page content
         $clone->copyPageOfQuestion($this_id);
 
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
         // duplicate the images
         $clone->duplicateImages($this_id, $thisObjId);
 
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ duplicateImages()

assSingleChoice::duplicateImages	(	$question_id,
		$objectId = `null`
	)

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

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

                                                                    : void
     {
         global $DIC;
         $ilLog = $DIC['ilLog'];
         $imagepath = $this->getImagePath();
         $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
 
         if ((int) $objectId > 0) {
             $imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
         }
 
         foreach ($this->answers as $answer) {
             if ($answer->hasImage()) {
                 $filename = $answer->getImage();
                 if (!file_exists($imagepath)) {
                     ilFileUtils::makeDirParents($imagepath);
                 }
                 if (!@copy($imagepath_original . $filename, $imagepath . $filename)) {
                     $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
                     $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                 }
                 if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename)) {
                     if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                         $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
                         $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ flushAnswers()

assSingleChoice::flushAnswers ( )

Deletes all answers.

public

See also: $answers

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

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

◆ getAdditionalTableName()

assSingleChoice::getAdditionalTableName ( )

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

Returns: string The additional table name public

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

Referenced by isComplete(), loadFromDb(), and savePreviewData().

                                             : string
     {
         return "qpl_qst_sc";
     }

Here is the caller graph for this function:

◆ getAnswer()

assSingleChoice::getAnswer ( $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 public

See also: $answers

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

Referenced by getAvailableAnswerOptions().

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

Here is the caller graph for this function:

◆ getAnswerCount()

assSingleChoice::getAnswerCount ( )

Returns the number of answers.

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

See also: $answers

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

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

◆ getAnswers()

& assSingleChoice::getAnswers ( )

Returns a reference to the answers array.

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

References $answers.

Referenced by getAvailableAnswerOptions(), lmMigrateQuestionTypeSpecificContent(), setExportDetailsXLSX(), and toJSON().

                                  : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assSingleChoice::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name public

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

Implements iQuestionCondition.

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

References getAnswer(), and getAnswers().

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

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 1210 of file class.assSingleChoice.php.

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

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

Here is the call graph for this function:

◆ getFeedbackSetting()

assSingleChoice::getFeedbackSetting ( )

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

References $feedback_setting.

                                         : int
     {
         return $this->feedback_setting;
     }

◆ getMaximumPoints()

assSingleChoice::getMaximumPoints ( )

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

public

See also: $points

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

References ILIAS\LTI\ToolProvider\$key, and assQuestion\$points.

Referenced by getExpressionTypes(), and isComplete().

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

Here is the caller graph for this function:

◆ getMultilineAnswerSetting()

assSingleChoice::getMultilineAnswerSetting ( )

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

References $DIC.

     {
         global $DIC;
         $ilUser = $DIC['ilUser'];
 
         $multilineAnswerSetting = $ilUser->getPref("tst_multiline_answers");
         if ($multilineAnswerSetting != 1) {
             $multilineAnswerSetting = 0;
         }
         return $multilineAnswerSetting;
     }

◆ getOperators()

assSingleChoice::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

string $expression

Implements iQuestionCondition.

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

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 public

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

Referenced by toJSON().

                                      : string
     {
         return "assSingleChoice";
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assSingleChoice::getRTETextWithMediaObjects ( )

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

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

References assQuestion\getId().

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

Here is the call graph for this function:

◆ getSpecificFeedbackAllCorrectOptionLabel()

assSingleChoice::getSpecificFeedbackAllCorrectOptionLabel ( )

Implements ilAssSpecificFeedbackOptionLabelProvider.

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

                                                               : string
     {
         return 'feedback_correct_sc_mc';
     }

◆ getSpecificFeedbackSetting()

assSingleChoice::getSpecificFeedbackSetting ( )

Gets the current feedback settings in effect for the question.

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

Returns: integer

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

References $feedback_setting.

                                                 : int
     {
         if ($this->feedback_setting) {
             return $this->feedback_setting;
         } else {
             return 1;
         }
     }

◆ isComplete()

assSingleChoice::isComplete ( )

Returns true, if a single choice question is complete for use.

Returns: boolean True, if the single choice question is complete for use, otherwise false public

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

References $data, $DIC, $ilDB, assQuestion\$original_id, getAdditionalTableName(), assQuestion\getId(), getMaximumPoints(), assQuestion\getThumbSize(), isSingleline(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb(), assQuestion\saveQuestionDataToDb(), and assQuestion\saveToDb().

                                 : 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->hasImage()) {
                     return false;
                 }
             }
             return true;
         } else {
             return false;
         }
     }

Here is the call graph for this function:

◆ isObligationPossible()

static assSingleChoice::isObligationPossible ( int $questionId )

static

returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration

(overwrites method in class assQuestion)

Parameters

integer $questionId

Returns: boolean $obligationPossible

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

                                                                 : bool
     {
         return true;
     }

◆ isSingleline()

assSingleChoice::isSingleline ( )

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

References $isSingleline.

Referenced by isComplete(), loadFromDb(), savePreviewData(), setImageFile(), and setIsSingleline().

                                   : bool
     {
         return $this->isSingleline;
     }

Here is the caller graph for this function:

◆ lmMigrateQuestionTypeSpecificContent()

assSingleChoice::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

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

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

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

Here is the call graph for this function:

◆ loadFromDb()

assSingleChoice::loadFromDb ( $question_id )

Loads a assSingleChoice object from a database.

Parameters

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

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

References $data, $DIC, Vendor\Package\$e, $ilDB, assQuestion\$shuffle, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getImagePath(), ilAssQuestionLifecycle\getInstance(), assQuestion\getMinimumThumbSize(), isSingleline(), 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().

                                             : void
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $result = $ilDB->queryF(
             "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
             ["integer"],
             [$question_id]
         );
         if ($result->numRows() == 1) {
             $data = $ilDB->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->isSingleline = $data['allow_images'] === null || $data['allow_images'] === '0';
             $this->lastChange = $data['tstamp'];
             $this->feedback_setting = $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) {
             }
         }
 
         $result = $ilDB->queryF(
             "SELECT * FROM qpl_a_sc WHERE question_fi = %s ORDER BY aorder ASC",
             ['integer'],
             [$question_id]
         );
 
         if ($result->numRows() > 0) {
             while ($data = $ilDB->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);
     }

Here is the call graph for this function:

◆ removeAnswerImage()

assSingleChoice::removeAnswerImage ( $index )

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

References deleteImage().

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

Here is the call graph for this function:

◆ savePreviewData()

assSingleChoice::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, ilRTE\_replaceMediaObjectImageSrc(), ilFileUtils\delDir(), assQuestion\getAdditionalContentEditingMode(), getAdditionalTableName(), assQuestion\getId(), assQuestion\getImagePath(), assQuestion\getShuffle(), assQuestion\getThumbSize(), ILIAS\FileDelivery\http(), isSingleline(), ILIAS\Repository\refinery(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb(), and ilAssQuestionPreviewSession\setParticipantsSolution().

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

Here is the call graph for this function:

◆ saveWorkingData()

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

Saves the learners input of the question to the database.

public

Parameters

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

Returns: boolean $status

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

References $DIC, $ilDB, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getCurrentSolutionResultSet(), assQuestion\getId(), assQuestion\getProcessLocker(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), assQuestion\logAction(), ILIAS\Repository\refinery(), assQuestion\removeSolutionRecordById(), assQuestion\saveCurrentSolution(), and assQuestion\updateCurrentSolution().

                                                                                  : bool
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilUser = $DIC['ilUser'];
 
         if (is_null($pass)) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $entered_values = 0;
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $ilDB, $active_id, $pass, $authorized) {
             $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized);
 
             $update = -1;
             if ($ilDB->numRows($result)) {
                 $row = $ilDB->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) {
                 if ($multiple_choice_result !== '') {
                     $this->updateCurrentSolution($update, $multiple_choice_result, null, $authorized);
                     $entered_values++;
                 } else {
                     $this->removeSolutionRecordById($update);
                 }
             } else {
                 if ($multiple_choice_result !== '') {
                     $this->saveCurrentSolution($active_id, $pass, $multiple_choice_result, null, $authorized);
                     $entered_values++;
                 }
             }
         });
 
         if ($entered_values) {
             if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                 assQuestion::logAction($this->lng->txtlng(
                     "assessment",
                     "log_user_entered_values",
                     ilObjAssessmentFolder::_getLogLanguage()
                 ), $active_id, $this->getId());
             }
         } else {
             if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                 assQuestion::logAction($this->lng->txtlng(
                     "assessment",
                     "log_user_not_entered_values",
                     ilObjAssessmentFolder::_getLogLanguage()
                 ), $active_id, $this->getId());
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ setAnswers()

assSingleChoice::setAnswers ( array $answers )

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

References $answers.

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

◆ setExportDetailsXLSX()

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

{}

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

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

                                                                                                                                : int
     {
         parent::setExportDetailsXLSX($worksheet, $startrow, $col, $active_id, $pass);
 
         $solution = $this->getSolutionValues($active_id, $pass);
         $i = 1;
         foreach ($this->getAnswers() as $id => $answer) {
             $worksheet->setCell($startrow + $i, $col, $answer->getAnswertext());
             $worksheet->setBold($worksheet->getColumnCoord($col) . ($startrow + $i));
             if (
                 count($solution) > 0 &&
                 isset($solution[0]) &&
                 is_array($solution[0]) &&
                 strlen($solution[0]['value1']) > 0 && $id == $solution[0]['value1']
             ) {
                 $worksheet->setCell($startrow + $i, $col + 2, 1);
             } else {
                 $worksheet->setCell($startrow + $i, $col + 2, 0);
             }
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setFeedbackSetting()

assSingleChoice::setFeedbackSetting ( int $feedback_setting )

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

References $feedback_setting.

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

◆ setImageFile()

assSingleChoice::setImageFile	(	$image_filename,
		$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 public

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

References assQuestion\getImagePath(), ilObjMediaObject\getMimeType(), assQuestion\getThumbSize(), isSingleline(), ilFileUtils\makeDirParents(), and ilFileUtils\moveUploadedFile().

                                                                            : 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->isSingleline && $this->getThumbSize()) {
             $this->generateThumbForFile(
                 $cleaned_image_filename,
                 $this->getImagePath(),
                 $this->getThumbSize()
             );
         }
 
         return 0;
     }

Here is the call graph for this function:

◆ setIsSingleline()

assSingleChoice::setIsSingleline ( bool $isSingleline )

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

References $isSingleline, and isSingleline().

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

Here is the call graph for this function:

◆ setMultilineAnswerSetting()

assSingleChoice::setMultilineAnswerSetting ( $a_setting = 0 )

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

References $DIC.

                                                              : void
     {
         global $DIC;
         $ilUser = $DIC['ilUser'];
         $ilUser->writePref("tst_multiline_answers", (string) $a_setting);
     }

◆ setSpecificFeedbackSetting()

assSingleChoice::setSpecificFeedbackSetting ( $a_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.

Parameters

integer $a_feedback_setting

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

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

◆ syncImages()

assSingleChoice::syncImages ( )

protected

Sync images of a MC question on synchronisation with the original question.

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

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

                                    : void
     {
         global $DIC;
         $ilLog = $DIC['ilLog'];
         $question_id = $this->questioninfo->getOriginalId();
         $imagepath = $this->getImagePath();
         $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
         ilFileUtils::delDir($imagepath_original);
         foreach ($this->answers as $answer) {
             if ($answer->hasImage()) {
                 $filename = $answer->getImage();
                 if (@file_exists($imagepath . $filename)) {
                     if (!file_exists($imagepath)) {
                         ilFileUtils::makeDirParents($imagepath);
                     }
                     if (!file_exists($imagepath_original)) {
                         ilFileUtils::makeDirParents($imagepath_original);
                     }
                     if (!@copy($imagepath . $filename, $imagepath_original . $filename)) {
                         $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
                         $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                     }
                 }
                 if (@file_exists($imagepath . $this->getThumbPrefix() . $filename)) {
                     if (!@copy($imagepath . $this->getThumbPrefix() . $filename, $imagepath_original . $this->getThumbPrefix() . $filename)) {
                         $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
                         $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ toJSON()

assSingleChoice::toJSON ( )

Returns a JSON representation of the question.

Implements ilAssQuestionLMExportable.

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

References $answers, ILIAS\LTI\ToolProvider\$key, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getId(), assQuestion\getImagePathWeb(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), assQuestion\getThumbSize(), assQuestion\getTitleForHTMLOutput(), and ILIAS\Repository\int().

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

Here is the call graph for this function:

Field Documentation

◆ $answers

assSingleChoice::$answers

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

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

◆ $feedback_setting

assSingleChoice::$feedback_setting

protected

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

Referenced by getFeedbackSetting(), getSpecificFeedbackSetting(), and setFeedbackSetting().

◆ $isSingleline

bool assSingleChoice::$isSingleline = true

private

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

Referenced by isSingleline(), and setIsSingleline().

◆ $output_type

assSingleChoice::$output_type

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

Referenced by __construct().

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

Modules/TestQuestionPool/classes/class.assSingleChoice.php

Public Member Functions

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

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswer()

◆ deleteImage()

◆ duplicate()

◆ duplicateImages()

◆ flushAnswers()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getExpressionTypes()

◆ getFeedbackSetting()

◆ getMaximumPoints()

◆ getMultilineAnswerSetting()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ isComplete()

◆ isObligationPossible()

◆ isSingleline()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadFromDb()

◆ removeAnswerImage()

◆ savePreviewData()

◆ saveWorkingData()

◆ setAnswers()

◆ setExportDetailsXLSX()

◆ setFeedbackSetting()

◆ setImageFile()

◆ setIsSingleline()

◆ setMultilineAnswerSetting()

◆ setSpecificFeedbackSetting()

◆ syncImages()

◆ toJSON()

Field Documentation

◆ $answers

◆ $feedback_setting

◆ $isSingleline

◆ $output_type