Collaboration diagram for ilTestQuestionNavigationGUI:

Public Member Functions
	__construct (protected ilLanguage $lng, protected UIFactory $ui_factory, protected UIRenderer $ui_renderer)

	setEditSolutionCommand (string $edit_solution_command)

	setQuestionWorkedThrough (bool $question_worked_through)

	setRevertChangesLinkTarget (string $revert_changes_link_target)

	setDiscardSolutionButtonEnabled (bool $discard_solution_button_enabled)

	setSkipQuestionLinkTarget (string $skip_question_link_target)

	setInstantFeedbackCommand (string $instant_feedback_command)

	setForceInstantResponseEnabled (bool $force_instant_response_enabled)

	setAnswerFreezingEnabled (bool $answer_freezing_enabled)

	setRequestHintCommand (string $request_hint_command)

	setShowHintsCommand (string $show_hints_command)

	setHintRequestsExist (bool $hint_requests_exist)

	setQuestionMarkLinkTarget (string $question_mark_link_target)

	setQuestionMarked (bool $question_marked)

	setAnythingRendered ()

	setShowDiscardModalSignal (Signal $signal)

	getActionsHTML ()

	getHTML ()

Data Fields
const	SHOW_DISABLED_COMMANDS = false

const	CSS_CLASS_SUBMIT_BUTTONS = 'ilc_qsubmit_Submit'

Private Member Functions
	getShowDiscardModalSignal ()

	getEditSolutionButtonLabel ()

	getCheckButtonLabel ()

	getRequestHintButtonLabel ()

	getQuestionMarkActionLabel ()

	getQuestionMarkIconLabel ()

	getQuestionMarkIconSource ()

	getTemplate ($a_purpose='toolbar')

	parseNavigation (ilTemplate $tpl)

	parseButtonsBlock (ilTemplate $tpl)

	renderButtonInstance (ilTemplate $tpl, Button $button)

	renderSubmitButton (ilTemplate $tpl, string $command, string $label)

	renderInstantFeedbackButton (ilTemplate $tpl, string $command, string $label, bool $is_primary)

	getOnLoadCode (string $command)

	renderActionsIcon (ilTemplate $tpl, string $icon_src, string $label, string $css_class)

Private Attributes
ILIAS DI UIServices	$ui

string	$edit_solution_command = ''

bool	$question_worked_through = false

string	$revert_changes_link_target = ''

bool	$discard_solution_button_enabled = false

string	$skip_question_link_target = ''

string	$instant_feedback_command = ''

bool	$answer_freezing_enabled = false

bool	$force_instant_response_enabled = false

string	$request_hint_command = ''

string	$show_hints_command = ''

bool	$hint_requests_exist = false

string	$question_mark_link_target = ''

bool	$question_marked = false

bool	$anything_rendered = false

Signal	$show_discard_modal_signal = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestQuestionNavigationGUI::__construct	(	protected ilLanguage	$lng,
		protected UIFactory	$ui_factory,
		protected UIRenderer	$ui_renderer
	)

Definition at line 56 of file class.ilTestQuestionNavigationGUI.php.

60 {

61 }

Member Function Documentation

◆ getActionsHTML()

ilTestQuestionNavigationGUI::getActionsHTML ( )

Definition at line 143 of file class.ilTestQuestionNavigationGUI.php.

References $id, $question_mark_link_target, $revert_changes_link_target, $skip_question_link_target, getQuestionMarkActionLabel(), getQuestionMarkIconLabel(), getQuestionMarkIconSource(), getShowDiscardModalSignal(), getTemplate(), ILIAS\Repository\lng(), and renderActionsIcon().

                                     : string
     {
         $tpl = $this->getTemplate('actions');
         $actions = [];
 
         if ($this->question_mark_link_target) {
             $this->renderActionsIcon(
                 $tpl,
                 $this->getQuestionMarkIconSource(),
                 $this->getQuestionMarkIconLabel(),
                 'ilTestMarkQuestionIcon'
             );
             $target = $this->question_mark_link_target;
             $actions[] = $this->ui_factory->button()->shy(
                 $this->getQuestionMarkActionLabel(),
                 ''
             )->withAdditionalOnLoadCode(
                 static function (string $id) use ($target): string {
                     return "document.getElementById('$id').addEventListener('click', "
                         . '(e) => {'
                         . " il.TestPlayerQuestionEditControl.checkNavigation('{$target}', 'show', e);"
                         . '});';
                 }
             );
         }
 
         if ($this->skip_question_link_target) {
             $actions[] = $this->ui_factory->button()->shy(
                 $this->lng->txt('postpone_question'),
                 $this->skip_question_link_target
             );
         }
 
         if ($actions !== []) {
             $actions[] = $this->ui_factory->divider()->horizontal();
         }
 
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('tst_revert_changes'),
             $this->revert_changes_link_target
         )->withUnavailableAction(!$this->revert_changes_link_target);
 
         if ($this->question_worked_through) {
             $actions[] = $this->ui_factory->button()->shy(
                 $this->lng->txt('discard_answer'),
                 '#'
             )->withUnavailableAction(!$this->discard_solution_button_enabled)
                 ->withOnClick($this->getShowDiscardModalSignal());
         }
 
         $list = $this->ui_factory->dropdown()->standard($actions)->withLabel($this->lng->txt('actions'));
         $tpl->setVariable('ACTION_MENU', $this->ui_renderer->render($list));
 
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getCheckButtonLabel()

ilTestQuestionNavigationGUI::getCheckButtonLabel ( )

private

Definition at line 251 of file class.ilTestQuestionNavigationGUI.php.

References ILIAS\Repository\lng().

Referenced by getHTML().

                                           : string
     {
         if ($this->answer_freezing_enabled) {
             return $this->lng->txt('submit_and_check');
         }
 
         return $this->lng->txt('check');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditSolutionButtonLabel()

ilTestQuestionNavigationGUI::getEditSolutionButtonLabel ( )

private

Definition at line 242 of file class.ilTestQuestionNavigationGUI.php.

References ILIAS\Repository\lng().

Referenced by getHTML().

                                                  : string
     {
         if ($this->question_worked_through) {
             return $this->lng->txt('edit_answer');
         }
 
         return $this->lng->txt('answer_question');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilTestQuestionNavigationGUI::getHTML ( )

Definition at line 199 of file class.ilTestQuestionNavigationGUI.php.

References getCheckButtonLabel(), getEditSolutionButtonLabel(), getRequestHintButtonLabel(), getTemplate(), ILIAS\Repository\lng(), parseNavigation(), renderInstantFeedbackButton(), renderSubmitButton(), and ilTestPlayerCommands\SHOW_INSTANT_RESPONSE.

                              : string
     {
         $tpl = $this->getTemplate('toolbar');
         if ($this->edit_solution_command) {
             $this->renderSubmitButton(
                 $tpl,
                 $this->edit_solution_command,
                 $this->getEditSolutionButtonLabel()
             );
         }
 
         if ($this->instant_feedback_command === ilTestPlayerCommands::SHOW_INSTANT_RESPONSE) {
             $this->renderInstantFeedbackButton(
                 $tpl,
                 $this->instant_feedback_command,
                 $this->getCheckButtonLabel(),
                 $this->force_instant_response_enabled
             );
         }
 
         if ($this->request_hint_command) {
             $this->renderSubmitButton(
                 $tpl,
                 $this->request_hint_command,
                 $this->getRequestHintButtonLabel()
             );
         }
 
         if ($this->show_hints_command) {
             $this->renderSubmitButton(
                 $tpl,
                 $this->show_hints_command,
                 $this->lng->txt('show_requested_question_hints')
             );
         }
 
         if ($this->anything_rendered) {
             $this->parseNavigation($tpl);
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getOnLoadCode()

ilTestQuestionNavigationGUI::getOnLoadCode ( string $command )

private

Definition at line 373 of file class.ilTestQuestionNavigationGUI.php.

References $id.

Referenced by renderInstantFeedbackButton(), and renderSubmitButton().

                                                    : Closure
     {
         return static function ($id) use ($command): string {
             return "document.getElementById('$id').addEventListener('click', "
                 . '(e) => {'
                 . "  e.target.setAttribute('name', 'cmd[$command]');"
                 . '  e.target.form.requestSubmit(e.target);'
                 . '});';
         };
     }

Here is the caller graph for this function:

◆ getQuestionMarkActionLabel()

ilTestQuestionNavigationGUI::getQuestionMarkActionLabel ( )

private

Definition at line 269 of file class.ilTestQuestionNavigationGUI.php.

References ILIAS\Repository\lng().

Referenced by getActionsHTML().

                                                  : string
     {
         if ($this->question_marked) {
             return $this->lng->txt('tst_remove_mark');
         }
 
         return $this->lng->txt('tst_question_mark');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionMarkIconLabel()

ilTestQuestionNavigationGUI::getQuestionMarkIconLabel ( )

private

Definition at line 279 of file class.ilTestQuestionNavigationGUI.php.

References ILIAS\Repository\lng().

Referenced by getActionsHTML().

                                                : string
     {
         if ($this->question_marked) {
             return $this->lng->txt('tst_question_marked');
         }
 
         return$this->lng->txt('tst_question_not_marked');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionMarkIconSource()

ilTestQuestionNavigationGUI::getQuestionMarkIconSource ( )

private

Definition at line 288 of file class.ilTestQuestionNavigationGUI.php.

References ilUtil\getImagePath().

Referenced by getActionsHTML().

                                                 : string
     {
         if ($this->question_marked) {
             return ilUtil::getImagePath('object/marked.svg');
         }
 
         return ilUtil::getImagePath('object/marked_.svg');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestHintButtonLabel()

ilTestQuestionNavigationGUI::getRequestHintButtonLabel ( )

private

Definition at line 260 of file class.ilTestQuestionNavigationGUI.php.

References ILIAS\Repository\lng().

Referenced by getHTML().

                                                 : string
     {
         if ($this->hint_requests_exist) {
             return $this->lng->txt('button_request_next_question_hint');
         }
 
         return $this->lng->txt('button_request_question_hint');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShowDiscardModalSignal()

ilTestQuestionNavigationGUI::getShowDiscardModalSignal ( )

private

Definition at line 138 of file class.ilTestQuestionNavigationGUI.php.

Referenced by getActionsHTML().

                                                 : Signal
     {
         return $this->show_discard_modal_signal ?? new SignalImplementation('');
     }

Here is the caller graph for this function:

◆ getTemplate()

ilTestQuestionNavigationGUI::getTemplate ( $a_purpose = 'toolbar' )

private

Definition at line 297 of file class.ilTestQuestionNavigationGUI.php.

Referenced by getActionsHTML(), and getHTML().

                                                         : ilTemplate
     {
         switch ($a_purpose) {
             case 'toolbar':
                 return new ilTemplate(
                     'tpl.tst_question_navigation.html',
                     true,
                     true,
                     'components/ILIAS/Test'
                 );
             default:
             case 'actions':
                 return new ilTemplate(
                     'tpl.tst_question_actions.html',
                     true,
                     true,
                     'components/ILIAS/Test'
                 );
         }
     }

Here is the caller graph for this function:

◆ parseButtonsBlock()

ilTestQuestionNavigationGUI::parseButtonsBlock ( ilTemplate $tpl )

private

Definition at line 324 of file class.ilTestQuestionNavigationGUI.php.

References ilTemplate\parseCurrentBlock(), and ilTemplate\setCurrentBlock().

Referenced by renderButtonInstance().

                                                        : void
     {
         $tpl->setCurrentBlock('buttons');
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseNavigation()

ilTestQuestionNavigationGUI::parseNavigation ( ilTemplate $tpl )

private

Definition at line 318 of file class.ilTestQuestionNavigationGUI.php.

References ilTemplate\parseCurrentBlock(), and ilTemplate\setCurrentBlock().

Referenced by getHTML().

                                                      : void
     {
         $tpl->setCurrentBlock('question_related_navigation');
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderActionsIcon()

ilTestQuestionNavigationGUI::renderActionsIcon	(	ilTemplate	$tpl,
		string	$icon_src,
		string	$label,
		string	$css_class
	)

private

Definition at line 384 of file class.ilTestQuestionNavigationGUI.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getActionsHTML().

      : void {
         $tpl->setCurrentBlock('actions_icon');
         $tpl->setVariable('ICON_SRC', $icon_src);
         $tpl->setVariable('ICON_TEXT', $label);
         $tpl->setVariable('ICON_CLASS', $css_class);
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderButtonInstance()

ilTestQuestionNavigationGUI::renderButtonInstance	(	ilTemplate	$tpl,
		Button	$button
	)

private

Definition at line 330 of file class.ilTestQuestionNavigationGUI.php.

References parseButtonsBlock(), ilTemplate\parseCurrentBlock(), setAnythingRendered(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by renderInstantFeedbackButton(), and renderSubmitButton().

                                                                           : void
     {
         $tpl->setCurrentBlock('button_instance');
         $tpl->setVariable('BUTTON_INSTANCE', $this->ui_renderer->render($button));
         $tpl->parseCurrentBlock();
 
         $this->parseButtonsBlock($tpl);
         $this->setAnythingRendered();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderInstantFeedbackButton()

ilTestQuestionNavigationGUI::renderInstantFeedbackButton	(	ilTemplate	$tpl,
		string	$command,
		string	$label,
		bool	$is_primary
	)

private

Definition at line 352 of file class.ilTestQuestionNavigationGUI.php.

References getOnLoadCode(), and renderButtonInstance().

Referenced by getHTML().

      : void {
         $on_load_code = $this->getOnLoadCode($command);
         if ($is_primary) {
             $this->renderButtonInstance(
                 $tpl,
                 $this->ui_factory->button()->primary($label, '')->withAdditionalOnLoadCode($on_load_code)
             );
             return;
         }
 
         $this->renderButtonInstance(
             $tpl,
             $this->ui_factory->button()->standard($label, '')->withAdditionalOnLoadCode($on_load_code)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderSubmitButton()

ilTestQuestionNavigationGUI::renderSubmitButton	(	ilTemplate	$tpl,
		string	$command,
		string	$label
	)

private

Definition at line 340 of file class.ilTestQuestionNavigationGUI.php.

References getOnLoadCode(), and renderButtonInstance().

Referenced by getHTML().

      : void {
         $on_load_code = $this->getOnLoadCode($command);
         $this->renderButtonInstance(
             $tpl,
             $this->ui_factory->button()->standard($label, '')->withAdditionalOnLoadCode($on_load_code)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAnswerFreezingEnabled()

ilTestQuestionNavigationGUI::setAnswerFreezingEnabled ( bool $answer_freezing_enabled )

Definition at line 98 of file class.ilTestQuestionNavigationGUI.php.

References $answer_freezing_enabled.

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

◆ setAnythingRendered()

ilTestQuestionNavigationGUI::setAnythingRendered ( )

Definition at line 128 of file class.ilTestQuestionNavigationGUI.php.

Referenced by renderButtonInstance().

                                          : void
     {
         $this->anything_rendered = true;
     }

Here is the caller graph for this function:

◆ setDiscardSolutionButtonEnabled()

ilTestQuestionNavigationGUI::setDiscardSolutionButtonEnabled ( bool $discard_solution_button_enabled )

Definition at line 78 of file class.ilTestQuestionNavigationGUI.php.

References $discard_solution_button_enabled.

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

◆ setEditSolutionCommand()

ilTestQuestionNavigationGUI::setEditSolutionCommand ( string $edit_solution_command )

Definition at line 63 of file class.ilTestQuestionNavigationGUI.php.

References $edit_solution_command.

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

◆ setForceInstantResponseEnabled()

ilTestQuestionNavigationGUI::setForceInstantResponseEnabled ( bool $force_instant_response_enabled )

Definition at line 93 of file class.ilTestQuestionNavigationGUI.php.

References $force_instant_response_enabled.

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

◆ setHintRequestsExist()

ilTestQuestionNavigationGUI::setHintRequestsExist ( bool $hint_requests_exist )

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

References $hint_requests_exist.

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

◆ setInstantFeedbackCommand()

ilTestQuestionNavigationGUI::setInstantFeedbackCommand ( string $instant_feedback_command )

Definition at line 88 of file class.ilTestQuestionNavigationGUI.php.

References $instant_feedback_command.

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

◆ setQuestionMarked()

ilTestQuestionNavigationGUI::setQuestionMarked ( bool $question_marked )

Definition at line 123 of file class.ilTestQuestionNavigationGUI.php.

References $question_marked.

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

◆ setQuestionMarkLinkTarget()

ilTestQuestionNavigationGUI::setQuestionMarkLinkTarget ( string $question_mark_link_target )

Definition at line 118 of file class.ilTestQuestionNavigationGUI.php.

References $question_mark_link_target.

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

◆ setQuestionWorkedThrough()

ilTestQuestionNavigationGUI::setQuestionWorkedThrough ( bool $question_worked_through )

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

References $question_worked_through.

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

◆ setRequestHintCommand()

ilTestQuestionNavigationGUI::setRequestHintCommand ( string $request_hint_command )

Definition at line 103 of file class.ilTestQuestionNavigationGUI.php.

References $request_hint_command.

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

◆ setRevertChangesLinkTarget()

ilTestQuestionNavigationGUI::setRevertChangesLinkTarget ( string $revert_changes_link_target )

Definition at line 73 of file class.ilTestQuestionNavigationGUI.php.

References $revert_changes_link_target.

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

◆ setShowDiscardModalSignal()

ilTestQuestionNavigationGUI::setShowDiscardModalSignal ( Signal $signal )

Definition at line 133 of file class.ilTestQuestionNavigationGUI.php.

                                                              : void
     {
         $this->show_discard_modal_signal = $signal;
     }

◆ setShowHintsCommand()

ilTestQuestionNavigationGUI::setShowHintsCommand ( string $show_hints_command )

Definition at line 108 of file class.ilTestQuestionNavigationGUI.php.

References $show_hints_command.

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

◆ setSkipQuestionLinkTarget()

ilTestQuestionNavigationGUI::setSkipQuestionLinkTarget ( string $skip_question_link_target )

Definition at line 83 of file class.ilTestQuestionNavigationGUI.php.

References $skip_question_link_target.

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