Collaboration diagram for ilTabsGUI:

Public Member Functions
	__construct ()
	Constructor public. More...

	setSetupMode ($a_val)
	Set setup mode. More...

	getSetupMode ()
	Get setup mode. More...

	setBackTarget ($a_title, $a_target, $a_frame="")
	back target for upper context More...

	setBack2Target ($a_title, $a_target, $a_frame="")
	back target for tow level upper context More...

	setForcePresentationOfSingleTab ($a_val)
	Set force presentation of single tab. More...

	getForcePresentationOfSingleTab ()
	Get force presentation of single tab. More...

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

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

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

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

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

	clearTargets ()
	clear all targets More...

	addSubTabTarget ( $a_text, $a_link, $a_cmd="", $a_cmdClass="", $a_frame="", $a_activate=false, $a_dir_text=false)
	DEPRECATED. More...

	addSubTab ($a_id, $a_text, $a_link, $a_frame="")
	Add a Subtab. More...

	setTabActive ($a_id)
	DEPRECATED. More...

	activateTab ($a_id)
	Activate a specific tab identified its id. More...

	setSubTabActive ($a_text)

	activateSubTab ($a_id)
	Activate a specific subtab identified its id. More...

	clearSubTabs ()
	Clear all already added sub tabs. More...

	getHTML ($a_after_tabs_anchor=false)
	get tabs code as html More...

	getSubTabHTML ()
	get sub tabs code as html More...

	addNonTabbedLink ($a_id, $a_text, $a_link, $a_frame="")
	Add a non-tabbed link (outside of tabs at same level) More...

	getActiveTab ()

	hasTabs ()

Data Fields
	$target_script

	$obj_type

	$tpl

	$lng

	$tabs

	$target = array()

	$sub_target = array()

	$non_tabbed_link = array()

	$setup_mode = false

Protected Attributes
	$ctrl

	$force_one_tab = false

Private Member Functions
	__getHTML ($a_get_sub_tabs, $a_after_tabs_anchor=false)
	get tabs code as html More...

Detailed Description

Tabs GUI.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilTabsGUI::__construct ( )

Constructor public.

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

References $DIC, $lng, and $tpl.

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $tpl = $DIC["tpl"];
         $lng = $DIC->language();
 
         $this->tpl = $tpl;
         $this->lng = $lng;
         $this->manual_activation = false;
         $this->subtab_manual_activation = false;
         $this->temp_var = "TABS";
         $this->sub_tabs = false;
         $this->back_title = "";
         $this->back_target = "";
         $this->back_2_target = "";
         $this->back_2_title = "";
     }

Member Function Documentation

◆ __getHTML()

ilTabsGUI::__getHTML	(	$a_get_sub_tabs,
		$a_after_tabs_anchor = `false`
	)

private

get tabs code as html

Parameters

bool	$a_get_sub_tabs	choose tabs or sub tabs
bool	$a_after_tabs_anchor

Returns: string Private

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

References $ctrl, $DIC, $i, $ilCtrl, $ilUser, $lng, XapiProxy\$resp, $target, $tpl, ilTooltipGUI\addTooltip(), ilGlyphGUI\get(), ilPluginAdmin\getPluginObject(), getSetupMode(), ilHelpGUI\ID_PART_SCREEN, ilHelpGUI\ID_PART_SUB_SCREEN, IL_COMP_SERVICE, ilGlyphGUI\NEXT, ilGlyphGUI\NO_TEXT, and ilGlyphGUI\PREVIOUS.

Referenced by getHTML(), and getSubTabHTML().

     {
         global $DIC;
 
         $ilHelp = null;
         if (isset($DIC["ilHelp"])) {
             $ilHelp = $DIC["ilHelp"];
         }
 
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilUser = null;
         if (isset($DIC["ilUser"])) {
             $ilUser = $DIC->user();
         }
         $ilPluginAdmin = null;
         if (isset($DIC["ilPluginAdmin"])) {
             $ilPluginAdmin = $DIC["ilPluginAdmin"];
         }
 
         // user interface hook [uihk]
         if (!$this->getSetupMode()) {
             $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");
             foreach ($pl_names as $pl) {
                 $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
                 $gui_class = $ui_plugin->getUIClassInstance();
                 $resp = $gui_class->modifyGUI(
                     "",
                     $a_get_sub_tabs ? "sub_tabs" : "tabs",
                     array("tabs" => $this)
                 );
             }
         }
 
         
         // user interface hook [uihk]
         if (!$this->getSetupMode()) {
             $cmd = $ilCtrl->getCmd();
             $cmdClass = $ilCtrl->getCmdClass();
         }
 
         if ($a_get_sub_tabs) {
             $tpl = new ilTemplate("tpl.sub_tabs.html", true, true, "Services/UIComponent/Tabs");
             $pre = "sub";
             $pre2 = "SUB_";
             $sr_pre = "sub_";
         } else {
             $tpl = new ilTemplate("tpl.tabs.html", true, true, "Services/UIComponent/Tabs");
             if ($a_after_tabs_anchor) {
                 $tpl->touchBlock("after_tabs");
             }
             $pre = $pre2 = "";
 
             include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
 
             // back 2 tab
             if ($this->back_2_title != "") {
                 $tpl->setCurrentBlock("back_2_tab");
                 $tpl->setVariable("BACK_2_ICON", ilGlyphGUI::get(ilGlyphGUI::PREVIOUS, ilGlyphGUI::NO_TEXT));
                 $tpl->setVariable("BACK_2_TAB_LINK", $this->back_2_target);
                 $tpl->setVariable("BACK_2_TAB_TEXT", $this->back_2_title);
                 if ($this->back_2_frame != "") {
                     $tpl->setVariable("BACK_2_TAB_TARGET", ' target="'.$this->back_2_frame.'" ');
                 }
 
                 $tpl->parseCurrentBlock();
             }
             
             // back tab
             if ($this->back_title != "") {
                 $tpl->setCurrentBlock("back_tab");
                 $tpl->setVariable("BACK_ICON", ilGlyphGUI::get(ilGlyphGUI::PREVIOUS, ilGlyphGUI::NO_TEXT));
                 $tpl->setVariable("BACK_TAB_LINK", $this->back_target);
                 $tpl->setVariable("BACK_TAB_TEXT", $this->back_title);
                 if ($this->back_frame != "") {
                     $tpl->setVariable("BACK_TAB_TARGET", ' target="'.$this->back_frame.'" ');
                 }
                 $tpl->parseCurrentBlock();
             }
         }
 
         $targets = $a_get_sub_tabs ? $this->sub_target : $this->target;
 
         $i = 0;
         
         // do not display one tab only
         if ((count($targets) > 1 || $this->force_one_tab) || ($this->back_title != "" && !$a_get_sub_tabs)
             || (count($this->non_tabbed_link) > 0 && !$a_get_sub_tabs)) {
             foreach ($targets as $target) {
                 $i++;
                 
                 if (!is_array($target["cmd"])) {
                     $target["cmd"] = array($target["cmd"]);
                 }
                 if (!($a_get_sub_tabs ? $this->subtab_manual_activation : $this->manual_activation) &&
                     (in_array($cmd, $target["cmd"]) || ($target["cmd"][0] == "" && count($target["cmd"]) == 1)) &&
                     (in_array($cmdClass, $target["cmdClass"]) || !$target["cmdClass"])) {
                     $tabtype = $pre . "tabactive";
                 } else {
                     $tabtype = $pre . "tabinactive";
                 }
                 
                 if (($a_get_sub_tabs ? $this->subtab_manual_activation : $this->manual_activation) && $target["activate"]) {
                     $tabtype = $pre . "tabactive";
                 }
 
                 if ($tabtype == "tabactive" || $tabtype == "subtabactive") {
                     $tpl->setCurrentBlock("sel_text");
                     $tpl->setVariable("TXT_SELECTED", $lng->txt("stat_selected"));
                     $tpl->parseCurrentBlock();
                     
                     if (!$this->getSetupMode()) {
                         if ($a_get_sub_tabs) {
                             $part = ilHelpGUI::ID_PART_SUB_SCREEN;
                         } else {
                             $part = ilHelpGUI::ID_PART_SCREEN;
                         }
                         $ilHelp->setDefaultScreenId($part, $target["id"]);
                     }
                 }
     
                 $tpl->setCurrentBlock($pre . "tab");
                 $tpl->setVariable("ID", $pre . "tab_" . $target["id"]);
                 
                 // tooltip
                 if (!$this->getSetupMode()) {
                     $ttext = $ilHelp->getTabTooltipText($target["id"]);
                     if ($ttext != "") {
                         include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                         ilTooltipGUI::addTooltip(
                             $pre . "tab_" . $target["id"],
                             $ttext,
                             "",
                             "bottom center",
                             "top center",
                             false
                         );
                     }
                 }
 
                 // bs-patch: start
                 $tabtype = in_array($tabtype, array("tabactive", "subtabactive"))
                     ? "active"
                     : "";
                 // bs-patch: end
 
                 $tpl->setVariable($pre2 . "TAB_TYPE", $tabtype);
                 if (!$this->getSetupMode()) {
                     $hash = ($ilUser->getPref("screen_reader_optimization"))
                         ? "#after_" . $sr_pre . "tabs"
                         : "";
                 }
                 
                 $tpl->setVariable($pre2 . "TAB_LINK", $target["link"] . $hash);
                 if ($target["dir_text"]) {
                     $tpl->setVariable($pre2 . "TAB_TEXT", $target["text"]);
                 } else {
                     $tpl->setVariable($pre2 . "TAB_TEXT", $lng->txt($target["text"]));
                 }
                 if ($target["frame"] != "") {
                     $tpl->setVariable($pre2 . "TAB_TARGET", ' target="'.$target["frame"].'" ');
                 }
                 $tpl->parseCurrentBlock();
             }
             
             if ($a_get_sub_tabs) {
                 $tpl->setVariable("TXT_SUBTABS", $lng->txt("subtabs"));
             } else {
                 $tpl->setVariable("TXT_TABS", $lng->txt("tabs"));
 
                 // non tabbed links
                 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                 foreach ($this->non_tabbed_link as $link) {
                     $tpl->setCurrentBlock("tab");
                     $tpl->setVariable("TAB_TYPE", "nontabbed");
                     $tpl->setVariable("TAB_ICON", " " . ilGlyphGUI::get(ilGlyphGUI::NEXT, ilGlyphGUI::NO_TEXT));
                     $tpl->setVariable("TAB_TEXT", $link["text"]);
                     $tpl->setVariable("TAB_LINK", $link["link"]);
                     $tpl->setVariable("TAB_TARGET", $link["frame"]);
                     $tpl->setVariable("ID", "nontab_" . $link["id"]);
                     $tpl->parseCurrentBlock();
                     
                     // tooltip
                     if (!$this->getSetupMode()) {
                         $ttext = $ilHelp->getTabTooltipText($link["id"]);
                         if ($ttext != "") {
                             include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                             ilTooltipGUI::addTooltip(
                                 "nontab_" . $link["id"],
                                 $ttext,
                                 "",
                                 "bottom center",
                                 "top center",
                                 false
                             );
                         }
                     }
                 }
             }
 
             return $tpl->get();
         } else {
             return "";
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activateSubTab()

ilTabsGUI::activateSubTab ( $a_id )

Activate a specific subtab identified its id.

Parameters

string $a_text menu item text

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

References setSubTabActive().

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

Here is the call graph for this function:

◆ activateTab()

ilTabsGUI::activateTab ( $a_id )

Activate a specific tab identified its id.

Parameters

string $a_text menu item text

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

References setTabActive().

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

Here is the call graph for this function:

◆ addNonTabbedLink()

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

Add a non-tabbed link (outside of tabs at same level)

Parameters

string	id
string	text (no lang var!)
string	link
string	frame target

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

     {
         $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	(	$a_id,
		$a_text,
		$a_link,
		$a_frame = `""`
	)

Add a Subtab.

Parameters

string	id
string	text (no lang var!)
string	link
string	frame target

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

Referenced by ilChatroomTabGUIFactory\buildTabs(), and ilIndividualAssessmentSettingsGUI\getSubTabs().

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

Here is the caller graph for this function:

◆ addSubTabTarget()

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

DEPRECATED.

Use addTab/addSubTab and activateTab/activateSubTab.

Add a Subtarget to the tabbed menu. If no target has set $a_activate to true, ILIAS tries to determine the current activated menu item automatically using $a_cmd and $a_cmdClass. If one item is set activated (and only one should be activated) the automatism is disabled.

Parameters

string	$a_text	menu item text
string	$a_link	menu item link
string	$a_cmd	command, used for auto activation
string	$a_cmdClass	used for auto activation. String or array of cmd classes
string	$a_frame	frame target
boolean	$a_activate	activate this menu item
boolean	$a_dir_text	text is direct text, no language variable

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

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

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

Here is the caller graph for this function:

◆ addTab()

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

Add a Tab.

Parameters

string	id
string	text (no lang var!)
string	link
string	frame target

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

Referenced by ilMembershipGUI\addMemberTab(), and ilChatroomTabGUIFactory\buildTabs().

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

Here is the caller graph for this function:

◆ addTarget()

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

Deprecated:: since version 5.0

Use addTab/addSubTab and activateTab/activateSubTab.

Add a target to the tabbed menu. If no target has set $a_activate to true, ILIAS tries to determine the current activated menu item automatically using $a_cmd and $a_cmdClass. If one item is set activated (and only one should be activated) the automatism is disabled.

Parameters

string	$a_text	menu item text
string	$a_link	menu item link
string	$a_cmd	command, used for auto activation
string	$a_cmdClass	used for auto activation. String or array of cmd classes
string	$a_frame	frame target
boolean	$a_activate	activate this menu item

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

Referenced by assQuestionGUI\addTab_QuestionFeedback(), assQuestionGUI\addTab_QuestionHints(), assQuestionGUI\addTab_QuestionPreview(), and assQuestionGUI\addTab_SuggestedSolution().

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

Here is the caller graph for this function:

◆ clearSubTabs()

ilTabsGUI::clearSubTabs ( )

Clear all already added sub tabs.

Parameters

boolean

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

     {
         $this->sub_target = array();
         return true;
     }

◆ clearTargets()

ilTabsGUI::clearTargets ( )

clear all targets

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

References $DIC, getSetupMode(), setSubTabActive(), and setTabActive().

     {
         global $DIC;
 
         $ilHelp = null;
         if (isset($DIC["ilHelp"])) {
             $ilHelp = $DIC["ilHelp"];
         }
         
         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("");
     }

Here is the call graph for this function:

◆ getActiveTab()

ilTabsGUI::getActiveTab ( )

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

References $i, and $target.

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

◆ getForcePresentationOfSingleTab()

ilTabsGUI::getForcePresentationOfSingleTab ( )

Get force presentation of single tab.

Returns: bool force presentation of single tab

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

References $force_one_tab.

     {
         return $this->force_one_tab;
     }

◆ getHTML()

ilTabsGUI::getHTML ( $a_after_tabs_anchor = false )

get tabs code as html

Parameters

bool $a_after_tabs_anchor

Returns: string

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

References __getHTML().

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

Here is the call graph for this function:

◆ getSetupMode()

ilTabsGUI::getSetupMode ( )

Get setup mode.

Returns: boolean setup mode

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

References $setup_mode.

Referenced by __getHTML(), and clearTargets().

     {
         return $this->setup_mode;
     }

Here is the caller graph for this function:

◆ getSubTabHTML()

ilTabsGUI::getSubTabHTML ( )

get sub tabs code as html

Returns: string

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

References __getHTML().

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

Here is the call graph for this function:

◆ hasTabs()

ilTabsGUI::hasTabs ( )

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

References $target.

     {
         return (bool) sizeof($this->target);
     }

◆ removeSubTab()

ilTabsGUI::removeSubTab ( $a_id )

Remove a tab identified by its id.

Parameters

string $a_id Id of tab to remove

Returns: bool false if tab wasn't found public

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

References $i, and $sub_target.

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

◆ removeTab()

ilTabsGUI::removeTab ( $a_id )

Remove a tab identified by its id.

Parameters

string $a_id Id of tab to remove

Returns: bool false if tab wasn't found public

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

References $target.

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

◆ replaceTab()

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

Replace a tab.

In contrast to a combination of removeTab and addTab, the position is kept.

Parameters

string	$a_old_id	old id of tab
string	$a_new_id	new id if tab
string	$a_text	tab text
string	$a_link	tab link
string	$a_frame,[optional]	frame

Returns: bool

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

References $i.

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

◆ setBack2Target()

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

back target for tow level upper context

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

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

◆ setBackTarget()

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

back target for upper context

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

Referenced by assQuestionGUI\addBackTab().

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

Here is the caller graph for this function:

◆ setForcePresentationOfSingleTab()

ilTabsGUI::setForcePresentationOfSingleTab ( $a_val )

Set force presentation of single tab.

Parameters

bool $a_val force presentation of single tab

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

     {
         $this->force_one_tab = $a_val;
     }

◆ setSetupMode()

ilTabsGUI::setSetupMode ( $a_val )

Set setup mode.

Parameters

boolean $a_val setup mode

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

     {
         $this->setup_mode = $a_val;
     }

◆ setSubTabActive()

ilTabsGUI::setSubTabActive ( $a_text )

Deprecated:: since version 5.2

Use addTab/addSubTab and activateTab/activateSubTab.

Activate a specific tab identified by name This method overrides the definition in YOUR_OBJECT::getTabs() and deactivates all other tabs.

Parameters

string	$a_text	menu item text
	boolean

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

References $i.

Referenced by activateSubTab(), and clearTargets().

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

Here is the caller graph for this function:

◆ setTabActive()

ilTabsGUI::setTabActive ( $a_id )

DEPRECATED.

Deprecated:: since version 5.2

Use addTab/addSubTab and activateTab/activateSubTab.

Activate a specific tab identified by name This method overrides the definition in YOUR_OBJECT::getTabs() and deactivates all other tabs.

Parameters

string $a_text menu item text

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

References $target.

Referenced by activateTab(), and clearTargets().

     {
         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;
         }
         return true;
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilTabsGUI::$ctrl

protected

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

Referenced by __getHTML().

◆ $force_one_tab

ilTabsGUI::$force_one_tab = false

protected

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

Referenced by getForcePresentationOfSingleTab().

◆ $lng

ilTabsGUI::$lng

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

Referenced by __construct(), and __getHTML().

◆ $non_tabbed_link

ilTabsGUI::$non_tabbed_link = array()

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

◆ $obj_type

ilTabsGUI::$obj_type

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

◆ $setup_mode

ilTabsGUI::$setup_mode = false

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

Referenced by getSetupMode().

◆ $sub_target

ilTabsGUI::$sub_target = array()

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

Referenced by removeSubTab().

◆ $tabs

ilTabsGUI::$tabs

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

◆ $target

ilTabsGUI::$target = array()

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

Referenced by __getHTML(), getActiveTab(), hasTabs(), removeTab(), and setTabActive().

◆ $target_script

ilTabsGUI::$target_script

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

◆ $tpl

ilTabsGUI::$tpl

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

Referenced by __construct(), and __getHTML().

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

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

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __getHTML()

◆ activateSubTab()

◆ activateTab()

◆ addNonTabbedLink()

◆ addSubTab()

◆ addSubTabTarget()

◆ addTab()

◆ addTarget()

◆ clearSubTabs()

◆ clearTargets()

◆ getActiveTab()

◆ getForcePresentationOfSingleTab()

◆ getHTML()

◆ getSetupMode()

◆ getSubTabHTML()

◆ hasTabs()

◆ removeSubTab()

◆ removeTab()

◆ replaceTab()

◆ setBack2Target()

◆ setBackTarget()

◆ setForcePresentationOfSingleTab()

◆ setSetupMode()

◆ setSubTabActive()

◆ setTabActive()

Field Documentation

◆ $ctrl

◆ $force_one_tab

◆ $lng

◆ $non_tabbed_link

◆ $obj_type

◆ $setup_mode

◆ $sub_target

◆ $tabs

◆ $target

◆ $target_script

◆ $tpl