class.assQuestionExport.php

Go to the documentation of this file.

<?php

use ILIAS\TestQuestionPool\Questions\SuggestedSolution\SuggestedSolutionFile;

class assQuestionExport
{
    public $object;

    public function __construct($a_object)
    {
        $this->object = $a_object;
    }

    protected function addAnswerSpecificFeedback(ilXmlWriter $a_xml_writer, $answers): 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");
        }
    }

    protected function addGenericFeedback(ilXmlWriter $a_xml_writer): void
    {
        $this->exportFeedbackOnly($a_xml_writer);
    }

    public function exportFeedbackOnly($a_xml_writer): 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");
        }
    }

    public function toXML($a_include_header = true, $a_include_binary = true, $a_shuffle = false, $test_output = false, $force_image_references = false): string
    {
        return '';
    }

    final protected function addQtiMetaDataField(ilXmlWriter $a_xml_writer, $fieldLabel, $fieldValue): 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");
    }

    final protected function addAdditionalContentEditingModeInformation(ilXmlWriter $a_xml_writer): void
    {
        $this->addQtiMetaDataField(
            $a_xml_writer,
            'additional_cont_edit_mode',
            $this->object->getAdditionalContentEditingMode()
        );
    }

    protected function addGeneralMetadata(ilXmlWriter $xmlwriter): 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()
        );
    }

    public const ITEM_SOLUTIONHINT = 'solutionhint';

    protected function addSolutionHints(ilXmlWriter $writer): 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;
    }

    protected function addSuggestedSolution(ilXmlWriter $writer): 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->getInternalLink();
            }

        }

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

    public function addQTIMaterial(ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag = true, bool $add_mobs = true): 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");
        }
    }
}