Actions

API17

Difference between revisions of "JAuthentication"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JAuthentication==
 +
===Description===
 +
{{Description:JAuthentication}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JAuthentication|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JAuthentication|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JAuthentication}}
 
===Defined in===
 
libraries/joomla/user/authentication.php
 
* see source code in [[jplatform:user/authentication.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage User/11.1|User]]
 
===Extends===
 
[[JObservable/11.1|JObservable]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
|[[JAuthentication::__construct/11.1|__construct]]
+
|public
|Constructor.
+
|-
+
 
|[[JAuthentication::authenticate/11.1|authenticate]]
 
|[[JAuthentication::authenticate/11.1|authenticate]]
 
|Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.  
 
|Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.  
 
|-
 
|-
 +
|public static
 
|[[JAuthentication::getInstance/11.1|getInstance]]
 
|[[JAuthentication::getInstance/11.1|getInstance]]
 
|Returns the global authentication object, only creating it if it doesn't already exist.  
 
|Returns the global authentication object, only creating it if it doesn't already exist.  
 +
|-
 +
|protected
 +
|[[JAuthentication::__construct/11.1|__construct]]
 +
|Constructor.
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/user/authentication.php
 +
* '''Extends''' [[JObservable/11.1|JObservable]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.user.authentication' );</source>
 
<source lang="php">jimport( 'joomla.user.authentication' );</source>
 
===See also===
 
===See also===
* JAuthentication source code in [[jplatform:user/authentication.php|BitBucket]]
+
* {{JVer|11.1}} '''JAuthentication source code''' on [[jplatform:user/authentication.php|BitBucket]]
* [[JAuthentication|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage User/11.1|User]]
 +
* [[JAuthentication|Other versions of JAuthentication]]
 
{{SeeAlso:JAuthentication}}
 
{{SeeAlso:JAuthentication}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JAuthentication|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JAuthentication|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 45: Line 46:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JAuthentication]]</noinclude>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JAuthentication]]</noinclude>

Revision as of 17:55, 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

Description

Description:JAuthentication [Edit Descripton]

Methods

Visibility Method name Description
public authenticate Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.
public static getInstance Returns the global authentication object, only creating it if it doesn't already exist.
protected __construct Constructor.
  • Defined in libraries/joomla/user/authentication.php
  • Extends JObservable

Importing

jimport( 'joomla.user.authentication' );

See also

SeeAlso:JAuthentication [Edit See Also]

User contributed notes

<CodeExamplesForm />