assQuestionExport Class Reference

Class for question exports. More...

Inheritance diagram for assQuestionExport:

Collaboration diagram for assQuestionExport:

Public Member Functions
	__construct ($a_object)
	assQuestionExport constructor More...
	exportFeedbackOnly ($a_xml_writer)
	toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
	Returns a QTI xml representation of the question Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation. More...
	addQTIMaterial (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true)

Data Fields
	$object
const	ITEM_SOLUTIONHINT = 'solutionhint'

Protected Member Functions
	addAnswerSpecificFeedback (ilXmlWriter $a_xml_writer, $answers)
	addGenericFeedback (ilXmlWriter $a_xml_writer)
	addQtiMetaDataField (ilXmlWriter $a_xml_writer, $fieldLabel, $fieldValue)
	adds a qti meta data field with given name and value to the passed xml writer (xml writer must be in context of opened "qtimetadata" tag) More...
	addAdditionalContentEditingModeInformation (ilXmlWriter $a_xml_writer)
	adds a qti meta data field for ilias specific information of "additional content editing mode" (xml writer must be in context of opened "qtimetadata" tag) More...
	addGeneralMetadata (ilXmlWriter $xmlwriter)
	addSolutionHints (ilXmlWriter $writer)
	addSuggestedSolution (ilXmlWriter $writer)

Detailed Description

Class for question exports.

exportQuestion is a basis class question exports

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

Version

$Id$ \

Definition at line 29 of file class.assQuestionExport.php.

Constructor & Destructor Documentation

__construct()

assQuestionExport::__construct

(

$a_object

)

assQuestionExport constructor

Parameters

object

$a_object

The question object public

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

    {
        $this->object = $a_object;
    }

Member Function Documentation

addAdditionalContentEditingModeInformation()

assQuestionExport::addAdditionalContentEditingModeInformation ( ilXmlWriter  $a_xml_writer )

finalprotected

adds a qti meta data field for ilias specific information of "additional content editing mode" (xml writer must be in context of opened "qtimetadata" tag)

protected

Parameters

ilXmlWriter

$a_xml_writer

Definition at line 205 of file class.assQuestionExport.php.

References addQtiMetaDataField(), and ILIAS\Repository\object().

Referenced by assLongMenuExport\toXML(), assKprimChoiceExport\toXML(), assFileUploadExport\toXML(), assErrorTextExport\toXML(), assFormulaQuestionExport\toXML(), assOrderingHorizontalExport\toXML(), assTextSubsetExport\toXML(), assNumericExport\toXML(), assSingleChoiceExport\toXML(), assMultipleChoiceExport\toXML(), assImagemapQuestionExport\toXML(), assMatchingQuestionExport\toXML(), assTextQuestionExport\toXML(), assOrderingQuestionExport\toXML(), and assClozeTestExport\toXML().

                                                                                                  : void
    {
        $this->addQtiMetaDataField(
            $a_xml_writer,
            'additional_cont_edit_mode',
            $this->object->getAdditionalContentEditingMode()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addAnswerSpecificFeedback()

assQuestionExport::addAnswerSpecificFeedback ( ilXmlWriter  $a_xml_writer,   $answers  )

protected

Parameters

ilXmlWriter

$a_xml_writer

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

References addQTIMaterial(), ILIAS\Repository\object(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by assErrorTextExport\toXML(), and assTextQuestionExport\toXML().

                                                                                     : void
    {
        foreach ($answers as $index => $answer) {
            $linkrefid = "response_$index";
            $attrs = [
                "ident" => $linkrefid,
                "view" => "All"
            ];
            $a_xml_writer->xmlStartTag("itemfeedback", $attrs);
            // qti flow_mat
            $a_xml_writer->xmlStartTag("flow_mat");
            $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation(
                $this->object->getId(),
                0,
                $index
            );
            $this->addQTIMaterial($a_xml_writer, $fb);
            $a_xml_writer->xmlEndTag("flow_mat");
            $a_xml_writer->xmlEndTag("itemfeedback");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addGeneralMetadata()

assQuestionExport::addGeneralMetadata ( ilXmlWriter  $xmlwriter )

protected

Parameters

ilXmlWriter

$xmlwriter

Definition at line 217 of file class.assQuestionExport.php.

References addQtiMetaDataField(), and ILIAS\Repository\object().

Referenced by assLongMenuExport\toXML(), assKprimChoiceExport\toXML(), assFileUploadExport\toXML(), assErrorTextExport\toXML(), assFormulaQuestionExport\toXML(), assOrderingHorizontalExport\toXML(), assTextSubsetExport\toXML(), assNumericExport\toXML(), assSingleChoiceExport\toXML(), assMultipleChoiceExport\toXML(), assImagemapQuestionExport\toXML(), assMatchingQuestionExport\toXML(), assTextQuestionExport\toXML(), assOrderingQuestionExport\toXML(), and assClozeTestExport\toXML().

                                                                 : void
    {
        $this->addQtiMetaDataField($xmlwriter, 'externalId', $this->object->getExternalId());

        $this->addQtiMetaDataField(
            $xmlwriter,
            'ilias_lifecycle',
            $this->object->getLifecycle()->getIdentifier()
        );

        $this->addQtiMetaDataField(
            $xmlwriter,
            'lifecycle',
            $this->object->getLifecycle()->getMappedLomLifecycle()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addGenericFeedback()

assQuestionExport::addGenericFeedback ( ilXmlWriter  $a_xml_writer )

protected

Parameters

ilXmlWriter

$a_xml_writer

Definition at line 75 of file class.assQuestionExport.php.

References exportFeedbackOnly().

Referenced by assErrorTextExport\toXML(), assOrderingHorizontalExport\toXML(), and assFormulaQuestionExport\toXML().

                                                                    : void
    {
        $this->exportFeedbackOnly($a_xml_writer);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addQTIMaterial()

assQuestionExport::addQTIMaterial	(	ilXmlWriter	$a_xml_writer,
		string	$a_material,
		bool	$close_material_tag = true,
		bool	$add_mobs = true
	)

Definition at line 297 of file class.assQuestionExport.php.

References ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), IL_INST_ID, ilUtil\isHTML(), null, ILIAS\Repository\object(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by addAnswerSpecificFeedback(), assClozeTestExport\exportAnswerSpecificFeedbacks(), exportFeedbackOnly(), assLongMenuExport\toXML(), assKprimChoiceExport\toXML(), assFileUploadExport\toXML(), assErrorTextExport\toXML(), assTextSubsetExport\toXML(), assFormulaQuestionExport\toXML(), assOrderingHorizontalExport\toXML(), assSingleChoiceExport\toXML(), assNumericExport\toXML(), assMultipleChoiceExport\toXML(), assImagemapQuestionExport\toXML(), assMatchingQuestionExport\toXML(), assOrderingQuestionExport\toXML(), assTextQuestionExport\toXML(), and assClozeTestExport\toXML().

                                                                                                                                         : void
    {
        $a_xml_writer->xmlStartTag("material");
        $attrs = [
            "texttype" => "text/plain"
        ];
        if (ilUtil::isHTML($a_material)) {
            $attrs["texttype"] = "text/xhtml";
        }
        $a_xml_writer->xmlElement("mattext", $attrs, ilRTE::_replaceMediaObjectImageSrc($a_material, 0));
        if ($add_mobs) {
            $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->object->getId());
            foreach ($mobs as $mob) {
                $moblabel = "il_" . IL_INST_ID . "_mob_" . $mob;
                if (str_contains($a_material, "mm_$mob")) {
                    if (ilObjMediaObject::_exists($mob)) {
                        $mob_obj = new ilObjMediaObject($mob);
                        $imgattrs = [
                            "label" => $moblabel,
                            "uri" => "objects/" . "il_" . IL_INST_ID . "_mob_" . $mob . "/" . $mob_obj->getTitle()
                        ];
                    }
                    $a_xml_writer->xmlElement("matimage", $imgattrs, null);
                }
            }
        }
        if ($close_material_tag) {
            $a_xml_writer->xmlEndTag("material");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addQtiMetaDataField()

assQuestionExport::addQtiMetaDataField ( ilXmlWriter  $a_xml_writer,   $fieldLabel,   $fieldValue  )

finalprotected

adds a qti meta data field with given name and value to the passed xml writer (xml writer must be in context of opened "qtimetadata" tag)

protected

Parameters

ilXmlWriter	$a_xml_writer
string	$fieldLabel
string	$fieldValue

Definition at line 189 of file class.assQuestionExport.php.

References null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by addAdditionalContentEditingModeInformation(), addGeneralMetadata(), assSingleChoiceExport\toXML(), assMultipleChoiceExport\toXML(), and assTextQuestionExport\toXML().

                                                                                                     : void
    {
        $a_xml_writer->xmlStartTag("qtimetadatafield");
        $a_xml_writer->xmlElement("fieldlabel", null, $fieldLabel);
        $a_xml_writer->xmlElement("fieldentry", null, $fieldValue);
        $a_xml_writer->xmlEndTag("qtimetadatafield");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addSolutionHints()

assQuestionExport::addSolutionHints ( ilXmlWriter  $writer )

protected

Definition at line 236 of file class.assQuestionExport.php.

References $data, Vendor\Package\$e, ilAssQuestionHintList\getListByQuestionId(), ILIAS\Repository\int(), ILIAS\Repository\object(), and ilXmlWriter\xmlElement().

Referenced by assLongMenuExport\toXML(), assKprimChoiceExport\toXML(), assFileUploadExport\toXML(), assErrorTextExport\toXML(), assFormulaQuestionExport\toXML(), assOrderingHorizontalExport\toXML(), assTextSubsetExport\toXML(), assNumericExport\toXML(), assSingleChoiceExport\toXML(), assMultipleChoiceExport\toXML(), assImagemapQuestionExport\toXML(), assMatchingQuestionExport\toXML(), assTextQuestionExport\toXML(), assOrderingQuestionExport\toXML(), and assClozeTestExport\toXML().

                                                            : ilXmlWriter
    {
        $question_id = (int) $this->object->getId();
        $list = ilAssQuestionHintList::getListByQuestionId($question_id);

        foreach ($list as $hint) {
            $attrs = [
                'index' => $hint->getIndex(),
                'points' => $hint->getPoints()
            ];
            if ($this->object->isAdditionalContentEditingModePageObject()) {
                try {
                    $data = (new ilAssHintPage($hint->getId()))->getXMLContent();
                } catch (Exception $e) {
                    continue;
                }
            } else {
                $data = $hint->getText();
            }

            $writer->xmlElement(self::ITEM_SOLUTIONHINT, $attrs, $data);
        }
        return $writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addSuggestedSolution()

assQuestionExport::addSuggestedSolution ( ilXmlWriter  $writer )

protected

Definition at line 261 of file class.assQuestionExport.php.

References IL_INST_ID, null, ILIAS\Repository\object(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by assLongMenuExport\toXML(), assKprimChoiceExport\toXML(), assFileUploadExport\toXML(), assErrorTextExport\toXML(), assFormulaQuestionExport\toXML(), assOrderingHorizontalExport\toXML(), assTextSubsetExport\toXML(), assNumericExport\toXML(), assSingleChoiceExport\toXML(), assMultipleChoiceExport\toXML(), assImagemapQuestionExport\toXML(), assMatchingQuestionExport\toXML(), assTextQuestionExport\toXML(), assOrderingQuestionExport\toXML(), and assClozeTestExport\toXML().

                                                                : ilXmlWriter
    {
        $solution = $this->object->getSuggestedSolution();
        if ($solution === null) {
            return $writer;
        }

        $mattext = ['type' => $solution->getType()];
        $attrs = [
            'label' => 'suggested_solution',
            'texttype' => 'application/json'
        ];

        if ($solution instanceof SuggestedSolutionFile) {
            $mattext['title'] = $solution->getTitle();
            $mattext['filename'] = $solution->getFilename();
            $mattext['value'] = base64_encode(file_get_contents(
                $this->object->getSuggestedSolutionPath() . $solution->getFilename()
            ));
        } else {
            if (!preg_match('/il_(\d*?)_(\w+)_(\d+)/', $solution->getInternalLink(), $matches)) {
                return $writer;
            }
            $mattext['value'] = 'il_' . IL_INST_ID . '_' . $matches[2] . '_' . $matches[3];
            if ($matches[1] !== '') {
                $mattext['value'] = $solution['internal_link'];
            }

        }

        $writer->xmlStartTag('material');
        $writer->xmlElement('mattext', $attrs, json_encode($mattext));
        $writer->xmlEndTag('material');
        return $writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportFeedbackOnly()

assQuestionExport::exportFeedbackOnly

(

$a_xml_writer

)

Definition at line 80 of file class.assQuestionExport.php.

References addQTIMaterial(), and ILIAS\Repository\object().

Referenced by addGenericFeedback(), and assFileUploadExport\toXML().

                                                     : void
    {
        $feedback_allcorrect = $this->object->feedbackOBJ->getGenericFeedbackExportPresentation(
            $this->object->getId(),
            true
        );
        $feedback_onenotcorrect = $this->object->feedbackOBJ->getGenericFeedbackExportPresentation(
            $this->object->getId(),
            false
        );
        if (strlen($feedback_allcorrect . $feedback_onenotcorrect)) {
            $a_xml_writer->xmlStartTag("resprocessing");
            $a_xml_writer->xmlStartTag("outcomes");
            $a_xml_writer->xmlStartTag("decvar");
            $a_xml_writer->xmlEndTag("decvar");
            $a_xml_writer->xmlEndTag("outcomes");

            if (strlen($feedback_allcorrect)) {
                $attrs = [
                    "continue" => "Yes"
                ];
                $a_xml_writer->xmlStartTag("respcondition", $attrs);
                // qti conditionvar
                $a_xml_writer->xmlStartTag("conditionvar");
                $attrs = [
                    "respident" => "points"
                ];
                $a_xml_writer->xmlElement("varequal", $attrs, $this->object->getPoints());
                $a_xml_writer->xmlEndTag("conditionvar");
                // qti displayfeedback
                $attrs = [
                    "feedbacktype" => "Response",
                    "linkrefid" => "response_allcorrect"
                ];
                $a_xml_writer->xmlElement("displayfeedback", $attrs);
                $a_xml_writer->xmlEndTag("respcondition");
            }

            if (strlen($feedback_onenotcorrect)) {
                $attrs = [
                    "continue" => "Yes"
                ];
                $a_xml_writer->xmlStartTag("respcondition", $attrs);
                // qti conditionvar
                $a_xml_writer->xmlStartTag("conditionvar");
                $a_xml_writer->xmlStartTag("not");
                $attrs = [
                    "respident" => "points"
                ];
                $a_xml_writer->xmlElement("varequal", $attrs, $this->object->getPoints());
                $a_xml_writer->xmlEndTag("not");
                $a_xml_writer->xmlEndTag("conditionvar");
                // qti displayfeedback
                $attrs = [
                    "feedbacktype" => "Response",
                    "linkrefid" => "response_onenotcorrect"
                ];
                $a_xml_writer->xmlElement("displayfeedback", $attrs);
                $a_xml_writer->xmlEndTag("respcondition");
            }
            $a_xml_writer->xmlEndTag("resprocessing");
        }

        if (strlen($feedback_allcorrect)) {
            $attrs = [
                "ident" => "response_allcorrect",
                "view" => "All"
            ];
            $a_xml_writer->xmlStartTag("itemfeedback", $attrs);
            // qti flow_mat
            $a_xml_writer->xmlStartTag("flow_mat");
            $this->addQTIMaterial($a_xml_writer, $feedback_allcorrect);
            $a_xml_writer->xmlEndTag("flow_mat");
            $a_xml_writer->xmlEndTag("itemfeedback");
        }
        if (strlen($feedback_onenotcorrect)) {
            $attrs = [
                "ident" => "response_onenotcorrect",
                "view" => "All"
            ];
            $a_xml_writer->xmlStartTag("itemfeedback", $attrs);
            // qti flow_mat
            $a_xml_writer->xmlStartTag("flow_mat");
            $this->addQTIMaterial($a_xml_writer, $feedback_onenotcorrect);
            $a_xml_writer->xmlEndTag("flow_mat");
            $a_xml_writer->xmlEndTag("itemfeedback");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toXML()

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

Returns a QTI xml representation of the question Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.

Definition at line 174 of file class.assQuestionExport.php.

                                                                                                                                                        : string
    {
        return '';
    }

Field Documentation

$object

assQuestionExport::$object

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

Referenced by assClozeTestExport\__construct().

ITEM_SOLUTIONHINT

const assQuestionExport::ITEM_SOLUTIONHINT = 'solutionhint'

Definition at line 234 of file class.assQuestionExport.php.

Referenced by ilQTIParser\handlerParseBeginTag(), ilQTIParser\handlerParseEndTag(), and ilQTIParser\handlerVerifyBeginTag().

---

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

• components/ILIAS/TestQuestionPool/classes/export/qti12/class.assQuestionExport.php