Joomla\CMS\Form\Rule\BooleanRule

Since: 1.7.0

class BooleanRule extends FormRule

Form Rule class for the Joomla Platform.

Properties

protected string Since: 1.7.0	$regex	The regular expression to use in testing a form field value.
protected string Since: 1.7.0	$modifiers	The regular expression modifiers to use when testing a form field value.

bool

test(SimpleXMLElement $element, mixed $value, string $group = null, Registry|null $input = null, Form|null $form = null)

Method to test the value.

Since: 1.6

Method to test the value.

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]".
Registry\|null	$input	An optional Registry object with the entire data set to validate against the entire form.
Form\|null	$form	The form object for which the field is being tested.

bool	True if the value is valid, false otherwise.