Class JFormFieldCheckboxes

Form Field class for the Joomla Platform. Displays options as a list of checkboxes. Multiselect may be forced to be true.

JFormField

JFormFieldList

JFormFieldCheckboxes

Direct known subclasses

FOFFormFieldCheckboxes

Package: Joomla\Platform\Form
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
See: JFormFieldCheckbox
Located at joomla/form/fields/checkboxes.php

Methods summary

`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 3.2 Overrides `JFormFieldList::__get`
`public`	# `__set( string $name, mixed $value )` Method to set certain otherwise inaccessible properties of the form field object. Method to set certain otherwise inaccessible properties of the form field object. Parameters `$name` `string` - $name The property name for which to the the value. `$value` `mixed` - $value The value of the property. Since 3.2 Overrides `JFormField::__set`
`protected string`	# `getInput( )` Method to get the radio button field input markup. Method to get the radio button field input markup. Returns `string` - The field input markup. Since 11.1 Overrides `JFormFieldList::getInput`
`public boolean`	# `setup( SimpleXMLElement $element, mixed $value, string $group = null )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the `<field>` tag for the form field object. `$value` `mixed` - $value The form field value to validate. `$group` `string` - $group The 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]". Returns `boolean` - True on success. Since 3.2 See `JFormField::setup()` Overrides `JFormField::setup`
`protected array`	# `getLayoutData( )` Method to get the data to be passed to the layout for rendering. Method to get the data to be passed to the layout for rendering. Returns `array` Since 3.5 Overrides `JFormField::getLayoutData`

Methods inherited from JFormFieldList

addOption(), getOptions()

Methods inherited from JFormField

__construct(), getAttribute(), getControlGroup(), getFieldName(), getId(), getLabel(), getLayoutPaths(), getName(), getRenderer(), getTitle(), isDebugEnabled(), render(), renderField(), setForm(), setValue()

Magic methods summary

Properties summary

`protected string`	`$type`	# The form field type. The form field type. Since 11.1
`protected string`	`$layout`	# Name of the layout being used to render the field Name of the layout being used to render the field Since 3.5
`protected boolean`	`$forceMultiple`	# Flag to tell the field to always be in multiple values mode. Flag to tell the field to always be in multiple values mode. Since 11.1
`public mixed`	`$checkedOptions`	# The comma seprated list of checked checkboxes value. The comma seprated list of checked checkboxes value. Since 3.2

Properties inherited from JFormField

$autocomplete, $autofocus, $class, $count, $default, $description, $disabled, $element, $fieldname, $form, $formControl, $generated_fieldname, $group, $hidden, $hint, $id, $input, $label, $labelclass, $multiple, $name, $onchange, $onclick, $pattern, $readonly, $renderLabelLayout, $renderLayout, $repeat, $required, $showon, $size, $spellcheck, $translateDescription, $translateHint, $translateLabel, $validate, $value

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFormFieldCheckboxes

Direct known subclasses

Methods summary

Parameters

Returns

Since

Overrides

Parameters

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Since

See

Overrides

Returns

Since

Overrides

Methods inherited from JFormFieldList

Methods inherited from JFormField

Magic methods summary

Properties summary

Since

Since

Since

Since

Properties inherited from JFormField