Inheritance diagram for ilTestInfoScreenToolbarGUI:

Collaboration diagram for ilTestInfoScreenToolbarGUI:

Public Member Functions
	__construct (private ilObjTest $test_obj, private ilTestPlayerAbstractGUI $test_player_gui, private ilTestQuestionSetConfig $test_question_set_config, private ilTestSession $test_session, private ilDBInterface $db, private ilAccessHandler $access, private ilCtrlInterface $ctrl, protected ilLanguage $lng, private UIFactory $ui_factory, private UIRenderer $ui_renderer, private ilGlobalTemplateInterface $main_tpl, private ilToolbarGUI $global_toolbar)

	getSessionLockString ()

	setSessionLockString ($sessionLockString)

	getInfoMessages ()

	addInfoMessage ($infoMessage)
	@ param string $infoMessage Could be. More...

	getFailureMessages ()

	addFailureMessage (string $failureMessage)

	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...

	setCloseFormTag (bool $a_val)

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

	addFormInput ($formInput)

	clearItems ()

	build ()

	sendMessages ()

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)

	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)

	getStickyItems ()

	setStickyItems (array $items)

Protected Member Functions
	populateMessage ($message)

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...

Protected Attributes
ilTestQuestionSetConfig	$testQuestionSetConfig = null

ilTestSession	$testSession = null

	$testSequence

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

	getTestOBJ ()

	getTestPlayerGUI ()

	getTestSession ()

	getClassName ($target)

	getClassNameArray ($target)

	getClassPath ($target)

	setParameter ($target, $parameter, $value)

	buildLinkTarget ($target, $cmd=null)

	buildFormAction ($target)

	ensureInitialisedSessionLockString ()

	buildSessionLockString ()

Private Attributes
string	$sessionLockString = ''

array	$infoMessages = []

array	$failureMessages = []

Static Private Attributes
static array	$TARGET_CLASS_PATH_BASE = ['ilRepositoryGUI', 'ilObjTestGUI']

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

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

Detailed Description

Definition at line 31 of file class.ilTestInfoScreenToolbarGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestInfoScreenToolbarGUI::__construct	(	private ilObjTest	$test_obj,
		private ilTestPlayerAbstractGUI	$test_player_gui,
		private ilTestQuestionSetConfig	$test_question_set_config,
		private ilTestSession	$test_session,
		private ilDBInterface	$db,
		private ilAccessHandler	$access,
		private ilCtrlInterface	$ctrl,
		protected ilLanguage	$lng,
		private UIFactory	$ui_factory,
		private UIRenderer	$ui_renderer,
		private ilGlobalTemplateInterface	$main_tpl,
		private ilToolbarGUI	$global_toolbar
	)

Definition at line 47 of file class.ilTestInfoScreenToolbarGUI.php.

60 {

61 }

Member Function Documentation

◆ addFailureMessage()

ilTestInfoScreenToolbarGUI::addFailureMessage ( string $failureMessage )

Definition at line 111 of file class.ilTestInfoScreenToolbarGUI.php.

                                                             : void
    {
        $this->failureMessages[] = $failureMessage;
    }

◆ addFormInput()

ilTestInfoScreenToolbarGUI::addFormInput ( $formInput )

Definition at line 148 of file class.ilTestInfoScreenToolbarGUI.php.

                                            : void
    {
        if ($this->global_toolbar instanceof parent) {
            $this->global_toolbar->addFormInput($formInput);
        }
    }

◆ addInfoMessage()

ilTestInfoScreenToolbarGUI::addInfoMessage ( $infoMessage )

@ param string $infoMessage Could be.

Doesn't have to.

Definition at line 101 of file class.ilTestInfoScreenToolbarGUI.php.

                                                : void
    {
        $this->infoMessages[] = $infoMessage;
    }

◆ addInputItem()

ilTestInfoScreenToolbarGUI::addInputItem	(	ilToolbarItem	$a_item,
		bool	$a_output_label = `false`
	)

Reimplemented from ilToolbarGUI.

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

     : void {
        if ($this->global_toolbar instanceof parent) {
            $this->global_toolbar->addInputItem($a_item, $a_output_label);
        } else {
            parent::addInputItem($a_item, $a_output_label);
        }
    }

◆ build()

ilTestInfoScreenToolbarGUI::build ( )

Definition at line 214 of file class.ilTestInfoScreenToolbarGUI.php.

                           : void
    {
        $this->ensureInitialisedSessionLockString();
 
        $this->setParameter($this->getTestPlayerGUI(), 'lock', $this->getSessionLockString());
        $this->setParameter($this->getTestPlayerGUI(), 'sequence', $this->getTestSession()->getLastSequence());
        $this->setParameter('ilObjTestGUI', 'ref_id', $this->getTestOBJ()->getRefId());
        $this->setFormAction($this->buildFormAction($this->getTestPlayerGUI()));
 
        if ($this->getTestOBJ()->getOfflineStatus()) {
            $message = $this->lng->txt('test_is_offline');
 
            $links = [];
 
            if ($this->access->checkAccess("write", "", $this->getTestOBJ()->getRefId())) {
                $links[] = $this->ui_factory->link()->standard(
                    $this->lng->txt('test_edit_settings'),
                    $this->buildLinkTarget(SettingsMainGUI::class)
                );
            }
 
            $msgBox = $this->ui_factory->messageBox()->info($message)->withLinks($links);
 
            $this->populateMessage($this->ui_renderer->render($msgBox));
        }
 
        if ($this->access->checkAccess("write", "", $this->getTestOBJ()->getRefId())) {
            $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($this->test_obj->getId());
            $sltImportFails = new ilTestSkillLevelThresholdImportFails($this->test_obj->getId());
 
            if ($qsaImportFails->failedImportsRegistered() || $sltImportFails->failedImportsRegistered()) {
                $importFailsMsg = [];
 
                if ($qsaImportFails->failedImportsRegistered()) {
                    $importFailsMsg[] = $qsaImportFails->getFailedImportsMessage($this->lng);
                }
 
                if ($sltImportFails->failedImportsRegistered()) {
                    $importFailsMsg[] = $sltImportFails->getFailedImportsMessage($this->lng);
                }
 
                $message = implode('<br />', $importFailsMsg);
 
                $button = $this->ui_factory->button()->standard(
                    $this->lng->txt('ass_skl_import_fails_remove_btn'),
                    $this->ctrl->getLinkTargetByClass('ilObjTestGUI', 'removeImportFails')
                );
 
                $msgBox = $this->ui_factory->messageBox()->failure($message)->withButtons([$button]);
 
                $this->populateMessage($this->ui_renderer->render($msgBox));
            }
        }
    }

References ILIAS\Repository\access(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildFormAction()

ilTestInfoScreenToolbarGUI::buildFormAction ( $target )

private

Definition at line 197 of file class.ilTestInfoScreenToolbarGUI.php.

                                             : string
    {
        return $this->ctrl->getFormActionByClass($this->getClassPath($target));
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ buildLinkTarget()

ilTestInfoScreenToolbarGUI::buildLinkTarget	(	$target,
		$cmd = `null`
	)

private

Definition at line 192 of file class.ilTestInfoScreenToolbarGUI.php.

                                                          : string
    {
        return $this->ctrl->getLinkTargetByClass($this->getClassPath($target), $cmd);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ buildSessionLockString()

ilTestInfoScreenToolbarGUI::buildSessionLockString ( )

private

Definition at line 209 of file class.ilTestInfoScreenToolbarGUI.php.

                                             : string
    {
        return md5($_COOKIE[session_name()] . time());
    }

References $_COOKIE.

◆ clearItems()

ilTestInfoScreenToolbarGUI::clearItems ( )

Definition at line 155 of file class.ilTestInfoScreenToolbarGUI.php.

                                : void
    {
        if ($this->global_toolbar instanceof parent) {
            $this->global_toolbar->setItems([]);
        } else {
            $this->setItems([]);
        }
    }

◆ ensureInitialisedSessionLockString()

ilTestInfoScreenToolbarGUI::ensureInitialisedSessionLockString ( )

private

Definition at line 202 of file class.ilTestInfoScreenToolbarGUI.php.

                                                         : void
    {
        if ($this->getSessionLockString() === '') {
            $this->setSessionLockString($this->buildSessionLockString());
        }
    }

◆ getClassName()

ilTestInfoScreenToolbarGUI::getClassName ( $target )

private

Definition at line 164 of file class.ilTestInfoScreenToolbarGUI.php.

    {
        if (is_object($target)) {
            $target = get_class($target);
        }
 
        return $target;
    }

◆ getClassNameArray()

ilTestInfoScreenToolbarGUI::getClassNameArray ( $target )

private

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

                                               : array
    {
        if (is_array($target)) {
            return $target;
        }
 
        return [$this->getClassName($target)];
    }

◆ getClassPath()

ilTestInfoScreenToolbarGUI::getClassPath ( $target )

private

Definition at line 182 of file class.ilTestInfoScreenToolbarGUI.php.

                                          : array
    {
        return array_merge(self::$TARGET_CLASS_PATH_BASE, $this->getClassNameArray($target));
    }

◆ getFailureMessages()

ilTestInfoScreenToolbarGUI::getFailureMessages ( )

Definition at line 106 of file class.ilTestInfoScreenToolbarGUI.php.

                                        : array
    {
        return $this->failureMessages;
    }

References $failureMessages.

◆ getInfoMessages()

ilTestInfoScreenToolbarGUI::getInfoMessages ( )

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

                                     : array
    {
        return $this->infoMessages;
    }

References $infoMessages.

◆ getSessionLockString()

ilTestInfoScreenToolbarGUI::getSessionLockString ( )

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

                                          : ?string
    {
        return $this->sessionLockString;
    }

References $sessionLockString.

◆ getTestOBJ()

ilTestInfoScreenToolbarGUI::getTestOBJ ( )

private

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

                                 : ilObjTest
    {
        return $this->test_obj;
    }

◆ getTestPlayerGUI()

ilTestInfoScreenToolbarGUI::getTestPlayerGUI ( )

private

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

                                       : ?ilTestPlayerAbstractGUI
    {
        return $this->test_player_gui;
    }

◆ getTestQuestionSetConfig()

ilTestInfoScreenToolbarGUI::getTestQuestionSetConfig ( )

private

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

                                               : ?ilTestQuestionSetConfig
    {
        return $this->test_question_set_config;
    }

◆ getTestSession()

ilTestInfoScreenToolbarGUI::getTestSession ( )

private

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

                                     : ?ilTestSession
    {
        return $this->test_session;
    }

◆ populateMessage()

ilTestInfoScreenToolbarGUI::populateMessage ( $message )

protected

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

                                                : void
    {
        $this->main_tpl->setCurrentBlock('mess');
        $this->main_tpl->setVariable('MESSAGE', $message);
        $this->main_tpl->parseCurrentBlock();
    }

◆ sendMessages()

ilTestInfoScreenToolbarGUI::sendMessages ( )

Definition at line 276 of file class.ilTestInfoScreenToolbarGUI.php.

                                  : void
    {
        $info_messages = $this->getInfoMessages();
        if ($info_messages !== []) {
            $this->main_tpl->setOnScreenMessage('info', array_pop($info_messages));
        }
 
        $failure_messages = $this->getFailureMessages();
        if ($failure_messages !== []) {
            $this->main_tpl->setOnScreenMessage('failure', array_pop($failure_messages));
        }
    }

◆ setCloseFormTag()

ilTestInfoScreenToolbarGUI::setCloseFormTag ( bool $a_val )

Reimplemented from ilToolbarGUI.

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

                                                : void
    {
        if ($this->global_toolbar instanceof parent) {
            $this->global_toolbar->setCloseFormTag($a_val);
        } else {
            parent::setCloseFormTag($a_val);
        }
    }

◆ setFormAction()

ilTestInfoScreenToolbarGUI::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)

Reimplemented from ilToolbarGUI.

Definition at line 116 of file class.ilTestInfoScreenToolbarGUI.php.

     : void {
        if ($this->global_toolbar instanceof parent) {
            $this->global_toolbar->setFormAction($a_val, $a_multipart, $a_target);
        } else {
            parent::setFormAction($a_val, $a_multipart, $a_target);
        }
    }

◆ setParameter()

ilTestInfoScreenToolbarGUI::setParameter	(	$target,
		$parameter,
		$value
	)

private

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

                                                              : void
    {
        $this->ctrl->setParameterByClass($this->getClassName($target), $parameter, $value);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ setSessionLockString()

ilTestInfoScreenToolbarGUI::setSessionLockString ( $sessionLockString )

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

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

References $sessionLockString.

Field Documentation

◆ $failureMessages

array ilTestInfoScreenToolbarGUI::$failureMessages = []

private

Definition at line 45 of file class.ilTestInfoScreenToolbarGUI.php.

Referenced by getFailureMessages().

◆ $infoMessages

array ilTestInfoScreenToolbarGUI::$infoMessages = []

private

Definition at line 44 of file class.ilTestInfoScreenToolbarGUI.php.

Referenced by getInfoMessages().

◆ $sessionLockString

string ilTestInfoScreenToolbarGUI::$sessionLockString = ''

private

Definition at line 43 of file class.ilTestInfoScreenToolbarGUI.php.

Referenced by getSessionLockString(), and setSessionLockString().

◆ $TARGET_CLASS_PATH_BASE

array ilTestInfoScreenToolbarGUI::$TARGET_CLASS_PATH_BASE = ['ilRepositoryGUI', 'ilObjTestGUI']

staticprivate

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

◆ $testQuestionSetConfig

ilTestQuestionSetConfig ilTestInfoScreenToolbarGUI::$testQuestionSetConfig = null

protected

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

◆ $testSequence

ilTestInfoScreenToolbarGUI::$testSequence

protected

Definition at line 41 of file class.ilTestInfoScreenToolbarGUI.php.

◆ $testSession

ilTestSession ilTestInfoScreenToolbarGUI::$testSession = null

protected

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

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

components/ILIAS/Test/classes/Toolbars/class.ilTestInfoScreenToolbarGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFailureMessage()

◆ addFormInput()

◆ addInfoMessage()

◆ addInputItem()

◆ build()

◆ buildFormAction()

◆ buildLinkTarget()

◆ buildSessionLockString()

◆ clearItems()

◆ ensureInitialisedSessionLockString()

◆ getClassName()

◆ getClassNameArray()

◆ getClassPath()

◆ getFailureMessages()

◆ getInfoMessages()

◆ getSessionLockString()

◆ getTestOBJ()

◆ getTestPlayerGUI()

◆ getTestQuestionSetConfig()

◆ getTestSession()

◆ populateMessage()

◆ sendMessages()

◆ setCloseFormTag()

◆ setFormAction()

◆ setParameter()

◆ setSessionLockString()

Field Documentation

◆ $failureMessages

◆ $infoMessages

◆ $sessionLockString

◆ $TARGET_CLASS_PATH_BASE

◆ $testQuestionSetConfig

◆ $testSequence

◆ $testSession