API16:JFormRuleRules/test
From Joomla! Documentation
Description
Method to test if two values are equal. To use this rule, the form XML needs a validate attribute of equals and a field attribute that is equal to the field to test against.
Template:Description:JFormRuleRules/test
Syntax
test(&$field, &$values)
| Parameter Name | Default Value | Description |
|---|---|---|
| $field A reference to the form field. | ||
| $values The values to test for validiaty. |
Returns
mixed on invalid rule, true if the value is valid, false otherwise.
Defined in
libraries/joomla/form/rules/rules.php
Importing
jimport( 'joomla.form.rules.rules' );
Source Body
public function test(&$field, &$values)
{
$name = (string)$field->attributes()->name;
// TODO: probably should check to see if the action is even available for this field.
// $values[$name];
return true;
}
[Edit See Also] Template:SeeAlso:JFormRuleRules/test
Examples
<CodeExamplesForm />