Inheritance diagram for ilTestNavigationToolbarGUI:

Collaboration diagram for ilTestNavigationToolbarGUI:

Public Member Functions
	__construct (protected ilCtrl $ctrl, protected ilTestPlayerAbstractGUI $player_gui)

	isSuspendTestButtonEnabled ()

	setSuspendTestButtonEnabled ($suspendTestButtonEnabled)

	isUserPassOverviewEnabled ()

	setUserPassOverviewEnabled (bool $user_pass_overview_button_enabled)

	isQuestionTreeVisible ()

	setQuestionTreeVisible (bool $questionTreeVisible)

	isFinishTestButtonEnabled ()

	setFinishTestButtonEnabled ($finishTestButtonEnabled)

	getFinishTestCommand ()

	setFinishTestCommand ($finishTestCommand)

	isFinishTestButtonPrimary ()

	setFinishTestButtonPrimary ($finishTestButtonPrimary)

	isDisabledStateEnabled ()

	setDisabledStateEnabled ($disabledStateEnabled)

	build ()

Public Member Functions inherited from ilToolbarGUI
	setFormAction (string $a_val, bool $a_multipart=false, string $a_target="")
	Set form action (if form action is set, toolbar is wrapped into form tags) More...

	getFormAction ()

	setLeadingImage (string $a_img, string $a_alt)

	setHidden (bool $a_val)

	getHidden ()

	setId (string $a_val)

	getId ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	addButton (string $a_txt, string $a_cmd, string $a_target="", ?int $a_acc_key=null, string $a_additional_attrs='', string $a_id="", string $a_class='submit')

	addFormButton (string $a_txt, string $a_cmd, ?int $a_acc_key=null, bool $a_primary=false, ?string $a_class=null)

	addInputItem (ilToolbarItem $a_item, bool $a_output_label=false)

	addStickyItem ( $a_item, bool $a_output_label=false)
	Add a sticky item. More...

	addButtonInstance (ilButtonBase $a_button)
	Add button instance. More...

	addDropDown (string $a_txt, string $a_dd_html)

	addAdvancedSelectionList (ilAdvancedSelectionListGUI $adv)

	addSeparator ()

	addText (string $a_text)

	addSpacer (string $a_width=null)

	addComponent (\ILIAS\UI\Component\Component $a_comp)

	addLink (string $a_caption, string $a_url, bool $a_disabled=false)

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	setFormName (string $a_val)

	getFormName ()

	getGroupedItems ()
	Get all groups (items separated by a separator) More...

	getItems ()

	setItems (array $items)

Protected Attributes
InterruptiveModal	$finish_test_modal = null

bool	$user_pass_overview_button_enabled = false

Protected Attributes inherited from ilToolbarGUI
ilLanguage	$lng

string	$id = ''

string	$form_action = ''

bool	$hidden = false

array	$lead_img

bool	$open_form_tag = true

bool	$close_form_tag = true

string	$form_target = ""

string	$form_name = ""

bool	$prevent_double_submission = false

array	$sticky_items = array()

bool	$has_separator = false

ILIAS DI UIServices	$ui

bool	$multipart = false

Private Member Functions
	addSuspendTestButton ()

	addPassOverviewButton ()

	retrieveFinishTestButton ()

	getStandardOrPrimaryFinishButtonInstance ()

	buildCheckNavigationClosure (string $target)

Private Attributes
bool	$suspendTestButtonEnabled = false

bool	$questionTreeVisible = false

bool	$questionSelectionButtonEnabled = false

bool	$finishTestButtonEnabled = false

string	$finishTestCommand = ''

bool	$finishTestButtonPrimary = false

bool	$disabledStateEnabled = false

Additional Inherited Members
Data Fields inherited from ilToolbarGUI
array	$items = array()

Protected Member Functions inherited from ilToolbarGUI
	applyAutoStickyToSingleElement ()
	If the toolbar consists of only one button, make it sticky Note: Atm this is only possible for buttons. More...

Static Protected Attributes inherited from ilToolbarGUI
static int	$instances = 0

Detailed Description

Definition at line 30 of file class.ilTestNavigationToolbarGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestNavigationToolbarGUI::__construct	(	protected ilCtrl	$ctrl,
		protected ilTestPlayerAbstractGUI	$player_gui
	)

Definition at line 42 of file class.ilTestNavigationToolbarGUI.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct().

       {
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addPassOverviewButton()

ilTestNavigationToolbarGUI::addPassOverviewButton ( )

private

Definition at line 187 of file class.ilTestNavigationToolbarGUI.php.

References ilToolbarGUI\addComponent(), buildCheckNavigationClosure(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTestPlayerCommands\QUESTION_SUMMARY, and ILIAS\Repository\ui().

Referenced by build().

     {
         $button = $this->ui->factory()->button()->standard(
             $this->lng->txt('question_summary_btn'),
             ''
         )->withUnavailableAction(true)->withAdditionalOnLoadCode(
             $this->buildCheckNavigationClosure(
                 $this->ctrl->getLinkTarget($this->player_gui, ilTestPlayerCommands::QUESTION_SUMMARY)
             )
         );
 
         $this->addComponent($button);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSuspendTestButton()

ilTestNavigationToolbarGUI::addSuspendTestButton ( )

private

Definition at line 173 of file class.ilTestNavigationToolbarGUI.php.

References ilToolbarGUI\addComponent(), buildCheckNavigationClosure(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTestPlayerCommands\SUSPEND_TEST, and ILIAS\Repository\ui().

Referenced by build().

     {
         $button = $this->ui->factory()->button()->standard(
             $this->lng->txt('cancel_test'),
             ''
         )->withUnavailableAction(true)->withAdditionalOnLoadCode(
             $this->buildCheckNavigationClosure(
                 $this->ctrl->getLinkTarget($this->player_gui, ilTestPlayerCommands::SUSPEND_TEST)
             )
         );
 
         $this->addComponent($button);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build()

ilTestNavigationToolbarGUI::build ( )

Definition at line 158 of file class.ilTestNavigationToolbarGUI.php.

References addPassOverviewButton(), ilToolbarGUI\addStickyItem(), addSuspendTestButton(), isFinishTestButtonEnabled(), isSuspendTestButtonEnabled(), isUserPassOverviewEnabled(), and retrieveFinishTestButton().

     {
         if ($this->isUserPassOverviewEnabled()) {
             $this->addPassOverviewButton();
         }
 
         if ($this->isSuspendTestButtonEnabled()) {
             $this->addSuspendTestButton();
         }
 
         if ($this->isFinishTestButtonEnabled()) {
             $this->addStickyItem($this->retrieveFinishTestButton());
         }
     }

Here is the call graph for this function:

◆ buildCheckNavigationClosure()

ilTestNavigationToolbarGUI::buildCheckNavigationClosure ( string $target )

private

Definition at line 224 of file class.ilTestNavigationToolbarGUI.php.

References ilToolbarGUI\$id.

Referenced by addPassOverviewButton(), addSuspendTestButton(), and retrieveFinishTestButton().

                                                                 : Closure
     {
         return static function (string $id) use ($target): string {
             return "document.getElementById('{$id}').addEventListener('click', "
                 . '(e) => {'
                 . " il.TestPlayerQuestionEditControl.checkNavigation('{$target}', 'show', e);"
                 . '}); '
                 . "document.getElementById('{$id}').removeAttribute('disabled');";
         };
     }

Here is the caller graph for this function:

◆ getFinishTestCommand()

ilTestNavigationToolbarGUI::getFinishTestCommand ( )

Returns: string

Definition at line 113 of file class.ilTestNavigationToolbarGUI.php.

References $finishTestCommand.

Referenced by retrieveFinishTestButton().

                                           : string
     {
         return $this->finishTestCommand;
     }

Here is the caller graph for this function:

◆ getStandardOrPrimaryFinishButtonInstance()

ilTestNavigationToolbarGUI::getStandardOrPrimaryFinishButtonInstance ( )

private

Definition at line 215 of file class.ilTestNavigationToolbarGUI.php.

References isFinishTestButtonPrimary(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by retrieveFinishTestButton().

                                                                : Button
     {
         if ($this->isFinishTestButtonPrimary()) {
             return $this->ui->factory()->button()->primary($this->lng->txt('finish_test'), '');
         }
 
         return $this->ui->factory()->button()->standard($this->lng->txt('finish_test'), '');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDisabledStateEnabled()

ilTestNavigationToolbarGUI::isDisabledStateEnabled ( )

Returns: boolean

Definition at line 145 of file class.ilTestNavigationToolbarGUI.php.

References $disabledStateEnabled.

                                             : bool
     {
         return $this->disabledStateEnabled;
     }

◆ isFinishTestButtonEnabled()

ilTestNavigationToolbarGUI::isFinishTestButtonEnabled ( )

Returns: boolean

Definition at line 97 of file class.ilTestNavigationToolbarGUI.php.

References $finishTestButtonEnabled.

Referenced by build().

                                                : bool
     {
         return $this->finishTestButtonEnabled;
     }

Here is the caller graph for this function:

◆ isFinishTestButtonPrimary()

ilTestNavigationToolbarGUI::isFinishTestButtonPrimary ( )

Returns: boolean

Definition at line 129 of file class.ilTestNavigationToolbarGUI.php.

References $finishTestButtonPrimary.

Referenced by getStandardOrPrimaryFinishButtonInstance().

                                                : bool
     {
         return $this->finishTestButtonPrimary;
     }

Here is the caller graph for this function:

◆ isQuestionTreeVisible()

ilTestNavigationToolbarGUI::isQuestionTreeVisible ( )

Returns: boolean

Definition at line 84 of file class.ilTestNavigationToolbarGUI.php.

References $questionTreeVisible.

                                            : bool
     {
         return $this->questionTreeVisible;
     }

◆ isSuspendTestButtonEnabled()

ilTestNavigationToolbarGUI::isSuspendTestButtonEnabled ( )

Returns: boolean

Definition at line 52 of file class.ilTestNavigationToolbarGUI.php.

References $suspendTestButtonEnabled.

Referenced by build().

                                                 : bool
     {
         return $this->suspendTestButtonEnabled;
     }

Here is the caller graph for this function:

◆ isUserPassOverviewEnabled()

ilTestNavigationToolbarGUI::isUserPassOverviewEnabled ( )

Returns: boolean

Definition at line 68 of file class.ilTestNavigationToolbarGUI.php.

References $user_pass_overview_button_enabled.

Referenced by build().

                                                : bool
     {
         return $this->user_pass_overview_button_enabled;
     }

Here is the caller graph for this function:

◆ retrieveFinishTestButton()

ilTestNavigationToolbarGUI::retrieveFinishTestButton ( )

private

Definition at line 201 of file class.ilTestNavigationToolbarGUI.php.

References buildCheckNavigationClosure(), ILIAS\Repository\ctrl(), getFinishTestCommand(), getStandardOrPrimaryFinishButtonInstance(), and ilTestPlayerCommands\QUESTION_SUMMARY.

Referenced by build().

                                                : Button
     {
         $target = $this->ctrl->getLinkTarget($this->player_gui, $this->getFinishTestCommand());
         if ($this->player_gui->getObject()->getMainSettings()->getFinishingSettings()->getShowAnswerOverview()
             && $this->getFinishTestCommand() !== ilTestPlayerCommands::QUESTION_SUMMARY) {
             $target = $this->ctrl->getLinkTargetByClass('ilTestSubmissionReviewGUI', 'show');
         }
 
         $button = $this->getStandardOrPrimaryFinishButtonInstance();
         return $button->withUnavailableAction(true)->withAdditionalOnLoadCode(
             $this->buildCheckNavigationClosure($target)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDisabledStateEnabled()

ilTestNavigationToolbarGUI::setDisabledStateEnabled ( $disabledStateEnabled )

Parameters

boolean $disabledStateEnabled

Definition at line 153 of file class.ilTestNavigationToolbarGUI.php.

References $disabledStateEnabled.

     {
         $this->disabledStateEnabled = $disabledStateEnabled;
     }

◆ setFinishTestButtonEnabled()

ilTestNavigationToolbarGUI::setFinishTestButtonEnabled ( $finishTestButtonEnabled )

Parameters

boolean $finishTestButtonEnabled

Definition at line 105 of file class.ilTestNavigationToolbarGUI.php.

References $finishTestButtonEnabled.

     {
         $this->finishTestButtonEnabled = $finishTestButtonEnabled;
     }

◆ setFinishTestButtonPrimary()

ilTestNavigationToolbarGUI::setFinishTestButtonPrimary ( $finishTestButtonPrimary )

Parameters

boolean $finishTestButtonPrimary

Definition at line 137 of file class.ilTestNavigationToolbarGUI.php.

References $finishTestButtonPrimary.

Referenced by ilTestOutputGUI\handlePrimaryButton().

     {
         $this->finishTestButtonPrimary = $finishTestButtonPrimary;
     }

Here is the caller graph for this function:

◆ setFinishTestCommand()

ilTestNavigationToolbarGUI::setFinishTestCommand ( $finishTestCommand )

Parameters

string $finishTestCommand

Definition at line 121 of file class.ilTestNavigationToolbarGUI.php.

References $finishTestCommand.

     {
         $this->finishTestCommand = $finishTestCommand;
     }

◆ setQuestionTreeVisible()

ilTestNavigationToolbarGUI::setQuestionTreeVisible ( bool $questionTreeVisible )

Definition at line 89 of file class.ilTestNavigationToolbarGUI.php.

References $questionTreeVisible.

                                                                      : void
     {
         $this->questionTreeVisible = $questionTreeVisible;
     }

◆ setSuspendTestButtonEnabled()

ilTestNavigationToolbarGUI::setSuspendTestButtonEnabled ( $suspendTestButtonEnabled )

Parameters

boolean $suspendTestButtonEnabled

Definition at line 60 of file class.ilTestNavigationToolbarGUI.php.

References $suspendTestButtonEnabled.

     {
         $this->suspendTestButtonEnabled = $suspendTestButtonEnabled;
     }

◆ setUserPassOverviewEnabled()

ilTestNavigationToolbarGUI::setUserPassOverviewEnabled ( bool $user_pass_overview_button_enabled )

Parameters

boolean $questionListButtonEnabled

Definition at line 76 of file class.ilTestNavigationToolbarGUI.php.

References $user_pass_overview_button_enabled.

     {
         $this->user_pass_overview_button_enabled = $user_pass_overview_button_enabled;
     }

Field Documentation

◆ $disabledStateEnabled

bool ilTestNavigationToolbarGUI::$disabledStateEnabled = false

private

Definition at line 38 of file class.ilTestNavigationToolbarGUI.php.

Referenced by isDisabledStateEnabled(), and setDisabledStateEnabled().

◆ $finish_test_modal

InterruptiveModal ilTestNavigationToolbarGUI::$finish_test_modal = null

protected

Definition at line 39 of file class.ilTestNavigationToolbarGUI.php.

◆ $finishTestButtonEnabled

bool ilTestNavigationToolbarGUI::$finishTestButtonEnabled = false

private

Definition at line 35 of file class.ilTestNavigationToolbarGUI.php.

Referenced by isFinishTestButtonEnabled(), and setFinishTestButtonEnabled().

◆ $finishTestButtonPrimary

bool ilTestNavigationToolbarGUI::$finishTestButtonPrimary = false

private

Definition at line 37 of file class.ilTestNavigationToolbarGUI.php.

Referenced by isFinishTestButtonPrimary(), and setFinishTestButtonPrimary().

◆ $finishTestCommand

string ilTestNavigationToolbarGUI::$finishTestCommand = ''

private

Definition at line 36 of file class.ilTestNavigationToolbarGUI.php.

Referenced by getFinishTestCommand(), and setFinishTestCommand().

◆ $questionSelectionButtonEnabled

bool ilTestNavigationToolbarGUI::$questionSelectionButtonEnabled = false

private

Definition at line 34 of file class.ilTestNavigationToolbarGUI.php.

◆ $questionTreeVisible

bool ilTestNavigationToolbarGUI::$questionTreeVisible = false

private

Definition at line 33 of file class.ilTestNavigationToolbarGUI.php.

Referenced by isQuestionTreeVisible(), and setQuestionTreeVisible().

◆ $suspendTestButtonEnabled

bool ilTestNavigationToolbarGUI::$suspendTestButtonEnabled = false

private

Definition at line 32 of file class.ilTestNavigationToolbarGUI.php.

Referenced by isSuspendTestButtonEnabled(), and setSuspendTestButtonEnabled().

◆ $user_pass_overview_button_enabled

bool ilTestNavigationToolbarGUI::$user_pass_overview_button_enabled = false

protected

Definition at line 40 of file class.ilTestNavigationToolbarGUI.php.

Referenced by isUserPassOverviewEnabled(), and setUserPassOverviewEnabled().

The documentation for this class was generated from the following file:

Modules/Test/classes/toolbars/class.ilTestNavigationToolbarGUI.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPassOverviewButton()

◆ addSuspendTestButton()

◆ build()

◆ buildCheckNavigationClosure()

◆ getFinishTestCommand()

◆ getStandardOrPrimaryFinishButtonInstance()

◆ isDisabledStateEnabled()

◆ isFinishTestButtonEnabled()

◆ isFinishTestButtonPrimary()

◆ isQuestionTreeVisible()

◆ isSuspendTestButtonEnabled()

◆ isUserPassOverviewEnabled()

◆ retrieveFinishTestButton()

◆ setDisabledStateEnabled()

◆ setFinishTestButtonEnabled()

◆ setFinishTestButtonPrimary()

◆ setFinishTestCommand()

◆ setQuestionTreeVisible()

◆ setSuspendTestButtonEnabled()

◆ setUserPassOverviewEnabled()

Field Documentation

◆ $disabledStateEnabled

◆ $finish_test_modal

◆ $finishTestButtonEnabled

◆ $finishTestButtonPrimary

◆ $finishTestCommand

◆ $questionSelectionButtonEnabled

◆ $questionTreeVisible

◆ $suspendTestButtonEnabled

◆ $user_pass_overview_button_enabled