Actions

API17

Difference between revisions of "JAuthentication::authenticate"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JAuthentication::authenticate|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JAuthentication::authenticate|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JAuthentication::authenticate ($credentials, $options)
+
public function authenticate (
 +
        $credentials
 +
        $options
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' mixed Integer userid for valid user if credentials are valid or boolean false if they are not
mixed Integer userid for valid user if credentials are valid or boolean false if they are not
+
* '''Defined''' on line 83 of libraries/joomla/user/authentication.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/user/authentication.php (line 87)
+
* see source code in [[jplatform:user/authentication.php#cl-87|BitBucket]]
+
===Referenced by===
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JAuthentication::authenticate source code''' on [[jplatform:user/authentication.php#cl-75|BitBucket]]
 +
* {{JVer|11.1}} Class [[JAuthentication/11.1|JAuthentication]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
 +
* [[JAuthentication::authenticate|Other versions of JAuthentication::authenticate]]
 +
{{SeeAlso:JAuthentication::authenticate}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JAuthentication::authenticate|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JAuthentication::authenticate|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JAuthentication/11.1|JAuthentication]]
+
===User contributed notes===
* [[JAuthentication::authenticate|Other versions of this method]]
+
{{SeeAlso:JAuthentication::authenticate}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 53: Line 52:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JAuthentication]][[Category:JAuthentication::authenticate]]</noinclude>
 
<noinclude>[[Category:JAuthentication]][[Category:JAuthentication::authenticate]]</noinclude>

Revision as of 20:11, 27 April 2011

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 JAuthentication::authenticate

Description

Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.

Description:JAuthentication::authenticate [Edit Descripton]

public function authenticate (
        $credentials
        $options
)
Parameter Type Default Description
$credentials array Array holding the user credentials
$options
  • Returns mixed Integer userid for valid user if credentials are valid or boolean false if they are not
  • Defined on line 83 of libraries/joomla/user/authentication.php
  • Since Joomla 11.1

See also

SeeAlso:JAuthentication::authenticate [Edit See Also]

User contributed notes

<CodeExamplesForm />