Joomla! API

Download
Launch

JAuthenticationResponse

Extends \JObject

Authentication response class, provides an object for storing user and error details

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)
inherited
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
inherited deprecated
since

11.1
deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
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
inherited deprecated
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
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1
see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
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
inherited deprecated
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
inherited
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
inherited deprecated
since

11.1
deprecated

12.1 Use magic method __toString()
see \JObject::__toString()

Response

string

Properties

status

Response status (see status codes)

since

11.1

Type(s)

string

type

The type of authentication that was successful

since

11.1

Type(s)

string

error_message

The error message

since

11.1

Type(s)

string

username

Any UTF-8 string that the End User wants to use as a username.

since

11.1

Type(s)

string

password

Any UTF-8 string that the End User wants to use as a password.

since

11.1

Type(s)

string

email

The email address of the End User as specified in section 3.4.1 of [RFC2822]

since

11.1

Type(s)

string

fullname

UTF-8 string free text representation of the End User's full name.

since

11.1

Type(s)

string

birthdate

The End User's date of birth as YYYY-MM-DD. Any values whose representation uses fewer than the specified number of digits should be zero-padded. The length of this value MUST always be 10. If the End User user does not want to reveal any particular component of this value, it MUST be set to zero.

For instance, if a End User wants to specify that his date of birth is in 1980, but not the month or day, the value returned SHALL be "1980-00-00".

since

11.1

Type(s)

string

gender

The End User's gender, "M" for male, "F" for female.

since

11.1

Type(s)

string

postcode

UTF-8 string free text that SHOULD conform to the End User's country's postal system.

since

11.1

Type(s)

\postcode

country

The End User's country of residence as specified by ISO3166.

since

11.1

Type(s)

string

language

End User's preferred language as specified by ISO639.

since

11.1

Type(s)

string

timezone

ASCII string from TimeZone database

since

11.1

Type(s)

string

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array
  • \ \
  • \ JAuthenticationResponse