Docs For 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 347)

Variable Summary

string $birthdate

string $country

string $email

string $error_message

string $fullname

string $gender

string $language

string $password

string $postcode

string $status

string $timezone

string $type

string $username

Variables

string $birthdate = '' (line 418)

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

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

since: 11.1
access: public

string $email = '' (line 395)

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

The error message

since: 11.1
access: public

string $fullname = '' (line 404)

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

since: 11.1
access: public

string $gender = '' (line 426)

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

since: 11.1
access: public

string $language = '' (line 450)

End User's preferred language as specified by ISO639.

since: 11.1
access: public

string $password = '' (line 387)

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

since: 11.1
access: public

string $postcode = '' (line 434)

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

Response status (see status codes)

since: 11.1
access: public

string $timezone = '' (line 458)

ASCII string from TimeZone database

since: 11.1
access: public

string $type = '' (line 363)

The type of authentication that was successful

since: 11.1
access: public

string $username = '' (line 379)

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

since: 11.1
access: public