blob: 476035b525eec0d2ce56e3003b470d1f425a14ed (
plain)
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
|
<?php
/**
* Request-dependant objects containers.
*
* 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 context on request.
*/
interface IContextSource {
/**
* Get the WebRequest object
*
* @return WebRequest
*/
public function getRequest();
/**
* Get the Title object
*
* @return Title
*/
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 object
*/
public function getOutput();
/**
* Get the User object
*
* @return User
*/
public function getUser();
/**
* Get the Language object
*
* @deprecated 1.19 Use getLanguage instead
* @return Language
*/
public function getLang();
/**
* Get the Language object
*
* @return Language
* @since 1.19
*/
public function getLanguage();
/**
* Get the Skin object
*
* @return Skin
*/
public function getSkin();
/**
* Get a Message object with context set
*
* @return Message object
*/
public function msg();
}
|
