__construct()
getDescription()
getId()
getLabel()
getName()
isRequired()
outputHTML()
setDescription()
setId()
setLabel()
setMaxLength()
setMinLength()
setName()
showInEmail()
showIndividualLabels()
showLabel()
Creates a group of checkbox elements.
package | FormItBuilder |
---|
__construct(string $id, string $label, array $values)
Creates a group of checkboxes that allow rules such as required, minimum length (minimum number of items that must be checked) and maximum length (maximum number of items that can be checked). The list of checkbox values are specified in an array along with their default ticked state.
$a_checkArray=array(
array('title'=>'Cheese','checked'=>false),
array('title'=>'Grapes','checked'=>true),
array('title'=>'Salad','checked'=>false),
array('title'=>'Bread','checked'=>true)
);
$o_fe_checkgroup = new FormItBuilder_elementCheckboxGroup('favFoods','Favorite Foods',$a_checkArray);
//Ensure at least 2 checkboxes are selected
$a_formRules[] = new FormRule(FormRuleType::minimumLength,$o_fe_checkgroup,2);
//Ensure no more than 3 checkboxes are selected
$a_formRules[] = new FormRule(FormRuleType::maximumLength,$o_fe_checkgroup,3);
string
Id of the element
string
Label of the select element
array
Array of title/value arrays in order of display.
getDescription() : string
Returns the form elements description.
inherited_from | \FormItBuilder_element::getDescription() |
---|
string
getId() : string
Returns the form elements ID.
inherited_from | \FormItBuilder_element::getId() |
---|
string
getLabel() : string
Returns the form elements label.
inherited_from | \FormItBuilder_element::getLabel() |
---|
string
getName() : string
Returns the form elements name.
inherited_from | \FormItBuilder_element::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() |
---|
boolean
If true the field must be filled out.
boolean
outputHTML() : string
Outputs the HTML for the element.
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() |
---|
string
setId(string $value)
Sets the form elements ID.
inherited_from | \FormItBuilder_element::setId() |
---|
string
setLabel(string $value)
Sets the form elements label.
inherited_from | \FormItBuilder_element::setLabel() |
---|
string
setMaxLength(int $value)
Sets the maximum number of checkboxes that can be selected before the checkbox group will be valid (e.g. please select up to three options...).
int
setMinLength(int $value)
Sets the minimum number of checkboxes that must be selected before the checkbox group will be valid (e.g. please select at least two options...).
int
setName(string $value)
Sets the form elements name.
inherited_from | \FormItBuilder_element::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() |
---|
boolean
If true (which is in most cases default) the element will be shown in the email.
boolean
showIndividualLabels(boolean $value) : boolean
By default (true) each checkbox will have its own label. Users may wish to have checkboxes in some kind of table with custom surrounding HTML. In this case labels can be hidden. If no value passed the method will return the current label display status.
boolean
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() |
---|
boolean
If true (which is in most cases default) a label will be shown next to the form element and in the email.
boolean