class.ilPCQuestion.php

Go to the documentation of this file.

<?php

class ilPCQuestion extends ilPageContent
{
    protected ilLanguage $lng;
    protected ilCtrl $ctrl;
    protected ilObjUser $user;
    protected static bool $initial_done = false;

    public function init(): void
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->setType("pcqst");
    }

    public function setQuestionReference(string $a_questionreference): void
    {
        if (is_object($this->getChildNode())) {
            $this->getChildNode()->setAttribute("QRef", $a_questionreference);
        }
    }

    public function getQuestionReference(): ?string
    {
        if (is_object($this->getChildNode())) {
            return $this->getChildNode()->getAttribute("QRef");
        }
        return null;
    }

    public function create(
        ilPageObject $a_pg_obj,
        string $a_hier_id,
        string $a_pc_id = ""
    ): void {
        $this->createInitialChildNode(
            $a_hier_id,
            $a_pc_id,
            "Question",
            ["QRef" => ""]
        );
    }

    public function copyPoolQuestionIntoPage(
        string $a_q_id,
        string $a_hier_id
    ): void {
        $question = assQuestion::instantiateQuestion($a_q_id);
        $duplicate_id = $question->copyObject(0, $question->getTitle());
        $duplicate = assQuestion::instantiateQuestion($duplicate_id);
        $duplicate->setObjId(0);

        ilAssSelfAssessmentQuestionFormatter::prepareQuestionForLearningModule($duplicate);

        $this->getChildNode()->setAttribute("QRef", "il__qst_" . $duplicate_id);
    }

    public static function getLangVars(): array
    {
        return array("ed_insert_pcqst", "empty_question", "pc_qst");
    }

    public static function afterPageUpdate(
        ilPageObject $a_page,
        DOMDocument $a_domdoc,
        string $a_xml,
        bool $a_creation
    ): void {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulateF(
            "DELETE FROM page_question WHERE page_parent_type = %s " .
            " AND page_id = %s AND page_lang = %s",
            array("text", "integer", "text"),
            array($a_page->getParentType(), $a_page->getId(), $a_page->getLanguage())
        );

        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query('//Question');
        $q_ids = array();
        foreach ($nodes as $node) {
            $q_ref = $node->getAttribute("QRef");

            $inst_id = ilInternalLink::_extractInstOfTarget($q_ref);
            if (!($inst_id > 0)) {
                $q_id = ilInternalLink::_extractObjIdOfTarget($q_ref);
                if ($q_id > 0) {
                    $q_ids[$q_id] = $q_id;
                }
            }
        }
        foreach ($q_ids as $qid) {
            $ilDB->replace(
                "page_question",
                [
                "page_parent_type" => ["text", $a_page->getParentType()],
                "page_id" => ["integer", $a_page->getId()],
                "page_lang" => ["text", $a_page->getLanguage()],
                "question_id" => ["integer", $qid]
            ],
                []
            );
        }
    }

    public static function beforePageDelete(
        ilPageObject $a_page
    ): void {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulateF(
            "DELETE FROM page_question WHERE page_parent_type = %s " .
            " AND page_id = %s AND page_lang = %s",
            array("text", "integer", "text"),
            array($a_page->getParentType(), $a_page->getId(), $a_page->getLanguage())
        );
    }

    public static function _getQuestionIdsForPage(
        string $a_parent_type,
        int $a_page_id,
        string $a_lang = "-"
    ): array {
        global $DIC;

        $ilDB = $DIC->database();

        $parent_type_array = explode(':', $a_parent_type);

        $res = $ilDB->queryF(
            "SELECT * FROM page_question WHERE page_parent_type = %s " .
            " AND page_id = %s AND page_lang = %s",
            array("text", "integer", "text"),
            array($parent_type_array[0], $a_page_id, $a_lang)
        );
        $q_ids = array();
        while ($rec = $ilDB->fetchAssoc($res)) {
            $q_ids[] = $rec["question_id"];
        }

        return $q_ids;
    }

    public static function _getPageForQuestionId(
        int $a_q_id,
        string $a_parent_type = ""
    ): ?array {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query(
            "SELECT * FROM page_question " .
            " WHERE question_id = " . $ilDB->quote($a_q_id, "integer")
        );
        while ($rec = $ilDB->fetchAssoc($set)) {
            if ($a_parent_type == "" || $rec["page_parent_type"] == $a_parent_type) {
                return array("page_id" => $rec["page_id"], "parent_type" => $rec["page_parent_type"]);
            }
        }
        return null;
    }

    public function modifyPageContentPostXsl(
        string $a_output,
        string $a_mode,
        bool $a_abstract_only = false
    ): string {
        $lng = $this->lng;

        $qhtml = "";

        if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
            // #14154
            $q_ids = $this->getQuestionIds();
            if (count($q_ids)) {
                foreach ($q_ids as $q_id) {
                    $q_gui = assQuestionGUI::_getQuestionGUI("", $q_id);
                    // object check due to #16557
                    if (is_object($q_gui->object) && !$q_gui->object->isComplete()) {
                        $a_output = str_replace(
                            "{{{{{Question;il__qst_" . $q_id . "}}}}}",
                            "<i>" . $lng->txt("cont_empty_question") . "</i>",
                            $a_output
                        );
                    }
                }

                // this exports the questions which is needed below
                $qhtml = $this->getQuestionJsOfPage($a_mode == "edit", $a_mode);

                $a_output = "<script>" . ilQuestionExporter::questionsJS($q_ids) . "</script>" . $a_output;
                if (!self::$initial_done) {
                    $a_output = "<script>var ScormApi=null; var questions = new Array();</script>" . $a_output;
                    self::$initial_done = true;
                }
            }
        } else {
            // set by T&A components
            $qhtml = $this->getPage()->getPageConfig()->getQuestionHTML();

            // address #19788
            if (!is_array($qhtml) || count($qhtml) == 0) {
                // #14154
                $q_ids = $this->getQuestionIds();
                if (count($q_ids)) {
                    foreach ($q_ids as $k) {
                        $a_output = str_replace("{{{{{Question;il__qst_$k" . "}}}}}", " " . $lng->txt("copg_questions_not_supported_here"), $a_output);
                    }
                }
            }
        }

        if (is_array($qhtml)) {
            foreach ($qhtml as $k => $h) {
                $a_output = str_replace("{{{{{Question;il__qst_$k" . "}}}}}", " " . $h, $a_output);
            }
        }

        return $a_output;
    }

    public static function resetInitialState(): void
    {
        self::$initial_done = false;
    }

    public function getJavascriptFiles(string $a_mode): array
    {
        $js_files = array();

        if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
            $js_files[] = "./Modules/Scorm2004/scripts/questions/pure.js";
            $js_files[] = "./Modules/Scorm2004/scripts/questions/question_handling.js";
            $js_files[] = 'Modules/TestQuestionPool/js/ilAssMultipleChoice.js';
            $js_files[] = "Modules/TestQuestionPool/js/ilMatchingQuestion.js";

            foreach ($this->getQuestionIds() as $qId) {
                $qstGui = assQuestionGUI::_getQuestionGUI('', $qId);
                $js_files = array_merge($js_files, $qstGui->getPresentationJavascripts());
            }
        }

        if (!$this->getPage()->getPageConfig()->getEnableSelfAssessmentScorm() && $a_mode != ilPageObjectGUI::PREVIEW
            && $a_mode != "offline") {
            $js_files[] = "./Services/COPage/js/ilCOPageQuestionHandler.js";
        }

        return $js_files;
    }

    public function getCssFiles(string $a_mode): array
    {
        if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
            return array("./Modules/Scorm2004/templates/default/question_handling.css",
                "Modules/TestQuestionPool/templates/default/test_javascript.css");
        }
        return array();
    }

    public function getOnloadCode(string $a_mode): array
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $code = array();

        if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
            if (!$this->getPage()->getPageConfig()->getEnableSelfAssessmentScorm() && $a_mode != ilPageObjectGUI::PREVIEW
                && $a_mode != "offline" && $a_mode !== "edit") {
                $ilCtrl->setParameterByClass(strtolower(get_class($this->getPage())) . "gui", "page_id", $this->getPage()->getId());
                $url = $ilCtrl->getLinkTargetByClass(strtolower(get_class($this->getPage())) . "gui", "processAnswer", "", true, false);
                $code[] = "ilCOPageQuestionHandler.initCallback('" . $url . "');";
            }

            if ($this->getPage()->getPageConfig()->getDisableDefaultQuestionFeedback()) {
                $code[] = "ilias.questions.default_feedback = false;";
            }

            $code[] = self::getJSTextInitCode($this->getPage()->getPageConfig()->getLocalizationLanguage()) . ' il.COPagePres.updateQuestionOverviews();';
        }

        $q_ids = $this->getQuestionIds();

        // call renderers
        foreach ($q_ids as $q_id) {
            $code[] = "if (typeof renderILQuestion$q_id === 'function') {renderILQuestion$q_id();}";
        }

        // init answer status
        $get_stored_tries = $this->getPage()->getPageConfig()->getUseStoredQuestionTries();
        if ($get_stored_tries) {
            if (count($q_ids) > 0) {
                foreach ($q_ids as $q_id) {
                    $as = ilPageQuestionProcessor::getAnswerStatus($q_id, $ilUser->getId());
                    $code[] = "ilias.questions.initAnswer(" . $q_id . ", " . (int) ($as["try"] ?? 0) . ", " . ($as["passed"] ? "true" : "null") . ");";
                }
            }
        }
        return $code;
    }

    public static function getJSTextInitCode(string $a_lang): string
    {
        global $DIC;

        $lng = $DIC->language();
        $ilUser = $DIC->user();

        if ($a_lang == "") {
            $a_lang = $ilUser->getLanguage();
        }

        return
            '
                        ilias.questions.txt.wrong_answers = "' . $lng->txtlng("content", "cont_wrong_answers", $a_lang) . '";
                        ilias.questions.txt.wrong_answers_single = "' . $lng->txtlng("content", "cont_wrong_answers_single", $a_lang) . '";
                        ilias.questions.txt.tries_remaining = "' . $lng->txtlng("content", "cont_tries_remaining", $a_lang) . '";
                        ilias.questions.txt.please_try_again = "' . $lng->txtlng("content", "cont_please_try_again", $a_lang) . '";
                        ilias.questions.txt.all_answers_correct = "' . $lng->txtlng("content", "cont_all_answers_correct", $a_lang) . '";
                        ilias.questions.txt.enough_answers_correct = "' . $lng->txtlng("content", "cont_enough_answers_correct", $a_lang) . '";
                        ilias.questions.txt.nr_of_tries_exceeded = "' . $lng->txtlng("content", "cont_nr_of_tries_exceeded", $a_lang) . '";
                        ilias.questions.txt.correct_answers_separator = "' . $lng->txtlng("assessment", "or", $a_lang) . '";
                        ilias.questions.txt.correct_answers_shown = "' . $lng->txtlng("content", "cont_correct_answers_shown", $a_lang) . '";
                        ilias.questions.txt.correct_answers_also = "' . $lng->txtlng("content", "cont_correct_answers_also", $a_lang) . '";
                        ilias.questions.txt.correct_answer_also = "' . $lng->txtlng("content", "cont_correct_answer_also", $a_lang) . '";
                        ilias.questions.txt.ov_all_correct = "' . $lng->txtlng("content", "cont_ov_all_correct", $a_lang) . '";
                        ilias.questions.txt.ov_some_correct = "' . $lng->txtlng("content", "cont_ov_some_correct", $a_lang) . '";
                        ilias.questions.txt.ov_wrong_answered = "' . $lng->txtlng("content", "cont_ov_wrong_answered", $a_lang) . '";
                        ilias.questions.txt.please_select = "' . $lng->txtlng("content", "cont_please_select", $a_lang) . '";
                        ilias.questions.txt.ov_preview = "' . $lng->txtlng("content", "cont_ov_preview", $a_lang) . '";
                        ilias.questions.txt.submit_answers = "' . $lng->txtlng("content", "cont_submit_answers", $a_lang) . '";
                        ilias.questions.refresh_lang();
                        ';
    }

    public function getQuestionJsOfPage(
        bool $a_no_interaction,
        string $a_mode
    ): array {
        $q_ids = $this->getQuestionIds();
        $js = array();
        if (count($q_ids) > 0) {
            foreach ($q_ids as $q_id) {
                $q_exporter = new ilQuestionExporter($a_no_interaction);
                $image_path = "";
                if ($a_mode == "offline") {
                    if ($this->getPage()->getParentType() == "sahs") {
                        $image_path = "./objects/";
                    }
                    if ($this->getPage()->getParentType() == "lm") {
                        $image_path = "./assessment/0/" . $q_id . "/images/";
                    }
                }
                $js[$q_id] = $q_exporter->exportQuestion($q_id, $image_path, $a_mode);
            }
        }
        return $js;
    }

    protected function getQuestionIds(): array
    {
        $dom = $this->getPage()->getDomDoc();
        $q_ids = [];
        $nodes = $this->dom_util->path($dom, "//Question");
        foreach ($nodes as $node) {
            $qref = $node->getAttribute("QRef");
            $inst_id = ilInternalLink::_extractInstOfTarget($qref);
            $obj_id = ilInternalLink::_extractObjIdOfTarget($qref);

            if (!($inst_id > 0)) {
                if ($obj_id > 0) {
                    $q_ids[] = $obj_id;
                }
            }
        }
        return $q_ids;
    }

    public static function handleCopiedContent(
        DOMDocument $a_domdoc,
        bool $a_self_ass = true,
        bool $a_clone_mobs = false,
        int $new_parent_id = 0,
        int $obj_copy_id = 0
    ): void {
        global $DIC;

        $dom_util = $DIC->copage()->internal()->domain()->domUtil();

        // handle question elements
        if ($a_self_ass) {
            // copy questions
            $path = "//Question";
            $nodes = $dom_util->path($a_domdoc, $path);
            foreach ($nodes as $node) {
                $qref = $node->getAttribute("QRef");

                $inst_id = ilInternalLink::_extractInstOfTarget($qref);
                $q_id = ilInternalLink::_extractObjIdOfTarget($qref);

                if (!($inst_id > 0)) {
                    if ($q_id > 0) {
                        $question = null;
                        try {
                            $question = assQuestion::instantiateQuestion($q_id);
                        } catch (Exception $e) {
                        }
                        // check due to #16557
                        if (is_object($question) && $question->isComplete()) {
                            // check if page for question exists
                            // due to a bug in early 4.2.x version this is possible
                            if (!ilPageObject::_exists("qpl", $q_id)) {
                                $question->createPageObject();
                            }

                            // now copy this question and change reference to
                            // new question id
                            $duplicate_id = $question->duplicate(false);
                            $node->setAttribute("QRef", "il__qst_" . $duplicate_id);
                        }
                    }
                }
            }
        } else {
            // remove question
            $path = "//Question";
            $nodes = $dom_util->path($a_domdoc, $path);
            foreach ($nodes as $node) {
                $parent = $node->parentNode;
                $parent->parentNode->removeChild($parent);
            }
        }
    }
}