Search:

# CWIS Developers Documentation

# FormTool Class Reference

## Public Member Functions
| FormTool ($FormFields, $AdditionalErrorMessages=NULL)
| ValueForField ($FieldName, $NewValue=NULL)
| AllRequiredVarsAreSet ()
| GetValsAsUrlParams ($IncludePasswords=FALSE)
| SetFieldValuesFromUrlParams ()
| IncomingFieldValuesHaveErrors ()
| GetErrorCodesAsUrlParams ()
| SetAdditionalErrorFields ($FieldNames)
| SetAdditionalErrorCodes ($Codes)
| GetUrlWithValuesAndErrorCodes ($BaseUrl, $IncludePasswords=FALSE)
| GetErrorMessages ($EliminateDuplicateMessages=TRUE)
| PrintField ($FieldName)
| PrintLabelForField ($FieldName)
| PrintInputForField ($FieldName)
| ErrorCodesAvailable ()
| GetArrayOfUsStates ()
| CheckFieldValue ($FieldName)
## Public Attributes
| $Fields
| $ErrorColor
| $AdditionalErrorCodes
| $AdditionalErrorFields
| $AdditionalErrorMessages

List of all members.

## Detailed Description

Definition at line 19 of file FormTool.php.

## Member Function Documentation

FormTool::AllRequiredVarsAreSet | ( |  | ) |

Definition at line 56 of file FormTool.php.

FormTool::CheckFieldValue | ( | $ | FieldName | ) |

Definition at line 409 of file FormTool.php.

Referenced by GetErrorCodesAsUrlParams(), PrintField(), PrintInputForField(), and PrintLabelForField().

Here is the caller graph for this function:

FormTool::ErrorCodesAvailable | ( |  | ) |

Definition at line 334 of file FormTool.php.

Referenced by PrintField(), PrintInputForField(), and PrintLabelForField().

Here is the caller graph for this function:

FormTool::FormTool | ( | $ | FormFields,
|  | $ | AdditionalErrorMessages = `NULL` |
| ) |  |  |

Definition at line 24 of file FormTool.php.

References $AdditionalErrorMessages.

FormTool::GetArrayOfUsStates | ( |  | ) |

Definition at line 341 of file FormTool.php.

FormTool::GetErrorCodesAsUrlParams | ( |  | ) |

Definition at line 129 of file FormTool.php.

References CheckFieldValue().

Referenced by GetUrlWithValuesAndErrorCodes(), and IncomingFieldValuesHaveErrors().

Here is the caller graph for this function:

FormTool::GetErrorMessages | ( | $ | EliminateDuplicateMessages = `TRUE` | ) |

Definition at line 242 of file FormTool.php.

FormTool::GetUrlWithValuesAndErrorCodes | ( | $ | BaseUrl,
|  | $ | IncludePasswords = `FALSE` |
| ) |  |  |

Definition at line 230 of file FormTool.php.

References GetErrorCodesAsUrlParams(), and GetValsAsUrlParams().

FormTool::GetValsAsUrlParams | ( | $ | IncludePasswords = `FALSE` | ) |

Definition at line 80 of file FormTool.php.

Referenced by GetUrlWithValuesAndErrorCodes().

Here is the caller graph for this function:

FormTool::IncomingFieldValuesHaveErrors | ( |  | ) |

Definition at line 120 of file FormTool.php.

References GetErrorCodesAsUrlParams().

FormTool::PrintField | ( | $ | FieldName | ) |

Definition at line 314 of file FormTool.php.

References CheckFieldValue(), and ErrorCodesAvailable().

FormTool::PrintInputForField | ( | $ | FieldName | ) |

Definition at line 326 of file FormTool.php.

References CheckFieldValue(), and ErrorCodesAvailable().

FormTool::PrintLabelForField | ( | $ | FieldName | ) |

Definition at line 320 of file FormTool.php.

References CheckFieldValue(), and ErrorCodesAvailable().

FormTool::SetAdditionalErrorCodes | ( | $ | Codes | ) |

Definition at line 210 of file FormTool.php.

FormTool::SetAdditionalErrorFields | ( | $ | FieldNames | ) |

Definition at line 191 of file FormTool.php.

FormTool::SetFieldValuesFromUrlParams | ( |  | ) |

Definition at line 105 of file FormTool.php.

FormTool::ValueForField | ( | $ | FieldName,
|  | $ | NewValue = `NULL` |
| ) |  |  |

Definition at line 50 of file FormTool.php.

## Member Data Documentation

FormTool::$AdditionalErrorCodes

Definition at line 404 of file FormTool.php.

FormTool::$AdditionalErrorFields

Definition at line 405 of file FormTool.php.

FormTool::$AdditionalErrorMessages

Definition at line 406 of file FormTool.php.

Referenced by FormTool().

FormTool::$ErrorColor

Definition at line 403 of file FormTool.php.

FormTool::$Fields

Definition at line 402 of file FormTool.php.

The documentation for this class was generated from the following file:

- FormTool.php