Docs For Class TFormTime

Description

Time Field

version: 05-07-2002 11:50
author: Greg MacLellan

TFormElement
   |
   --TFormDateTime
      |
      --TFormTime

Variable Summary

mixed $htmltype

mixed $legend

mixed $type

Method Summary

TFormTime TFormTime (string $name, string $displayname, string $class, bool $required, [bool $hr24 = false], [bool $seconds = true], [int $value = ""], [bool $store = true])

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

void output ()

true setValue (mixed $value)

void validate ()

Variables

mixed $htmltype = "select" (line 16)

The HTML element type

Redefinition of:

TFormDateTime::$htmltype: The HTML element type

mixed $legend = false (line 19)

If "h" "m" "s" should be displayed after the boxes

mixed $type = "datetime" (line 14)

The type of element

Redefinition of:

TFormDateTime::$type: The type of element

Inherited Variables

Inherited from TFormDateTime

TFormDateTime::$minuteIncrement
TFormDateTime::$months
TFormDateTime::$required

Inherited from TFormElement

TFormElement::$alwaysSet
TFormElement::$class
TFormElement::$displayname
TFormElement::$name
TFormElement::$parent
TFormElement::$store
TFormElement::$value

Methods

Constructor TFormTime (line 40)

Creates a new TFormTime element (multi-combobox based time field).

TFormTime TFormTime (string $name, string $displayname, string $class, bool $required, [bool $hr24 = false], [bool $seconds = true], [int $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
bool $required: True if the field has to be filled in
bool $hr24: True if a 24-hour time should be used, or false to display an am/pm box
bool $seconds: True to display a seconds field
int $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 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

Redefinition of:

TFormDateTime::getValue(): Returns a textual description of the current value

output (line 88)

void output ()

Redefinition of:

TFormDateTime::output()

setValue (line 59)

Sets the value of the field

return: if the value was set

true setValue (mixed $value)

mixed $value: The value to set

Redefinition of:

TFormDateTime::setValue(): Sets the value of the field

validate (line 46)

void validate ()

Redefinition of:

TFormDateTime::validate()

Inherited Methods

Inherited From TFormDateTime

TFormDateTime::TFormDateTime()
TFormDateTime::getValue()
TFormDateTime::output()
TFormDateTime::setValue()
TFormDateTime::validate()

Inherited From TFormElement

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