Field Interface Reference
[Basic Fields]

Inheritance diagram for Field:

List of all members.

---

Detailed Description

Field interface.

All fields must implement this, although most will just inheirt from AbstractField so this really is just a formality

Author:

Scott Peshak

Date:

Date

2006-05-19 21:27:22 -0500 (Fri, 19 May 2006)

Definition at line 10 of file field.inc.php.

Public Member Functions
	__construct ($name, Form &$parentForm, array $attribs)
	Constructor.
	drawInput ()
	Draw the HTML input for the field.
	getData ()
	Get the value of the Field.
	validate ()
	Validate the input of the form.
	getSqlImpl ()
	Get an SQL representation of the field data.
	hasError ()
	Check to see if the field has any errors.
	setData ($value)
	Set the field data to a passed value.
	getJs ()
	Get any JavaScript that is needed by this field.
	getCss ()
	Get any special CSS that is needed by the field.
	forceError ()
	Force a field to have an error.

---

Member Function Documentation

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

Constructor. Parameters: $name  Field name $parentForm  Form object that owns the field. $attribs  Array of extra attributes Implemented in AbstractField, AbstractListField, AutoCompleteField, CheckboxField, CityStateZipField, CollectionField, ConditionalField, DateField, DateTimeField, EditorField, EmailField, GenderField, IpAddressField, NameField, PasswordChangeField, PhoneNumberField, SSNField, TimeField, and UsStateField.

Field::drawInput (   )

Draw the HTML input for the field. Implemented in AutoCompleteField, ButtonField, CheckboxField, CheckboxListField, CollectionField, ConditionalField, DateField, EditorField, HiddenField, LabelField, MultiSelectField, PasswordField, PasswordChangeField, RadioField, RadioListField, SelectField, TextField, TextareaField, TimeField, and UploadField.

Field::forceError (   )

Force a field to have an error. Implemented in AbstractField.

Field::getCss (   )

Get any special CSS that is needed by the field. Returns: string of CSS Implemented in AbstractField, CollectionField, and PasswordChangeField.

Field::getData (   )

Get the value of the Field. Returns: Value of the Field Implemented in AbstractField, ButtonField, CollectionField, DateTimeField, IpAddressField, MultiSelectField, PasswordField, PasswordChangeField, PhoneNumberField, and SSNField.

Field::getJs (   )

Get any JavaScript that is needed by this field. Returns: string of JavaScript Implemented in AbstractField, CollectionField, ConditionalField, and PasswordChangeField.

Field::getSqlImpl (   )

Get an SQL representation of the field data. Returns: SQL string ready to use in a query. Implemented in AbstractField, ButtonField, CheckboxListField, CityStateZipField, CollectionField, DateTimeField, IpAddressField, LabelField, NameField, PasswordField, PasswordChangeField, PhoneNumberField, and SSNField.

Field::hasError (   )

Check to see if the field has any errors. Returns: Boolean true if the field has an error, false otherwise Implemented in AbstractField, ButtonField, and CollectionField.

Field::setData (  $  value  )

Set the field data to a passed value. Parameters: $value  Value to set Implemented in AbstractField, CheckboxListField, DateTimeField, IpAddressField, MultiSelectField, PhoneNumberField, and SSNField.

Field::validate (   )

Validate the input of the form. This sets the form data from the $_REQUEST input, and runs any sort of validation routines needed Implemented in AbstractField, ButtonField, CheckboxField, CollectionField, IpAddressField, PasswordChangeField, SSNField, and UploadField.

---

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

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

---