Difference between revisions of "JFormRuleUsername::test"

Revision as of 20:39, 23 April 2011

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.

JFormRuleUsername::test[edit]

Description[edit]

Method to test the username for uniqueness.

Template:Description:JFormRuleUsername::test [Edit Descripton]

Since[edit]

Synopsis[edit]

public JFormRuleUsername::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[edit]

boolean True if the value is valid, false otherwise.

Defined in[edit]

libraries/joomla/form/rules/username.php (line 42)

see source code in BitBucket

Referenced by[edit]

Examples[edit]

@@ Line 12: / Line 12: @@
 ===Synopsis===
 <source lang="php">
-public  JFormRuleUsername->test (&$element, $value, $group=null, &$input=null, &$form=null)
+public JFormRuleUsername::test (&$element, $value, $group=null, &$input=null, &$form=null)
 </source>
 {| class="wikitable"
@@ Line 50: / Line 50: @@
 boolean True if the value is valid, false otherwise.
 ===Defined in===
-libraries/joomla/form/rules/username.php
+libraries/joomla/form/rules/username.php (line 42)
+* see source code in [[jplatform:form/rules/username.php#cl-42|BitBucket]]
 ===Referenced by===
 ===See also===

API17