Joomla! Platform 12.1

Download

Demo

Class JAuthenticationResponse

Description
Description | Variables (details) | Methods (details)

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

  • since: 11.1

Located in /libraries/joomla/user/authentication.php (line 345) 

Class JObject   (Subpackage Object)

Class JAuthenticationResponse   (Subpackage User)
Variable Summary
Description | Variables (details) | Methods (details)
Variable string $birthdate
Variable string $country
Variable string $email
Variable string $error_message
Variable string $fullname
Variable string $gender
Variable string $language
Variable string $password
Variable string $postcode
Variable string $status
Variable string $timezone
Variable string $type
Variable string $username
Method Summary
Description | Variables (details) | Methods (details)
Constructor JAuthenticationResponse __construct ()
Variables
Description | Variables (details) | Methods (details)
string $birthdate = '' (line 416)

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
  • access: public
string $country = '' (line 440)

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

  • since: 11.1
  • access: public
string $email = '' (line 393)

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

  • since: 11.1
  • access: public
string $error_message = '' (line 369)

The error message

  • since: 11.1
  • access: public
string $fullname = '' (line 402)

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

  • since: 11.1
  • access: public
string $gender = '' (line 424)

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

  • since: 11.1
  • access: public
string $language = '' (line 448)

End User's preferred language as specified by ISO639.

  • since: 11.1
  • access: public
string $password = '' (line 385)

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

  • since: 11.1
  • access: public
string $postcode = '' (line 432)

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

  • since: 11.1
  • access: public
string $status = JAuthentication::STATUS_FAILURE (line 353)

Response status (see status codes)

  • since: 11.1
  • access: public
string $timezone = '' (line 456)

ASCII string from TimeZone database

  • since: 11.1
  • access: public
string $type = '' (line 361)

The type of authentication that was successful

  • since: 11.1
  • access: public
string $username = '' (line 377)

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

  • since: 11.1
  • access: public

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 463)

Constructor

  • since: 11.1
  • access: public
JAuthenticationResponse __construct ()
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()
Support Joomla!
/html>