class.ilListOfQuestionsTableGUI.php

Go to the documentation of this file.

<?php

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;

class ilListOfQuestionsTableGUI extends ilTable2GUI
{
    protected ?bool $showPointsEnabled = false;
    protected ?bool $showMarkerEnabled = false;

    protected ?bool $showObligationsEnabled = false;
    protected ?bool $obligationsFilterEnabled = false;

    protected ?bool $obligationsNotAnswered = false;

    protected ?bool $finishTestButtonEnabled = false;
    protected UIFactory $ui_factory;
    protected UIRenderer $ui_renderer;

    public function __construct($a_parent_obj, $a_parent_cmd)
    {
        parent::__construct($a_parent_obj, $a_parent_cmd);

        global $DIC;
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];

        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];

        $this->setFormName('listofquestions');
        $this->setStyle('table', 'fullwidth');

        $this->setRowTemplate("tpl.il_as_tst_list_of_questions_row.html", "Modules/Test");

        $this->setLimit(999);

        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));

        $this->enable('header');
        $this->disable('sort');
        $this->disable('select_all');
    }

    public function init(): void
    {
        // table title

        if ($this->isObligationsFilterEnabled()) {
            $this->setTitle($this->lng->txt('obligations_summary'));
        } else {
            $this->setTitle($this->lng->txt('question_summary'));
        }

        // columns

        $this->addColumn($this->lng->txt("tst_qst_order"), 'order', '');
        $this->addColumn($this->lng->txt("tst_question_title"), 'title', '');

        if ($this->isShowObligationsEnabled()) {
            $this->addColumn($this->lng->txt("obligatory"), 'obligatory', '');
        }

        $this->addColumn('', 'postponed', '');

        if ($this->isShowPointsEnabled()) {
            $this->addColumn($this->lng->txt("tst_maximum_points"), 'points', '');
        }

        #$this->addColumn($this->lng->txt("worked_through"),'worked_through', '');
        $this->addColumn($this->lng->txt("answered"), 'answered', '');

        if (false && $this->isShowObligationsEnabled()) {
            $this->addColumn($this->lng->txt("answered"), 'answered', '');
        }

        if ($this->isShowMarkerEnabled()) {
            $this->addColumn($this->lng->txt("tst_question_marker"), 'marked', '');
        }

        // command buttons

        $this->addCommandButton(
            ilTestPlayerCommands::SHOW_QUESTION,
            $this->lng->txt('tst_resume_test')
        );

        if (!$this->areObligationsNotAnswered() && $this->isFinishTestButtonEnabled()) {
            $button = ilSubmitButton::getInstance();
            $button->setCaption('finish_test');
            $button->setCommand(ilTestPlayerCommands::FINISH_TEST);
            $this->addCommandButtonInstance($button);
        }
    }

    public function fillRow(array $a_set): void
    {
        if ($this->isShowPointsEnabled()) {
            $this->tpl->setCurrentBlock('points');
            $this->tpl->setVariable("POINTS", $a_set['points'] . '&nbsp;' . $this->lng->txt("points_short"));
            $this->tpl->parseCurrentBlock();
        }
        if (strlen($a_set['description'])) {
            $this->tpl->setCurrentBlock('description');
            $this->tpl->setVariable("DESCRIPTION", ilLegacyFormElementsUtil::prepareFormOutput($a_set['description']));
            $this->tpl->parseCurrentBlock();
        }
        if ($this->isShowMarkerEnabled()) {
            if ($a_set['marked']) {
                $this->tpl->setCurrentBlock('marked_img');
                $this->tpl->setVariable(
                    "HREF_MARKED",
                    ilUtil::img(
                        ilUtil::getImagePath('marked.svg'),
                        $this->lng->txt("tst_question_marked"),
                        '24px',
                        '24px'
                    )
                );
                $this->tpl->parseCurrentBlock();
            } else {
                $this->tpl->touchBlock('marker');
            }
        }
        if ($this->isShowObligationsEnabled()) {
            // obligatory answer status
            if (false) {
                $value = '&nbsp;';
                if ($a_set['isAnswered']) {
                    $value = $this->lng->txt("yes");
                }
                $this->tpl->setCurrentBlock('answered_col');
                $this->tpl->setVariable('ANSWERED', $value);
                $this->tpl->parseCurrentBlock();
            }

            // obligatory icon
            if ($a_set["obligatory"]) {
                $icon = $this->ui_factory->symbol()->icon()->custom(
                    ilUtil::getImagePath("icon_checked.svg"),
                    $this->lng->txt('question_obligatory')

                );
                $OBLIGATORY = $this->ui_renderer->render($icon);
            } else {
                $OBLIGATORY = '';
            }
            $this->tpl->setVariable("QUESTION_OBLIGATORY", $OBLIGATORY);
        }

        $postponed = (
            $a_set['postponed'] ? $this->lng->txt('postponed') : ''
        );

        if ($a_set['disabled']) {
            $this->tpl->setCurrentBlock('static_title');
            $this->tpl->setVariable("STATIC_TITLE", ilLegacyFormElementsUtil::prepareFormOutput($a_set['title']));
            $this->tpl->parseCurrentBlock();
        } else {
            $this->ctrl->setParameter($this->parent_obj, 'sequence', $a_set['sequence']);
            $this->ctrl->setParameter($this->parent_obj, 'pmode', '');
            $href = $this->ctrl->getLinkTarget($this->parent_obj, ilTestPlayerCommands::SHOW_QUESTION);

            $this->tpl->setCurrentBlock('linked_title');
            $this->tpl->setVariable("LINKED_TITLE", ilLegacyFormElementsUtil::prepareFormOutput($a_set['title']));
            $this->tpl->setVariable("HREF", $href);
            $this->tpl->parseCurrentBlock();
        }

        $this->tpl->setVariable("ORDER", $a_set['order']);
        $this->tpl->setVariable("POSTPONED", $postponed);
        if ($a_set["worked_through"]) {
            $this->tpl->setVariable("WORKED_THROUGH", $this->lng->txt("yes"));
        } else {
            $this->tpl->setVariable("WORKED_THROUGH", '&nbsp;');
        }
    }

    public function isShowPointsEnabled(): bool
    {
        return $this->showPointsEnabled;
    }

    public function setShowPointsEnabled($showPointsEnabled): void
    {
        $this->showPointsEnabled = $showPointsEnabled;
    }

    public function isShowMarkerEnabled(): bool
    {
        return $this->showMarkerEnabled;
    }

    public function setShowMarkerEnabled($showMarkerEnabled): void
    {
        $this->showMarkerEnabled = $showMarkerEnabled;
    }

    public function isShowObligationsEnabled(): bool
    {
        return $this->showObligationsEnabled;
    }

    public function setShowObligationsEnabled($showObligationsEnabled): void
    {
        $this->showObligationsEnabled = $showObligationsEnabled;
    }

    public function isObligationsFilterEnabled(): bool
    {
        return $this->obligationsFilterEnabled;
    }

    public function setObligationsFilterEnabled($obligationsFilterEnabled): void
    {
        $this->obligationsFilterEnabled = $obligationsFilterEnabled;
    }

    public function areObligationsNotAnswered(): bool
    {
        return $this->obligationsNotAnswered;
    }

    public function setObligationsNotAnswered($obligationsNotAnswered): void
    {
        $this->obligationsNotAnswered = $obligationsNotAnswered;
    }

    public function isFinishTestButtonEnabled(): bool
    {
        return $this->finishTestButtonEnabled;
    }

    public function setFinishTestButtonEnabled(bool $finishTestButtonEnabled): void
    {
        $this->finishTestButtonEnabled = $finishTestButtonEnabled;
    }
}