Class JAuthentication

Authentication class, provides an interface for the Joomla authentication system

JObject

JAuthentication

Package: Joomla\Platform\Authentication
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/authentication/authentication.php

Methods summary

`public`	# `__construct( )` Constructor Constructor Since 11.1 Overrides `JObject::__construct`
`public static JAuthentication`	# `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. Returns `JAuthentication` - The global JAuthentication object Since 11.1
`public mixed`	# `getState( )` Get the state of the JAuthentication object Get the state of the JAuthentication object Returns `mixed` - The state of the object. Since 11.1
`public`	# `attach( object $observer )` Attach an observer object Attach an observer object Parameters `$observer` `object` - $observer An observer object to attach Since 11.1
`public boolean`	# `detach( object $observer )` Detach an observer object Detach an observer object Parameters `$observer` `object` - $observer An observer object to detach. Returns `boolean` - True if the observer object was detached. Since 11.1
`public JAuthenticationResponse`	# `authenticate( array $credentials, array $options = array() )` Finds out if a set of login credentials are valid by asking all observing objects to run their respective authentication routines. Finds out if a set of login credentials are valid by asking all observing objects to run their respective authentication routines. Parameters `$credentials` `array` - $credentials Array holding the user credentials. `$options` `array` - $options Array holding user options. Returns `JAuthenticationResponse` - Response object with status variable filled in for last plugin or first successful plugin. Since 11.1 See `JAuthenticationResponse`
`public static JAuthenticationResponse[]`	# `authorise( JAuthenticationResponse $response, array $options = array() )` Authorises that a particular user should be able to login Authorises that a particular user should be able to login Parameters `$response` `JAuthenticationResponse` - $response response including username of the user to authorise `$options` `array` - $options list of options Returns `JAuthenticationResponse[]` - Array of authentication response objects Since 11.2

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Constants summary

`integer`	`STATUS_SUCCESS`	`1`	# This is the status code returned when the authentication is success (permit login) This is the status code returned when the authentication is success (permit login) Since 11.2 Const STATUS_SUCCESS successful response
`integer`	`STATUS_CANCEL`	`2`	# Status to indicate cancellation of authentication (unused) Status to indicate cancellation of authentication (unused) Since 11.2 Const STATUS_CANCEL cancelled request (unused)
`integer`	`STATUS_FAILURE`	`4`	# This is the status code returned when the authentication failed (prevent login if no success) This is the status code returned when the authentication failed (prevent login if no success) Since 11.2 Const STATUS_FAILURE failed request
`integer`	`STATUS_EXPIRED`	`8`	# This is the status code returned when the account has expired (prevent login) This is the status code returned when the account has expired (prevent login) Since 11.2 Const STATUS_EXPIRED an expired account (will prevent login)
`integer`	`STATUS_DENIED`	`16`	# This is the status code returned when the account has been denied (prevent login) This is the status code returned when the account has been denied (prevent login) Since 11.2 Const STATUS_DENIED denied request (will prevent login)
`integer`	`STATUS_UNKNOWN`	`32`	# This is the status code returned when the account doesn't exist (not an error) This is the status code returned when the account doesn't exist (not an error) Since 11.2 Const STATUS_UNKNOWN unknown account (won't permit or prevent login)

Properties summary

`protected array`	`$observers`	# An array of Observer objects to notify An array of Observer objects to notify Since 12.1
`protected mixed`	`$state`	# The state of the observable object The state of the observable object Since 12.1
`protected array`	`$methods`	# A multi dimensional array of [function][] = key for observers A multi dimensional array of [function][] = key for observers Since 12.1
`protected static JAuthentication`	`$instance`	# JAuthentication instances container. JAuthentication instances container. Since 11.3

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JAuthentication

Methods summary

Since

Overrides

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

See

Parameters

Returns

Since

Methods inherited from JObject

Magic methods summary

Constants summary

Since

Const

Since

Const

Since

Const

Since

Const

Since

Const

Since

Const

Properties summary

Since

Since

Since

Since

Properties inherited from JObject