Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JAuthenticateResponse

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

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

Located in /joomla/user/authenticate.php (line 219) 

Class JObject   (Subpackage Base)

Class JAuthenticateResponse   (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 fullname $postcode
Variable type $status
Variable fullname $timezone
Variable name $type
Variable fullname $username
Method Summary
Description | Variables (details) | Methods (details)
Constructor JAuthenticateResponse __construct ( $type, string $name)
Variables
Description | Variables (details) | Methods (details)
fullname $birthdate = '' (line 281)

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

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

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

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

The error message

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

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

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

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

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

End User's preferred language as specified by ISO639.

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

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

  • var: string
  • access: public
type $status = 4 (line 235)

Response status (see status codes)

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

ASCII string from TimeZone database

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

User type (refers to the authentication method used)

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

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

  • var: string
  • access: public
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 329)

Constructor

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

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 20:52:44 +0000 by phpDocumentor 1.3.1