Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

Class JAuthenticationResponse

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

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

Located in /joomla/user/authentication.php (line 155) 

Class JObject   (Subpackage Base)

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

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".

  • var: string
  • access: public
fullname $country = '' (line 249)

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

  • var: string
  • access: public
email $email = '' (line 203)

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

  • var: string
  • access: public
error_message $error_message = '' (line 179)

The error message

  • var: string
  • access: public
fullname $fullname = '' (line 211)

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

  • var: string
  • access: public
fullname $gender = '' (line 233)

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

  • var: string
  • access: public
fullname $language = '' (line 257)

End User's preferred language as specified by ISO639.

  • var: string
  • access: public
password $password = '' (line 195)

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

  • var: string
  • access: public
fullname $postcode = '' (line 241)

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

  • var: string
  • access: public
type $status = JAUTHENTICATE_STATUS_FAILURE (line 163)

Response status (see status codes)

  • var: string
  • access: public
fullname $timezone = '' (line 265)

ASCII string from TimeZone database

  • var: string
  • access: public
type $type = '' (line 171)

The type of authentication that was successful

  • var: string
  • access: public
fullname $username = '' (line 187)

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

  • var: string
  • access: public

Inherited Variables

Inherited from JObject

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

Constructor

  • since: 1.5
JAuthenticationResponse __construct (string $name)
  • string $name: The type of the response
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
Documentation generated on Tue, 29 Jan 2008 18:44:32 +0000 by phpDocumentor 1.3.1