Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class CheckboxField - list of methods

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

Extends

FormField
Package: Joomla\CMS\Form\Field
Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Form/Field/CheckboxField.php
Project: Joomla

Method Summary

public mixed
__get
(mixed $name)

Method to get certain otherwise inaccessible properties from the form field object.
Parameters
  • string $name The property name for which to get the value.
Returns
  • mixed The property value or null.
Since
  • 3.2
Show source code of this method: __get Source Code

public void
__set
(mixed $name, mixed $value)

Method to set certain otherwise inaccessible properties of the form field object.
Parameters
  • string $name The property name for which to set the value.
  • mixed $value The value of the property.
Returns
  • void
Since
  • 3.2
Show source code of this method: __set Source Code

public bool
(\SimpleXMLElement $element, mixed $value, mixed $group = null)

Method to attach a Form object to the field.
Parameters
  • \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 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
  • bool True on success.
Since
  • 3.2
-
  • \Joomla\CMS\Form\FormField::setup()
Show source code of this method: setup Source Code

protected array
()

Method to get the data to be passed to the layout for rendering.
Returns
  • array
Since
  • 4.0.0
Show source code of this method: getLayoutData Source Code

Properties Summary

protected string
$type
The form field type.
Since
  • 1.7.0
protected string
$layout
Name of the layout being used to render the field
Since
  • 4.0.0
protected bool
$checked
The checked state of checkbox field.
Since
  • 3.2

Tags Summary

Since
1.7.0