API17:JFormRule::test
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 12: | Line 12: | ||
===Synopsis=== | ===Synopsis=== | ||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public JFormRule::test (&$element, $value, $group=null, &$input=null, &$form=null) |
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 50: | Line 50: | ||
boolean True if the value is valid, false otherwise. | boolean True if the value is valid, false otherwise. | ||
===Defined in=== | ===Defined in=== | ||
| − | libraries/joomla/form/formrule.php | + | libraries/joomla/form/formrule.php (line 61) |
| + | * see source code in [[jplatform:form/formrule.php#cl-61|BitBucket]] | ||
===Referenced by=== | ===Referenced by=== | ||
===See also=== | ===See also=== | ||
Revision as of 20:38, 23 April 2011
JFormRule::test
Description
Method to test the value.
Description:JFormRule::test [Edit Descripton]
Since
Synopsis
public JFormRule::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 in
libraries/joomla/form/formrule.php (line 61)
- see source code in BitBucket
Referenced by
See also
Examples
<CodeExamplesForm />
