JFormFieldCheckbox

Extends \JFormField

Form Field class for the Joomla Platform.

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

link

http://www.w3.org/TR/html-markup/input.checkbox.html#input.checkbox

see \JFormFieldCheckboxes
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.2

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.

getInput

Method to get the field input markup.

getInput() : string

The checked element sets the field to selected.

since

1.7.0

Response

stringThe field input markup.

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

checked

The checked state of checkbox field.

since

3.2

Type(s)

boolean