\Horde_Core_Ui_Tabs

The Horde_Core_Ui_Tabs:: class manages and renders a tab-like interface.

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods

Properties

Constants

__construct()
preserve()
render()
addTab()
getTitleFromAction()

No public properties found

No constants found

_addPreserved()
_link()

$_preserve
$_name
$_vars
$_config
$_url_callback
$_tabs

N/A

No private methods found

No private properties found

N/A

File: Horde/Core/Ui/Tabs.php
Package: Core
Class hierarchy: \Horde_Core_Ui_Widget

\Horde_Core_Ui_Tabs

Type

array

$_name

$_name : string

The name of this widget. This is used as the basename for variables we access and manipulate.

Type

string

$_vars

$_vars : \Horde_Variables

A reference to a Horde_Variables:: object this widget will use and manipulate.

Type

\Horde_Variables

$_config

$_config : array

An array of name => value pairs which configure how this widget behaves.

Type

array

$_url_callback

$_url_callback : callable

Holds the name of a callback function to call on any URLS before they are used/returned. If an array, it is taken as an object/method name, if a string, it is taken as a php function.

Type

callable

$_tabs

$_tabs : array

The array of tabs.

Type

array

Methods

__construct()

__construct(string  $name, \Horde_Variables  $vars, array  $config = array())

Construct a new UI Widget interface.

Parameters

string	$name	The name of the variable which will track this UI widget's state.
\Horde_Variables	$vars	A Horde_Variables:: object.
array	$config	The widget's configuration.

preserve()

preserve(string|array  $var, mixed  $value = null)

Instructs widget to preserve a variable or a set of variables.

Parameters

string\|array	$var	The name of the variable to preserve, or an array of variables to preserve.
mixed	$value	If preserving a single key, the value of the variable to preserve.

render()

render(string  $active_tab = null, string  $class = 'tabset')

Renders the tabs.

Parameters

string	$active_tab	If specified, the name of the active tab. If not, the active tab is determined automatically.
string	$class	The CSS class of the tabset.

addTab()

addTab(string  $title, \Horde_Url  $link, mixed  $params = array())

Adds a tab to the interface.

Parameters

string	$title	The text which appears on the tab.
\Horde_Url	$link	The target page.
mixed	$params	Either a string value to set the tab variable to, or a hash of parameters. If an array, the tab variable can be set by the 'tabname' key.

getTitleFromAction()

getTitleFromAction(string  $tabname) : string

Returns the title of the tab with the specified name.

Parameters

string

$tabname

The name of the tab.

Returns

string —

The tab's title.

_addPreserved()

_addPreserved(  $link)

TODO

Parameters

$link

_link()

_link(  $link)

TODO

Parameters

$link