FORMfields


FORMfields.fields.YearField

Class YearField

FormField
|
+--DropDownField
|
+--YearField

public class YearField
extends DropDownField

YearField is a drop down field of years.

Since:
FORMfields v1.0

Field Summary
mixed

$ENUM_YEARS

An array of 2 or 4 digit year numeric years.

mixed

$ENUM_YEAR_NAMES

An array of year strings determined by the dateFormat.

Fields inherited from FORMfields.fields.DropDownField
OR_STRING_MAX_SIZE, blankString, fieldEnabled, height, includeNewChoice, newChoice, options, subFieldsCannotBeEmpty, values
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

YearField(string name, string label, int required, string blankString, string dateFormat, mixed yearStart, mixed yearEnd, int startYear, int endYear)

Creates a new YearField.

__construct(string name, string label, int required, string blankString, string dateFormat, mixed yearStart, mixed yearEnd, int startYear, int endYear)

Creates a new YearField.

Methods inherited from FORMfields.fields.DropDownField
getEditableFieldTag, getParameter, setValue
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

ENUM_YEARS

public mixed $ENUM_YEARS = null

An array of 2 or 4 digit year numeric years.

Since:
FORMfields v1.0

ENUM_YEAR_NAMES

public mixed $ENUM_YEAR_NAMES = null

An array of year strings determined by the dateFormat.

Since:
FORMfields v1.0

Constructor Detail

YearField

public YearField(string name, string label, int required, string blankString, string dateFormat, mixed yearStart, mixed yearEnd, int startYear, int endYear)

Creates a new YearField. Populates ENUM_YEARS and ENUM_MONTH_YEARS based on the startYear and endYear.

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
blankString - the default display value for each drop down field or a single space for "Month". Defaulted to a single space.
dateFormat - the format of the outputted date as defined by PHP's date() function. Formats currently supported: "m", "M", "m - M". Defaulted to M if dateFormat is null.
startYear - The earliest 2 or 4 digit year permitted. Defaulted to 10 years before the current year.
endYear - The latest 2 or 4 digit year permitted. Defaulted to 10 years after the current year.
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

FORMfields