includes/auth/CreateFromLoginAuthenticationRequest.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  * This transfers state between the login and account creation flows.
  26  *
  27  * AuthManager::getAuthenticationRequests() won't return this type, but it
  28  * may be passed to AuthManager::beginAccountCreation() anyway.
  29  *
  30  * @ingroup Auth
  31  * @since 1.27
  32  */
  33 class CreateFromLoginAuthenticationRequest extends AuthenticationRequest {
  34         public $required = self::OPTIONAL;
  35
  36         /** @var AuthenticationRequest|null */
  37         public $createRequest;
  38
  39         /** @var AuthenticationRequest[] */
  40         public $maybeLink = [];
  41
  42         /**
  43          * @param AuthenticationRequest|null $createRequest A request to use to
  44          *  begin creating the account
  45          * @param AuthenticationRequest[] $maybeLink Additional accounts to link
  46          *  after creation.
  47          */
  48         public function __construct(
  49                 AuthenticationRequest $createRequest = null, array $maybeLink = []
  50         ) {
  51                 $this->createRequest = $createRequest;
  52                 $this->maybeLink = $maybeLink;
  53         }
  54
  55         public function getFieldInfo() {
  56                 return [];
  57         }
  58
  59         public function loadFromSubmission( array $data ) {
  60                 return true;
  61         }
  62 }