1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Auth
*/
namespace MediaWiki\Auth;
use MediaWiki\Config\Config;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\User\UserNameUtils;
use Psr\Log\LoggerInterface;
/**
* A base class that implements some of the boilerplate for an AuthenticationProvider
* @stable to extend
* @ingroup Auth
* @since 1.27
*/
abstract class AbstractAuthenticationProvider implements AuthenticationProvider {
/** @var LoggerInterface */
protected $logger;
/** @var AuthManager */
protected $manager;
/** @var Config */
protected $config;
/** @var HookContainer */
private $hookContainer;
/** @var HookRunner */
private $hookRunner;
/** @var UserNameUtils */
protected $userNameUtils;
/**
* Initialise with dependencies of an AuthenticationProvider
*
* @since 1.37
* @internal In production code AuthManager will initialize the
* AbstractAuthenticationProvider, in tests
* AuthenticationProviderTestTrait must be used.
*
* @param LoggerInterface $logger
* @param AuthManager $manager
* @param HookContainer $hookContainer
* @param Config $config
* @param UserNameUtils $userNameUtils
*/
public function init(
LoggerInterface $logger,
AuthManager $manager,
HookContainer $hookContainer,
Config $config,
UserNameUtils $userNameUtils
) {
$this->logger = $logger;
$this->manager = $manager;
$this->hookContainer = $hookContainer;
$this->hookRunner = new HookRunner( $hookContainer );
$this->config = $config;
$this->userNameUtils = $userNameUtils;
$this->postInitSetup();
}
/**
* A provider can override this to do any necessary setup after init()
* is called.
*
* @since 1.37
* @stable to override
*/
protected function postInitSetup() {
}
/**
* @inheritDoc
* @note Override this if it makes sense to support more than one instance
*/
public function getUniqueId() {
return static::class;
}
/**
* @since 1.35
* @return HookContainer
*/
protected function getHookContainer(): HookContainer {
return $this->hookContainer;
}
/**
* @internal This is for use by core only. Hook interfaces may be removed
* without notice.
* @since 1.35
* @return HookRunner
*/
protected function getHookRunner(): HookRunner {
return $this->hookRunner;
}
}
|
