includes/auth/AbstractAuthenticationProvider.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 use Config;
  25 use Psr\Log\LoggerInterface;
  26
  27 /**
  28  * A base class that implements some of the boilerplate for an AuthenticationProvider
  29  * @ingroup Auth
  30  * @since 1.27
  31  */
  32 abstract class AbstractAuthenticationProvider implements AuthenticationProvider {
  33         /** @var LoggerInterface */
  34         protected $logger;
  35         /** @var AuthManager */
  36         protected $manager;
  37         /** @var Config */
  38         protected $config;
  39
  40         public function setLogger( LoggerInterface $logger ) {
  41                 $this->logger = $logger;
  42         }
  43
  44         public function setManager( AuthManager $manager ) {
  45                 $this->manager = $manager;
  46         }
  47
  48         public function setConfig( Config $config ) {
  49                 $this->config = $config;
  50         }
  51
  52         /**
  53          * @inheritDoc
  54          * @note Override this if it makes sense to support more than one instance
  55          */
  56         public function getUniqueId() {
  57                 return static::class;
  58         }
  59 }