API17

JFormRuleEmail::test

From Joomla! Documentation

Revision as of 03:09, 25 March 2017 by JoomlaWikiBot (talk | contribs) (preparing for archive only)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JFormRuleEmail::test[edit]

Description[edit]

Method to test the email address and optionally check for uniqueness.


public function 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 on line 50 of libraries/joomla/form/rules/email.php
  • Since Joomla 11.1

See also[edit]


User contributed notes[edit]

Code Examples[edit]