Difference between revisions of "JFormRule::test"
From Joomla! Documentation
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JFormRule::test|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JFormRule::test|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function test ( |
| + | &$element | ||
| + | $value | ||
| + | $group=null | ||
| + | &$input=null | ||
| + | &$form=null | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 47: | Line 50: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' boolean True if the value is valid, false otherwise. | |
| − | boolean True if the value is valid, false otherwise. | + | * '''Defined''' on line 61 of libraries/joomla/form/formrule.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/form/formrule.php | ||
| − | |||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JFormRule::test source code''' on [[jplatform:form/formrule.php#cl-53|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JFormRule/11.1|JFormRule]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Form/11.1|Form]] | ||
| + | * [[JFormRule::test|Other versions of JFormRule::test]] | ||
| + | {{SeeAlso:JFormRule::test}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JFormRule::test|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JFormRule::test|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | |||
| − | |||
| − | === | ||
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 67: | Line 70: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JFormRule]][[Category:JFormRule::test]]</noinclude> | <noinclude>[[Category:JFormRule]][[Category:JFormRule::test]]</noinclude> | ||
Revision as of 21:03, 27 April 2011
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JFormRule::test[edit]
Description[edit]
Method to test the value.
Template:Description:JFormRule::test [Edit Descripton]
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[edit]
- JFormRule::test source code on BitBucket
- Class JFormRule
- Subpackage Form
- Other versions of JFormRule::test
Template:SeeAlso:JFormRule::test [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />