[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * @package    Joomla.Administrator
   5   * @subpackage com_users
   6   *
   7   * @copyright  (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
   8   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   9   */
  10  
  11  namespace Joomla\Component\Users\Administrator\DataShape;
  12  
  13  use Joomla\Component\Users\Administrator\Table\MfaTable;
  14  
  15  // phpcs:disable PSR1.Files.SideEffects
  16  \defined('_JEXEC') or die;
  17  // phpcs:enable PSR1.Files.SideEffects
  18  
  19  /**
  20   * @property  string  $name                Internal code of this MFA Method
  21   * @property  string  $display             User-facing name for this MFA Method
  22   * @property  string  $shortinfo           Short description of this MFA Method displayed to the user
  23   * @property  string  $image               URL to the logo image for this Method
  24   * @property  bool    $canDisable          Are we allowed to disable it?
  25   * @property  bool    $allowMultiple       Are we allowed to have multiple instances of it per user?
  26   * @property  string  $help_url            URL for help content
  27   * @property  bool    $allowEntryBatching  Allow authentication against all entries of this MFA Method.
  28   *
  29   * @since       4.2.0
  30   */
  31  class MethodDescriptor extends DataShapeObject
  32  {
  33      /**
  34       * Internal code of this MFA Method
  35       *
  36       * @var   string
  37       * @since 4.2.0
  38       */
  39      protected $name = '';
  40  
  41      /**
  42       * User-facing name for this MFA Method
  43       *
  44       * @var   string
  45       * @since 4.2.0
  46       */
  47      protected $display = '';
  48  
  49      /**
  50       * Short description of this MFA Method displayed to the user
  51       *
  52       * @var   string
  53       * @since 4.2.0
  54       */
  55      protected $shortinfo = '';
  56  
  57      /**
  58       * URL to the logo image for this Method
  59       *
  60       * @var   string
  61       * @since 4.2.0
  62       */
  63      protected $image = '';
  64  
  65      /**
  66       * Are we allowed to disable it?
  67       *
  68       * @var   boolean
  69       * @since 4.2.0
  70       */
  71      protected $canDisable = true;
  72  
  73      /**
  74       * Are we allowed to have multiple instances of it per user?
  75       *
  76       * @var   boolean
  77       * @since 4.2.0
  78       */
  79      protected $allowMultiple = false;
  80  
  81      /**
  82       * URL for help content
  83       *
  84       * @var   string
  85       * @since 4.2.0
  86       */
  87      protected $help_url = '';
  88  
  89      /**
  90       * Allow authentication against all entries of this MFA Method.
  91       *
  92       * Otherwise authentication takes place against a SPECIFIC entry at a time.
  93       *
  94       * @var   boolean
  95       * @since 4.2.0
  96       */
  97      protected $allowEntryBatching = false;
  98  
  99      /**
 100       * Active authentication methods, used internally only
 101       *
 102       * @var   MfaTable[]
 103       * @since 4.2.0
 104       * @internal
 105       */
 106      protected $active = [];
 107  
 108      /**
 109       * Adds an active MFA method
 110       *
 111       * @param   MfaTable  $record  The MFA method record to add
 112       *
 113       * @return void
 114       * @since 4.2.0
 115       */
 116      public function addActiveMethod(MfaTable $record)
 117      {
 118          $this->active[$record->id] = $record;
 119      }
 120  }