Docs For Class TFormSubmit

Description

Basic Submit button

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

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

TFormElement
   |
   --TFormSubmit

Variable Summary

mixed $htmltype

mixed $type

Method Summary

TFormSubmit TFormSubmit (string $name, string $displayname, string $class, [bool $store = false])

void output ()

True setButtonText (mixed $value)

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

void validate ()

Variables

mixed $htmltype = "button" (line 16)

The HTML element type

Redefinition of:

TFormElement::$htmltype: The HTML element type

mixed $type = "submit" (line 14)

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 TFormSubmit (line 28)

Basic constructor for form elements.

TFormSubmit TFormSubmit (string $name, string $displayname, string $class, [bool $store = false])

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 will show up on the button (the value)
string $class: The HTML Class to use for the element
bool $store: Weather this value is persistent. Used by TDBForm to decide to save/load this value from database.

output (line 37)

void output ()

Redefinition of:

TFormElement::output(): Outputs the HTML for this tag

setButtonText (line 56)

Sets the button text (this sets the value of the html tag). This function is functionally the same as TFormElement::setValue() but has its own name since it is for user interface purposes and not data.

return: for the value being successfully set

True setButtonText (mixed $value)

setValue (line 45)

Sets the value

Since this is a submit button, this implementation doesn't do anything.

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

Redefinition of:

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

validate (line 33)

void validate ()

Redefinition of:

TFormElement::validate(): Validates the data in this field.

Inherited Methods

Inherited From TFormElement

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