1 <?php
2 /**
3 * @package Joomla.Platform
4 * @subpackage Authentication
5 *
6 * @copyright Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
7 * @license GNU General Public License version 2 or later; see LICENSE
8 */
9
10 defined('JPATH_PLATFORM') or die;
11
12 /**
13 * Authentication response class, provides an object for storing user and error details
14 *
15 * @since 11.1
16 */
17 class JAuthenticationResponse
18 {
19 /**
20 * Response status (see status codes)
21 *
22 * @var string
23 * @since 11.1
24 */
25 public $status = JAuthentication::STATUS_FAILURE;
26
27 /**
28 * The type of authentication that was successful
29 *
30 * @var string
31 * @since 11.1
32 */
33 public $type = '';
34
35 /**
36 * The error message
37 *
38 * @var string
39 * @since 11.1
40 */
41 public $error_message = '';
42
43 /**
44 * Any UTF-8 string that the End User wants to use as a username.
45 *
46 * @var string
47 * @since 11.1
48 */
49 public $username = '';
50
51 /**
52 * Any UTF-8 string that the End User wants to use as a password.
53 *
54 * @var string
55 * @since 11.1
56 */
57 public $password = '';
58
59 /**
60 * The email address of the End User as specified in section 3.4.1 of [RFC2822]
61 *
62 * @var string
63 * @since 11.1
64 */
65 public $email = '';
66
67 /**
68 * UTF-8 string free text representation of the End User's full name.
69 *
70 * @var string
71 * @since 11.1
72 */
73 public $fullname = '';
74
75 /**
76 * The End User's date of birth as YYYY-MM-DD. Any values whose representation uses
77 * fewer than the specified number of digits should be zero-padded. The length of this
78 * value MUST always be 10. If the End User user does not want to reveal any particular
79 * component of this value, it MUST be set to zero.
80 *
81 * For instance, if an End User wants to specify that their date of birth is in 1980, but
82 * not the month or day, the value returned SHALL be "1980-00-00".
83 *
84 * @var string
85 * @since 11.1
86 */
87 public $birthdate = '';
88
89 /**
90 * The End User's gender, "M" for male, "F" for female.
91 *
92 * @var string
93 * @since 11.1
94 */
95 public $gender = '';
96
97 /**
98 * UTF-8 string free text that SHOULD conform to the End User's country's postal system.
99 *
100 * @var string
101 * @since 11.1
102 */
103 public $postcode = '';
104
105 /**
106 * The End User's country of residence as specified by ISO3166.
107 *
108 * @var string
109 * @since 11.1
110 */
111 public $country = '';
112
113 /**
114 * End User's preferred language as specified by ISO639.
115 *
116 * @var string
117 * @since 11.1
118 */
119 public $language = '';
120
121 /**
122 * ASCII string from TimeZone database
123 *
124 * @var string
125 * @since 11.1
126 */
127 public $timezone = '';
128 }
129