ILIAS\GlobalScreen\GUI\Tabs\Tabs Class Reference

Collaboration diagram for ILIAS\GlobalScreen\GUI\Tabs\Tabs:

Public Member Functions
	__construct (private Translator $translator, private \ilCtrlInterface $ctrl, private \ilTabsGUI $tabs_gui, private Flow $flow,)
	activate (string $tab_id)
	build (string $id, string $language_key, array|URI $target, ?Tab $parent=null, ?string $handling_class=null,)
	show ()
	structure ()
	add (Tab ... $tab)
	backToMainTab ()

Private Attributes
Structure	$structure
string	$active_tab = null
string	$active_subtab = null

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 31 of file Tabs.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::__construct	(	private Translator	$translator,
		private \ilCtrlInterface	$ctrl,
		private \ilTabsGUI	$tabs_gui,
		private Flow	$flow
	)

Definition at line 37 of file Tabs.php.

      {
        $this->structure = new Structure();
    }

References ILIAS\GlobalScreen\GUI\Tabs\Tabs\structure().

Here is the call graph for this function:

Member Function Documentation

activate()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::activate

(

string

$tab_id

)

Definition at line 46 of file Tabs.php.

                                            : void
    {
        $tab = $this->structure->getById($tab_id);
        if ($tab === null) {
            return;
        }
        if ($tab->getParent() === null) {
            $this->active_tab = $tab_id;
        } else {
            $this->active_subtab = $tab_id;
            $this->active_tab = $tab->getParent()->getId();
        }
    }

References ILIAS\GlobalScreen\GUI\Tabs\Tabs\structure().

Here is the call graph for this function:

add()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::add

(

Tab ...

$tab

)

Definition at line 160 of file Tabs.php.

                                    : void
    {
        foreach ($tab as $t) {
            $this->structure->add($t);
        }
    }

References ILIAS\GlobalScreen\GUI\Tabs\Tabs\structure().

Here is the call graph for this function:

backToMainTab()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::backToMainTab

(

)

Definition at line 167 of file Tabs.php.

                                   : void
    {
        $this->tabs_gui->clearTargets();
 
        if (
            $this->ctrl->getCmd(ilFooterEntriesGUI::CMD_DEFAULT) !== ilFooterEntriesGUI::CMD_DEFAULT
            && $this->ctrl->getCmdClass() === strtolower(ilFooterEntriesGUI::class)
        ) {
            $this->tabs_gui->setBackTarget(
                $this->translator->translate('back'),
                $this->ctrl->getLinkTargetByClass(
                    ilFooterEntriesGUI::class,
                    ilFooterEntriesGUI::CMD_DEFAULT
                )
            );
            return;
        }
 
        $this->tabs_gui->setBackTarget(
            $this->translator->translate('back'),
            $this->ctrl->getLinkTargetByClass(
                ilObjFooterAdministrationGUI::class,
                ilObjFooterAdministrationGUI::CMD_DEFAULT
            )
        );
    }

References ilObjFooterAdministrationGUI\CMD_DEFAULT, ilFooterEntriesGUI\CMD_DEFAULT, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

build()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::build	(	string	$id,
		string	$language_key,
		array|URI	$target,
		?Tab	$parent = null,
		?string	$handling_class = null
	)

Definition at line 60 of file Tabs.php.

     : Tab {
        if ($handling_class === null) {
            if ($target instanceof URI) {
                throw new \InvalidArgumentException('No handling class given');
            }
            if (is_array($target[0])) {
                // get last element of array without changing the array
                $handling_class = $target[0][count($target[0]) - 1];
            } elseif (is_string($target[0])) {
                $handling_class = $target[0];
            } else {
                throw new \InvalidArgumentException('No handling class given');
            }
        }
 
        if ($handling_class === null) {
            throw new \InvalidArgumentException('No handling class given');
        }
        if (!$target instanceof URI) {
            $target_class = $target[0];
            $command = $target[1] ?? null;
            //
            //            if ($parent !== null && !is_array($target_class)) {
            //                $flow = $this->flow->getHereAsFlow();
            //                $flow[] = $target_class;
            //            } else {
            //                $flow = $target_class;
            //            }
 
            $uri = $this->flow->getTargetURI($target_class, $command);
        } else {
            $uri = $target;
        }
 
        return new Tab(
            $id,
            $language_key,
            $uri,
            $handling_class,
            $parent
        );
    }

show()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::show

(

)

Definition at line 109 of file Tabs.php.

                          : void
    {
        $this->tabs_gui->clearTargets();
 
        $current_tab = $this->structure->getByHandlingClass(
            $this->flow->getCurrentClass() ?? ''
        );
 
        if (
            $current_tab !== null
            && $current_tab->getParent() !== null
            && $current_tab->getParent()->getParent() !== null
        ) {
            // add backtab
            $this->tabs_gui->setBackTarget(
                $this->translator->translate('back'),
                $this->ctrl->getLinkTargetByClass(
                    $current_tab->getParent()->getHandlingClass()
                )
            );
            return;
        }
 
        foreach ($this->structure->get() as $tab) {
            if ($tab->getParent() === null) {
                $this->tabs_gui->addTab(
                    $tab->getId(),
                    $this->translator->t($tab->getLanguageKey()),
                    (string) $tab->getTarget()
                );
            } elseif ($tab->getParent()->getId() === $this->active_tab) {
                $this->tabs_gui->addSubTab(
                    $tab->getId(),
                    $this->translator->t($tab->getLanguageKey()),
                    (string) $tab->getTarget()
                );
            }
        }
        if ($this->active_tab !== null) {
            $this->tabs_gui->activateTab($this->active_tab);
        }
        if ($this->active_subtab !== null) {
            $this->tabs_gui->activateSubTab($this->active_subtab);
        }
    }

References ILIAS\GlobalScreen\GUI\Tabs\Tabs\structure().

Here is the call graph for this function:

structure()

ILIAS\GlobalScreen\GUI\Tabs\Tabs::structure

(

)

Definition at line 155 of file Tabs.php.

                               : Structure
    {
        return $this->structure;
    }

References ILIAS\GlobalScreen\GUI\Tabs\Tabs\$structure.

Referenced by ILIAS\GlobalScreen\GUI\Tabs\Tabs\__construct(), ILIAS\GlobalScreen\GUI\Tabs\Tabs\activate(), ILIAS\GlobalScreen\GUI\Tabs\Tabs\add(), and ILIAS\GlobalScreen\GUI\Tabs\Tabs\show().

Here is the caller graph for this function:

Field Documentation

$active_subtab

string ILIAS\GlobalScreen\GUI\Tabs\Tabs::$active_subtab = null

private

Definition at line 35 of file Tabs.php.

$active_tab

string ILIAS\GlobalScreen\GUI\Tabs\Tabs::$active_tab = null

private

Definition at line 34 of file Tabs.php.

$structure

Structure ILIAS\GlobalScreen\GUI\Tabs\Tabs::$structure

private

Definition at line 33 of file Tabs.php.

Referenced by ILIAS\GlobalScreen\GUI\Tabs\Tabs\structure().

---

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

• components/ILIAS/GlobalScreen/src/GUI/Tabs/Tabs.php