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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<?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
*
* @author Happy-melon
* @file
*/
use MediaWiki\MediaWikiServices;
/**
* The simplest way of implementing IContextSource is to hold a RequestContext as a
* member variable and provide accessors to it.
*
* @stable to extend
* @since 1.18
*/
abstract class ContextSource implements IContextSource {
/**
* @var IContextSource
*/
private $context;
/**
* Get the base IContextSource object
* @since 1.18
* @stable to override
* @return IContextSource
*/
public function getContext() {
if ( $this->context === null ) {
$class = static::class;
wfDebug( __METHOD__ . " ($class): called and \$context is null. " .
"Using RequestContext::getMain() for sanity" );
$this->context = RequestContext::getMain();
}
return $this->context;
}
/**
* @since 1.18
* @stable to override
* @param IContextSource $context
*/
public function setContext( IContextSource $context ) {
$this->context = $context;
}
/**
* @since 1.23
* @stable to override
* @return Config
*/
public function getConfig() {
return $this->getContext()->getConfig();
}
/**
* @since 1.18
* @stable to override
* @return WebRequest
*/
public function getRequest() {
return $this->getContext()->getRequest();
}
/**
* @since 1.18
* @stable to override
* @return Title|null
*/
public function getTitle() {
return $this->getContext()->getTitle();
}
/**
* Check whether a WikiPage object can be get with getWikiPage().
* Callers should expect that an exception is thrown from getWikiPage()
* if this method returns false.
*
* @since 1.19
* @stable to override
* @return bool
*/
public function canUseWikiPage() {
return $this->getContext()->canUseWikiPage();
}
/**
* Get the WikiPage object.
* May throw an exception if there's no Title object set or the Title object
* belongs to a special namespace that doesn't have WikiPage, so use first
* canUseWikiPage() to check whether this method can be called safely.
*
* @since 1.19
* @stable to override
* @return WikiPage
*/
public function getWikiPage() {
return $this->getContext()->getWikiPage();
}
/**
* @since 1.18
* @stable to override
* @return OutputPage
*/
public function getOutput() {
return $this->getContext()->getOutput();
}
/**
* @stable to override
* @since 1.18
* @stable to override
* @return User
*/
public function getUser() {
return $this->getContext()->getUser();
}
/**
* @since 1.19
* @stable to override
* @return Language
*/
public function getLanguage() {
return $this->getContext()->getLanguage();
}
/**
* @since 1.18
* @stable to override
* @return Skin
*/
public function getSkin() {
return $this->getContext()->getSkin();
}
/**
* @since 1.27
* @stable to override
* @return Timing
*/
public function getTiming() {
return $this->getContext()->getTiming();
}
/**
* @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
*
* @since 1.25
* @stable to override
* @return IBufferingStatsdDataFactory
*/
public function getStats() {
return MediaWikiServices::getInstance()->getStatsdDataFactory();
}
/**
* Get a Message object with context set
* Parameters are the same as wfMessage()
*
* @since 1.18
* @stable to override
* @param string|string[]|MessageSpecifier $key Message key, or array of keys,
* or a MessageSpecifier.
* @param mixed ...$params
* @return Message
*/
public function msg( $key, ...$params ) {
return $this->getContext()->msg( $key, ...$params );
}
/**
* Export the resolved user IP, HTTP headers, user ID, and session ID.
* The result will be reasonably sized to allow for serialization.
*
* @since 1.21
* @stable to override
* @return array
*/
public function exportSession() {
return $this->getContext()->exportSession();
}
}
|
