JFormRuleEquals/test: Difference between revisions
From Joomla! Documentation
No edit summary |
m removing red link to edit, no existant pages |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 57: | Line 57: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
| Line 72: | Line 72: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Revision as of 02:53, 14 May 2013
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.
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
test(&$field, &$values)
| Parameter Name | Default Value | Description |
|---|---|---|
| &$field | $field A reference to the form field. | |
| &$values | $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/equals.php
Importing
jimport( 'joomla.form.rules.equals' );
Source Body
public function test(&$field, &$values)
{
$return = false;
$field1 = (string)$field->attributes()->name;
$field2 = (string)$field->attributes()->field;
// Check the rule.
if (!$field2) {
return new JException('Invalid Form Rule :: '.get_class($this));
}
// Test the two values against each other.
if ($values[$field1] == $values[$field2]) {
$return = true;
}
return $return;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />