Class Horde_Form_Action

Description

The Horde_Form_Action class provides an API for adding actions to Horde_Form variables.

$Horde: framework/Form/Form/Action.php,v 1.19.10.11 2009/01/06 15:23:06 jan Exp $ Copyright 2002-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 /Form/Form/Action.php (line 15)


	
			
Direct descendents
Class Description
 class Horde_Form_Action_ConditionalEnable Horde_Form_Action_ConditionalEnable is a Horde_Form_Action that enables or disables an element based on the value of another element
 class Horde_Form_Action_ConditionalSetValue Horde_Form_Action_ConditionalSetValue is a Horde_Form_Action that sets the value of one Horde_Form variable based on the value of the variable the action is attached to.
 class Horde_Form_Action_conditional_enable Horde_Form_Action_conditional_enable is a Horde_Form_Action that enables or disables an element based on the value of another element
 class Horde_Form_Action_conditional_setvalue Horde_Form_Action_conditional_setvalue is a Horde_Form_Action that sets the value of one Horde_Form variable based on the value of the variable the action is attached to.
 class Horde_Form_Action_reload Horde_Form_Action_reload is a Horde_Form Action that reloads the form with the current (not the original) value after the form element that the action is attached to is modified.
 class Horde_Form_Action_setcursorpos Horde_Form_Action_setcursorpos is a Horde_Form_Action that places the cursor in a text field.
 class Horde_Form_Action_submit Horde_Form_Action_submit is a Horde_Form Action that submits the form after the form element that the action is attached to is modified.
 class Horde_Form_Action_sum_fields Horde_Form_Action_sum_fields is a Horde_Form_Action that sets the target field to the sum of one or more other numeric fields.
 class Horde_Form_Action_updatefield Horde_Form_Action_updatefield is a Horde_Form_Action that updates the value of one Horde_Form variable as the variable the action is attached to is updated.
Variable Summary
 mixed $_id
 mixed $_params
 mixed $_trigger
Method Summary
 Horde_Form_Action Horde_Form_Action ([ $params = null])
 Horde_Form_Action &factory (mixed $action, [array $params = null])
 void getActionScript ( $form,  $renderer,  $varname)
 void getTarget ()
 void getTrigger ()
 void id ()
 void printJavaScript ()
 void setValues ( &$vars,  $sourceVal, [ $index = null], [ $arrayVal = false])
 Horde_Form_Action &singleton (mixed $action, [array $params = null])
Variables
Methods
Constructor Horde_Form_Action (line 21)
Horde_Form_Action Horde_Form_Action ([ $params = null])
  • $params
factory (line 79)

Attempts to return a concrete Horde_Form_Action instance based on $form.

  • return: The concrete Horde_Form_Action reference, or false on an error.
Horde_Form_Action &factory (mixed $action, [array $params = null])
  • mixed $action: The type of concrete Horde_Form_Action subclass to return. If $action is an array, then we will look in $action[0]/lib/Form/Action/ for the subclass implementation named $action[1].php.
  • array $params: A hash containing any additional configuration a form might need.
getTarget (line 56)
void getTarget ()
getTrigger (line 27)
void getTrigger ()
id (line 32)
void id ()
setValues (line 61)
void setValues ( &$vars,  $sourceVal, [ $index = null], [ $arrayVal = false])
  • &$vars
  • $sourceVal
  • $index
  • $arrayVal

Redefined in descendants as:
singleton (line 127)

Attempts to return a reference to a concrete Horde_Form_Action instance based on $action. It will only create a new instance if no Horde_Form_Action instance with the same parameters currently exists.

This should be used if multiple types of form renderers (and, thus, multiple Horde_Form_Action instances) are required.

This method must be invoked as: $var = &Horde_Form_Action::singleton()

  • return: The concrete Horde_Form_Action reference, or false on an error.
Horde_Form_Action &singleton (mixed $action, [array $params = null])
  • mixed $action: The type of concrete Horde_Form_Action subclass to return. The code is dynamically included. If $action is an array, then we will look in $action[0]/lib/Form/Action/ for the subclass implementation named $action[1].php.
  • array $params: A hash containing any additional configuration a form might need.
_printJavaScriptEnd (line 51)
void _printJavaScriptEnd ()
_printJavaScriptStart (line 46)
void _printJavaScriptStart ()

Documentation generated on Sun, 30 Jan 2011 05:14:58 +0000 by phpDocumentor 1.4.3