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::beginAuthentication() or
  29  * AuthManager::beginAccountCreation() anyway.
  30  *
  31  * @stable to extend
  32  * @ingroup Auth
  33  * @since 1.27
  34  */
  35 class CreateFromLoginAuthenticationRequest extends AuthenticationRequest {
  36         /** @inheritDoc */
  37         public $required = self::OPTIONAL;
  38
  39         /** @var AuthenticationRequest|null */
  40         public $createRequest;
  41
  42         /** @var AuthenticationRequest[] */
  43         public $maybeLink = [];
  44
  45         /**
  46          * @stable to call
  47          * @param AuthenticationRequest|null $createRequest A request to use to
  48          *  begin creating the account
  49          * @param AuthenticationRequest[] $maybeLink Additional accounts to link
  50          *  after creation.
  51          */
  52         public function __construct(
  53                 ?AuthenticationRequest $createRequest = null, array $maybeLink = []
  54         ) {
  55                 $this->createRequest = $createRequest;
  56                 $this->maybeLink = $maybeLink;
  57                 $this->username = $createRequest ? $createRequest->username : null;
  58         }
  59
  60         /**
  61          * @inheritDoc
  62          * @stable to override
  63          */
  64         public function getFieldInfo() {
  65                 return [];
  66         }
  67
  68         /**
  69          * @inheritDoc
  70          * @stable to override
  71          */
  72         public function loadFromSubmission( array $data ) {
  73                 return true;
  74         }
  75
  76         /**
  77          * Indicate whether this request contains any state for the specified
  78          * action.
  79          * @stable to override
  80          * @param string $action One of the AuthManager::ACTION_* constants
  81          * @return bool
  82          */
  83         public function hasStateForAction( $action ) {
  84                 switch ( $action ) {
  85                         case AuthManager::ACTION_LOGIN:
  86                                 return (bool)$this->maybeLink;
  87                         case AuthManager::ACTION_CREATE:
  88                                 return $this->maybeLink || $this->createRequest;
  89                         default:
  90                                 return false;
  91                 }
  92         }
  93
  94         /**
  95          * Indicate whether this request contains state for the specified
  96          * action sufficient to replace other primary-required requests.
  97          * @stable to override
  98          * @param string $action One of the AuthManager::ACTION_* constants
  99          * @return bool
 100          */
 101         public function hasPrimaryStateForAction( $action ) {
 102                 switch ( $action ) {
 103                         case AuthManager::ACTION_CREATE:
 104                                 return (bool)$this->createRequest;
 105                         default:
 106                                 return false;
 107                 }
 108         }
 109 }