Class TFormRadio

Description

Basic Radio Button Set

  • version: 03-08-2002 12:00
  • author: Greg MacLellan

Located in /form-radio.inc.php (line 12)

TFormElement
   |
   --TFormRadio
Variable Summary
mixed $checked
mixed $htmltype
mixed $storeValue
mixed $type
Method Summary
TFormRadio TFormRadio (string $name, string $displayname, string $class, mixed $storeValue, [mixed $checked = false], [bool $store = true], bool $required, array $elements, string $value)
void getValue ([mixed $display = false])
void output ()
void setValue (mixed $value)
Variables
mixed $checked (line 13)
mixed $htmltype = "radio" (line 18)

The HTML element type


Redefinition of:
TFormElement::$htmltype
The HTML element type
mixed $storeValue (line 14)
mixed $type = "radio" (line 16)

The type of element


Redefinition of:
TFormElement::$type
The type of element

Inherited Variables

Inherited from TFormElement

TFormElement::$alwaysSet
TFormElement::$class
TFormElement::$displayname
TFormElement::$name
TFormElement::$parent
TFormElement::$store
TFormElement::$value
Methods
Constructor TFormRadio (line 38)

Creates a new TFormText element (basic text field).

TFormRadio TFormRadio (string $name, string $displayname, string $class, mixed $storeValue, [mixed $checked = false], [bool $store = true], bool $required, array $elements, string $value)
  • 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
  • bool $required: True if one of the values needs to be selected
  • array $elements: The elements to go in the box. Key field is value, value is the displayed value.
  • 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: Whether this value is persistent. Used by TDBForm to decide to save/load this value from database.
getValue (line 47)
void getValue ([mixed $display = false])

Redefinition of:
TFormElement::getValue()
Returns a textual description of the current value
output (line 51)
void output ()

Redefinition of:
TFormElement::output()
Outputs the HTML for this tag
setValue (line 43)
void setValue (mixed $value)

Redefinition of:
TFormElement::setValue()
Sets the value of the field

Inherited Methods

Inherited From TFormElement

TFormElement::TFormElement()
TFormElement::getValue()
TFormElement::output()
TFormElement::setParent()
TFormElement::setValue()
TFormElement::validate()

Documentation generated on Thu, 27 Nov 2003 14:58:56 -0500 by phpDocumentor 1.2.3