API17:JFormRule::test

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

JFormRule::test

Description

Method to test the value.

Since

Synopsis

public JFormRule::test (&$element, $value, $group=null, &$input=null, &$form=null)

Parameter	Type	Default	Description
&$element			on invalid rule.
$value	mixed		The form field value to validate.
$group	string	null	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]".
&$input	object	null	$input An optional object with the entire data set to validate against the entire form.
&$form	object	null	$form The form object for which the field is being tested.

Returns

boolean True if the value is valid, false otherwise.

Defined in

libraries/joomla/form/formrule.php (line 61)

• see source code in BitBucket

See also

• JFormRule
• Other versions of this method

Examples

<CodeExamplesForm />