Class JAuthenticationResponse

Description

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

  • since: 11.1

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

JObject
   |
   --JAuthenticationResponse
Variable Summary
string $birthdate
string $country
string $email
string $fullname
string $gender
string $language
string $password
postcode $postcode
string $status
string $timezone
string $type
string $username
Method Summary
JAuthenticationResponse __construct ()
Variables
string $birthdate = '' (line 436)

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 460)

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

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

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 389)

The error message

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

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

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

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

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

End User's preferred language as specified by ISO639.

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

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

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

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

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

Response status (see status codes)

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

ASCII string from TimeZone database

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

The type of authentication that was successful

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

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

  • since: 11.1
  • access: public

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 483)

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()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:52:28 -0500 by phpDocumentor 1.4.4