API Documentation
\

\Horde_Core_Ui_Widget

The Horde_Core_Ui_Widget:: class provides base functionality for other Horde UI elements.

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

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()
No public properties found
No constants found
_addPreserved()
_link()
$_preserve
$_name
$_vars
$_config
$_url_callback
N/A
No private methods found
No private properties found
N/A

Properties

$_preserve

$_preserve : array

Any variables that should be preserved in all of the widget's links.

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

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(mixed  $data = null)

Render the widget.

Parameters

mixed $data

The widget's state data.

_addPreserved()

_addPreserved(  $link)

TODO

Parameters

$link

_link()

_link(  $link)

TODO

Parameters

$link