ilAssConfigurableMultiOptionQuestionFeedback Class Reference

Inheritance diagram for ilAssConfigurableMultiOptionQuestionFeedback:

Collaboration diagram for ilAssConfigurableMultiOptionQuestionFeedback:

Public Member Functions
	completeSpecificFormProperties (ilPropertyFormGUI $form)
	completes a given form object with the specific form properties required by this question type More...
	initSpecificFormProperties (ilPropertyFormGUI $form)
	initialises a given form object's specific form properties relating to this question type More...
	saveSpecificFormProperties (ilPropertyFormGUI $form)
	saves a given form object's SPECIFIC form properties relating to this question type More...
	isSaveableInPageObjectEditingMode ()
	returns the fact that the feedback editing form is saveable in page object editing mode, because this question type has additional feedback settings More...
	saveSpecificFeedbackSetting (int $questionId, int $specificFeedbackSetting)
	saves the given specific feedback setting for the given question id to the db. More...
Public Member Functions inherited from ilAssMultiOptionQuestionFeedback
	getSpecificAnswerFeedbackTestPresentation (int $question_id, int $question_index, int $answer_index)
	returns the html of SPECIFIC feedback for the given question id and answer index for test presentation More...
	completeSpecificFormProperties (ilPropertyFormGUI $form)
	completes a given form object with the specific form properties required by this question type More...
	initSpecificFormProperties (ilPropertyFormGUI $form)
	initialises a given form object's specific form properties relating to this question type More...
	saveSpecificFormProperties (ilPropertyFormGUI $form)
	saves a given form object's SPECIFIC form properties relating to this question type More...
	getSpecificAnswerFeedbackContent (int $question_id, int $question_index, int $answer_index)
	getAllSpecificAnswerFeedbackContents (int $question_id)
	getAllSpecificAnswerPageEditorFeedbackContents (int $question_id)
	saveSpecificAnswerFeedbackContent (int $question_id, int $question_index, int $answer_index, string $feedback_content)
	deleteSpecificAnswerFeedbacks (int $question_id, bool $is_additional_content_editing_mode_page_object)
	getAnswerOptionsByAnswerIndex ()
	getSpecificAnswerFeedbackExportPresentation (int $question_id, int $question_index, int $answer_index)
	returns the generic feedback export presentation for given question id either for solution completed or incompleted More...
	importSpecificAnswerFeedback (int $question_id, int $question_index, int $answer_index, string $feedback_content)
	specificAnswerFeedbackExists ()
Public Member Functions inherited from ilAssQuestionFeedback
	__construct (assQuestion $questionOBJ, ilCtrl $ctrl, ilDBInterface $db, ilLanguage $lng)
	constructor More...
	getGenericFeedbackTestPresentation (int $question_id, bool $solution_completed)
	returns the html of GENERIC feedback for the given question id for test presentation (either for the complete solution or for the incomplete solution) More...
	getSpecificAnswerFeedbackTestPresentation (int $question_id, int $question_index, int $answer_index)
	returns the html of SPECIFIC feedback for the given question id and answer index for test presentation More...
	completeGenericFormProperties (ilPropertyFormGUI $form)
	completes a given form object with the GENERIC form properties required by all question types More...
	completeSpecificFormProperties (ilPropertyFormGUI $form)
	completes a given form object with the SPECIFIC form properties required by this question type More...
	initGenericFormProperties (ilPropertyFormGUI $form)
	initialises a given form object's GENERIC form properties relating to all question types More...
	initSpecificFormProperties (ilPropertyFormGUI $form)
	initialises a given form object's SPECIFIC form properties relating to this question type More...
	saveGenericFormProperties (ilPropertyFormGUI $form)
	saves a given form object's GENERIC form properties relating to all question types More...
	saveSpecificFormProperties (ilPropertyFormGUI $form)
	saves a given form object's SPECIFIC form properties relating to this question type More...
	isSaveableInPageObjectEditingMode ()
	returns the fact wether the feedback editing form is saveable in page object editing or not. More...
	getGenericFeedbackContent (int $question_id, bool $solution_completed)
	returns the GENERIC feedback content for a given question state. More...
	getSpecificAnswerFeedbackContent (int $question_id, int $question_index, int $answer_index)
	getAllSpecificAnswerFeedbackContents (int $question_id)
	isSpecificAnswerFeedbackAvailable (int $question_id)
	saveGenericFeedbackContent (int $question_id, bool $solution_completed, string $feedback_content)
	saves GENERIC feedback content for the given question id to the database. More...
	saveSpecificAnswerFeedbackContent (int $question_id, int $question_index, int $answer_index, string $feedback_content)
	deleteGenericFeedbacks (int $question_id, bool $isAdditionalContentEditingModePageObject)
	deletes all GENERIC feedback contents (and page objects if required) for the given question id More...
	deleteSpecificAnswerFeedbacks (int $question_id, bool $isAdditionalContentEditingModePageObject)
	duplicateFeedback (int $originalQuestionId, int $duplicateQuestionId)
	duplicates the feedback relating to the given original question id and saves it for the given duplicate question id More...
	cloneFeedback (int $originalQuestionId, int $duplicateQuestionId)
	syncs the feedback from a duplicated question back to the original question More...
	checkFeedbackParent (int $feedbackId)
	getClassNameByType (string $a_type, bool $a_gui=false)
	setPageObjectOutputMode (string $page_obj_output_mode)
	getPageObjectOutputMode ()
	getGenericFeedbackExportPresentation (int $question_id, bool $solution_completed)
	returns the generic feedback export presentation for given question id either for solution completed or incompleted More...
	getSpecificAnswerFeedbackExportPresentation (int $question_id, int $question_index, int $answer_index)
	returns the generic feedback export presentation for given question id either for solution completed or incompleted More...
	importGenericFeedback (int $question_id, bool $solution_completed, string $feedback_content)
	imports the given feedback content as generic feedback for the given question id for either the complete or incomplete solution More...
	importSpecificAnswerFeedback (int $question_id, int $question_index, int $answer_index, string $feedback_content)
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator, int $question_id)
	createFeedbackPages (string $mode)

Data Fields
const	FEEDBACK_SETTING_ALL = 1
const	FEEDBACK_SETTING_CHECKED = 2
const	FEEDBACK_SETTING_CORRECT = 3
Data Fields inherited from ilAssMultiOptionQuestionFeedback
const	TABLE_NAME_SPECIFIC_FEEDBACK = 'qpl_fb_specific'
	table name for specific feedback More...
Data Fields inherited from ilAssQuestionFeedback
const	CSS_CLASS_FEEDBACK_CORRECT = 'ilc_qfeedr_FeedbackRight'
const	CSS_CLASS_FEEDBACK_WRONG = 'ilc_qfeedw_FeedbackWrong'
const	PAGE_OBJECT_TYPE_GENERIC_FEEDBACK = 'qfbg'
	type for generic feedback page objects More...
const	PAGE_OBJECT_TYPE_SPECIFIC_FEEDBACK = 'qfbs'
	type for specific feedback page objects More...
const	FEEDBACK_SOLUTION_INCOMPLETE_PAGE_OBJECT_ID = 1
	id for page object relating to generic incomplete solution feedback More...
const	FEEDBACK_SOLUTION_COMPLETE_PAGE_OBJECT_ID = 2
	id for page object relating to generic complete solution feedback More...
const	TABLE_NAME_GENERIC_FEEDBACK = 'qpl_fb_generic'

Protected Member Functions
	getSpecificQuestionTableName ()
	cloneSpecificFeedback (int $source_question_id, int $target_question_id)
	duplicates the SPECIFIC feedback relating to the given original question id and saves it for the given duplicate question id More...
Protected Member Functions inherited from ilAssMultiOptionQuestionFeedback
	cloneSpecificFeedback (int $source_question_id, int $target_question_id)
	duplicates the SPECIFIC feedback relating to the given original question id and saves it for the given duplicate question id More...
	getSpecificAnswerFeedbackId (int $question_id, int $question_index, int $answer_index)
	getSpecificFeedbackContentForFeedbackIds (array $feedback_ids)
	isSpecificAnswerFeedbackId (int $feedback_id)
	getSpecificFeedbackTableName ()
	buildAnswerOptionLabel (int $index, $answer)
	getSpecificAnswerFeedbackPageObjectId (int $question_id, int $question_index, int $answer_index)
	returns a useable page object id for specific answer feedback page objects for the given question id and answer index (using the id sequence of non page object specific answer feedback) More...
Protected Member Functions inherited from ilAssQuestionFeedback
	buildFeedbackContentFormProperty (string $label, string $post_var, bool $as_non_editable)
	builds and returns a form property gui object with the given label and postvar that is addable to property forms depending on the given flag "asNonEditable" it returns a ... More...
	cloneSpecificFeedback (int $originalQuestionId, int $duplicateQuestionId)
	duplicates the SPECIFIC feedback relating to the given original question id and saves it for the given duplicate question id More...
	getGenericFeedbackId (int $question_id, bool $solution_completed)
	returns the SPECIFIC answer feedback ID for a given question id and answer index. More...
	isGenericFeedbackId (int $feedbackId)
	isSpecificAnswerFeedbackId (int $feedbackId)
	getGenericFeedbackTableName ()
	getPageObjectNonEditableValueHTML (string $page_object_type, int $page_object_id)
	returns html content to be used as value for non editable value form properties in feedback editing form More...
	getPageObjectXML (string $page_object_type, int $page_object_id)
	createPageObject (string $page_object_type, int $page_object_id, string $page_object_content)
	clonePageObject (string $page_object_type, int $source_page_object_id, int $target_page_object_id, int $target_page_object_parent_id)
	ensurePageObjectDeleted (string $page_object_type, int $page_object_id)
	getGenericFeedbackPageObjectType ()
	getSpecificAnswerFeedbackPageObjectType ()
	getGenericFeedbackPageObjectId (int $question_id, bool $solution_completed)
	returns a useable page object id for generic feedback page objects for the given question id for either the complete or incomplete solution (using the id sequence of non page object generic feedback) More...
	cleanupPageContent (string $content)

Private Member Functions
	cloneSpecificFeedbackSetting (int $source_question_id, int $target_question_id)

Additional Inherited Members
Static Public Member Functions inherited from ilAssQuestionFeedback
static	isValidFeedbackPageObjectType (string $feedbackPageObjectType)
	returns the fact whether the given page object type relates to generic or specific feedback page objects More...
Protected Attributes inherited from ilAssQuestionFeedback
assQuestion	$questionOBJ
ilCtrl	$ctrl
ilDBInterface	$db
ilLanguage	$lng
string	$page_obj_output_mode = "presentation"

Detailed Description

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

Member Function Documentation

cloneSpecificFeedback()

ilAssConfigurableMultiOptionQuestionFeedback::cloneSpecificFeedback ( int  $originalQuestionId, int  $duplicateQuestionId  )

protected

duplicates the SPECIFIC feedback relating to the given original question id and saves it for the given duplicate question id

Reimplemented from ilAssMultiOptionQuestionFeedback.

Definition at line 148 of file class.ilAssConfigurableMultiOptionQuestionFeedback.php.

                                                                                              : void
    {
        $this->cloneSpecificFeedbackSetting($source_question_id, $target_question_id);
        parent::cloneSpecificFeedback($source_question_id, $target_question_id);
    }

References cloneSpecificFeedbackSetting().

Here is the call graph for this function:

cloneSpecificFeedbackSetting()

ilAssConfigurableMultiOptionQuestionFeedback::cloneSpecificFeedbackSetting ( int  $source_question_id, int  $target_question_id  )

private

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

                                                                                                   : void
    {
        $res = $this->db->queryF(
            "SELECT feedback_setting FROM {$this->getSpecificQuestionTableName()} WHERE question_fi = %s",
            ['integer'],
            [$source_question_id]
        );
 
        $row = $this->db->fetchAssoc($res);
 
        if ($this->db->numRows($res) < 1) {
            return;
        }
 
        $this->db->update(
            $this->getSpecificQuestionTableName(),
            [ 'feedback_setting' => ['integer', $row['feedback_setting']] ],
            [ 'question_fi' => ['integer', $target_question_id] ]
        );
    }

References $res, and getSpecificQuestionTableName().

Referenced by cloneSpecificFeedback().

Here is the call graph for this function:

Here is the caller graph for this function:

completeSpecificFormProperties()

ilAssConfigurableMultiOptionQuestionFeedback::completeSpecificFormProperties

(

ilPropertyFormGUI

$form

)

completes a given form object with the specific form properties required by this question type

Reimplemented from ilAssMultiOptionQuestionFeedback.

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

                                                                           : void
    {
        if (!$this->questionOBJ->getSelfAssessmentEditingMode()) {
            $header = new ilFormSectionHeaderGUI();
            $header->setTitle($this->lng->txt('feedback_answers'));
            $form->addItem($header);
 
            $feedback = new ilRadioGroupInputGUI($this->lng->txt('feedback_setting'), 'feedback_setting');
            $feedback->addOption(
                new ilRadioOption($this->lng->txt('feedback_all'), self::FEEDBACK_SETTING_ALL)
            );
            $feedback->addOption(
                new ilRadioOption($this->lng->txt('feedback_checked'), self::FEEDBACK_SETTING_CHECKED)
            );
            $feedback->addOption(
                new ilRadioOption($this->lng->txt($this->questionOBJ->getSpecificFeedbackAllCorrectOptionLabel()), self::FEEDBACK_SETTING_CORRECT)
            );
 
            $feedback->setRequired(true);
            $form->addItem($feedback);
 
            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                $propertyLabel = ilLegacyFormElementsUtil::prepareTextareaOutput(
                    $this->buildAnswerOptionLabel($index, $answer),
                    true
                );
 
                $propertyPostVar = "feedback_answer_$index";
 
                $form->addItem($this->buildFeedbackContentFormProperty(
                    $propertyLabel,
                    $propertyPostVar,
                    $this->questionOBJ->isAdditionalContentEditingModePageObject()
                ));
            }
        }
    }

References ilPropertyFormGUI\addItem(), ilAssMultiOptionQuestionFeedback\buildAnswerOptionLabel(), ilAssQuestionFeedback\buildFeedbackContentFormProperty(), ilAssMultiOptionQuestionFeedback\getAnswerOptionsByAnswerIndex(), ILIAS\Repository\lng(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Here is the call graph for this function:

getSpecificQuestionTableName()

ilAssConfigurableMultiOptionQuestionFeedback::getSpecificQuestionTableName ( )

abstractprotected

Reimplemented in ilAssKprimChoiceFeedback, ilAssMultipleChoiceFeedback, and ilAssSingleChoiceFeedback.

Referenced by cloneSpecificFeedbackSetting(), and saveSpecificFeedbackSetting().

Here is the caller graph for this function:

initSpecificFormProperties()

ilAssConfigurableMultiOptionQuestionFeedback::initSpecificFormProperties

(

ilPropertyFormGUI

$form

)

initialises a given form object's specific form properties relating to this question type

Reimplemented from ilAssMultiOptionQuestionFeedback.

Definition at line 77 of file class.ilAssConfigurableMultiOptionQuestionFeedback.php.

                                                                       : void
    {
        if (!$this->questionOBJ->getSelfAssessmentEditingMode()) {
            $form->getItemByPostVar('feedback_setting')->setValue(
                $this->questionOBJ->getSpecificFeedbackSetting()
            );
 
            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
                    $value = $this->getPageObjectNonEditableValueHTML(
                        $this->getSpecificAnswerFeedbackPageObjectType(),
                        $this->getSpecificAnswerFeedbackPageObjectId($this->questionOBJ->getId(), 0, $index)
                    );
                } else {
                    $value = ilLegacyFormElementsUtil::prepareTextareaOutput(
                        $this->getSpecificAnswerFeedbackContent($this->questionOBJ->getId(), 0, $index)
                    );
                }
 
                $form->getItemByPostVar("feedback_answer_$index")->setValue($value);
            }
        }
    }

References ilAssMultiOptionQuestionFeedback\getAnswerOptionsByAnswerIndex(), ilPropertyFormGUI\getItemByPostVar(), ilAssQuestionFeedback\getPageObjectNonEditableValueHTML(), ilAssMultiOptionQuestionFeedback\getSpecificAnswerFeedbackContent(), ilAssMultiOptionQuestionFeedback\getSpecificAnswerFeedbackPageObjectId(), ilAssQuestionFeedback\getSpecificAnswerFeedbackPageObjectType(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Here is the call graph for this function:

isSaveableInPageObjectEditingMode()

ilAssConfigurableMultiOptionQuestionFeedback::isSaveableInPageObjectEditingMode

(

)

returns the fact that the feedback editing form is saveable in page object editing mode, because this question type has additional feedback settings

Reimplemented from ilAssQuestionFeedback.

Definition at line 130 of file class.ilAssConfigurableMultiOptionQuestionFeedback.php.

                                                       : bool
    {
        return true;
    }

saveSpecificFeedbackSetting()

ilAssConfigurableMultiOptionQuestionFeedback::saveSpecificFeedbackSetting	(	int	$questionId,
		int	$specificFeedbackSetting
	)

saves the given specific feedback setting for the given question id to the db.

(It::s stored to dataset of question itself)

Definition at line 139 of file class.ilAssConfigurableMultiOptionQuestionFeedback.php.

                                                                                              : void
    {
        $this->db->update(
            $this->getSpecificQuestionTableName(),
            ['feedback_setting' => ['integer', $specificFeedbackSetting]],
            ['question_fi' => ['integer', $questionId]]
        );
    }

References getSpecificQuestionTableName().

Referenced by saveSpecificFormProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

saveSpecificFormProperties()

ilAssConfigurableMultiOptionQuestionFeedback::saveSpecificFormProperties

(

ilPropertyFormGUI

$form

)

saves a given form object's SPECIFIC form properties relating to this question type

Reimplemented from ilAssMultiOptionQuestionFeedback.

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

                                                                       : void
    {
        $feedback_setting = $form->getInput('feedback_setting');
 
        /* sk 03.03.2023: This avoids Problems with questions in Learning Module
         * See: https://mantis.ilias.de/view.php?id=34724
         */
        if ($feedback_setting === '') {
            return;
        }
 
        $this->saveSpecificFeedbackSetting($this->questionOBJ->getId(), (int) $feedback_setting);
 
        if (!$this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            foreach ($this->getAnswerOptionsByAnswerIndex() as $index => $answer) {
                $this->saveSpecificAnswerFeedbackContent(
                    $this->questionOBJ->getId(),
                    0,
                    $index,
                    (string) ($form->getInput("feedback_answer_$index") ?? '')
                );
            }
        }
    }

References ilAssMultiOptionQuestionFeedback\getAnswerOptionsByAnswerIndex(), ilPropertyFormGUI\getInput(), ilAssMultiOptionQuestionFeedback\saveSpecificAnswerFeedbackContent(), and saveSpecificFeedbackSetting().

Here is the call graph for this function:

Field Documentation

FEEDBACK_SETTING_ALL

const ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_ALL = 1

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

Referenced by assKprimChoiceGUI\populateSpecificFeedbackInline().

FEEDBACK_SETTING_CHECKED

const ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_CHECKED = 2

Definition at line 34 of file class.ilAssConfigurableMultiOptionQuestionFeedback.php.

Referenced by assKprimChoiceGUI\populateSpecificFeedbackInline().

FEEDBACK_SETTING_CORRECT

const ilAssConfigurableMultiOptionQuestionFeedback::FEEDBACK_SETTING_CORRECT = 3

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

Referenced by assKprimChoiceGUI\populateSpecificFeedbackInline().

---

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

• components/ILIAS/TestQuestionPool/classes/feedback/class.ilAssConfigurableMultiOptionQuestionFeedback.php