MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
7  protected $lessVariables = [];
12  public function __construct(
13  $options = [],
14  $localBasePath = null,
15  $remoteBasePath = null
16  ) {
17  if ( isset( $options['lessMessages'] ) ) {
18  $this->lessVariables = $options['lessMessages'];
19  }
20  parent::__construct( $options, $localBasePath, $remoteBasePath );
21  }
26  public function getMessages() {
27  // Overload so MessageBlobStore can detect updates to messages and purge as needed.
28  return array_merge( $this->messages, $this->lessVariables );
29  }
38  protected function excludeMessagesFromBlob( $blob, $exclusions ) {
39  $data = json_decode( $blob, true );
40  // unset the LESS variables so that they are not forwarded to JavaScript
41  foreach ( $exclusions as $key ) {
42  unset( $data[$key] );
43  }
44  return (object)$data;
45  }
51  $blob = parent::getMessageBlob( $context );
52  return json_encode( $this->excludeMessagesFromBlob( $blob, $this->lessVariables ) );
53  }
64  private static function wrapAndEscapeMessage( $msg ) {
65  return str_replace( "'", "\'", CSSMin::serializeStringValue( $msg ) );
66  }
74  protected function getLessVars( ResourceLoaderContext $context ) {
75  $blob = parent::getMessageBlob( $context );
76  $lessMessages = $this->excludeMessagesFromBlob( $blob, $this->messages );
78  $vars = parent::getLessVars( $context );
79  foreach ( $lessMessages as $msgKey => $value ) {
80  $vars['msg-' . $msgKey] = self::wrapAndEscapeMessage( $value );
81  }
82  return $vars;
83  }
84 }
Subclass with context specific LESS variables.
Definition: ResourceLoaderLessVarFileModule.php:6
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2636
Definition: ResourceLoaderLessVarFileModule.php:7
getLessVars(ResourceLoaderContext $context)
Get language-specific LESS variables for this module.
Definition: ResourceLoaderLessVarFileModule.php:74
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
ResourceLoader module based on local JavaScript/CSS files.
Definition: ResourceLoaderFileModule.php:28
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
Definition: testCompression.php:65
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2220
Definition: styleTest.css.php:49
__construct( $options=[], $localBasePath=null, $remoteBasePath=null)
Definition: ResourceLoaderLessVarFileModule.php:12
excludeMessagesFromBlob( $blob, $exclusions)
Exclude a set of messages from a JSON string representation.
Definition: ResourceLoaderLessVarFileModule.php:38
string $localBasePath
Local base path, see __construct()
Definition: ResourceLoaderFileModule.php:31
getMessageBlob(ResourceLoaderContext $context)
Definition: ResourceLoaderLessVarFileModule.php:50
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1985
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 as
Definition: distributors.txt:9
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error messages
Definition: hooks.txt:1290
string $remoteBasePath
Remote base path, see __construct()
Definition: ResourceLoaderFileModule.php:34
Definition: ResourceLoaderLessVarFileModule.php:26
static wrapAndEscapeMessage( $msg)
Takes a message and wraps it in quotes for compatibility with LESS parser (ModifyVars) method so that...
Definition: ResourceLoaderLessVarFileModule.php:64