includes/auth/CreatedAccountAuthenticationRequest.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Auth
  20  */
  21
  22 namespace MediaWiki\Auth;
  23
  24 /**
  25  * Returned from account creation to allow for logging into the created account
  26  * @stable to extend
  27  * @ingroup Auth
  28  * @since 1.27
  29  */
  30 class CreatedAccountAuthenticationRequest extends AuthenticationRequest {
  31
  32         /** @inheritDoc */
  33         public $required = self::OPTIONAL;
  34
  35         /** @var int User id */
  36         public $id;
  37
  38         /**
  39          * @inheritDoc
  40          * @stable to override
  41          */
  42         public function getFieldInfo() {
  43                 return [];
  44         }
  45
  46         /**
  47          * @stable to call
  48          * @param int $id User id
  49          * @param string $name Username
  50          */
  51         public function __construct( $id, $name ) {
  52                 $this->id = (int)$id;
  53                 $this->username = $name;
  54         }
  55 }