class.ilTestNavigationToolbarGUI.php

Go to the documentation of this file.

<?php

require_once 'Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
require_once 'Modules/Test/classes/class.ilTestPlayerNavButton.php';

class ilTestNavigationToolbarGUI extends ilToolbarGUI
{
    protected $ctrl;

    protected $playerGUI;

    private $suspendTestButtonEnabled = false;

    private $questionListButtonEnabled = false;

    private $questionTreeButtonEnabled = false;

    private bool $questionTreeVisible = false;

    private $questionSelectionButtonEnabled = false;

    private $finishTestButtonEnabled = false;

    private $finishTestCommand = '';

    private $finishTestButtonPrimary = false;

    private $disabledStateEnabled = false;

    public function __construct(ilCtrl $ctrl, ilLanguage $lng, ilTestPlayerAbstractGUI $playerGUI)
    {
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->playerGUI = $playerGUI;

        parent::__construct();
    }

    public function isSuspendTestButtonEnabled(): bool
    {
        return $this->suspendTestButtonEnabled;
    }

    public function setSuspendTestButtonEnabled($suspendTestButtonEnabled)
    {
        $this->suspendTestButtonEnabled = $suspendTestButtonEnabled;
    }

    public function isQuestionListButtonEnabled(): bool
    {
        return $this->questionListButtonEnabled;
    }

    public function setQuestionListButtonEnabled($questionListButtonEnabled)
    {
        $this->questionListButtonEnabled = $questionListButtonEnabled;
    }

    public function isQuestionTreeButtonEnabled(): bool
    {
        return $this->questionTreeButtonEnabled;
    }

    public function setQuestionTreeButtonEnabled($questionTreeButtonEnabled)
    {
        $this->questionTreeButtonEnabled = $questionTreeButtonEnabled;
    }

    public function isQuestionTreeVisible(): bool
    {
        return $this->questionTreeVisible;
    }

    public function setQuestionTreeVisible(bool $questionTreeVisible): void
    {
        $this->questionTreeVisible = $questionTreeVisible;
    }

    public function isQuestionSelectionButtonEnabled(): bool
    {
        return $this->questionSelectionButtonEnabled;
    }

    public function setQuestionSelectionButtonEnabled($questionSelectionButtonEnabled)
    {
        $this->questionSelectionButtonEnabled = $questionSelectionButtonEnabled;
    }

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

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

    public function getFinishTestCommand(): string
    {
        return $this->finishTestCommand;
    }

    public function setFinishTestCommand($finishTestCommand)
    {
        $this->finishTestCommand = $finishTestCommand;
    }

    public function isFinishTestButtonPrimary(): bool
    {
        return $this->finishTestButtonPrimary;
    }

    public function setFinishTestButtonPrimary($finishTestButtonPrimary)
    {
        $this->finishTestButtonPrimary = $finishTestButtonPrimary;
    }

    public function isDisabledStateEnabled(): bool
    {
        return $this->disabledStateEnabled;
    }

    public function setDisabledStateEnabled($disabledStateEnabled)
    {
        $this->disabledStateEnabled = $disabledStateEnabled;
    }

    public function build()
    {
        if ($this->isQuestionTreeButtonEnabled()) {
            $this->addQuestionTreeButton();
        }

        if ($this->isQuestionListButtonEnabled()) {
            $this->addQuestionListButton();
        }

        if ($this->isQuestionSelectionButtonEnabled()) {
            $this->addQuestionSelectionButton();
        }

        if ($this->isSuspendTestButtonEnabled()) {
            $this->addSuspendTestButton();
        }

        if ($this->isFinishTestButtonEnabled()) {
            $this->addFinishTestButton();
        }
    }

    private function addSuspendTestButton()
    {
        $btn = ilTestPlayerNavButton::getInstance();
        $btn->setNextCommand(ilTestPlayerCommands::SUSPEND_TEST);
        $btn->setUrl($this->ctrl->getLinkTarget(
            $this->playerGUI,
            ilTestPlayerCommands::SUSPEND_TEST
        ));
        $btn->setCaption('cancel_test');
        //$btn->setDisabled($this->isDisabledStateEnabled());
        $btn->addCSSClass('ilTstNavElem');
        $this->addButtonInstance($btn);
    }

    private function addQuestionListButton()
    {
        $btn = ilTestPlayerNavButton::getInstance();
        $btn->setNextCommand(ilTestPlayerCommands::QUESTION_SUMMARY);
        $btn->setUrl($this->ctrl->getLinkTarget(
            $this->playerGUI,
            ilTestPlayerCommands::QUESTION_SUMMARY
        ));
        $btn->setCaption('question_summary_btn');
        //$btn->setDisabled($this->isDisabledStateEnabled());
        $btn->addCSSClass('ilTstNavElem');
        $this->addButtonInstance($btn);
    }

    private function addQuestionSelectionButton()
    {
        $btn = ilTestPlayerNavButton::getInstance();
        $btn->setNextCommand(ilTestPlayerCommands::SHOW_QUESTION_SELECTION);
        $btn->setUrl($this->ctrl->getLinkTarget(
            $this->playerGUI,
            ilTestPlayerCommands::SHOW_QUESTION_SELECTION
        ));
        $btn->setCaption('tst_change_dyn_test_question_selection');
        //$btn->setDisabled($this->isDisabledStateEnabled());
        $btn->addCSSClass('ilTstNavElem');
        $this->addButtonInstance($btn);
    }

    private function addQuestionTreeButton()
    {
        $btn = ilTestPlayerNavButton::getInstance();
        $btn->setNextCommand(ilTestPlayerCommands::TOGGLE_SIDE_LIST);
        $btn->setUrl($this->ctrl->getLinkTarget(
            $this->playerGUI,
            ilTestPlayerCommands::TOGGLE_SIDE_LIST
        ));
        if ($this->isQuestionTreeVisible()) {
            $btn->setCaption('tst_hide_side_list');
        } else {
            $btn->setCaption('tst_show_side_list');
        }
        //$btn->setDisabled($this->isDisabledStateEnabled());
        $btn->addCSSClass('ilTstNavElem');
        $this->addButtonInstance($btn);
    }

    private function addFinishTestButton()
    {
        $btn = ilTestPlayerNavButton::getInstance();
        $btn->setNextCommand($this->getFinishTestCommand());
        $btn->setUrl($this->ctrl->getLinkTarget(
            $this->playerGUI,
            $this->getFinishTestCommand()
        ));
        $btn->setCaption('finish_test');
        //$btn->setDisabled($this->isDisabledStateEnabled());
        $btn->setPrimary($this->isFinishTestButtonPrimary());
        $btn->addCSSClass('ilTstNavElem');
        $this->addButtonInstance($btn);
    }
}