API17

Difference between revisions of "JAuthentication"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (preparing for archive only)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<span class="editsection" style="font-size:76%;">
+
=={{JVer|11.1}} JAuthentication==
<nowiki>[</nowiki>[[Description:JAuthentication|Edit Descripton]]<nowiki>]</nowiki>
+
===Description===
</span>
+
 
{{Description:JAuthentication}}
+
 
===Defined in===
 
libraries/joomla/user/authentication.php
 
===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.
+
|[[API17:JAuthentication::authenticate|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.  
 
|-
 
|-
|[[JAuthentication::getInstance/11.1|getInstance]]
+
|public static
 +
|[[API17:JAuthentication::getInstance|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
 +
|[[API17:JAuthentication::__construct|__construct]]
 +
|Constructor.
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/user/authentication.php
 +
* '''Extends''' [[API17:JObservable|JObservable]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.user.authentication' );</source>
 
<source lang="php">jimport( 'joomla.user.authentication' );</source>
 
===See also===
 
===See also===
* [[JAuthentication|Other versions of this class]]
+
* {{JVer|11.1}} '''JAuthentication source code''' on [[jplatform:user/authentication.php|BitBucket]]
{{SeeAlso:JAuthentication}}
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage User|User]]
<span class="editsection" style="font-size:76%;">
+
* [[API17:JAuthentication|Other versions of JAuthentication]]
<nowiki>[</nowiki>[[SeeAlso:JAuthentication|Edit See Also]]<nowiki>]</nowiki>
+
 
</span>
+
 
===Examples===
+
===User contributed notes===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JAuthentication
 
category=JAuthentication
category=CodeExample
+
namespace=CodeExample
 
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 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 20:21, 24 March 2017

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 JAuthentication[edit]

Description[edit]

Methods[edit]

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[edit]

jimport( 'joomla.user.authentication' );

See also[edit]


User contributed notes[edit]

Code Examples[edit]