This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilTabsGUI:

Public Member Functions
	setSetupMode (bool $a_val)

	getSetupMode ()

	setBackTarget (string $a_title, string $a_target, string $a_frame="")

	setBack2Target (string $a_title, string $a_target, string $a_frame="")

	setForcePresentationOfSingleTab (bool $a_val)

	getForcePresentationOfSingleTab ()

	addTarget (string $a_text, string $a_link, $a_cmd="", $a_cmdClass="", string $a_frame="", bool $a_activate=false, bool $a_dir_text=false)

	addTab (string $a_id, string $a_text, string $a_link, string $a_frame="")
	Add a Tab. More...

	removeTab (string $a_id)
	Remove a tab identified by its id. More...

	removeSubTab (string $a_id)
	Remove a subtab identified by its id. More...

	replaceTab (string $a_old_id, string $a_new_id, string $a_text, string $a_link, string $a_frame='')
	Replace a tab. More...

	clearTargets ()
	clear all targets More...

	addSubTabTarget (string $a_text, string $a_link, $a_cmd="", $a_cmdClass="", string $a_frame="", bool $a_activate=false, bool $a_dir_text=false)

	addSubTab (string $a_id, string $a_text, string $a_link, string $a_frame="")

	setTabActive (string $a_id)

	activateTab (string $a_id)

	setSubTabActive (string $a_text)

	activateSubTab (string $a_id)

	clearSubTabs ()

	getHTML (bool $a_after_tabs_anchor=false)

	getSubTabHTML ()

	addNonTabbedLink (string $a_id, string $a_text, string $a_link, string $a_frame="")

	removeNonTabbedLinks ()

	getActiveTab ()

	hasTabs ()

Data Fields
string	$target_script

string	$obj_type

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

array	$tabs

array	$target = array()

array	$sub_target = array()

array	$non_tabbed_link = array()

bool	$setup_mode = false

string	$back_target

Protected Member Functions
	getTabTextOfId (string $id)

Protected Attributes
ilCtrl	$ctrl

bool	$force_one_tab = false

bool	$manual_activation

bool	$subtab_manual_activation

bool	$sub_tabs

string	$temp_var

string	$back_title

string	$back_2_target

string	$back_2_title

string	$back_2_frame

string	$back_frame

Private Member Functions
	isTabActive (bool $isSubTabsContext, array $target, ?string $cmd, ?string $cmdClass)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Tabs GUI

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilTabsGUI.php.

Member Function Documentation

◆ activateSubTab()

ilTabsGUI::activateSubTab ( string $a_id )

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

                                                : void
    {
        $this->setSubTabActive($a_id);
    }

Here is the caller graph for this function:

◆ activateTab()

ilTabsGUI::activateTab ( string $a_id )

Definition at line 271 of file class.ilTabsGUI.php.

                                             : void
    {
        $this->setTabActive($a_id);
    }

Referenced by ilObjSkillTreeGUI\edit(), ilObjLearningHistorySettingsGUI\editSettings(), ilObjCommentsSettingsGUI\editSettings(), ilObjNotesSettingsGUI\editSettings(), ilObjSkillManagementGUI\editSettings(), ilObjLearningHistorySettingsGUI\executeCommand(), ilObjCommentsSettingsGUI\executeCommand(), ilObjNotesSettingsGUI\executeCommand(), ilObjPersonalWorkspaceSettingsGUI\executeCommand(), ilObjPersonalWorkspaceSettingsGUI\getSettingsForm(), ilObjectPluginGUI\infoScreen(), ilObjFileBasedLMGUI\properties(), ilObjCategoryGUI\renderObject(), ilAchievementsGUI\setTabs(), and ilObjFileBasedLMGUI\showInfoScreen().

Here is the caller graph for this function:

◆ addNonTabbedLink()

ilTabsGUI::addNonTabbedLink	(	string	$a_id,
		string	$a_text,
		string	$a_link,
		string	$a_frame = `""`
	)

Definition at line 307 of file class.ilTabsGUI.php.

     : void {
        $this->non_tabbed_link[] = array("text" => $a_text, "link" => $a_link,
            "frame" => $a_frame, "dir_text" => true, "id" => $a_id, "cmdClass" => array());
    }

◆ addSubTab()

ilTabsGUI::addSubTab	(	string	$a_id,
		string	$a_text,
		string	$a_link,
		string	$a_frame = `""`
	)

Definition at line 246 of file class.ilTabsGUI.php.

     : void {
        $this->sub_target[] = array("text" => $a_text, "link" => $a_link,
            "frame" => $a_frame, "dir_text" => true, "id" => $a_id, "cmdClass" => array());
    }

Referenced by ilObjWorkspaceFolderGUI\addContentSubTabs(), ilTaxMDGUI\addSubTab(), ilContainerSkillGUI\addTabs(), ilChatroomTabGUIFactory\buildTabs(), ilIndividualAssessmentSettingsGUI\getSubTabs(), and ilBookingGatewayGUI\setSubTabs().

Here is the caller graph for this function:

◆ addSubTabTarget()

ilTabsGUI::addSubTabTarget	(	string	$a_text,
		string	$a_link,
			$a_cmd = `""`,
			$a_cmdClass = `""`,
		string	$a_frame = `""`,
		bool	$a_activate = `false`,
		bool	$a_dir_text = `false`
	)

Deprecated:

Parameters

string \| array	$a_cmd
string \| array	$a_cmdClass

Definition at line 223 of file class.ilTabsGUI.php.

     : void {
        if (!$a_cmdClass) {
            $a_cmdClass = array();
        }
        $a_cmdClass = !is_array($a_cmdClass) ? array(strtolower($a_cmdClass)) : $a_cmdClass;
        #$a_cmdClass = strtolower($a_cmdClass);
 
        if ($a_activate) {
            $this->subtab_manual_activation = true;
        }
        $this->sub_target[] = array("text" => $a_text, "link" => $a_link,
            "cmd" => $a_cmd, "cmdClass" => $a_cmdClass, "frame" => $a_frame,
            "activate" => $a_activate, "dir_text" => $a_dir_text, "id" => $a_text);
    }

Referenced by ilObjQuestionPoolGUI\addSettingsSubTabs(), ilInfoScreenGUI\getTabs(), ilLearningSequenceMembershipGUI\setSubTabs(), and ilMembershipGUI\setSubTabs().

Here is the caller graph for this function:

◆ addTab()

ilTabsGUI::addTab	(	string	$a_id,
		string	$a_text,
		string	$a_link,
		string	$a_frame = `""`
	)

Add a Tab.

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

     : void {
        $this->target[] = array("text" => $a_text, "link" => $a_link,
            "frame" => $a_frame, "dir_text" => true, "id" => $a_id, "cmdClass" => array());
    }

Referenced by ilMembershipGUI\addMemberTab(), ilSkillTreeNodeGUI\addObjectsTab(), ilSkillTreeNodeGUI\addUsageTab(), ilChatroomTabGUIFactory\buildTabs(), ilObjPortfolioAdministrationGUI\getAdminTabs(), ilObjAccessibilitySettingsGUI\getAdminTabs(), ilObjLearningHistorySettingsGUI\getAdminTabs(), ilObjCommentsSettingsGUI\getAdminTabs(), ilObjNotesSettingsGUI\getAdminTabs(), ilObjPersonalWorkspaceSettingsGUI\getAdminTabs(), and ilAchievementsGUI\setTabs().

Here is the caller graph for this function:

◆ addTarget()

ilTabsGUI::addTarget	(	string	$a_text,
		string	$a_link,
			$a_cmd = `""`,
			$a_cmdClass = `""`,
		string	$a_frame = `""`,
		bool	$a_activate = `false`,
		bool	$a_dir_text = `false`
	)

Deprecated:: since version 5.0

Parameters

string \| array	$a_cmd
string \| array	$a_cmdClass

Definition at line 112 of file class.ilTabsGUI.php.

     : void {
        if (!$a_cmdClass) {
            $a_cmdClass = array();
        }
        $a_cmdClass = !is_array($a_cmdClass) ? array(strtolower($a_cmdClass)) : $a_cmdClass;
 
        if ($a_activate) {
            $this->manual_activation = true;
        }
        $this->target[] = array("text" => $a_text, "link" => $a_link,
            "cmd" => $a_cmd, "cmdClass" => $a_cmdClass, "frame" => $a_frame,
            "activate" => $a_activate, "dir_text" => $a_dir_text, "id" => $a_text);
    }

Referenced by ilObjectPluginGUI\addInfoTab(), ilObjectPluginGUI\addInilPluginAdminfoTab(), assQuestionGUI\addTab_Question(), assQuestionGUI\addTab_QuestionFeedback(), assQuestionGUI\addTab_QuestionHints(), assQuestionGUI\addTab_SuggestedSolution(), ilObjMediaObjectsSettingsGUI\getAdminTabs(), and assFormulaQuestionGUI\setQuestionSpecificTabs().

Here is the caller graph for this function:

◆ clearSubTabs()

ilTabsGUI::clearSubTabs ( )

Definition at line 292 of file class.ilTabsGUI.php.

                                  : void
    {
        $this->sub_target = array();
    }

◆ clearTargets()

ilTabsGUI::clearTargets ( )

clear all targets

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

                                  : void
    {
        global $DIC;
 
        $ilHelp = $DIC["ilHelp"] ?? null;
 
        if (!$this->getSetupMode()) {
            $ilHelp->setScreenIdComponent("");
        }
 
        $this->target = array();
        $this->sub_target = array();
        $this->non_tabbed_link = array();
        $this->back_title = "";
        $this->back_target = "";
        $this->back_2_target = "";
        $this->back_2_title = "";
        $this->setTabActive("");
        $this->setSubTabActive("");
    }

References $DIC.

Referenced by ilSkillProfileGUI\confirmLevelAssignmentRemoval(), ilObjSkillTreeGUI\create(), ilBookingObjectGUI\create(), ilSkillProfileGUI\createLocal(), ilExerciseManagementGUI\executeCommand(), ilNewsItemGUI\initFormNewsItem(), ilNewsForContextBlockGUI\initSettingsForm(), ilStructureObjectGUI\insertTemplate(), ilSurveySkillThresholdsGUI\listSkillThresholds(), ilObjSkillTreeGUI\save(), ilContainerGUI\showContainerPageTabs(), and ilSkillProfileGUI\showLevelsWithLocalContext().

Here is the caller graph for this function:

◆ getActiveTab()

ilTabsGUI::getActiveTab ( )

Definition at line 536 of file class.ilTabsGUI.php.

                                  : string
    {
        foreach ($this->target as $i => $target) {
            if ($this->target[$i]['activate'] ?? null) {
                return $this->target[$i]['id'];
            }
        }
        return "";
    }

References $i.

◆ getForcePresentationOfSingleTab()

ilTabsGUI::getForcePresentationOfSingleTab ( )

Definition at line 102 of file class.ilTabsGUI.php.

                                                     : bool
    {
        return $this->force_one_tab;
    }

◆ getHTML()

ilTabsGUI::getHTML ( bool $a_after_tabs_anchor = false )

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

                                                              : string
    {
        return $this->__getHTML(false, $a_after_tabs_anchor);
    }

◆ getSetupMode()

ilTabsGUI::getSetupMode ( )

Definition at line 72 of file class.ilTabsGUI.php.

                                  : bool
    {
        return $this->setup_mode;
    }

References $setup_mode.

◆ getSubTabHTML()

ilTabsGUI::getSubTabHTML ( )

Definition at line 302 of file class.ilTabsGUI.php.

                                   : string
    {
        return $this->__getHTML(true);
    }

◆ getTabTextOfId()

ilTabsGUI::getTabTextOfId ( string $id )

protected

Definition at line 522 of file class.ilTabsGUI.php.

                                                 : string
    {
        foreach ($this->target as $i => $target) {
            if ($this->target[$i]['id'] == $id) {
                if ($target["dir_text"]) {
                    return $target["text"];
                } else {
                    return $this->lng->txt($target["text"]);
                }
            }
        }
        return "";
    }

References $i, $id, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasTabs()

ilTabsGUI::hasTabs ( )

Definition at line 546 of file class.ilTabsGUI.php.

                             : bool
    {
        return $this->target !== [];
    }

◆ isTabActive()

ilTabsGUI::isTabActive	(	bool	$isSubTabsContext,
		array	$target,
		?string	$cmd,
		?string	$cmdClass
	)

private

Definition at line 551 of file class.ilTabsGUI.php.

                                                                                                        : bool
    {
        if (($isSubTabsContext && $this->subtab_manual_activation) || (!$isSubTabsContext && $this->manual_activation)) {
            return false;
        }
 
        $cmdClass = (string) $cmdClass;
        $cmd = (string) $cmd;
 
        $targetMatchesCmdClass = (
            !$target['cmdClass'] ||
            in_array(strtolower($cmdClass), array_map('strtolower', $target['cmdClass']), true)
        );
 
        $targetMatchesCmd = (
            in_array(strtolower($cmd), array_map('strtolower', $target['cmd']), true) ||
            (count($target['cmd']) === 1 && $target['cmd'][0] === '')
        );
 
        return $targetMatchesCmd && $targetMatchesCmdClass;
    }

◆ removeNonTabbedLinks()

ilTabsGUI::removeNonTabbedLinks ( )

Definition at line 317 of file class.ilTabsGUI.php.

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

◆ removeSubTab()

ilTabsGUI::removeSubTab ( string $a_id )

Remove a subtab identified by its id.

Definition at line 162 of file class.ilTabsGUI.php.

                                              : void
    {
        foreach ($this->sub_target as $i => $sub_target) {
            if ($this->sub_target[$i]['id'] == $a_id) {
                unset($this->sub_target[$i]);
            }
        }
    }

References $i.

◆ removeTab()

ilTabsGUI::removeTab ( string $a_id )

Remove a tab identified by its id.

Definition at line 150 of file class.ilTabsGUI.php.

                                           : void
    {
        foreach ($this->target as $key => $target) {
            if ($target['id'] == $a_id) {
                unset($this->target[$key]);
            }
        }
    }

References ILIAS\LTI\ToolProvider\$key.

◆ replaceTab()

ilTabsGUI::replaceTab	(	string	$a_old_id,
		string	$a_new_id,
		string	$a_text,
		string	$a_link,
		string	$a_frame = `''`
	)

Replace a tab.

Definition at line 174 of file class.ilTabsGUI.php.

     : void {
        for ($i = 0, $iMax = count($this->target); $i < $iMax; $i++) {
            if ($this->target[$i]['id'] == $a_old_id) {
                $this->target[$i] = array(
                    "text" => $a_text,
                    "link" => $a_link,
                    "frame" => $a_frame,
                    "dir_text" => true,
                    "id" => $a_new_id,
                    "cmdClass" => array());
            }
        }
    }

References $i.

◆ setBack2Target()

ilTabsGUI::setBack2Target	(	string	$a_title,
		string	$a_target,
		string	$a_frame = `""`
	)

Definition at line 87 of file class.ilTabsGUI.php.

     : void {
        $this->back_2_title = $a_title;
        $this->back_2_target = $a_target;
        $this->back_2_frame = $a_frame;
    }

◆ setBackTarget()

ilTabsGUI::setBackTarget	(	string	$a_title,
		string	$a_target,
		string	$a_frame = `""`
	)

Definition at line 77 of file class.ilTabsGUI.php.

     : void {
        $this->back_title = $a_title;
        $this->back_target = $a_target;
        $this->back_frame = $a_frame;
    }

Referenced by assQuestionGUI\addBackTab(), ilLMPageObjectGUI\create(), ilObjSkillTreeGUI\create(), ilSkillTreeNodeGUI\create(), ilSkillProfileGUI\createLocal(), ilStructureObjectGUI\insertTemplate(), ilObjSkillTreeGUI\save(), ilContainerGUI\showContainerPageTabs(), ilSkillProfileGUI\showLevelsWithLocalContext(), and ilLMPresentationGUI\showPrintView().

Here is the caller graph for this function:

◆ setForcePresentationOfSingleTab()

ilTabsGUI::setForcePresentationOfSingleTab ( bool $a_val )

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

                                                                : void
    {
        $this->force_one_tab = $a_val;
    }

◆ setSetupMode()

ilTabsGUI::setSetupMode ( bool $a_val )

Definition at line 67 of file class.ilTabsGUI.php.

                                             : void
    {
        $this->setup_mode = $a_val;
    }

Referenced by ilLMMenuRendererGUI\render().

Here is the caller graph for this function:

◆ setSubTabActive()

ilTabsGUI::setSubTabActive ( string $a_text )

Deprecated:: since version 5.2

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

                                                   : void
    {
        for ($i = 0, $iMax = count($this->sub_target); $i < $iMax; $i++) {
            $this->sub_target[$i]['activate'] = $this->sub_target[$i]['id'] === $a_text;
        }
        $this->subtab_manual_activation = true;
    }

References $i.

◆ setTabActive()

ilTabsGUI::setTabActive ( string $a_id )

Deprecated:: since version 5.2

Definition at line 259 of file class.ilTabsGUI.php.

                                              : void
    {
        foreach ($this->target as $key => $target) {
            $this->target[$key]['activate'] = $this->target[$key]['id'] === $a_id;
        }
        if ($a_id !== "") {
            $this->manual_activation = true;
        } else {
            $this->manual_activation = false;
        }
    }

References ILIAS\LTI\ToolProvider\$key.

Referenced by ilPCQuestionGUI\edit(), ilContainerReferenceGUI\editObject(), ilObjTaggingSettingsGUI\editSettings(), ilPCQuestionGUI\feedback(), assQuestionGUI\save(), and assQuestionGUI\saveReturn().

Here is the caller graph for this function:

Field Documentation

◆ $back_2_frame

string ilTabsGUI::$back_2_frame

protected

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

◆ $back_2_target

string ilTabsGUI::$back_2_target

protected

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

◆ $back_2_title

string ilTabsGUI::$back_2_title

protected

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

◆ $back_frame

string ilTabsGUI::$back_frame

protected

Definition at line 46 of file class.ilTabsGUI.php.

◆ $back_target

string ilTabsGUI::$back_target

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

◆ $back_title

string ilTabsGUI::$back_title

protected

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

◆ $ctrl

ilCtrl ilTabsGUI::$ctrl

protected

Definition at line 25 of file class.ilTabsGUI.php.

◆ $force_one_tab

bool ilTabsGUI::$force_one_tab = false

protected

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

◆ $lng

ilLanguage ilTabsGUI::$lng

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

◆ $manual_activation

bool ilTabsGUI::$manual_activation

protected

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

◆ $non_tabbed_link

array ilTabsGUI::$non_tabbed_link = array()

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

◆ $obj_type

string ilTabsGUI::$obj_type

Definition at line 28 of file class.ilTabsGUI.php.

◆ $setup_mode

bool ilTabsGUI::$setup_mode = false

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

Referenced by getSetupMode().

◆ $sub_tabs

bool ilTabsGUI::$sub_tabs

protected

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

◆ $sub_target

array ilTabsGUI::$sub_target = array()

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

◆ $subtab_manual_activation

bool ilTabsGUI::$subtab_manual_activation

protected

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

◆ $tabs

array ilTabsGUI::$tabs

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

◆ $target

array ilTabsGUI::$target = array()

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

◆ $target_script

string ilTabsGUI::$target_script

Definition at line 27 of file class.ilTabsGUI.php.

◆ $temp_var

string ilTabsGUI::$temp_var

protected

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

◆ $tpl

ilGlobalTemplateInterface ilTabsGUI::$tpl

Definition at line 29 of file class.ilTabsGUI.php.

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

Services/UIComponent/Tabs/classes/class.ilTabsGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ activateSubTab()

◆ activateTab()

◆ addNonTabbedLink()

◆ addSubTab()

◆ addSubTabTarget()

◆ addTab()

◆ addTarget()

◆ clearSubTabs()

◆ clearTargets()

◆ getActiveTab()

◆ getForcePresentationOfSingleTab()

◆ getHTML()

◆ getSetupMode()

◆ getSubTabHTML()

◆ getTabTextOfId()

◆ hasTabs()

◆ isTabActive()

◆ removeNonTabbedLinks()

◆ removeSubTab()

◆ removeTab()

◆ replaceTab()

◆ setBack2Target()

◆ setBackTarget()

◆ setForcePresentationOfSingleTab()

◆ setSetupMode()

◆ setSubTabActive()

◆ setTabActive()

Field Documentation

◆ $back_2_frame

◆ $back_2_target

◆ $back_2_title

◆ $back_frame

◆ $back_target

◆ $back_title

◆ $ctrl

◆ $force_one_tab

◆ $lng

◆ $manual_activation

◆ $non_tabbed_link

◆ $obj_type

◆ $setup_mode

◆ $sub_tabs

◆ $sub_target

◆ $subtab_manual_activation

◆ $tabs

◆ $target

◆ $target_script

◆ $temp_var

◆ $tpl