API17:JFormRule::test
From Joomla! Documentation
JFormRule::test
Description
Method to test the value.
public function test (
&$element
$value
$group=null
&$input=null
&$form=null
)
| Parameter | Type | Default | Description |
|---|---|---|---|
| &$element | on invalid rule. | ||
| $value | mixed | The form field value to validate. | |
| $group | string | null | 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]". |
| &$input | object | null | $input An optional object with the entire data set to validate against the entire form. |
| &$form | object | null | $form The form object for which the field is being tested. |
- Returns boolean True if the value is valid, false otherwise.
- Defined on line 61 of libraries/joomla/form/formrule.php
- Since

See also
JFormRule::test source code on BitBucket
Class JFormRule
Subpackage Form- Other versions of JFormRule::test
User contributed notes
Code Examples