__construct()
getDateFormat()
getDescription()
getId()
getLabel()
getMaxLength()
getMaxValue()
getMinLength()
getMinValue()
getName()
isRequired()
outputHTML()
setDateFormat()
setDescription()
setId()
setLabel()
setMaxLength()
setMaxValue()
setMinLength()
setMinValue()
setName()
showInEmail()
showLabel()
Creates a password field element.
package | FormItBuilder |
---|
__construct(string $id, string $label, string $defaultValue)
Creates a password field.
string
The ID of the password field
string
The label of the password field
string
The default text to be written into the password field
getDateFormat() : string
Returns the date format used by a field with a date FormRule.
inherited_from | \FormItBuilder_elementText::getDateFormat() |
---|
string
getDescription() : string
Returns the form elements description.
inherited_from | \FormItBuilder_element::getDescription() |
---|---|
inherited_from | \FormItBuilder_elementText::getDescription() |
string
getId() : string
Returns the form elements ID.
inherited_from | \FormItBuilder_element::getId() |
---|---|
inherited_from | \FormItBuilder_elementText::getId() |
string
getLabel() : string
Returns the form elements label.
inherited_from | \FormItBuilder_element::getLabel() |
---|---|
inherited_from | \FormItBuilder_elementText::getLabel() |
string
getMaxLength() : int
Returns the maximum string length for the field.
inherited_from | \FormItBuilder_elementText::getMaxLength() |
---|
int
getMaxValue() : int
Returns the maximum value for the field.
inherited_from | \FormItBuilder_elementText::getMaxValue() |
---|
int
getMinLength() : int
Returns the minimum string length for the field.
inherited_from | \FormItBuilder_elementText::getMinLength() |
---|
int
getMinValue() : int
Returns the minimum string length for the field.
inherited_from | \FormItBuilder_elementText::getMinValue() |
---|
int
getName() : string
Returns the form elements name.
inherited_from | \FormItBuilder_element::getName() |
---|---|
inherited_from | \FormItBuilder_elementText::getName() |
string
isRequired(boolean $value) : boolean
Sets wether the element is required or not.
This setting is generally toggled automatically based on FormRule settings applied in the form.
If no value passed the method will return the current required status.
inherited_from | \FormItBuilder_element::isRequired() |
---|---|
inherited_from | \FormItBuilder_elementText::isRequired() |
boolean
If true the field must be filled out.
boolean
outputHTML() : string
Outputs the HTML for the element.
inherited_from | \FormItBuilder_elementText::outputHTML() |
---|
string
setDateFormat(string $value)
Sets the date format used by a field with a date FormRule. This is generally done automatically via a FormRule.
inherited_from | \FormItBuilder_elementText::setDateFormat() |
---|
string
setDescription(string $value)
Allows a sub label (or more descriptive label) to be set within the element label. Could be shown on hover or displayed with main label.
inherited_from | \FormItBuilder_element::setDescription() |
---|---|
inherited_from | \FormItBuilder_elementText::setDescription() |
string
setId(string $value)
Sets the form elements ID.
inherited_from | \FormItBuilder_element::setId() |
---|---|
inherited_from | \FormItBuilder_elementText::setId() |
string
setLabel(string $value)
Sets the form elements label.
inherited_from | \FormItBuilder_element::setLabel() |
---|---|
inherited_from | \FormItBuilder_elementText::setLabel() |
string
setMaxLength(int $value)
Sets the maximum string length for the field. This is generally done automatically via a FormRule.
inherited_from | \FormItBuilder_elementText::setMaxLength() |
---|
int
setMaxValue(int $value)
Sets the maximum numeric value for a field. This is generally done automatically via a FormRule.
inherited_from | \FormItBuilder_elementText::setMaxValue() |
---|
int
setMinLength(int $value)
Sets the minimum string length for the field. This is generally done automatically via a FormRule.
inherited_from | \FormItBuilder_elementText::setMinLength() |
---|
int
setMinValue(int $value)
Sets the minimum numeric value for a field. This is generally done automatically via a FormRule.
inherited_from | \FormItBuilder_elementText::setMinValue() |
---|
int
setName(string $value)
Sets the form elements name.
inherited_from | \FormItBuilder_element::setName() |
---|---|
inherited_from | \FormItBuilder_elementText::setName() |
string
showInEmail(boolean $value) : boolean
Sets wether the element is shown in the email or not.
In some cases fields may be wanted in the form, but not in the email (an example would be fields like a "Confirm Password" field).
If no value passed the method will return the current status.
inherited_from | \FormItBuilder_element::showInEmail() |
---|---|
inherited_from | \FormItBuilder_elementText::showInEmail() |
boolean
If true (which is in most cases default) the element will be shown in the email.
boolean
showLabel(boolean $value) : boolean
Sets wether the label should be displayed for this element or not. If no value passed the method will return the current status.
inherited_from | \FormItBuilder_element::showLabel() |
---|---|
inherited_from | \FormItBuilder_elementText::showLabel() |
boolean
If true (which is in most cases default) a label will be shown next to the form element and in the email.
boolean