ConditionalField Class Reference
[Collection Fields]

Inheritance diagram for ConditionalField:

List of all members.

---

Detailed Description

Field that is active only when an accompaning checkbox is selected (or not selected).

Author:

Scott Peshak

Date:

Date

2006-05-29 14:55:45 -0500 (Mon, 29 May 2006)

Definition at line 8 of file conditional-field.inc.php.

Public Member Functions
	__construct ($name, Form &$parentForm, array $attribs=array())
	Constructor.
	__set ($name, $value)
	Magic setter.
	drawInput ()
	Draw the HTML for the field.
	getJs ()
	Get the JavaScript for the conditional field.
Protected Member Functions
	subFieldsToJsArray ()
	Get the list of sub fields (except the checkbox) as a javascript array.
Static Protected Attributes
	$jsDrawn = false
	Boolean flag if the drawJs method had been called yet.
Private Attributes
	$activeOn
	What condition the field will be active on.

---

Member Function Documentation

ConditionalField::__construct (  $  name, Form &$  parentForm, array $  attribs = array() )

Constructor. Parameters: $name  Name of collection $parentForm  Form object that the field belongs to. $attribs  Extra attributes Reimplemented from CollectionField. Definition at line 19 of file conditional-field.inc.php.

ConditionalField::__set (  $  name, $  value )

Magic setter. Parameters: $name  Name of member to set $value  Value to set Reimplemented from CollectionField. Definition at line 40 of file conditional-field.inc.php.

ConditionalField::drawInput (   )

Draw the HTML for the field. Reimplemented from CollectionField. Definition at line 52 of file conditional-field.inc.php. References subFieldsToJsArray().

ConditionalField::getJs (   )

Get the JavaScript for the conditional field. Returns: string of JavaScript Reimplemented from CollectionField. Definition at line 63 of file conditional-field.inc.php.

ConditionalField::subFieldsToJsArray (   )  [protected]

Get the list of sub fields (except the checkbox) as a javascript array. Returns: String of javascript ready for use Definition at line 95 of file conditional-field.inc.php. Referenced by drawInput().

---

Member Data Documentation

ConditionalField::$activeOn [private]

What condition the field will be active on. Definition at line 10 of file conditional-field.inc.php.

ConditionalField::$jsDrawn = false [static, protected]

Boolean flag if the drawJs method had been called yet. Reimplemented from CollectionField. Definition at line 11 of file conditional-field.inc.php.

---

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

• lib/form/fields/conditional-field.inc.php

---