Docs For Class TFormElement

Description

Base class for all Form elements. This does nothing on its own.

abstract:
version: 09-02-2003 12:22
author: Greg MacLellan

Located in /form-element.inc.php (line 11)

Direct descendents

Class	Description
TFormCheckbox	Basic Text Field
TFormDateTime	Date and Time Field
TFormDayMatrix	Picks day of week
TFormDayPicker	Picks day of week
TFormDisplay	Displays the value of a field. Only for display purposes, not used in queries.
TFormDivision	Division in edit form. Only for display purposes, not stored anywhere.
TFormFileDisk	Basic File Upload Handler
TFormFile	Basic File Upload Handler
TFormHidden	Basic Hidden Field
TFormMultiCheck	Multiple-item check boxes
TFormRadio	Basic Radio Button Set
TFormSelect	Basic Select Field
TFormStatic	Displays a static text value (not stored)
TFormSubmit	Basic Submit button
TFormTextarea	Text Area
TFormText	Basic Text Field

Variable Summary

mixed $alwaysSet

mixed $class

mixed $displayname

mixed $htmltype

mixed $name

mixed $parent

mixed $store

mixed $type

mixed $value

Method Summary

TFormElement TFormElement (string $name, string $displayname, string $class, [string $value = ""], [bool $store = true])

A getValue ([$display $display = false])

void output ()

void setParent (mixed &$parent)

true setValue (mixed $value)

Boolean validate ()

Variables

mixed $alwaysSet = false (line 18)

If the value should always be set, even if null

mixed $class (line 16)

mixed $displayname (line 13)

mixed $htmltype = "" (line 22)

The HTML element type

Redefined in descendants as:

TFormCheckbox::$htmltype : The HTML element type
TFormDateTime::$htmltype : The HTML element type
TFormDate::$htmltype : The HTML element type
TFormTime::$htmltype : The HTML element type
TFormDayMatrix::$htmltype : The HTML element type
TFormDayPicker::$htmltype : The HTML element type
TFormDisplay::$htmltype : The HTML element type
TFormDivision::$htmltype : The HTML element type
TFormFileDisk::$htmltype : The HTML element type
TFormFile::$htmltype : The HTML element type
TFormHidden::$htmltype : The HTML element type
TFormMultiCheck::$htmltype : The HTML element type
TFormRadio::$htmltype : The HTML element type
TFormSelect::$htmltype : The HTML element type
TFormLookup::$htmltype : The HTML element type
TFormSelectSubmit::$htmltype : The HTML element type
TFormStatic::$htmltype : The HTML element type
TFormSubmit::$htmltype : The HTML element type
TFormText::$htmltype : The HTML element type
TFormPassword::$htmltype : The HTML element type

mixed $name (line 12)

mixed $parent = null (line 24)

Parent form

mixed $store (line 15)

mixed $type = "element" (line 20)

The type of element

Redefined in descendants as:

TFormCheckbox::$type : The type of element
TFormDateTime::$type : The type of element
TFormDate::$type : The type of element
TFormTime::$type : The type of element
TFormDayMatrix::$type : The type of element
TFormDayPicker::$type : The type of element
TFormDisplay::$type : The type of element
TFormDivision::$type : The type of element
TFormFileDisk::$type : The type of element
TFormFile::$type : The type of element
TFormFileImage::$type : The type of element
TFormHidden::$type : The type of element
TFormMultiCheck::$type : The type of element
TFormRadio::$type : The type of element
TFormSelect::$type : The type of element
TFormLookup::$type : The type of element
TFormSelectSubmit::$type : The type of element
TFormStatic::$type : The type of element
TFormSubmit::$type : The type of element
TFormTextarea::$type : The type of element
TFormText::$type : The type of element

mixed $value (line 14)

Redefined in descendants as:

TFormPasswordConfirm::$value

Methods

Constructor TFormElement (line 41)

Basic constructor for form elements.

TFormElement TFormElement (string $name, string $displayname, string $class, [string $value = ""], [bool $store = true])

string $name: The name of the element. This should correspond to the field names if using with TDBForm, and should not include any spaces or special characters.
string $displayname: The name that should show up to the user for this field.
string $class: The HTML Class to use for the element
string $value: The initial value for the field. Note if using a TDBForm this value will be overridden by loadValues so it is effectively only the default for new entries.
bool $store: Weather this value is persistent. Used by TDBForm to decide to save/load this value from database.

getValue (line 81)

Returns a textual description of the current value

return: string containing the value of the element

A getValue ([$display $display = false])

$display $display: True if the value is going to be used for display

Redefined in descendants as:

TFormCheckbox::getValue() : Returns a textual description of the current value
TFormDateTime::getValue() : Returns a textual description of the current value
TFormTime::getValue() : Returns a textual description of the current value
TFormDayMatrix::getValue() : Returns a textual description of the current value
TFormDayPicker::getValue() : Returns a textual description of the current value
TFormFileDisk::getValue() : Returns a textual description of the current value
TFormFile::getValue() : Returns a textual description of the current value
TFormMultiCheck::getValue() : Returns a textual description of the current value
TFormRadio::getValue()
TFormSelect::getValue() : Returns a textual description of the current value
TFormTextIntDouble::getValue() : Returns a textual description of the current value

output (line 62)

Outputs the HTML for this tag

void output ()

Redefined in descendants as:

TFormCheckbox::output()
TFormDateTime::output()
TFormDate::output()
TFormTime::output()
TFormDayMatrix::output()
TFormDayPicker::output()
TFormDisplay::output() : Output the value.
TFormDivision::output()
TFormFileDisk::output()
TFormFile::output()
TFormHidden::output()
TFormMultiCheck::output()
TFormRadio::output()
TFormSelect::output()
TFormSelectSubmit::output() : Creates a new TFormSelectSubmit element (basic text field).
TFormStatic::output()
TFormSubmit::output()
TFormTextarea::output()
TFormText::output()
TFormPassword::output()
TFormPasswordConfirm::output()
TFormTextIntDouble::output()
TFormTextNumber::output()
TFormTextCurrency::output()

setParent (line 85)

void setParent (mixed &$parent)

setValue (line 71)

Sets the value of the field

return: if the value was set

true setValue (mixed $value)

mixed $value: The value to set

Redefined in descendants as:

TFormCheckbox::setValue() : Sets the checked state of the field. If there is any "value" then it sets checked to true.
TFormDateTime::setValue() : Sets the value of the field
TFormDate::setValue() : Sets the value of the field
TFormTime::setValue() : Sets the value of the field
TFormDayMatrix::setValue() : Sets the value of the field
TFormDayPicker::setValue() : Sets the value of the field
TFormDivision::setValue() : This implementation doesn't do anything
TFormFileDisk::setValue() : Sets the value of the field to be the file data.
TFormFile::setValue() : Sets the value of the field to be the file data.
TFormFileImage::setValue() : Sets the value of the field to be the file data.
TFormMultiCheck::setValue() : Sets the value of the field
TFormRadio::setValue()
TFormSubmit::setValue() : Sets the value
TFormTextIntDouble::setValue() : Sets the value of the field
TFormTextNumber::setValue() : Sets the value of the field
TFormTextCurrency::setValue() : Sets the value of the field
TFormTextPhone::setValue() : Sets the value of the field
TFormTextUrl::setValue() : Sets the value of the field

validate (line 54)

Validates the data in this field.

return: True if the data is valid, or a string containing an error message if there is a problem.

Boolean validate ()

Redefined in descendants as: