JFormRuleEmail
Description
Form Rule class for the Joomla Platform.
Located in /libraries/joomla/form/rule/email.php (line 19)
JFormRule | --JFormRuleEmail
Direct descendents
| Class | Description |
|---|---|
JFormRuleContactEmail
|
JFormRule for com_contact to make sure the E-Mail adress is not blocked. |
Variable Summary
Method Summary
Variables
string
$regex
= '^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$' (line 28)
The regular expression to use in testing a form field value.
Redefinition of:
- JFormRule::$regex
- The regular expression to use in testing a form field value.
Inherited Variables
Inherited from JFormRule
Methods
Method to test the email address and optionally check for uniqueness.
boolean
test
(SimpleXMLElement $element, mixed $value, [string $group = null], [JRegistry $input = null], [JForm $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.
- JForm $form: The form object for which the field is being tested.
Redefinition of:
- JFormRule::test()
- Method to test the value.
Redefined in descendants as:
- JFormRuleContactEmail::test() : Method to test for banned e-mail addresses
Inherited Methods
Inherited From JFormRule
JFormRule::test()
Documentation generated on Tue, 19 Nov 2013 15:02:26 +0100 by phpDocumentor 1.4.3