MediaWiki  master
DerivativeContext.php
Go to the documentation of this file.
1 <?php
22 
34  private $request;
35 
39  private $title;
40 
44  private $wikipage;
45 
49  private $output;
50 
54  private $user;
55 
59  private $lang;
60 
64  private $skin;
65 
69  private $config;
70 
74  private $timing;
75 
79  public function __construct( IContextSource $context ) {
80  $this->setContext( $context );
81  }
82 
86  public function setConfig( Config $config ) {
87  $this->config = $config;
88  }
89 
93  public function getConfig() {
94  return $this->config ?: $this->getContext()->getConfig();
95  }
96 
102  public function getStats() {
103  return MediaWikiServices::getInstance()->getStatsdDataFactory();
104  }
105 
109  public function getTiming() {
110  return $this->timing ?: $this->getContext()->getTiming();
111  }
112 
116  public function setRequest( WebRequest $request ) {
117  $this->request = $request;
118  }
119 
123  public function getRequest() {
124  return $this->request ?: $this->getContext()->getRequest();
125  }
126 
130  public function setTitle( Title $title ) {
131  $this->title = $title;
132  }
133 
137  public function getTitle() {
138  return $this->title ?: $this->getContext()->getTitle();
139  }
140 
149  public function canUseWikiPage() {
150  if ( $this->wikipage !== null ) {
151  return true;
152  }
153 
154  if ( $this->title !== null ) {
155  return $this->title->canExist();
156  }
157 
158  return $this->getContext()->canUseWikiPage();
159  }
160 
165  public function setWikiPage( WikiPage $wikiPage ) {
166  $this->wikipage = $wikiPage;
167  }
168 
178  public function getWikiPage() {
179  return $this->wikipage ?: $this->getContext()->getWikiPage();
180  }
181 
185  public function setOutput( OutputPage $output ) {
186  $this->output = $output;
187  }
188 
192  public function getOutput() {
193  return $this->output ?: $this->getContext()->getOutput();
194  }
195 
199  public function setUser( User $user ) {
200  $this->user = $user;
201  }
202 
206  public function getUser() {
207  return $this->user ?: $this->getContext()->getUser();
208  }
209 
215  public function setLanguage( $language ) {
216  if ( $language instanceof Language ) {
217  $this->lang = $language;
218  } elseif ( is_string( $language ) ) {
219  $language = RequestContext::sanitizeLangCode( $language );
220  $obj = Language::factory( $language );
221  $this->lang = $obj;
222  } else {
223  throw new MWException( __METHOD__ . " was passed an invalid type of data." );
224  }
225  }
226 
231  public function getLanguage() {
232  return $this->lang ?: $this->getContext()->getLanguage();
233  }
234 
238  public function setSkin( Skin $skin ) {
239  $this->skin = clone $skin;
240  $this->skin->setContext( $this );
241  }
242 
246  public function getSkin() {
247  return $this->skin ?: $this->getContext()->getSkin();
248  }
249 
262  public function msg( $key ) {
263  $args = func_get_args();
264 
265  // phpcs:ignore MediaWiki.Usage.ExtendClassUsage.FunctionVarUsage
266  return wfMessage( ...$args )->setContext( $this );
267  }
268 }
setContext(IContextSource $context)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
__construct(IContextSource $context)
An IContextSource implementation which will inherit context from another source but allow individual ...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
getWikiPage()
Get the WikiPage object.
title
IContextSource $context
setRequest(WebRequest $request)
setConfig(Config $config)
if( $line===false) $args
Definition: cdb.php:64
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
setWikiPage(WikiPage $wikiPage)
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
Interface for configuration instances.
Definition: Config.php:28
setTitle(Title $title)
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:9
getContext()
Get the base IContextSource object.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set this hook should only be used to add variables that depend on the current page request
Definition: hooks.txt:2147
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
static sanitizeLangCode( $code)
Accepts a language code and ensures it&#39;s sane.
msg( $key)
Get a message using the current context.
setOutput(OutputPage $output)