JFormRuleRules::test: Difference between revisions
From Joomla! Documentation
m clean up |
m preparing for archive only |
||
| Line 4: | Line 4: | ||
Method to test the value. | Method to test the value. | ||
<source lang="php"> | <source lang="php"> | ||
| Line 56: | Line 56: | ||
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Form|Form]] | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Form|Form]] | ||
* [[API17:JFormRuleRules::test|Other versions of JFormRuleRules::test]] | * [[API17:JFormRuleRules::test|Other versions of JFormRuleRules::test]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JFormRuleRules::test | category=JFormRuleRules::test | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Latest revision as of 03:09, 25 March 2017
JFormRuleRules::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 42 of libraries/joomla/form/rules/rules.php
- Since
See also
- JFormRuleRules::test source code on BitBucket
- Class JFormRuleRules
- Subpackage Form
- Other versions of JFormRuleRules::test
User contributed notes
Code Examples