JFormRule::test

Method to test the value.

Signature

public function test(SimpleXMLElement
        $element,
            [JRegistry
        $value = null,
            [JRegistry
        $group = null,
            [JRegistry
        $input = null,
            [JForm
        $form = null]]]] )

Parameters

$element: The SimpleXMLElement object representing the <field /> tag for the form field object.
$value: The form field value to validate.
$group: The field name group control value. This acts as as an array container for the field.
$input: An optional JRegistry object with the entire data set to validate against the entire form.
$form: The form object for which the field is being tested.

Returns

boolean: True if the value is valid, false otherwise.

Errors/Exceptions

UnexpectedValueException: if rule is invalid.