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
103 public function setTitle( $t ) {
104 if ( $t !== null && !$t instanceof Title
) {
105 throw new MWException( __METHOD__
. " expects an instance of Title" );
111 * Get the Title object
115 public function getTitle() {
116 if ( !is_null( $this->title
) ) {
119 return $this->getContext()->getTitle();
124 * Check whether a WikiPage object can be get with getWikiPage().
125 * Callers should expect that an exception is thrown from getWikiPage()
126 * if this method returns false.
131 public function canUseWikiPage() {
132 if ( $this->wikipage
!== null ) {
134 } elseif ( $this->title
!== null ) {
135 return $this->title
->canExist();
137 return $this->getContext()->canUseWikiPage();
142 * Set the WikiPage object
147 public function setWikiPage( WikiPage
$p ) {
148 $this->wikipage
= $p;
152 * Get the WikiPage object.
153 * May throw an exception if there's no Title object set or the Title object
154 * belongs to a special namespace that doesn't have WikiPage, so use first
155 * canUseWikiPage() to check whether this method can be called safely.
160 public function getWikiPage() {
161 if ( !is_null( $this->wikipage
) ) {
162 return $this->wikipage
;
164 return $this->getContext()->getWikiPage();
169 * Set the OutputPage object
171 * @param OutputPage $o
173 public function setOutput( OutputPage
$o ) {
178 * Get the OutputPage object
182 public function getOutput() {
183 if ( !is_null( $this->output
) ) {
184 return $this->output
;
186 return $this->getContext()->getOutput();
191 * Set the User object
195 public function setUser( User
$u ) {
200 * Get the User object
204 public function getUser() {
205 if ( !is_null( $this->user
) ) {
208 return $this->getContext()->getUser();
213 * Set the Language object
215 * @deprecated since 1.19 Use setLanguage instead
216 * @param Language|string $l Language instance or language code
218 public function setLang( $l ) {
219 wfDeprecated( __METHOD__
, '1.19' );
220 $this->setLanguage( $l );
224 * Set the Language object
226 * @param Language|string $l Language instance or language code
227 * @throws MWException
230 public function setLanguage( $l ) {
231 if ( $l instanceof Language
) {
233 } elseif ( is_string( $l ) ) {
234 $l = RequestContext
::sanitizeLangCode( $l );
235 $obj = Language
::factory( $l );
238 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
243 * @deprecated since 1.19 Use getLanguage instead
246 public function getLang() {
247 wfDeprecated( __METHOD__
, '1.19' );
248 $this->getLanguage();
252 * Get the Language object
257 public function getLanguage() {
258 if ( !is_null( $this->lang
) ) {
261 return $this->getContext()->getLanguage();
266 * Set the Skin object
270 public function setSkin( Skin
$s ) {
271 $this->skin
= clone $s;
272 $this->skin
->setContext( $this );
276 * Get the Skin object
280 public function getSkin() {
281 if ( !is_null( $this->skin
) ) {
284 return $this->getContext()->getSkin();
289 * Get a message using the current context.
291 * This can't just inherit from ContextSource, since then
292 * it would set only the original context, and not take
293 * into account any changes.
295 * @param String Message name
296 * @param Variable number of message arguments
299 public function msg() {
300 $args = func_get_args();
301 return call_user_func_array( 'wfMessage', $args )->setContext( $this );