Class JFormRuleEquals

Description

Form Rule class for the Joomla Platform.

  • since: 11.1

Located in /libraries/joomla/form/rules/equals.php (line 19)

JFormRule
   |
   --JFormRuleEquals
Method Summary
boolean test (SimpleXMLElement &$element, mixed $value, [string $group = null], [JRegistry &$input = null], [object &$form = null])
Variables

Inherited Variables

Inherited from JFormRule

JFormRule::$modifiers
JFormRule::$regex
Methods
test (line 39)

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.

  • return: True if the value is valid, false otherwise.
  • since: 11.1
  • throws: JException on invalid rule.
  • access: public
boolean test (SimpleXMLElement &$element, mixed $value, [string $group = null], [JRegistry &$input = null], [object &$form = null])
  • SimpleXMLElement &$element: The SimpleXMLElement object representing the <field /> tag for the form field object.
  • mixed $value: The form field value to validate.
  • string $group: 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]".
  • JRegistry &$input: An optional JRegistry object with the entire data set to validate against the entire form.
  • object &$form: The form object for which the field is being tested.

Redefinition of:
JFormRule::test()
Method to test the value.

Inherited Methods

Inherited From JFormRule

JFormRule::test()

Documentation generated on Mon, 25 Jun 2012 13:54:28 -0500 by phpDocumentor 1.4.4