class.assClozeTestImport.php

Go to the documentation of this file.

<?php

class assClozeTestImport extends assQuestionImport
{
    public function fromXML(&$item, $questionpool_id, &$tst_id, &$tst_object, &$question_counter, $import_mapping): array
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];

        // empty session variable for imported xhtml mobs
        ilSession::clear('import_mob_xhtml');
        $presentation = $item->getPresentation();

        $questiontext = $this->processNonAbstractedImageReferences(
            $item->getMetadataEntry("question") ?? '&nbsp;',
            $item->getIliasSourceNic()
        );

        $clozetext_array = [];
        $shuffle = 0;
        $gaps = [];
        foreach ($presentation->order as $entry) {
            switch ($entry["type"]) {
                case "material":

                    $material_string = $this->QTIMaterialToString(
                        $presentation->material[$entry["index"]]
                    );

                    if ($questiontext === '&nbsp;') {
                        //needs to be checked here to suport imports from >= 5.4 < 9.0
                        $questiontext = $material_string;
                    } else {
                        array_push($clozetext_array, $material_string);
                    }

                    break;
                case "response":
                    $response = $presentation->response[$entry["index"]];
                    $rendertype = $response->getRenderType();
                    array_push($clozetext_array, "<<" . $response->getIdent() . ">>");

                    switch (strtolower(get_class($response->getRenderType()))) {
                        case "ilqtirenderfib":
                            switch ($response->getRenderType()->getFibtype()) {
                                case ilQTIRenderFib::FIBTYPE_DECIMAL:
                                case ilQTIRenderFib::FIBTYPE_INTEGER:
                                    array_push(
                                        $gaps,
                                        [
                                            "ident" => $response->getIdent(),
                                            "type" => CLOZE_NUMERIC,
                                            "answers" => [],
                                            "minnumber" => $response->getRenderType()->getMinnumber(),
                                            "maxnumber" => $response->getRenderType()->getMaxnumber(),
                                            'gap_size' => $response->getRenderType()->getMaxchars()
                                        ]
                                    );
                                    break;
                                default:
                                case ilQTIRenderFib::FIBTYPE_STRING:
                                    array_push(
                                        $gaps,
                                        ["ident" => $response->getIdent(),
                                            "type" => CLOZE_TEXT,
                                            "answers" => [],
                                            'gap_size' => $response->getRenderType()->getMaxchars()
                                        ]
                                    );
                                    break;
                            }
                            break;
                        case "ilqtirenderchoice":
                            $answers = [];
                            $shuffle = $rendertype->getShuffle();
                            $answerorder = 0;
                            foreach ($rendertype->response_labels as $response_label) {
                                $ident = $response_label->getIdent();
                                $answertext = "";
                                foreach ($response_label->material as $mat) {
                                    $answertext .= $this->QTIMaterialToString($mat);
                                }
                                $answers[$ident] = [
                                    "answertext" => $answertext,
                                    "points" => 0,
                                    "answerorder" => $answerorder++,
                                    "action" => "",
                                    "shuffle" => $rendertype->getShuffle()
                                ];
                            }
                            array_push($gaps, ["ident" => $response->getIdent(), "type" => CLOZE_SELECT, "shuffle" => $rendertype->getShuffle(), "answers" => $answers]);
                            break;
                    }
                    break;
            }
        }
        $responses = [];
        $feedbacks = [];
        $feedbacksgeneric = [];
        foreach ($item->resprocessing as $resprocessing) {
            foreach ($resprocessing->respcondition as $respcondition) {
                $ident = "";
                $correctness = 1;
                $conditionvar = $respcondition->getConditionvar();
                foreach ($conditionvar->order as $order) {
                    switch ($order["field"]) {
                        case "varequal":
                            $equals = $conditionvar->varequal[$order["index"]]->getContent();
                            $gapident = $conditionvar->varequal[$order["index"]]->getRespident();
                            break;
                    }
                }
                foreach ($respcondition->setvar as $setvar) {
                    if (strcmp($gapident, "") != 0) {
                        foreach ($gaps as $gi => $g) {
                            if (strcmp($g["ident"], $gapident) == 0) {
                                if ($g["type"] == CLOZE_SELECT) {
                                    foreach ($gaps[$gi]["answers"] as $ai => $answer) {
                                        if (strcmp($answer["answertext"], $equals) == 0) {
                                            $gaps[$gi]["answers"][$ai]["action"] = $setvar->getAction();
                                            $gaps[$gi]["answers"][$ai]["points"] = $setvar->getContent();
                                        }
                                    }
                                } elseif ($g["type"] == CLOZE_TEXT) {
                                    array_push($gaps[$gi]["answers"], [
                                        "answertext" => $equals,
                                        "points" => $setvar->getContent(),
                                        "answerorder" => count($gaps[$gi]["answers"]),
                                        "action" => $setvar->getAction()

                                    ]);
                                } elseif ($g["type"] == CLOZE_NUMERIC) {
                                    array_push($gaps[$gi]["answers"], [
                                        "answertext" => $equals,
                                        "points" => $setvar->getContent(),
                                        "answerorder" => count($gaps[$gi]["answers"]),
                                        "action" => $setvar->getAction()
                                    ]);
                                }
                            }
                        }
                    }
                }

                if (count($respcondition->displayfeedback)) {
                    foreach ($respcondition->displayfeedback as $feedbackpointer) {
                        if (strlen($feedbackpointer->getLinkrefid())) {
                            foreach ($item->itemfeedback as $ifb) {
                                if (strcmp($ifb->getIdent(), "response_allcorrect") == 0) {
                                    // found a feedback for the identifier
                                    if (count($ifb->material)) {
                                        foreach ($ifb->material as $material) {
                                            $feedbacksgeneric[1] = $material;
                                        }
                                    }
                                    if ((count($ifb->flow_mat) > 0)) {
                                        foreach ($ifb->flow_mat as $fmat) {
                                            if (count($fmat->material)) {
                                                foreach ($fmat->material as $material) {
                                                    $feedbacksgeneric[1] = $material;
                                                }
                                            }
                                        }
                                    }
                                } elseif (strcmp($ifb->getIdent(), "response_onenotcorrect") == 0) {
                                    // found a feedback for the identifier
                                    if (count($ifb->material)) {
                                        foreach ($ifb->material as $material) {
                                            $feedbacksgeneric[0] = $material;
                                        }
                                    }
                                    if ((count($ifb->flow_mat) > 0)) {
                                        foreach ($ifb->flow_mat as $fmat) {
                                            if (count($fmat->material)) {
                                                foreach ($fmat->material as $material) {
                                                    $feedbacksgeneric[0] = $material;
                                                }
                                            }
                                        }
                                    }
                                } else {
                                    // found a feedback for the identifier
                                    if (count($ifb->material)) {
                                        foreach ($ifb->material as $material) {
                                            $feedbacks[$ifb->getIdent()] = $material;
                                        }
                                    }
                                    if ((count($ifb->flow_mat) > 0)) {
                                        foreach ($ifb->flow_mat as $fmat) {
                                            if (count($fmat->material)) {
                                                foreach ($fmat->material as $material) {
                                                    $feedbacks[$ifb->getIdent()] = $material;
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }

        $this->addGeneralMetadata($item);
        $this->object->setTitle($item->getTitle());
        $this->object->setNrOfTries((int) $item->getMaxattempts());
        $this->object->setComment($item->getComment());
        $this->object->setAuthor($item->getAuthor());
        $this->object->setOwner($ilUser->getId());
        $this->object->setObjId($questionpool_id);
        $textgap_rating = $item->getMetadataEntry("textgaprating");
        $this->object->setFixedTextLength($item->getMetadataEntry("fixedTextLength"));
        $this->object->setIdenticalScoring($item->getMetadataEntry("identicalScoring"));
        $this->object->setFeedbackMode(
            strlen($item->getMetadataEntry("feedback_mode")) ?
                $item->getMetadataEntry("feedback_mode") : ilAssClozeTestFeedback::FB_MODE_GAP_QUESTION
        );
        $combinations = json_decode(base64_decode($item->getMetadataEntry("combinations")));
        if (strlen($textgap_rating) == 0) {
            $textgap_rating = "ci";
        }
        $this->object->setTextgapRating($textgap_rating);
        $gaptext = [];
        foreach ($gaps as $gapidx => $gap) {
            $gapcontent = [];
            $clozegap = new assClozeGap($gap["type"]);
            foreach ($gap["answers"] as $index => $answer) {
                $gapanswer = new assAnswerCloze($answer["answertext"], $answer["points"], $answer["answerorder"]);
                $gapanswer->setGapSize((int) ($gap["gap_size"] ?? 0));
                switch ($clozegap->getType()) {
                    case CLOZE_SELECT:
                        $clozegap->setShuffle($answer["shuffle"]);
                        break;
                    case CLOZE_NUMERIC:
                        $gapanswer->setLowerBound($gap["minnumber"]);
                        $gapanswer->setUpperBound($gap["maxnumber"]);
                        break;
                }
                $clozegap->setGapSize((int) ($gap["gap_size"] ?? 0));
                $clozegap->addItem($gapanswer);
                array_push($gapcontent, $answer["answertext"]);
            }
            $this->object->addGapAtIndex($clozegap, $gapidx);
            $gaptext[$gap["ident"]] = "[gap]" . join(",", $gapcontent) . "[/gap]";
        }

        $this->object->setQuestion($questiontext);
        $clozetext = join("", $clozetext_array);

        foreach ($gaptext as $idx => $val) {
            $clozetext = str_replace("<<" . $idx . ">>", $val, $clozetext);
        }
        $this->object->setClozeTextValue($clozetext);

        // additional content editing mode information
        $this->object->setAdditionalContentEditingMode(
            $this->fetchAdditionalContentEditingModeInformation($item)
        );
        $this->object->saveToDb();

        if (is_array($combinations) && count($combinations) > 0) {
            assClozeGapCombination::clearGapCombinationsFromDb($this->object->getId());
            assClozeGapCombination::importGapCombinationToDb($this->object->getId(), $combinations);
            $gap_combinations = new assClozeGapCombination();
            $gap_combinations->loadFromDb($this->object->getId());
            $this->object->setGapCombinations($gap_combinations);
            $this->object->setGapCombinationsExists(true);
        }

        // handle the import of media objects in XHTML code
        foreach ($feedbacks as $ident => $material) {
            $m = $this->QTIMaterialToString($material);
            $feedbacks[$ident] = $m;
        }
        foreach ($feedbacksgeneric as $correctness => $material) {
            $m = $this->QTIMaterialToString($material);
            $feedbacksgeneric[$correctness] = $m;
        }
        if (is_array(ilSession::get("import_mob_xhtml"))) {
            foreach (ilSession::get("import_mob_xhtml") as $mob) {
                if ($tst_id > 0) {
                    $importfile = $this->getTstImportArchivDirectory() . '/' . $mob["uri"];
                } else {
                    $importfile = $this->getQplImportArchivDirectory() . '/' . $mob["uri"];
                }
                global $DIC;
                /* @var ILIAS\DI\Container $DIC */
                $DIC['ilLog']->write(__METHOD__ . ': import mob from dir: ' . $importfile);

                $media_object = ilObjMediaObject::_saveTempFileAsMediaObject(basename($importfile), $importfile, false);
                $questiontext = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $questiontext);
                $clozetext = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $clozetext);
                foreach ($feedbacks as $ident => $material) {
                    $feedbacks[$ident] = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $material);
                }
                foreach ($feedbacksgeneric as $correctness => $material) {
                    $feedbacksgeneric[$correctness] = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $material);
                }
            }
        }
        $this->object->setQuestion(ilRTE::_replaceMediaObjectImageSrc($questiontext, 1));
        $this->object->setClozeTextValue(ilRTE::_replaceMediaObjectImageSrc($clozetext, 1));
        foreach ($feedbacks as $ident => $material) {
            $fbIdentifier = $this->buildFeedbackIdentifier($ident);
            $this->object->feedbackOBJ->importSpecificAnswerFeedback(
                $this->object->getId(),
                $fbIdentifier->getQuestionIndex(),
                $fbIdentifier->getAnswerIndex(),
                ilRTE::_replaceMediaObjectImageSrc($material, 1)
            );
        }
        foreach ($feedbacksgeneric as $correctness => $material) {
            $this->object->feedbackOBJ->importGenericFeedback(
                $this->object->getId(),
                $correctness,
                ilRTE::_replaceMediaObjectImageSrc($material, 1)
            );
        }
        $this->object->saveToDb();
        $this->importSuggestedSolutions($this->object->getId(), $item->suggested_solutions);
        if (isset($tst_id) && $tst_id !== $questionpool_id) {
            $qpl_qid = $this->object->getId();
            $tst_qid = $this->object->duplicate(true, "", "", -1, $tst_id);
            $tst_object->questions[$question_counter++] = $tst_qid;
            $import_mapping[$item->getIdent()] = ["pool" => $qpl_qid, "test" => $tst_qid];
            return $import_mapping;
        }

        if ($tst_id > 0) {
            $tst_object->questions[$question_counter++] = $this->object->getId();
            $import_mapping[$item->getIdent()] = ["pool" => 0, "test" => $this->object->getId()];
            return $import_mapping;
        }

        $import_mapping[$item->getIdent()] = ["pool" => $this->object->getId(), "test" => 0];
        return $import_mapping;
    }

    protected function buildFeedbackIdentifier($ident): ilAssSpecificFeedbackIdentifier
    {
        $fbIdentifier = new ilAssSpecificFeedbackIdentifier();

        $ident = explode('_', $ident);

        if (count($ident) > 1) {
            $fbIdentifier->setQuestionIndex($ident[0]);
            $fbIdentifier->setAnswerIndex($ident[1]);
        } else {
            $fbIdentifier->setQuestionIndex($ident[0]);
            $fbIdentifier->setAnswerIndex(0);
        }

        return $fbIdentifier;
    }
}