JAuthentication
Extends \JObjectAuthentication class, provides an interface for the Joomla authentication system
This class allows for simple but smart objects with get and set methods and an internal error handler.
| package |
Joomla.Platform |
|---|---|
| subpackage |
User |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
attach
Attach an observer object
attach(object $observer) : void
| since |
11.1 |
|---|
Arguments
- $observer
objectAn observer object to attach
authenticate
Finds out if a set of login credentials are valid by asking all observing objects to run their respective authentication routines.
authenticate(array $credentials, array $options = array()) : \JAuthenticationResponse
| see | \JAuthenticationResponse |
|---|---|
| since |
11.1 |
Arguments
- $credentials
arrayArray holding the user credentials.- $options
arrayArray holding user options.
Response
\JAuthenticationResponseResponse object with status variable filled in for last plugin or first successful plugin.
authorise
Authorises that a particular user should be able to login
authorise(\JAuthenticationResponse $response, array $options = array()) : \array[JAuthenticationResponse]
| since |
11.2 |
|---|
Arguments
- $response
\JAuthenticationResponseresponse including username of the user to authorise- $options
arraylist of options
Response
\array[JAuthenticationResponse]results of authorisation
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
detach
Detach an observer object
detach(object $observer) : boolean
| since |
11.1 |
|---|
Arguments
- $observer
objectAn observer object to detach.
Response
booleanTrue if the observer object was detached.
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getInstance
Returns the global authentication object, only creating it if it doesn't already exist.
getInstance() : \JAuthentication
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
getState
Get the state of the JAuthentication object
getState() : mixed
| since |
11.1 |
|---|
Response
mixedThe state of the object.
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Constants
STATUS_SUCCESS
This is the status code returned when the authentication is success (permit login)
| Value | 1 |
|---|---|
| const |
STATUS_SUCCESS successful response |
| since |
11.2 |
Type(s)
STATUS_CANCEL
Status to indicate cancellation of authentication (unused)
| Value | 2 |
|---|---|
| const |
STATUS_CANCEL cancelled request (unused) |
| since |
11.2 |
Type(s)
STATUS_FAILURE
This is the status code returned when the authentication failed (prevent login if no success)
| Value | 4 |
|---|---|
| const |
STATUS_FAILURE failed request |
| since |
11.2 |
Type(s)
STATUS_EXPIRED
This is the status code returned when the account has expired (prevent login)
| Value | 8 |
|---|---|
| const |
STATUS_EXPIRED an expired account (will prevent login) |
| since |
11.2 |
Type(s)
STATUS_DENIED
This is the status code returned when the account has been denied (prevent login)
| Value | 16 |
|---|---|
| const |
STATUS_DENIED denied request (will prevent login) |
| since |
11.2 |
Type(s)
STATUS_UNKNOWN
This is the status code returned when the account doesn't exist (not an error)
| Value | 32 |
|---|---|
| const |
STATUS_UNKNOWN unknown account (won't permit or prevent login) |
| since |
11.2 |
Type(s)
Properties
_observers
An array of Observer objects to notify
| since |
11.1 |
|---|
Type(s)
array
_state
The state of the observable object
| since |
11.1 |
|---|
Type(s)
mixed
_methods
A multi dimensional array of [function][] = key for observers
| since |
11.1 |
|---|
Type(s)
array
_errors
An array of error messages or Exception objects.