Form Field class for the Joomla Platform.

Single check box field. This is a boolean field with null for false and the specified option for true

• see: JFormFieldCheckboxes
• link: http://www.w3.org/TR/html-markup/input.checkbox.html#input.checkbox
• since: 11.1

Located in /libraries/joomla/form/fields/checkbox.php (line 23)

JFormField
   |
   --JFormFieldCheckbox

boolean $checked = false (line 39)

The checked state of checkbox field.

• since: 3.2
• access: protected

string $type = 'Checkbox' (line 31)

The form field type.

• since: 11.1
• access: protected

---

Redefinition of:

JFormField::$type

The form field type.

Inherited Variables

Inherited from JFormField

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

getInput (line 122)

Method to get the field input markup.

The checked element sets the field to selected.

• return: The field input markup.
• since: 11.1
• access: protected

string getInput ()

---

Redefinition of:

JFormField::getInput()

Method to get the field input markup.

setup (line 99)

Method to attach a JForm object to the field.

• return: True on success.
• see: JFormField::setup()
• since: 3.2
• access: public

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])

• SimpleXMLElement $element: The SimpleXMLElement object representing the <field /> tag for the form field object.
• mixed $value: The form field value to validate.
• string $group: The field name group control value. This acts as 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]".

---

Redefinition of:

JFormField::setup()

Method to attach a JForm object to the field.

__get (line 50)

Method to get certain otherwise inaccessible properties from the form field object.

• return: The property value or null.
• since: 3.2
• access: public

mixed __get (string $name)

• string $name: The property name for which to the the value.

---

Redefinition of:

JFormField::__get()

Method to get certain otherwise inaccessible properties from the form field object.

---

Redefined in descendants as:

• FOFFormFieldCheckbox::__get() : Method to get certain otherwise inaccessible properties from the form field object.

__set (line 71)

Method to set certain otherwise inaccessible properties of the form field object.

• since: 3.2
• access: public

void __set (string $name, mixed $value)

• string $name: The property name for which to the the value.
• mixed $value: The value of the property.

---

Redefinition of:

JFormField::__set()

Method to set certain otherwise inaccessible properties of the form field object.

Inherited Methods

Inherited From JFormField

JFormField::__construct()
JFormField::getAttribute()
JFormField::getControlGroup()
JFormField::getFieldName()
JFormField::getId()
JFormField::getInput()
JFormField::getLabel()
JFormField::getName()
JFormField::getTitle()
JFormField::setForm()
JFormField::setup()
JFormField::setValue()
JFormField::__get()
JFormField::__set()