3 * Request-dependant objects containers.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 * @author Daniel Friesen
27 * An IContextSource implementation which will inherit context from another source
28 * but allow individual pieces of context to be changed locally
29 * eg: A ContextSource that can inherit from the main RequestContext but have
30 * a different Title instance set on it.
32 class DerivativeContext
extends ContextSource
{
70 * @param IContextSource $context Context to inherit from
72 public function __construct( IContextSource
$context ) {
73 $this->setContext( $context );
77 * Set the WebRequest object
79 * @param WebRequest $r
81 public function setRequest( WebRequest
$r ) {
86 * Get the WebRequest object
90 public function getRequest() {
91 if ( !is_null( $this->request
) ) {
92 return $this->request
;
94 return $this->getContext()->getRequest();
99 * Set the Title object
102 * @throws MWException
104 public function setTitle( $t ) {
105 if ( $t !== null && !$t instanceof Title
) {
106 throw new MWException( __METHOD__
. " expects an instance of Title" );
112 * Get the Title object
116 public function getTitle() {
117 if ( !is_null( $this->title
) ) {
120 return $this->getContext()->getTitle();
125 * Check whether a WikiPage object can be get with getWikiPage().
126 * Callers should expect that an exception is thrown from getWikiPage()
127 * if this method returns false.
132 public function canUseWikiPage() {
133 if ( $this->wikipage
!== null ) {
135 } elseif ( $this->title
!== null ) {
136 return $this->title
->canExist();
138 return $this->getContext()->canUseWikiPage();
143 * Set the WikiPage object
148 public function setWikiPage( WikiPage
$p ) {
149 $this->wikipage
= $p;
153 * Get the WikiPage object.
154 * May throw an exception if there's no Title object set or the Title object
155 * belongs to a special namespace that doesn't have WikiPage, so use first
156 * canUseWikiPage() to check whether this method can be called safely.
161 public function getWikiPage() {
162 if ( !is_null( $this->wikipage
) ) {
163 return $this->wikipage
;
165 return $this->getContext()->getWikiPage();
170 * Set the OutputPage object
172 * @param OutputPage $o
174 public function setOutput( OutputPage
$o ) {
179 * Get the OutputPage object
183 public function getOutput() {
184 if ( !is_null( $this->output
) ) {
185 return $this->output
;
187 return $this->getContext()->getOutput();
192 * Set the User object
196 public function setUser( User
$u ) {
201 * Get the User object
205 public function getUser() {
206 if ( !is_null( $this->user
) ) {
209 return $this->getContext()->getUser();
214 * Set the Language object
216 * @deprecated since 1.19 Use setLanguage instead
217 * @param Language|string $l Language instance or language code
219 public function setLang( $l ) {
220 wfDeprecated( __METHOD__
, '1.19' );
221 $this->setLanguage( $l );
225 * Set the Language object
227 * @param Language|string $l Language instance or language code
228 * @throws MWException
231 public function setLanguage( $l ) {
232 if ( $l instanceof Language
) {
234 } elseif ( is_string( $l ) ) {
235 $l = RequestContext
::sanitizeLangCode( $l );
236 $obj = Language
::factory( $l );
239 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
244 * @deprecated since 1.19 Use getLanguage instead
247 public function getLang() {
248 wfDeprecated( __METHOD__
, '1.19' );
249 $this->getLanguage();
253 * Get the Language object
258 public function getLanguage() {
259 if ( !is_null( $this->lang
) ) {
262 return $this->getContext()->getLanguage();
267 * Set the Skin object
271 public function setSkin( Skin
$s ) {
272 $this->skin
= clone $s;
273 $this->skin
->setContext( $this );
277 * Get the Skin object
281 public function getSkin() {
282 if ( !is_null( $this->skin
) ) {
285 return $this->getContext()->getSkin();
290 * Get a message using the current context.
292 * This can't just inherit from ContextSource, since then
293 * it would set only the original context, and not take
294 * into account any changes.
296 * @param String Message name
297 * @param Variable number of message arguments
300 public function msg() {
301 $args = func_get_args();
303 return call_user_func_array( 'wfMessage', $args )->setContext( $this );