Actions

API17

Difference between revisions of "JFormRuleRules::test"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Layout updates)
Line 12: Line 12:
 
===Synopsis===
 
===Synopsis===
 
<source lang="php">
 
<source lang="php">
public JFormRuleRules->test (&$element, $value, $group=null, &$input=null, &$form=null)
+
public JFormRuleRules::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/rules/rules.php
+
libraries/joomla/form/rules/rules.php (line 42)
 +
* see source code in [[jplatform:form/rules/rules.php#cl-42|BitBucket]]
 
===Referenced by===
 
===Referenced by===
 
===See also===
 
===See also===

Revision as of 20:39, 23 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JFormRuleRules::test

Description

Method to test the value.

Description:JFormRuleRules::test [Edit Descripton]

Since

Joomla 11.1

Synopsis

public JFormRuleRules::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/rules/rules.php (line 42)

Referenced by

See also

[Edit See Also]

SeeAlso:JFormRuleRules::test

Examples

<CodeExamplesForm />