class.ilSurveyQuestionTableGUI.php

Go to the documentation of this file.

<?php

class ilSurveyQuestionTableGUI extends ilTable2GUI
{
    protected \ILIAS\Survey\InternalGUIService $gui;
    protected \ILIAS\DI\UIServices $ui;
    protected ilObjSurvey $object;
    protected bool $read_only;

    public function __construct(
        object $a_parent_obj,
        string $a_parent_cmd,
        ilObjSurvey $a_survey_obj,
        bool $a_read_only = false
    ) {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $this->ui = $DIC->ui();

        $this->object = $a_survey_obj;
        $this->read_only = $a_read_only;

        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->setId("il_svy_qst");
        $this->setLimit(9999);

        $edit_manager = $DIC->survey()
            ->internal()
            ->domain()
            ->edit();

        $this->gui = $DIC->survey()
            ->internal()
            ->gui();
        if (!$this->read_only) {
            // command dropdown
            if ((!($edit_manager->getQuestionClipboardMode($this->object->getRefId()) === "copy" && count($edit_manager->getQuestionClipboardQuestions($this->object->getRefId())) > 0))
                    && (count($edit_manager->getMoveSurveyQuestions()) === 0 ||
                $edit_manager->getMoveSurveyId() !== $this->object->getId())) {
                $this->addMultiCommand("createQuestionblock", $lng->txt("define_questionblock"));
                $this->addMultiCommand("unfoldQuestionblock", $lng->txt("unfold"));
                $this->addMultiCommand("removeQuestions", $lng->txt("remove_question"));
                $this->addMultiCommand("moveQuestions", $lng->txt("move"));
                $this->addMultiCommand("copyQuestionsToPool", $lng->txt("survey_copy_questions_to_pool"));
            } else {
                $this->addMultiCommand("insertQuestionsBefore", $lng->txt("insert_before"));
                $this->addMultiCommand("insertQuestionsAfter", $lng->txt("insert_after"));
            }

            // right side
            $this->addCommandButton("saveObligatory", $lng->txt("save_obligatory_state"));

            $this->setSelectAllCheckbox("id[]");
            $this->addColumn("", "");
            $this->addColumn($lng->txt("survey_order"), "");
        }

        $this->addColumn($lng->txt("title"), "");
        $this->addColumn($lng->txt("obligatory"), "");
        $this->addColumn($lng->txt("description"), "");
        $this->addColumn($lng->txt("type"), "");
        $this->addColumn($lng->txt("author"), "");
        $this->addColumn($lng->txt("survey_question_pool"), "");

        if (!$this->read_only) {
            $this->addColumn($lng->txt("actions"), "");
        }

        $this->setDefaultOrderField("order");
        $this->setDefaultOrderDirection("asc");

        $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
        $this->setRowTemplate("tpl.il_svy_svy_question_table.html", "components/ILIAS/Survey");

        $this->setShowRowsSelector(true);

        $this->importData();
    }

    protected function importData(): void
    {
        $ilCtrl = $this->ctrl;

        $table_data = [];
        $survey_questions = $this->object->getSurveyQuestions();
        if (count($survey_questions) > 0) {
            $questiontypes = ilObjSurveyQuestionPool::_getQuestiontypes();

            $questionpools = $this->object->getQuestionpoolTitles(true);

            $table_data = array();
            $last_questionblock_id = $position = $block_position = 0;
            foreach ($survey_questions as $question_id => $data) {
                // question block
                if ($data["questionblock_id"] > 0 &&
                    $data["questionblock_id"] != $last_questionblock_id) {
                    $id = "qb_" . $data["questionblock_id"];

                    $table_data[$id] = array("id" => $id,
                        "type" => "block",
                        "title" => $data["questionblock_title"]);

                    if (!$this->read_only) {
                        // order
                        if (count($survey_questions) > 1) {
                            $position += 10;
                            $table_data[$id]["position"] = $position;
                        }

                        $ilCtrl->setParameter($this->parent_obj, "bl_id", $data["questionblock_id"]);
                        $table_data[$id]["url"] = $ilCtrl->getLinkTarget($this->parent_obj, "editQuestionblock");
                        $ilCtrl->setParameter($this->parent_obj, "bl_id", "");
                    }

                    $block_position = 0;
                }

                // question

                $id = $data["question_id"];

                $table_data[$id] = array("id" => $id,
                    "type" => "question",
                    "heading" => $data["heading"],
                    "title" => $data["title"],
                    "description" => $data["description"],
                    "author" => $data["author"],
                    "block_id" => $data["questionblock_id"],
                    "obligatory" => (bool) $data["obligatory"]);

                // question type
                foreach ($questiontypes as $trans => $typedata) {
                    if (strcmp($typedata["type_tag"], $data["type_tag"]) === 0) {
                        $table_data[$id]["question_type"] = $trans;
                    }
                }

                // pool title
                if ($data["original_id"]) {
                    $original_fi = SurveyQuestion::lookupObjFi($data["original_id"]);
                    if (isset($questionpools[$original_fi])) {
                        $table_data[$id]["pool"] = $questionpools[$original_fi];
                    } else {
                        // #11186
                        $table_data[$id]["pool"] = "-";
                    }
                }

                if (!$this->read_only) {
                    if ($data["obj_fi"] > 0) {
                        // edit url
                        $q_gui = $data["type_tag"] . "GUI";
                        $ilCtrl->setParameterByClass($q_gui, "q_id", $id);
                        $table_data[$id]["url"] = $ilCtrl->getLinkTargetByClass($q_gui, "editQuestion") .
                        $ilCtrl->setParameterByClass($q_gui, "q_id", "");
                    }

                    // order
                    if (count($survey_questions) > 1) {
                        if (!$data["questionblock_id"]) {
                            $position += 10;
                            $table_data[$id]["position"] = $position;
                        } else {
                            $block_position += 10;
                            $table_data[$id]["position"] = $block_position;
                        }
                    }
                }

                $last_questionblock_id = $data["questionblock_id"];
            }
        }

        $this->setData($table_data);
    }

    protected function fillRow(array $a_set): void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ui_factory = $this->gui->ui()->factory();
        $ui_renderer = $this->gui->ui()->renderer();

        $obligatory = "";

        switch ($a_set["type"]) {
            case "block":
                if (!$this->read_only) {
                    // checkbox
                    $this->tpl->setCurrentBlock("checkable");
                    $this->tpl->setVariable("QUESTION_ID", $a_set["id"]);
                    $this->tpl->parseCurrentBlock();

                    // order
                    if ($a_set["position"]) {
                        $this->tpl->setCurrentBlock("order");
                        $this->tpl->setVariable("ORDER_NAME", "order[" . $a_set["id"] . "]");
                        $this->tpl->setVariable("ORDER_VALUE", $a_set["position"]);
                        $this->tpl->parseCurrentBlock();
                    }
                }

                $this->tpl->setVariable("TYPE", $lng->txt("questionblock"));
                break;

            case "question":
                $this->tpl->setVariable("DESCRIPTION", $a_set["description"]);
                $this->tpl->setVariable("TYPE", $a_set["question_type"]);
                $this->tpl->setVariable("AUTHOR", $a_set["author"]);
                $this->tpl->setVariable("POOL", $a_set["pool"] ?? "");

                if ($a_set["heading"] ?? false) {
                    $this->tpl->setCurrentBlock("heading");
                    $this->tpl->setVariable("TXT_HEADING", $a_set["heading"]);
                    $this->tpl->parseCurrentBlock();
                }

                if ($a_set["block_id"]) {
                    $this->tpl->setVariable("TITLE_INDENT", " style=\"padding-left:30px\"");
                }

                if (!$this->read_only) {
                    // checkbox
                    $this->tpl->setCurrentBlock("checkable");
                    $this->tpl->setVariable("QUESTION_ID", $a_set["id"]);
                    $this->tpl->parseCurrentBlock();

                    if ($a_set["block_id"]) {
                        $this->tpl->setVariable("CHECKABLE_INDENT", " style=\"padding-left:30px\"");
                    }

                    // order
                    if ($a_set["position"] ?? false) {
                        $this->tpl->setCurrentBlock("order");
                        if (!$a_set["block_id"]) {
                            $this->tpl->setVariable("ORDER_NAME", "order[q_" . $a_set["id"] . "]");
                        } else {
                            $this->tpl->setVariable("ORDER_NAME", "block_order[" . $a_set["block_id"] . "][" . $a_set["id"] . "]");
                        }
                        $this->tpl->setVariable("ORDER_VALUE", $a_set["position"]);
                        $this->tpl->parseCurrentBlock();
                        if ($a_set["block_id"]) {
                            $this->tpl->setVariable("ORDER_INDENT", " style=\"padding-left:30px\"");
                        }
                    }

                    // obligatory
                    $checked = $a_set["obligatory"] ? " checked=\"checked\"" : "";
                    $obligatory = "<input type=\"checkbox\" name=\"obligatory[" .
                        $a_set["id"] . "]\" value=\"1\"" . $checked . " />";
                } elseif ($a_set["obligatory"]) {
                    $obligatory = $this->ui->renderer()->render(
                        $this->ui->factory()->symbol()->icon()->custom(ilUtil::getImagePath("standard/icon_checked.svg"), $lng->txt("question_obligatory"))
                    );
                }
                $this->tpl->setVariable("OBLIGATORY", $obligatory);
                break;

            case "heading":
                if (!$this->read_only) {
                    // checkbox
                    $this->tpl->setCurrentBlock("checkable");
                    $this->tpl->setVariable("QUESTION_ID", $a_set["id"]);
                    $this->tpl->parseCurrentBlock();
                    if ($a_set["in_block"]) {
                        $this->tpl->setVariable("CHECKABLE_INDENT", " style=\"padding-left:30px\"");
                        $this->tpl->setVariable("TITLE_INDENT", " style=\"padding-left:30px\"");
                    }
                }

                $this->tpl->setVariable("TYPE", $lng->txt("heading"));
                break;
        }

        if (!$this->read_only) {
            $this->tpl->setCurrentBlock("actions");

            $ilCtrl->setParameter($this->parent_obj, "q_id", $a_set["id"]);

            $actions = [];

            if ($a_set["url"]) {
                $actions[] = $ui_factory->link()->standard(
                    $lng->txt("edit"),
                    $a_set["url"]
                );
            }

            if ($a_set["heading"] ?? false) {
                $actions[] = $ui_factory->link()->standard(
                    $lng->txt("survey_edit_heading"),
                    $ilCtrl->getLinkTarget($this->parent_obj, "editheading")
                );

                $actions[] = $ui_factory->link()->standard(
                    $lng->txt("survey_delete_heading"),
                    $ilCtrl->getLinkTarget($this->parent_obj, "removeheading")
                );
            } elseif ($a_set["type"] === "question") {
                $actions[] = $ui_factory->link()->standard(
                    $lng->txt("add_heading"),
                    $ilCtrl->getLinkTarget($this->parent_obj, "addHeading")
                );
                $actions[] = $ui_factory->link()->standard(
                    $lng->txt("copy"),
                    $ilCtrl->getLinkTarget($this->parent_obj, "copyQuestion")
                );
            }

            $dd = $ui_factory->dropdown()->standard($actions);

            $this->tpl->setVariable("ACTION", $ui_renderer->render($dd));

            $ilCtrl->setParameter($this->parent_obj, "q_id", "");

            $this->tpl->parseCurrentBlock();

            // #11186
            if ($a_set["url"]) {
                $this->tpl->setCurrentBlock("title_edit");
                $this->tpl->setVariable("TITLE", $a_set["title"]);
                $this->tpl->setVariable("URL_TITLE", $a_set["url"]);
            } else {
                $this->tpl->setCurrentBlock("title_static");
                $this->tpl->setVariable("TITLE", $a_set["title"]);
            }
        } else {
            $this->tpl->setCurrentBlock("title_static");
            $this->tpl->setVariable("TITLE", $a_set["title"]);
        }
        $this->tpl->parseCurrentBlock();
    }
}