FORMfields


FORMfields.fields.TaxIdField

Class TaxIdField

FormField
|
+--TaxIdField

public class TaxIdField
extends FormField

TaxIdField is a field for editing a Tax ID or Social Security Number.

Since:
FORMfields v2.0

Field Summary
mixed

$p1

The sub field for the 1st part of the Tax ID.

mixed

$p2

The sub field for the 2nd part of the Tax ID.

mixed

$p3

The sub field for the 3rd part of the Tax ID.

mixed

$subFieldDisplayValueSeparator

A string used to separate the display value parts.

mixed

$subFieldSeparator

A string used to separate the sub fields.

Fields inherited from FORMfields.fields.FormField
autoPropagate, data, disableEnterHandler, displayValuesOnNewLine, editable, enabled, endingString, enterTabHandler, enterTabs, error, extraHtml, fieldBelowLabel, formError, help, hidden, htmlify, id, isData, label, labelForId, multiValues, name, required, subFieldDisplayValueSeparator, subFieldSeparator, subFieldValueSeparator, subFields, subFieldsCannotBeEmpty, trimWhitespace, validators, value, valueIsHtml
Constructor Summary

TaxIdField(string name, string label, int required)

Creates a new TaxIdField.

__construct(string name, string label, int required)

Creates a new TaxIdField.

Method Summary
void

setValue(string value)

Sets the value of this field.

Methods inherited from FORMfields.fields.FormField
addFieldValidator, addSubField, checkForBlank, clearValue, disable, formatRequestParameter, formatText, getButtonClicked, getData, getDbValue, getDisableFieldJs, getDisableJs, getDisableLabelJs, getDisplayFieldTag, getDisplayHtmlValue, getDisplayLabelTag, getDisplayValue, getEditable, getEditableFieldTag, getEditableLabelTag, getEnabled, getError, getExtraHtml, getFieldTag, getFormError, getHelp, getHelpTag, getHidden, getHiddenFieldTag, getId, getIsData, getIsHidden, getLabel, getLabelHtml, getLabelTag, getName, getOrNull, getParameter, getRawDbValue, getRequired, getValue, isBlank, isEmpty, isValid, setAutoPropagate, setData, setDbValue, setDisplayValuesOnNewLine, setEditable, setEnabled, setEndingString, setError, setExtraHtml, setFieldBelowLabel, setFormError, setHelp, setHidden, setHtmlify, setId, setIsData, setIsHidden, setLabel, setName, setRequired, setTrimWhitespace, setValue, setValueIsHtml, validate

Field Detail

p1

public mixed $p1 = null

The sub field for the 1st part of the Tax ID.

Since:
FORMfields v2.0

p2

public mixed $p2 = null

The sub field for the 2nd part of the Tax ID.

Since:
FORMfields v2.0

p3

public mixed $p3 = null

The sub field for the 3rd part of the Tax ID.

Since:
FORMfields v2.0

subFieldDisplayValueSeparator

public mixed $subFieldDisplayValueSeparator = "-"

A string used to separate the display value parts.

Since:
FORMfields v2.0

subFieldSeparator

public mixed $subFieldSeparator = " - "

A string used to separate the sub fields.

Since:
FORMfields v2.0

Constructor Detail

TaxIdField

public TaxIdField(string name, string label, int required)

Creates a new TaxIdField.

Parameters:
name - the name of the form field. This value must not be a SQL reserved word and should follow all the standard variable naming conventions in PHP.
label - this form field's label. The label is the printable text that is typically displayed on the left side of the field.
required - Sets whether the field must be filled in and whether it looks like it must be filled in: FORM_FIELD_REQUIRED, FORM_FIELD_NOT_REQUIRED, FORM_FIELD_LOOKS_REQUIRED or FORM_FIELD_REQUIRED_NO_LOOK
See Also:
FORM_FIELD_REQUIRED
FORM_FIELD_NOT_REQUIRED
FORM_FIELD_LOOKS_REQUIRED
FORM_FIELD_REQUIRED_NO_LOOK
Since:
FORMfields v2.0
Deprecated:
deprecated as this constructor syntax is not expected in PHP 5 - will be removed once PHP 5 becomes a minimum requirement for FORMfields

Method Detail

setValue

public void setValue(string value)

Sets the value of this field.

Parameters:
value - a tax ID or SSN in the form of "XXXYYZZZZ", where X, Y and Z are digits
Since:
FORMfields v2.0

FORMfields