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
|
<?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
*
* @since 1.18
*
* @author Happy-melon
* @file
*/
/**
* Interface for objects which can provide a MediaWiki context on request
*
* Context objects contain request-dependent objects that manage the core
* web request/response logic for essentially all requests to MediaWiki.
* The contained objects include:
* a) Key objects that depend (for construction/loading) on the HTTP request
* b) Key objects used for response building and PHP session state control
* c) Performance metric deltas accumulated from request execution
* d) The site configuration object
* All of the objects are useful for the vast majority of MediaWiki requests.
* The site configuration object is included on grounds of extreme
* utility, even though it should not actually depend on the web request.
*
* More specifically, the scope of the context includes:
* a) Objects that represent the HTTP request/response and PHP session state
* b) Object representing the MediaWiki user (as determined by the HTTP request)
* c) Primary MediaWiki output builder objects (OutputPage, user skin object)
* d) The language object for the user/request
* e) The title and wiki page objects requested via URL (if any)
* f) Performance metric deltas accumulated from request execution
* g) The site configuration object
*
* This class is not intended as a service-locator nor a service singleton.
* Objects that only depend on site configuration do not belong here (aside
* from Config itself). Objects that represent persistent data stores do not
* belong here either. Session state changes should only be propagated on
* shutdown by separate persistence handler objects, for example.
*/
interface IContextSource {
/**
* Get the WebRequest object
*
* @return WebRequest
*/
public function getRequest();
/**
* Get the Title object
*
* @return Title|null
*/
public function 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
* @return bool
*/
public function 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
* @return WikiPage
*/
public function getWikiPage();
/**
* Get the OutputPage object
*
* @return OutputPage
*/
public function getOutput();
/**
* Get the User object
*
* @return User
*/
public function getUser();
/**
* Get the Language object
*
* @return Language
* @since 1.19
*/
public function getLanguage();
/**
* Get the Skin object
*
* @return Skin
*/
public function getSkin();
/**
* Get the site configuration
*
* @since 1.23
* @return Config
*/
public function getConfig();
/**
* Get the stats object
*
* @since 1.25
* @return BufferingStatsdDataFactory
*/
public function getStats();
/**
* Get a Message object with context set
*
* @return Message
*/
public function msg();
/**
* Export the resolved user IP, HTTP headers, user ID, and session ID.
* The result will be reasonably sized to allow for serialization.
*
* @return array
* @since 1.21
*/
public function exportSession();
}
|
