Actions

API17

Difference between revisions of "JFormRuleEmail::test"

From Joomla! Documentation

(Updated to r1448:247ba8d88526)
m (JoomlaWikiBot moved page JFormRuleEmail::test/11.1 to API17:JFormRuleEmail::test without leaving a redirect: Robot: Moved page)

Revision as of 18:32, 10 May 2013

Replacement filing cabinet.png
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.

Joomla 11.1 JFormRuleEmail::test

Description

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

Description:JFormRuleEmail::test [Edit Descripton]

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

SeeAlso:JFormRuleEmail::test [Edit See Also]

User contributed notes

<CodeExamplesForm />