<?php
/**
* Group all the pieces relevant to the context of a request into one instance
- *
+ *
+ * @since 1.18
+ *
* @author IAlex
* @author Daniel Friesen
* @file
*/
class RequestContext {
- private $request; /// WebRequest object
- private $title; /// Title object
- private $output; /// OutputPage object
- private $user; /// User object
- private $lang; /// Language object
- private $skin; /// Skin object
+
+ /**
+ * @var WebRequest
+ */
+ private $mRequest;
+
+ /**
+ * @var Title
+ */
+ private $mTitle;
+
+ /**
+ * @var OutputPage
+ */
+ private $mOutput;
+
+ /**
+ * @var User
+ */
+ private $mUser;
+
+ /**
+ * @var Language
+ */
+ private $mLang;
+
+ /**
+ * @var Skin
+ */
+ private $mSkin;
/**
* Set the WebRequest object
* @param $r WebRequest object
*/
public function setRequest( WebRequest $r ) {
- $this->request = $r;
+ $this->mRequest = $r;
}
/**
* @return WebRequest
*/
public function getRequest() {
- if ( !isset($this->request) ) {
+ if ( !isset( $this->mRequest ) ) {
global $wgRequest; # fallback to $wg till we can improve this
- $this->request = $wgRequest;
+ $this->mRequest = $wgRequest;
}
- return $this->request;
+ return $this->mRequest;
}
/**
* @param $t Title object
*/
public function setTitle( Title $t ) {
- $this->title = $t;
+ $this->mTitle = $t;
}
/**
* @return Title
*/
public function getTitle() {
- if ( !isset($this->title) ) {
+ if ( !isset( $this->mTitle ) ) {
global $wgTitle; # fallback to $wg till we can improve this
- $this->title = $wgTitle;
+ $this->mTitle = $wgTitle;
}
- return $this->title;
+ return $this->mTitle;
}
/**
- * Set the OutputPage object
- *
- * @param $u OutputPage
+ * @param $o OutputPage
*/
- public function setOutput( OutputPage $u ) {
- $this->output = $u;
+ public function setOutput( OutputPage $o ) {
+ $this->mOutput = $o;
}
/**
* @return OutputPage object
*/
public function getOutput() {
- if ( !isset($this->output) ) {
- $this->output = new OutputPage;
- $this->output->setContext( $this );
+ if ( !isset( $this->mOutput ) ) {
+ $this->mOutput = new OutputPage( $this );
}
- return $this->output;
+ return $this->mOutput;
}
/**
* @param $u User
*/
public function setUser( User $u ) {
- $this->user = $u;
+ $this->mUser = $u;
}
/**
* @return User
*/
public function getUser() {
- if ( !isset($this->user) ) {
+ if ( !isset( $this->mUser ) ) {
global $wgCommandLineMode;
- $this->user = $wgCommandLineMode ? new User : User::newFromSession( $this->getRequest() );
+ $this->mUser = $wgCommandLineMode
+ ? new User
+ : User::newFromSession( $this->getRequest() );
}
- return $this->user;
+ return $this->mUser;
}
/**
* @return Language
*/
public function getLang() {
- if ( !isset($this->lang) ) {
+ if ( !isset( $this->mLang ) ) {
global $wgLanguageCode, $wgContLang;
- $code = $this->getRequest()->getVal( 'uselang', $this->getUser()->getOption( 'language' ) );
+ $code = $this->getRequest()->getVal(
+ 'uselang',
+ $this->getUser()->getOption( 'language' )
+ );
// BCP 47 - letter case MUST NOT carry meaning
$code = strtolower( $code );
# Validate $code
- if( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) {
+ if ( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) {
wfDebug( "Invalid user language code\n" );
$code = $wgLanguageCode;
}
wfRunHooks( 'UserGetLanguageObject', array( $this->getUser(), &$code ) );
- if( $code === $wgLanguageCode ) {
- $this->lang = $wgContLang;
+ if ( $code === $wgLanguageCode ) {
+ $this->mLang = $wgContLang;
} else {
$obj = Language::factory( $code );
- $this->lang = $obj;
+ $this->mLang = $obj;
}
}
- return $this->lang;
+ return $this->mLang;
}
/**
* @return Skin
*/
public function getSkin() {
- if ( !isset($this->skin) ) {
+ if ( !isset( $this->mSkin ) ) {
wfProfileIn( __METHOD__ . '-createskin' );
-
+
global $wgHiddenPrefs;
- if( !in_array( 'skin', $wgHiddenPrefs ) ) {
+ if ( !in_array( 'skin', $wgHiddenPrefs ) ) {
# get the user skin
$userSkin = $this->getUser()->getOption( 'skin' );
$userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
$userSkin = $wgDefaultSkin;
}
- $this->skin = Skin::newFromKey( $userSkin );
- $this->skin->setContext( $this );
+ $this->mSkin = Skin::newFromKey( $userSkin );
+ $this->mSkin->setContext( $this );
wfProfileOut( __METHOD__ . '-createskin' );
}
- return $this->skin;
+ return $this->mSkin;
}
/** Helpful methods **/
*/
public static function getMain() {
static $instance = null;
- if ( !isset($instance) ) {
+ if ( !isset( $instance ) ) {
$instance = new self;
}
return $instance;
}
+
+ /**
+ * Make these C#-style accessors, so you can do $context->user->getName() which is
+ * internally mapped to $context->__get('user')->getName() which is mapped to
+ * $context->getUser()->getName()
+ *
+ * @param $name string
+ *
+ * @return string
+ */
+ public function __get( $name ) {
+ wfDeprecated( 'RequestContext::__get() is deprecated; use $context->getFoo() instead' );
+ if ( in_array( $name, array( 'request', 'title', 'output', 'user', 'lang', 'skin' ) ) ) {
+ $fname = 'get' . ucfirst( $name );
+ return $this->$fname();
+ }
+ trigger_error( "Undefined property {$name}", E_NOTICE );
+ }
+
+ /**
+ * @param $name string
+ * @param $value
+ * @return string
+ */
+ public function __set( $name, $value ) {
+ wfDeprecated( 'RequestContext::__set() is deprecated; use $context->setFoo() instead' );
+ if ( in_array( $name, array( 'request', 'title', 'output', 'user', 'lang', 'skin' ) ) ) {
+ $fname = 'set' . ucfirst( $name );
+ return $this->$fname( $value );
+ }
+ trigger_error( "Undefined property {$name}", E_NOTICE );
+ }
}
dépôts / lhc / web / wiklou.git / blobdiff