includes/auth/AbstractPreAuthenticationProvider.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  * A base class that implements some of the boilerplate for a PreAuthenticationProvider
  26  *
  27  * @stable to extend
  28  * @ingroup Auth
  29  * @since 1.27
  30  */
  31 abstract class AbstractPreAuthenticationProvider extends AbstractAuthenticationProvider
  32         implements PreAuthenticationProvider
  33 {
  34
  35         /**
  36          * @inheritDoc
  37          * @stable to override
  38          */
  39         public function getAuthenticationRequests( $action, array $options ) {
  40                 return [];
  41         }
  42
  43         /**
  44          * @inheritDoc
  45          * @stable to override
  46          */
  47         public function testForAuthentication( array $reqs ) {
  48                 return \StatusValue::newGood();
  49         }
  50
  51         /**
  52          * @inheritDoc
  53          * @stable to override
  54          */
  55         public function postAuthentication( $user, AuthenticationResponse $response ) {
  56         }
  57
  58         /**
  59          * @inheritDoc
  60          * @stable to override
  61          */
  62         public function testForAccountCreation( $user, $creator, array $reqs ) {
  63                 return \StatusValue::newGood();
  64         }
  65
  66         /**
  67          * @inheritDoc
  68          * @stable to override
  69          */
  70         public function testUserForCreation( $user, $autocreate, array $options = [] ) {
  71                 return \StatusValue::newGood();
  72         }
  73
  74         /**
  75          * @inheritDoc
  76          * @stable to override
  77          */
  78         public function postAccountCreation( $user, $creator, AuthenticationResponse $response ) {
  79         }
  80
  81         /**
  82          * @inheritDoc
  83          * @stable to override
  84          */
  85         public function testForAccountLink( $user ) {
  86                 return \StatusValue::newGood();
  87         }
  88
  89         /**
  90          * @inheritDoc
  91          * @stable to override
  92          */
  93         public function postAccountLink( $user, AuthenticationResponse $response ) {
  94         }
  95
  96 }