__construct()
getDescription()
getId()
getLabel()
getName()
isRequired()
setDescription()
setId()
setLabel()
setName()
showInEmail()
showLabel()
outputHTML()
A less primitive form element used as a base to extend into a variety of elements containing properties and methods used by all physical form elements.
| package | FormItBuilder |
|---|
__construct(string $id, string $label)
Main element constructor.
string
string
getDescription() : string
Returns the form elements description.
stringgetId() : string
Returns the form elements ID.
stringgetLabel() : string
Returns the form elements label.
stringgetName() : string
Returns the form elements name.
stringisRequired(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.
booleanIf true the field must be filled out.
booleansetDescription(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.
string
setId(string $value)
Sets the form elements ID.
string
setLabel(string $value)
Sets the form elements label.
string
setName(string $value)
Sets the form elements name.
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.
booleanIf true (which is in most cases default) the element will be shown in the email.
booleanshowLabel(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.
booleanIf true (which is in most cases default) a label will be shown next to the form element and in the email.
booleanoutputHTML() : string
string