FORMfields


FORMfields.fields.UsernameField

Class UsernameField

FormField
|
+--TextField
|
+--UsernameField

public class UsernameField
extends TextField

UsernameField is a field for editing a username. The username must be comprised of only letter, digits, periods and underscores.

Since:
FORMfields v1.0

Field Summary
mixed

$MAX_SIZE

The maximum length permitted.

mixed

$MIN_SIZE

The minimum length permitted.

mixed

$REGEX_USERNAME

A regular expression used to a username.

Fields inherited from FORMfields.fields.TextField
maxLength, minLength, size
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

UsernameField(string name, string label, int required)

Creates a new UsernameField.

__construct(string name, string label, int required)

Creates a new UsernameField.

Method Summary
boolean

isValid()

Checks for field errors detected by this field, including a check for blank.

Methods inherited from FORMfields.fields.TextField
getEditableFieldTag, isValid
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

MAX_SIZE

public mixed $MAX_SIZE = 30

The maximum length permitted.

Since:
FORMfields v1.0

MIN_SIZE

public mixed $MIN_SIZE = 6

The minimum length permitted.

Since:
FORMfields v1.0

REGEX_USERNAME

public mixed $REGEX_USERNAME = "/^(_|\\.|[0-9]|[a-z])+\$/i"

A regular expression used to a username.

Since:
FORMfields v1.0

Constructor Detail

UsernameField

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

Creates a new UsernameField.

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 v1.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

isValid

public boolean isValid()

Checks for field errors detected by this field, including a check for blank. This method ensures that the size of the value is within range and that the value is comprised of only letters, digits, periods and underscores. If an error is detected, the setError() method is called to set the appropriate error message.

Returns:
true if there is an error or false otherwise
Since:
FORMfields v1.0

FORMfields