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)

	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 ()

	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	$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 53 of file class.ilTestQuestionNavigationGUI.php.

57 {

58 }

Member Function Documentation

◆ getActionsHTML()

ilTestQuestionNavigationGUI::getActionsHTML ( )

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

                                    : 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)
        ->withAdditionalOnLoadCode(
            static fn(string $id): string => "document.getElementById('{$id}').classList.add('ilTestRevertChangesAction')"
        );
 
        $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();
    }

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

Here is the call graph for this function:

◆ getCheckButtonLabel()

ilTestQuestionNavigationGUI::getCheckButtonLabel ( )

private

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

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

References ILIAS\Repository\lng().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditSolutionButtonLabel()

ilTestQuestionNavigationGUI::getEditSolutionButtonLabel ( )

private

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

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

References ILIAS\Repository\lng().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilTestQuestionNavigationGUI::getHTML ( )

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

                             : 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->anything_rendered) {
            $this->parseNavigation($tpl);
        }
 
        return $tpl->get();
    }

References getCheckButtonLabel(), getEditSolutionButtonLabel(), getTemplate(), parseNavigation(), renderInstantFeedbackButton(), renderSubmitButton(), and ilTestPlayerCommands\SHOW_INSTANT_RESPONSE.

Here is the call graph for this function:

◆ getOnLoadCode()

ilTestQuestionNavigationGUI::getOnLoadCode ( string $command )

private

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

                                                   : 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);'
                . '});';
        };
    }

References $id.

◆ getQuestionMarkActionLabel()

ilTestQuestionNavigationGUI::getQuestionMarkActionLabel ( )

private

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

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

References ILIAS\Repository\lng().

Referenced by getActionsHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionMarkIconLabel()

ilTestQuestionNavigationGUI::getQuestionMarkIconLabel ( )

private

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

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

References ILIAS\Repository\lng().

Referenced by getActionsHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionMarkIconSource()

ilTestQuestionNavigationGUI::getQuestionMarkIconSource ( )

private

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

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

References ilUtil\getImagePath().

Referenced by getActionsHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShowDiscardModalSignal()

ilTestQuestionNavigationGUI::getShowDiscardModalSignal ( )

private

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

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

Referenced by getActionsHTML().

Here is the caller graph for this function:

◆ getTemplate()

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

private

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

                                                        : 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'
                );
        }
    }

Referenced by getActionsHTML(), and getHTML().

Here is the caller graph for this function:

◆ parseButtonsBlock()

ilTestQuestionNavigationGUI::parseButtonsBlock ( ilTemplate $tpl )

private

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

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

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

Referenced by renderButtonInstance().

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 275 of file class.ilTestQuestionNavigationGUI.php.

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

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

Referenced by getHTML().

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 341 of file class.ilTestQuestionNavigationGUI.php.

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

Referenced by getActionsHTML().

Here is the caller graph for this function:

◆ renderButtonInstance()

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

private

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

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

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

Here is the call graph for this function:

◆ renderInstantFeedbackButton()

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

private

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

     : 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)
        );
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ renderSubmitButton()

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

private

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

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

Referenced by getHTML().

Here is the caller graph for this function:

◆ setAnswerFreezingEnabled()

ilTestQuestionNavigationGUI::setAnswerFreezingEnabled ( bool $answer_freezing_enabled )

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

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

References $answer_freezing_enabled.

◆ setAnythingRendered()

ilTestQuestionNavigationGUI::setAnythingRendered ( )

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

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

Referenced by renderButtonInstance().

Here is the caller graph for this function:

◆ setDiscardSolutionButtonEnabled()

ilTestQuestionNavigationGUI::setDiscardSolutionButtonEnabled ( bool $discard_solution_button_enabled )

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

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

References $discard_solution_button_enabled.

◆ setEditSolutionCommand()

ilTestQuestionNavigationGUI::setEditSolutionCommand ( string $edit_solution_command )

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

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

References $edit_solution_command.

◆ setForceInstantResponseEnabled()

ilTestQuestionNavigationGUI::setForceInstantResponseEnabled ( bool $force_instant_response_enabled )

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

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

References $force_instant_response_enabled.

◆ setInstantFeedbackCommand()

ilTestQuestionNavigationGUI::setInstantFeedbackCommand ( string $instant_feedback_command )

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

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

References $instant_feedback_command.

◆ setQuestionMarked()

ilTestQuestionNavigationGUI::setQuestionMarked ( bool $question_marked )

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

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

References $question_marked.

◆ setQuestionMarkLinkTarget()

ilTestQuestionNavigationGUI::setQuestionMarkLinkTarget ( string $question_mark_link_target )

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

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

References $question_mark_link_target.

◆ setQuestionWorkedThrough()

ilTestQuestionNavigationGUI::setQuestionWorkedThrough ( bool $question_worked_through )

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

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

References $question_worked_through.

◆ setRevertChangesLinkTarget()

ilTestQuestionNavigationGUI::setRevertChangesLinkTarget ( string $revert_changes_link_target )

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

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

References $revert_changes_link_target.

◆ setShowDiscardModalSignal()

ilTestQuestionNavigationGUI::setShowDiscardModalSignal ( Signal $signal )

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

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

◆ setSkipQuestionLinkTarget()

ilTestQuestionNavigationGUI::setSkipQuestionLinkTarget ( string $skip_question_link_target )

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

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