[Summary view] [Print] [Text view]

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