JFormFieldCheckboxes
Extends \JFormFieldListForm Field class for the Joomla Platform.
Displays options as a list of checkboxes. Multiselect may be forced to be true.
| see | \JFormFieldCheckbox |
|---|---|
| since |
1.7.0 |
| package |
Joomla.Platform |
Methods
__get
Method to get certain otherwise inaccessible properties from the form field object.
__get(string $name) : mixed
| since |
3.7.0 |
|---|
Arguments
- $name
stringThe property name for which to get the value.
Response
mixedThe property value or null.
__set
Method to set certain otherwise inaccessible properties of the form field object.
__set(string $name, mixed $value) : void
| since |
3.2 |
|---|
Arguments
- $name
stringThe property name for which to set the value.- $value
mixedThe value of the property.
addOption
Method to add an option to the list field.
addOption(string $text, array $attributes = array()) : \JFormFieldList
| since |
3.7.0 |
|---|
Arguments
- $text
stringText/Language variable of the option.- $attributes
arrayArray of attributes ('name' => 'value' format)
Response
\JFormFieldListFor chaining.
getInput
Method to get the field input markup for a generic list.
getInput() : string
Use the multiple attribute to enable multiselect.
| since |
3.7.0 |
|---|
Response
stringThe field input markup.
getLayoutData
Method to get the data to be passed to the layout for rendering.
getLayoutData() : array
| since |
3.5 |
|---|
Response
array
getOptions
Method to get the field options.
getOptions() : array
| since |
3.7.0 |
|---|
Response
arrayThe field option objects.
setup
Method to attach a JForm object to the field.
setup(\SimpleXMLElement $element, mixed $value, string $group = null) : boolean
| see | \JFormField::setup() |
|---|---|
| since |
3.2 |
Arguments
- $element
\SimpleXMLElementThe SimpleXMLElement object representing the<field>tag for the form field object.- $value
mixedThe form field value to validate.- $group
stringThe field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".
Response
booleanTrue on success.
Properties
type
The form field type.
| since |
1.7.0 |
|---|
Type(s)
string
layout
Name of the layout being used to render the field
| since |
3.5 |
|---|
Type(s)
string
forceMultiple
Flag to tell the field to always be in multiple values mode.
| since |
1.7.0 |
|---|
Type(s)
boolean
checkedOptions
The comma seprated list of checked checkboxes value.
| since |
3.2 |
|---|
Type(s)
mixed