class JFormRuleRules extends JFormRule


Located at : UKNOWVA_ROOT/libraries/joomla/form/rules/rules.php

Form Rule class for the Joomla Framework.

Methods

boolean
test(object $element, mixed $value, string $group = null, object $input = null, object $form = null)

Method to test the value.

Details

at line 42
boolean test(object $element, mixed $value, string $group = null, object $input = null, object $form = null)

Method to test the value.

Parameters

object $element The JXMLElement object representing the 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]".
object $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.

Return Value

boolean True if the value is valid, false otherwise.

Exceptions

JException on invalid rule.