Class STPHPForm

STPHPObject
   |
   --STPHPComponent
      |
      --STPHPForm

Classes extended from STPHPForm:

Located in File: Program_Root/stphpform.php


A class that represents a form


Class Variable Summary
$variables
The list of variables of a form (input type=hidden elements)
Default Value: -><-

Inherited Class Variable Summary
Inherited From Class STPHPComponent
Variable Default Value Description
$attributes -><- The list of attributes
$components -><- The list of components
$configuration -><- The pointer to configuration XML node
$formParent -><- The form owner name
Inherited From Class STPHPObject
Variable Default Value Description
$name -><- The name of the object

Inherited Method Summary
Inherited From Class STPHPComponent
Function Description
constructor STPHPComponent ( [$name = ] ) Creates the object
addCodeFile ( $file ) Adds a code file (Javascript)
addComponent ( &$component ) Adds a component at the end of the components list
addCssFile ( $file ) Adds a CSS file
addVSpace ( $units ) Adds vertical spaces
appendAttributes ( $attributes ) Appends an array of attributes at the current values
appendComponent ( &$component ) Appends a component at the end of the components list
attributeIsEmpty ( $key ) Returns if attribute is empty
dtor ( ) Destructor
getAttribute ( $key ) Gets the value of an attribute
getFormParent ( ) Returns the form owner name
getTranslatedAttribute ( $key ) Translate an attribute to the current language
insertComponent ( &$component ) Inserts a component at the beginning of the components list
setAttribute ( $key, $val ) Sets an attribute
setConfiguration ( &$configuration ) Load the attributes from a STPHPXMLElement object
setFormParent ( $form ) Sets the form owner name of the component (used by JS functions)
translateAttribute ( $key ) Set an attribute to its translated value
write ( ) Designs the object at runtime
Inherited From Class STPHPObject
Function Description
constructor STPHPObject ( [$name = ] ) Creates the object
dtor ( ) Destructor
errorLog ( $message ) Print an error to the log system
getName ( ) Returns the name of the object

Method Summary
STPHPForm constructor STPHPForm ( $name )
Creates the object
void addVariable ( $variable, [$value = ''] )
Adds a variable inside FORM tag
void dtor ( )
Destructor
string write ( )
Designs the object at runtime
Variable Detail

$variables

Data type: array
The list of variables of a form (input type=hidden elements)



Method Detail

constructor STPHPForm

STPHPForm constructor STPHPForm ( $name )

Creates the object

Function Parameters:
- string $name: the name of the form used in NAME tag
Function Info:
Access - public

addVariable

void addVariable ( $variable, [$value = ''] )

Adds a variable inside FORM tag

Function Parameters:
- string $variable: the name of the variable
- string $value: the name of the variables value (optional)
Function Info:
Access - public

dtor

void dtor ( )

Overrides: STPHPComponent::dtor()

Destructor
Destroys all the resources associated with the object
Function Parameters:
Function Info:
Access - public

write

string write ( )

Overrides: STPHPComponent::write()

Designs the object at runtime
Available attributes :
- VISIBLE : defines if the component must be designed or not
- NAME : defines the name of the form (if empty $name of the object is used)
- METHOD : defines the method for the form (GET/POST)
- ACTION : defines the action for the form
- TARGET : defines the target for the action
- ENCTYPE : defines the content type for the form
Function Parameters:
Function Info:
Return - the code that represents the object at runtime
Access - private