class.ilQuestionBrowserTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\TestQuestionPool\QuestionPoolDIC;
use ILIAS\TestQuestionPool\RequestDataCollector;
use ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository;

class ilQuestionBrowserTableGUI extends ilTable2GUI
{
    private RequestDataCollector $request;
    private GeneralQuestionPropertiesRepository $questionrepository;
    protected \ILIAS\Notes\Service $notes;
    protected \ILIAS\UI\Factory $ui_factory;
    protected \ILIAS\UI\Renderer $renderer;
    protected $editable = true;
    protected $writeAccess = false;
    protected $totalPoints = 0;
    protected $confirmdelete;
    protected array $filter = [];

    protected $taxIds = [];

    protected $questionCommentingEnabled = false;

    public function __construct(
        $a_parent_obj,
        $a_parent_cmd,
        $a_write_access = false,
        $confirmdelete = false,
        $taxIds = [],
        $enableCommenting = false
    ) {
        $this->setQuestionCommentingEnabled($enableCommenting);

        // Bugfix: #0019539
        if ($confirmdelete) {
            $this->setId("qpl_confirm_del_" . $a_parent_obj->getObject()->getRefId());
        } else {
            $this->setId("qpl_qst_brows_" . $a_parent_obj->getObject()->getRefId());
        }

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

        global $DIC;
        $this->lng = $DIC['lng'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->renderer = $DIC->ui()->renderer();
        $this->ui_factory = $DIC->ui()->factory();

        $local_dic = QuestionPoolDIC::dic();
        $this->request = $local_dic['request_data_collector'];
        $this->questionrepository = $local_dic['question.general_properties.repository'];

        $this->confirmdelete = $confirmdelete;
        $this->setWriteAccess($a_write_access);
        $this->taxIds = $taxIds;

        $qplSetting = new ilSetting("qpl");

        $this->setFormName('questionbrowser');
        $this->setStyle('table', 'fullwidth');
        if (!$confirmdelete) {
            $this->addColumn('', '', '1%');
            $this->addColumn($this->lng->txt("title"), 'title', '');
            foreach ($this->getSelectedColumns() as $c) {
                if (strcmp($c, 'description') == 0) {
                    $this->addColumn($this->lng->txt("description"), 'description', '');
                }
                if (strcmp($c, 'type') == 0) {
                    $this->addColumn($this->lng->txt("question_type"), 'ttype', '');
                }
                // According to mantis #12713
                if (strcmp($c, 'points') == 0) {
                    $this->addColumn($this->lng->txt("points"), 'points', '', false, 'ilCenterForced');
                }
                if (strcmp($c, 'statistics') == 0) {
                    $this->addColumn($this->lng->txt('statistics'), '', '');
                }
                if (strcmp($c, 'author') == 0) {
                    $this->addColumn($this->lng->txt("author"), 'author', '');
                }
                if ($c == 'lifecycle') {
                    $this->addColumn($this->lng->txt('qst_lifecycle'), 'lifecycle', '');
                }
                if ($this->isQuestionCommentingEnabled() && $c == 'comments') {
                    $this->addColumn($this->lng->txt("ass_comments"), 'comments', '');
                }
                if (strcmp($c, 'created') == 0) {
                    $this->addColumn($this->lng->txt("create_date"), 'created', '');
                }
                if (strcmp($c, 'tstamp') == 0) {
                    $this->addColumn($this->lng->txt("last_update"), 'tstamp', '');
                }
            }
            $this->addColumn($this->lng->txt('actions'), '');
            $this->setSelectAllCheckbox('q_id');
        } else {
            $this->addColumn($this->lng->txt("title"), 'title', '');
            foreach ($this->getSelectedColumns() as $c) {
                if (strcmp($c, 'description') == 0) {
                    $this->addColumn($this->lng->txt("description"), 'description', '');
                }
                if (strcmp($c, 'type') == 0) {
                    $this->addColumn($this->lng->txt("question_type"), 'ttype', '');
                }
            }
        }

        if ($this->getWriteAccess()) {
            if ($confirmdelete) {
                $this->addCommandButton('confirmDeleteQuestions', $this->lng->txt('confirm'));
                $this->addCommandButton('cancelDeleteQuestions', $this->lng->txt('cancel'));
            } else {
                $this->addMultiCommand('copy', $this->lng->txt('copy'));
                $this->addMultiCommand('move', $this->lng->txt('move'));
                $this->addMultiCommand('exportQuestion', $this->lng->txt('export'));
                $this->addMultiCommand('deleteQuestions', $this->lng->txt('delete'));
            }
        }

        $this->setRowTemplate("tpl.il_as_qpl_questionbrowser_row.html", "components/ILIAS/TestQuestionPool");

        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");

        $this->setShowRowsSelector(true);

        if ($confirmdelete) {
            $this->disable('sort');
            $this->disable('select_all');
        } else {
            $this->enable('sort');
            $this->enable('header');
            $this->enable('select_all');
            $this->setFilterCommand('filterQuestionBrowser');
            $this->setResetCommand('resetQuestionBrowser');
            $this->initFilter();
        }
        $this->notes = $DIC->notes();
        if ($this->isQuestionCommentingEnabled()) {
            $this->notes->gui()->initJavascript();
        }
    }

    public function isQuestionCommentingEnabled(): bool
    {
        return $this->questionCommentingEnabled;
    }

    public function setQuestionCommentingEnabled(bool $questionCommentingEnabled): void
    {
        $this->questionCommentingEnabled = $questionCommentingEnabled;
    }

    protected function isCommentsColumnSelected(): bool
    {
        return in_array('comments', $this->getSelectedColumns());
    }

    public function setQuestionData($questionData): void
    {
        if ($this->isQuestionCommentingEnabled() && ($this->isCommentsColumnSelected() || $this->filter['commented'])) {
            foreach ($questionData as $key => $data) {
                $notes_context = $this->notes
                    ->data()
                    ->context(
                        $this->parent_obj->getObject()->getId(),
                        $data['question_id'],
                        'quest'
                    );
                $numComments = $this->notes
                    ->domain()
                    ->getNrOfCommentsForContext($notes_context);

                if ($this->filter['commented'] && !$numComments) {
                    unset($questionData[$key]);
                    continue;
                }

                $questionData[$key]['comments'] = $numComments;
            }
        }

        $this->setData($questionData);
    }

    public function getSelectableColumns(): array
    {
        global $DIC;
        $lng = $DIC['lng'];
        $cols["description"] = [
            "txt" => $lng->txt("description"),
            "default" => true
        ];
        $cols["type"] = [
            "txt" => $lng->txt("question_type"),
            "default" => true
        ];
        if (!$this->confirmdelete) {
            $cols["points"] = [
                "txt" => $lng->txt("points"),
                "default" => true
            ];
            $cols["statistics"] = [
                "txt" => $lng->txt("statistics"),
                "default" => true
            ];
            $cols["author"] = [
                "txt" => $lng->txt("author"),
                "default" => true
            ];
            $cols['lifecycle'] = [
                'txt' => $lng->txt('qst_lifecycle'),
                'default' => true
            ];
            if ($this->isQuestionCommentingEnabled()) {
                $cols["comments"] = [
                    "txt" => $lng->txt("comments"),
                    "default" => true
                ];
            }
            $cols["created"] = [
                "txt" => $lng->txt("create_date"),
                "default" => true
            ];
            $cols["tstamp"] = [
                "txt" => $lng->txt("last_update"),
                "default" => true
            ];
        }
        return $cols;
    }

    public function initFilter(): void
    {
        global $DIC;
        $lng = $DIC['lng'];

        $ti = new ilTextInputGUI($lng->txt("title"), "title");
        $ti->setMaxLength(64);
        $ti->setValidationRegexp('/^[^%]+$/is');
        $ti->setSize(20);
        $this->addFilterItem($ti);
        $ti->readFromSession();
        $this->filter["title"] = $ti->getValue();

        // description
        $ti = new ilTextInputGUI($lng->txt("description"), "description");
        $ti->setMaxLength(64);
        $ti->setSize(20);
        $ti->setValidationRegexp('/^[^%]+$/is');
        $this->addFilterItem($ti);
        $ti->readFromSession();
        $this->filter["description"] = $ti->getValue();

        if (!$this->confirmdelete) {
            // author
            $ti = new ilTextInputGUI($lng->txt("author"), "author");
            $ti->setMaxLength(64);
            $ti->setSize(20);
            $ti->setValidationRegexp('/^[^%]+$/is');
            $this->addFilterItem($ti);
            $ti->readFromSession();
            $this->filter["author"] = $ti->getValue();
        }

        // lifecycle
        $lifecycleOptions = array_merge(
            ['' => $this->lng->txt('qst_lifecycle_filter_all')],
            ilAssQuestionLifecycle::getDraftInstance()->getSelectOptions($this->lng)
        );
        $lifecycleInp = new ilSelectInputGUI($this->lng->txt('qst_lifecycle'), 'lifecycle');
        $lifecycleInp->setOptions($lifecycleOptions);
        $this->addFilterItem($lifecycleInp);
        $lifecycleInp->readFromSession();
        $this->filter['lifecycle'] = $lifecycleInp->getValue();

        $types = ilObjQuestionPool::_getQuestionTypes();
        $options = [];
        $options[""] = $lng->txt('filter_all_question_types');
        foreach ($types as $translation => $row) {
            $options[$row['type_tag']] = $translation;
        }

        $si = new ilSelectInputGUI($this->lng->txt("question_type"), "type");
        $si->setOptions($options);
        $this->addFilterItem($si);
        $si->readFromSession();
        $this->filter["type"] = $si->getValue();

        foreach ($this->taxIds as $taxId) {
            $postvar = "tax_$taxId";

            $inp = new ilTaxSelectInputGUI($taxId, $postvar, true);
            $this->addFilterItem($inp);
            $inp->readFromSession();
            $this->filter[$postvar] = $inp->getValue();
        }

        // comments
        if ($this->isQuestionCommentingEnabled()) {
            $comments = new ilCheckboxInputGUI($lng->txt('ass_commented_questions_only'), 'commented');
            $this->addFilterItem($comments);
            $comments->readFromSession();
            $this->filter['commented'] = $comments->getChecked();
        }
    }

    public function fillHeader(): void
    {
        foreach ($this->column as $key => $column) {
            if (strcmp($column['text'], $this->lng->txt("points")) == 0) {
                $this->column[$key]['text'] = $this->lng->txt("points") . "&nbsp;(" . $this->totalPoints . ")";
            }
        }
        parent::fillHeader();
    }

    public function fillRow(array $a_set): void
    {
        $class = strtolower($this->questionrepository->getForQuestionId($a_set['question_id'])->getGuiClassName());
        $this->ctrl->setParameterByClass("ilAssQuestionPageGUI", "q_id", $a_set["question_id"]);
        $this->ctrl->setParameterByClass("ilAssQuestionPreviewGUI", "q_id", $a_set["question_id"]);
        $this->ctrl->setParameterByClass($class, "q_id", $a_set["question_id"]);
        $points = 0;

        $actions = [];

        if (!$this->confirmdelete) {
            $this->tpl->setCurrentBlock('checkbox');
            $this->tpl->setVariable('CB_QUESTION_ID', $a_set["question_id"]);
            $this->tpl->parseCurrentBlock();

            if ($a_set["complete"] == 0) {
                $icon = $this->ui_factory->symbol()->icon()->custom(ilUtil::getImagePath("standard/icon_alert.svg"), $this->lng->txt("warning_question_not_complete"));
                $this->tpl->setCurrentBlock("qpl_warning");
                $this->tpl->setVariable("ICON_WARNING", $this->renderer->render($icon));
                $this->tpl->parseCurrentBlock();
            } else {
                $points = $a_set["points"];
            }
            $this->totalPoints += $points;

            foreach ($this->getSelectedColumns() as $c) {
                if (strcmp($c, 'points') == 0) {
                    $this->tpl->setCurrentBlock('points');
                    $this->tpl->setVariable("QUESTION_POINTS", $points);
                    $this->tpl->parseCurrentBlock();
                }
                if (strcmp($c, 'statistics') == 0) {
                    $this->tpl->setCurrentBlock('statistics');
                    $this->tpl->setVariable("LINK_ASSESSMENT", $this->ctrl->getLinkTargetByClass('ilAssQuestionPreviewGUI', ilAssQuestionPreviewGUI::CMD_STATISTICS));
                    $this->tpl->setVariable("TXT_ASSESSMENT", $this->lng->txt("statistics"));
                    $this->tpl->setVariable("IMG_ASSESSMENT", ilUtil::getImagePath("assessment.gif", "components/ILIAS/TestQuestionPool"));
                    $this->tpl->parseCurrentBlock();
                }
                if (strcmp($c, 'author') == 0) {
                    $this->tpl->setCurrentBlock('author');
                    $this->tpl->setVariable("QUESTION_AUTHOR", $a_set["author"]);
                    $this->tpl->parseCurrentBlock();
                }
                if ($c == 'lifecycle') {
                    $lifecycle = ilAssQuestionLifecycle::getInstance($a_set['lifecycle']);

                    $this->tpl->setCurrentBlock('lifecycle');
                    $this->tpl->setVariable("QUESTION_LIFECYCLE", $lifecycle->getTranslation($this->lng));
                    $this->tpl->parseCurrentBlock();
                }
                if ($c == 'comments' && $this->isQuestionCommentingEnabled()) {
                    $this->tpl->setCurrentBlock('comments');
                    $this->tpl->setVariable("COMMENTS", $this->getCommentsHtml($a_set));
                    $this->tpl->parseCurrentBlock();
                }
                if (strcmp($c, 'created') == 0) {
                    $this->tpl->setCurrentBlock('created');
                    $this->tpl->setVariable('QUESTION_CREATED', ilDatePresentation::formatDate(new ilDateTime($a_set['created'], IL_CAL_UNIX)));
                    $this->tpl->parseCurrentBlock();
                }
                if (strcmp($c, 'tstamp') == 0) {
                    $this->tpl->setCurrentBlock('updated');
                    $this->tpl->setVariable('QUESTION_UPDATED', ilDatePresentation::formatDate(new ilDateTime($a_set['tstamp'], IL_CAL_UNIX)));
                    $this->tpl->parseCurrentBlock();
                }
            }

            $actions[] = $this->ui_factory->link()->standard(
                $this->lng->txt('preview'),
                $this->ctrl->getLinkTargetByClass('ilAssQuestionPreviewGUI', ilAssQuestionPreviewGUI::CMD_SHOW)
            );

            $actions[] = $this->ui_factory->link()->standard(
                $this->lng->txt('statistics'),
                $this->ctrl->getLinkTargetByClass('ilAssQuestionPreviewGUI', ilAssQuestionPreviewGUI::CMD_STATISTICS)
            );

            if ($this->getEditable()) {
                $this->ctrl->setParameterByClass($a_set['type_tag'] . 'GUI', 'q_id', $a_set['question_id']);
                $editHref = $this->ctrl->getLinkTargetByClass($a_set['type_tag'] . 'GUI', 'editQuestion');
                $this->ctrl->setParameterByClass($a_set['type_tag'] . 'GUI', 'q_id', null);
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('edit_question'), $editHref);

                $editPageHref = $this->ctrl->getLinkTargetByClass('ilAssQuestionPageGUI', 'edit');
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('edit_page'), $editPageHref);
            }

            if ($this->getWriteAccess()) {
                $this->ctrl->setParameter($this->parent_obj, 'q_id', $a_set['question_id']);
                $moveHref = $this->ctrl->getLinkTarget($this->parent_obj, 'move');
                $this->ctrl->setParameter($this->parent_obj, 'q_id', null);
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('move'), $moveHref);

                $this->ctrl->setParameter($this->parent_obj, 'q_id', $a_set['question_id']);
                $copyHref = $this->ctrl->getLinkTarget($this->parent_obj, 'copy');
                $this->ctrl->setParameter($this->parent_obj, 'q_id', null);
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('copy'), $copyHref);

                $this->ctrl->setParameter($this->parent_obj, 'q_id', $a_set['question_id']);
                $deleteHref = $this->ctrl->getLinkTarget($this->parent_obj, 'deleteQuestions');
                $this->ctrl->setParameter($this->parent_obj, 'q_id', null);
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('delete'), $deleteHref);
            }

            if ($this->getEditable()) {
                $this->ctrl->setParameterByClass('ilAssQuestionFeedbackEditingGUI', 'q_id', $a_set['question_id']);
                $feedbackHref = $this->ctrl->getLinkTargetByClass('ilAssQuestionFeedbackEditingGUI', ilAssQuestionFeedbackEditingGUI::CMD_SHOW);
                $this->ctrl->setParameterByClass('ilAssQuestionFeedbackEditingGUI', 'q_id', null);
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('tst_feedback'), $feedbackHref);

                $this->ctrl->setParameterByClass('ilAssQuestionHintsGUI', 'q_id', $a_set['question_id']);
                $hintsHref = $this->ctrl->getLinkTargetByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST);
                $this->ctrl->setParameterByClass('ilAssQuestionHintsGUI', 'q_id', null);
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('tst_question_hints_tab'), $hintsHref);
            }

            if ($this->isQuestionCommentingEnabled()) {
                $actions[] = $this->ui_factory->link()->standard($this->lng->txt('ass_comments'), $this->getCommentsAjaxLink($a_set['question_id']));
            }
        } else {
            $this->tpl->setCurrentBlock('hidden');
            $this->tpl->setVariable('HIDDEN_QUESTION_ID', $a_set["question_id"]);
            $this->tpl->parseCurrentBlock();
        }

        foreach ($this->getSelectedColumns() as $c) {
            if (strcmp($c, 'description') == 0) {
                $this->tpl->setCurrentBlock('description');
                $this->tpl->setVariable("QUESTION_COMMENT", $a_set['description']);
                $this->tpl->parseCurrentBlock();
            }
            if (strcmp($c, 'type') == 0) {
                $this->tpl->setCurrentBlock('type');
                $this->tpl->setVariable("QUESTION_TYPE", $this->questionrepository->getForQuestionId($a_set["question_id"])->getTypeName($this->lng));
                $this->tpl->parseCurrentBlock();
            }
        }
        $this->tpl->setVariable('QUESTION_ID', $a_set["question_id"]);
        if (!$this->confirmdelete) {
            $this->tpl->setVariable('QUESTION_HREF_LINKED', $this->ctrl->getLinkTargetByClass('ilAssQuestionPreviewGUI', ilAssQuestionPreviewGUI::CMD_SHOW));
            $this->tpl->setVariable('QUESTION_TITLE_LINKED', $a_set['title']);

            $dropdown = $this->ui_factory->dropdown()->standard($actions)->withLabel($this->lng->txt('actions'));

            $this->tpl->setVariable('ACTIONS', $this->renderer->render($dropdown));
        } else {
            $this->tpl->setVariable('QUESTION_ID_UNLINKED', $a_set['question_id']);
            $this->tpl->setVariable('QUESTION_TITLE_UNLINKED', $a_set['title']);
        }
    }

    public function setEditable($value): void
    {
        $this->editable = $value;
    }

    public function getEditable(): bool
    {
        return $this->editable;
    }

    public function setWriteAccess($value): void
    {
        $this->writeAccess = $value;
    }

    public function getWriteAccess(): bool
    {
        return $this->writeAccess;
    }

    public function numericOrdering(string $a_field): bool
    {
        if (in_array($a_field, ['points', 'created', 'tstamp', 'comments'])) {
            return true;
        }

        return false;
    }

    protected function getCommentsHtml($qData): string
    {
        if (!$qData['comments']) {
            return '';
        }

        $ajax_link = $this->getCommentsAjaxLink($qData['question_id']);

        $comment_glyph = $this->ui_factory->symbol()->glyph()->comment()->withCounter(
            $this->ui_factory->counter()->status($qData['comments'])
        )->withAdditionalOnLoadCode(function ($id) use ($ajax_link): string {
            return "document.getElementById('$id').onclick = function (event) { $ajax_link; };";
        });
        return $this->renderer->render($comment_glyph);
    }

    protected function getCommentsAjaxLink($questionId): string
    {
        $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(1, $this->request->getRefId(), 'quest', $this->parent_obj->getObject()->getId(), 'quest', $questionId);
        $update_code = "il.UI.counter.getCounterObject($(\".ilTableOuter\")).incrementStatusCount(1);";
        return ilCommentGUI::getListCommentsJSCall($ajax_hash, $update_code);
    }
}