Class Horde_UI_Widget

Description

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

$Horde: framework/UI/UI/Widget.php,v 1.7.10.13 2009/01/06 15:23:45 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /UI/UI/Widget.php (line 17)


	
			
Direct descendents
Class Description
 class Horde_UI_Pager The Horde_UI_Pager:: provides links to individual pages.
 class Horde_UI_Tabs The Horde_UI_Tabs:: class manages and renders a tab-like interface.
Variable Summary
Method Summary
 Horde_UI_Widget Horde_UI_Widget (string $name, Variables &$vars, [array $config = array()])
 void preserve (string|array $var, [mixed $value = null])
 void render (mixed $data)
 void _link ( $link)
Variables
array $_config (line 49)

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

string $_name (line 33)

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

array $_preserve = array() (line 25)

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

callable $_url_callback = array('Horde', 'applicationUrl') (line 58)

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.

Variables $_vars (line 41)

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

Methods
Constructor Horde_UI_Widget (line 68)

Construct a new UI Widget interface.

Horde_UI_Widget Horde_UI_Widget (string $name, Variables &$vars, [array $config = array()])
  • string $name: The name of the variable which will track this UI widget's state.
  • Variables &$vars: A Variables:: object.
  • array $config: The widget's configuration.
preserve (line 89)

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

void preserve (string|array $var, [mixed $value = null])
  • string|array $var: The name of the variable to preserve, or (since Horde 3.2) an array of variables to preserve.
  • mixed $value: If preserving a single key, the value of the variable to preserve.
render (line 118)

Render the widget.

  • abstract:
void render (mixed $data)
  • mixed $data: The widget's state data.

Redefined in descendants as:
_link (line 124)
void _link ( $link)
  • $link

Documentation generated on Sun, 30 Jan 2011 05:23:27 +0000 by phpDocumentor 1.4.3