Docs For Class TFormTextCurrency

Description

Text Field, only accepts dollar values

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

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

TFormElement
   |
   --TFormText
      |
      --TFormTextNumber
         |
         --TFormTextCurrency

Variable Summary

mixed $usesign

Method Summary

TFormTextCurrency TFormTextCurrency (string $name, string $displayname, string $class, bool $required, int $size, bool $usesign, bool $format, int $min, [int $max = null], [string $value = ""], [bool $store = true])

void output ()

true setValue (mixed $value, [bool $user = false])

Variables

mixed $usesign (line 13)

Inherited Variables

Inherited from TFormTextNumber

TFormTextNumber::$format
TFormTextNumber::$maxdec
TFormTextNumber::$maxval
TFormTextNumber::$minval

Inherited from TFormText

TFormText::$htmltype
TFormText::$maxsize
TFormText::$regex
TFormText::$required
TFormText::$size
TFormText::$type

Inherited from TFormElement

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

Methods

Constructor TFormTextCurrency (line 35)

Creates a new TFormTextCurrency element (currency input field). Ignores $ in input

TFormTextCurrency TFormTextCurrency (string $name, string $displayname, string $class, bool $required, int $size, bool $usesign, bool $format, int $min, [int $max = null], [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
bool $required: True if the field has to be filled in
int $size: The displayed size of the text box
bool $usesign: Whether to put the $ sign in the textbox
bool $format: True to format the value using comma seperators
int $min: The minimum value, or null if no minimum
int $max: The maximum value, or null if no maximum
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.

output (line 52)

void output ()

Redefinition of:

TFormTextNumber::output()

setValue (line 47)

Sets the value of the field

return: if the value was set

true setValue (mixed $value, [bool $user = false])

mixed $value: The value to set
bool $user: True if the value is from user input

Redefinition of:

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

Inherited Methods

Inherited From TFormTextNumber

TFormTextNumber::TFormTextNumber()
TFormTextNumber::output()
TFormTextNumber::setValue()
TFormTextNumber::validate()

Inherited From TFormText

TFormText::TFormText()
TFormText::output()
TFormText::setRegex()
TFormText::validate()

Inherited From TFormElement

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