MediaWiki  1.27.1
ResourceLoaderModule.php
Go to the documentation of this file.
1 <?php
28 
32 abstract class ResourceLoaderModule implements LoggerAwareInterface {
33  # Type of resource
34  const TYPE_SCRIPTS = 'scripts';
35  const TYPE_STYLES = 'styles';
36  const TYPE_COMBINED = 'combined';
37 
38  # sitewide core module like a skin file or jQuery component
40 
41  # per-user module generated by the software
43 
44  # sitewide module generated from user-editable files, like MediaWiki:Common.js, or
45  # modules accessible to multiple users, such as those generated by the Gadgets extension.
47 
48  # per-user module generated from user-editable files, like User:Me/vector.js
50 
51  # an access constant; make sure this is kept as the largest number in this group
52  const ORIGIN_ALL = 10;
53 
54  # script and style modules form a hierarchy of trustworthiness, with core modules like
55  # skins and jQuery as most trustworthy, and user scripts as least trustworthy. We can
56  # limit the types of scripts and styles we allow to load on, say, sensitive special
57  # pages like Special:UserLogin and Special:Preferences
58  protected $origin = self::ORIGIN_CORE_SITEWIDE;
59 
60  /* Protected Members */
61 
62  protected $name = null;
63  protected $targets = [ 'desktop' ];
64 
65  // In-object cache for file dependencies
66  protected $fileDeps = [];
67  // In-object cache for message blob (keyed by language)
68  protected $msgBlobs = [];
69  // In-object cache for version hash
70  protected $versionHash = [];
71  // In-object cache for module content
72  protected $contents = [];
73 
77  protected $config;
78 
82  protected $logger;
83 
84  /* Methods */
85 
92  public function getName() {
93  return $this->name;
94  }
95 
102  public function setName( $name ) {
103  $this->name = $name;
104  }
105 
113  public function getOrigin() {
114  return $this->origin;
115  }
116 
123  public function setOrigin( $origin ) {
124  $this->origin = $origin;
125  }
126 
131  public function getFlip( $context ) {
133 
134  return $wgContLang->getDir() !== $context->getDirection();
135  }
136 
145  // Stub, override expected
146  return '';
147  }
148 
154  public function getTemplates() {
155  // Stub, override expected.
156  return [];
157  }
158 
163  public function getConfig() {
164  if ( $this->config === null ) {
165  // Ugh, fall back to default
166  $this->config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
167  }
168 
169  return $this->config;
170  }
171 
176  public function setConfig( Config $config ) {
177  $this->config = $config;
178  }
179 
185  public function setLogger( LoggerInterface $logger ) {
186  $this->logger = $logger;
187  }
188 
193  protected function getLogger() {
194  if ( !$this->logger ) {
195  $this->logger = new NullLogger();
196  }
197  return $this->logger;
198  }
199 
215  $resourceLoader = $context->getResourceLoader();
216  $derivative = new DerivativeResourceLoaderContext( $context );
217  $derivative->setModules( [ $this->getName() ] );
218  $derivative->setOnly( 'scripts' );
219  $derivative->setDebug( true );
220 
221  $url = $resourceLoader->createLoaderURL(
222  $this->getSource(),
223  $derivative
224  );
225 
226  return [ $url ];
227  }
228 
235  public function supportsURLLoading() {
236  return true;
237  }
238 
248  // Stub, override expected
249  return [];
250  }
251 
262  $resourceLoader = $context->getResourceLoader();
263  $derivative = new DerivativeResourceLoaderContext( $context );
264  $derivative->setModules( [ $this->getName() ] );
265  $derivative->setOnly( 'styles' );
266  $derivative->setDebug( true );
267 
268  $url = $resourceLoader->createLoaderURL(
269  $this->getSource(),
270  $derivative
271  );
272 
273  return [ 'all' => [ $url ] ];
274  }
275 
283  public function getMessages() {
284  // Stub, override expected
285  return [];
286  }
287 
293  public function getGroup() {
294  // Stub, override expected
295  return null;
296  }
297 
303  public function getSource() {
304  // Stub, override expected
305  return 'local';
306  }
307 
315  public function getPosition() {
316  return 'bottom';
317  }
318 
326  public function isRaw() {
327  return false;
328  }
329 
342  public function getDependencies( ResourceLoaderContext $context = null ) {
343  // Stub, override expected
344  return [];
345  }
346 
352  public function getTargets() {
353  return $this->targets;
354  }
355 
370  public function getSkipFunction() {
371  return null;
372  }
373 
383  $vary = $context->getSkin() . '|' . $context->getLanguage();
384 
385  // Try in-object cache first
386  if ( !isset( $this->fileDeps[$vary] ) ) {
387  $dbr = wfGetDB( DB_SLAVE );
388  $deps = $dbr->selectField( 'module_deps',
389  'md_deps',
390  [
391  'md_module' => $this->getName(),
392  'md_skin' => $vary,
393  ],
394  __METHOD__
395  );
396 
397  if ( !is_null( $deps ) ) {
398  $this->fileDeps[$vary] = self::expandRelativePaths(
399  (array)FormatJson::decode( $deps, true )
400  );
401  } else {
402  $this->fileDeps[$vary] = [];
403  }
404  }
405  return $this->fileDeps[$vary];
406  }
407 
418  $vary = $context->getSkin() . '|' . $context->getLanguage();
419  $this->fileDeps[$vary] = $files;
420  }
421 
429  protected function saveFileDependencies( ResourceLoaderContext $context, $localFileRefs ) {
430  // Normalise array
431  $localFileRefs = array_values( array_unique( $localFileRefs ) );
432  sort( $localFileRefs );
433 
434  try {
435  // If the list has been modified since last time we cached it, update the cache
436  if ( $localFileRefs !== $this->getFileDependencies( $context ) ) {
438  $key = $cache->makeKey( __METHOD__, $this->getName() );
439  $scopeLock = $cache->getScopedLock( $key, 0 );
440  if ( !$scopeLock ) {
441  return; // T124649; avoid write slams
442  }
443 
444  $vary = $context->getSkin() . '|' . $context->getLanguage();
445  $dbw = wfGetDB( DB_MASTER );
446  $dbw->replace( 'module_deps',
447  [ [ 'md_module', 'md_skin' ] ],
448  [
449  'md_module' => $this->getName(),
450  'md_skin' => $vary,
451  // Use relative paths to avoid ghost entries when $IP changes (T111481)
452  'md_deps' => FormatJson::encode( self::getRelativePaths( $localFileRefs ) ),
453  ]
454  );
455 
456  $dbw->onTransactionIdle( function () use ( &$scopeLock ) {
457  ScopedCallback::consume( $scopeLock ); // release after commit
458  } );
459  }
460  } catch ( Exception $e ) {
461  wfDebugLog( 'resourceloader', __METHOD__ . ": failed to update DB: $e" );
462  }
463  }
464 
475  public static function getRelativePaths( array $filePaths ) {
476  global $IP;
477  return array_map( function ( $path ) use ( $IP ) {
478  return RelPath\getRelativePath( $path, $IP );
479  }, $filePaths );
480  }
481 
489  public static function expandRelativePaths( array $filePaths ) {
490  global $IP;
491  return array_map( function ( $path ) use ( $IP ) {
492  return RelPath\joinPath( $IP, $path );
493  }, $filePaths );
494  }
495 
504  if ( !$this->getMessages() ) {
505  // Don't bother consulting MessageBlobStore
506  return null;
507  }
508  // Message blobs may only vary language, not by context keys
509  $lang = $context->getLanguage();
510  if ( !isset( $this->msgBlobs[$lang] ) ) {
511  $this->getLogger()->warning( 'Message blob for {module} should have been preloaded', [
512  'module' => $this->getName(),
513  ] );
514  $store = $context->getResourceLoader()->getMessageBlobStore();
515  $this->msgBlobs[$lang] = $store->getBlob( $this, $lang );
516  }
517  return $this->msgBlobs[$lang];
518  }
519 
529  public function setMessageBlob( $blob, $lang ) {
530  $this->msgBlobs[$lang] = $blob;
531  }
532 
541  return [];
542  }
543 
552  $contextHash = $context->getHash();
553  // Cache this expensive operation. This calls builds the scripts, styles, and messages
554  // content which typically involves filesystem and/or database access.
555  if ( !array_key_exists( $contextHash, $this->contents ) ) {
556  $this->contents[$contextHash] = $this->buildContent( $context );
557  }
558  return $this->contents[$contextHash];
559  }
560 
568  final protected function buildContent( ResourceLoaderContext $context ) {
569  $rl = $context->getResourceLoader();
570  $stats = RequestContext::getMain()->getStats();
571  $statStart = microtime( true );
572 
573  // Only include properties that are relevant to this context (e.g. only=scripts)
574  // and that are non-empty (e.g. don't include "templates" for modules without
575  // templates). This helps prevent invalidating cache for all modules when new
576  // optional properties are introduced.
577  $content = [];
578 
579  // Scripts
580  if ( $context->shouldIncludeScripts() ) {
581  // If we are in debug mode, we'll want to return an array of URLs if possible
582  // However, we can't do this if the module doesn't support it
583  // We also can't do this if there is an only= parameter, because we have to give
584  // the module a way to return a load.php URL without causing an infinite loop
585  if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
586  $scripts = $this->getScriptURLsForDebug( $context );
587  } else {
588  $scripts = $this->getScript( $context );
589  // rtrim() because there are usually a few line breaks
590  // after the last ';'. A new line at EOF, a new line
591  // added by ResourceLoaderFileModule::readScriptFiles, etc.
592  if ( is_string( $scripts )
593  && strlen( $scripts )
594  && substr( rtrim( $scripts ), -1 ) !== ';'
595  ) {
596  // Append semicolon to prevent weird bugs caused by files not
597  // terminating their statements right (bug 27054)
598  $scripts .= ";\n";
599  }
600  }
601  $content['scripts'] = $scripts;
602  }
603 
604  // Styles
605  if ( $context->shouldIncludeStyles() ) {
606  $styles = [];
607  // Don't create empty stylesheets like array( '' => '' ) for modules
608  // that don't *have* any stylesheets (bug 38024).
609  $stylePairs = $this->getStyles( $context );
610  if ( count( $stylePairs ) ) {
611  // If we are in debug mode without &only= set, we'll want to return an array of URLs
612  // See comment near shouldIncludeScripts() for more details
613  if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
614  $styles = [
615  'url' => $this->getStyleURLsForDebug( $context )
616  ];
617  } else {
618  // Minify CSS before embedding in mw.loader.implement call
619  // (unless in debug mode)
620  if ( !$context->getDebug() ) {
621  foreach ( $stylePairs as $media => $style ) {
622  // Can be either a string or an array of strings.
623  if ( is_array( $style ) ) {
624  $stylePairs[$media] = [];
625  foreach ( $style as $cssText ) {
626  if ( is_string( $cssText ) ) {
627  $stylePairs[$media][] =
628  ResourceLoader::filter( 'minify-css', $cssText );
629  }
630  }
631  } elseif ( is_string( $style ) ) {
632  $stylePairs[$media] = ResourceLoader::filter( 'minify-css', $style );
633  }
634  }
635  }
636  // Wrap styles into @media groups as needed and flatten into a numerical array
637  $styles = [
638  'css' => $rl->makeCombinedStyles( $stylePairs )
639  ];
640  }
641  }
642  $content['styles'] = $styles;
643  }
644 
645  // Messages
646  $blob = $this->getMessageBlob( $context );
647  if ( $blob ) {
648  $content['messagesBlob'] = $blob;
649  }
650 
651  $templates = $this->getTemplates();
652  if ( $templates ) {
653  $content['templates'] = $templates;
654  }
655 
656  $statTiming = microtime( true ) - $statStart;
657  $statName = strtr( $this->getName(), '.', '_' );
658  $stats->timing( "resourceloader_build.all", 1000 * $statTiming );
659  $stats->timing( "resourceloader_build.$statName", 1000 * $statTiming );
660 
661  return $content;
662  }
663 
687  // The startup module produces a manifest with versions representing the entire module.
688  // Typically, the request for the startup module itself has only=scripts. That must apply
689  // only to the startup module content, and not to the module version computed here.
690  $context = new DerivativeResourceLoaderContext( $context );
691  $context->setModules( [] );
692  // Version hash must cover all resources, regardless of startup request itself.
693  $context->setOnly( null );
694  // Compute version hash based on content, not debug urls.
695  $context->setDebug( false );
696 
697  // Cache this somewhat expensive operation. Especially because some classes
698  // (e.g. startup module) iterate more than once over all modules to get versions.
699  $contextHash = $context->getHash();
700  if ( !array_key_exists( $contextHash, $this->versionHash ) ) {
701 
702  if ( $this->enableModuleContentVersion() ) {
703  // Detect changes directly
704  $str = json_encode( $this->getModuleContent( $context ) );
705  } else {
706  // Infer changes based on definition and other metrics
707  $summary = $this->getDefinitionSummary( $context );
708  if ( !isset( $summary['_cacheEpoch'] ) ) {
709  throw new LogicException( 'getDefinitionSummary must call parent method' );
710  }
711  $str = json_encode( $summary );
712 
713  $mtime = $this->getModifiedTime( $context );
714  if ( $mtime !== null ) {
715  // Support: MediaWiki 1.25 and earlier
716  $str .= strval( $mtime );
717  }
718 
719  $mhash = $this->getModifiedHash( $context );
720  if ( $mhash !== null ) {
721  // Support: MediaWiki 1.25 and earlier
722  $str .= strval( $mhash );
723  }
724  }
725 
726  $this->versionHash[$contextHash] = ResourceLoader::makeHash( $str );
727  }
728  return $this->versionHash[$contextHash];
729  }
730 
740  public function enableModuleContentVersion() {
741  return false;
742  }
743 
788  return [
789  '_class' => get_class( $this ),
790  '_cacheEpoch' => $this->getConfig()->get( 'CacheEpoch' ),
791  ];
792  }
793 
802  return null;
803  }
804 
813  return null;
814  }
815 
828  if ( !is_string( $this->getModifiedHash( $context ) ) ) {
829  return 1;
830  }
831  // Dummy that is > 1
832  return 2;
833  }
834 
844  if ( $this->getDefinitionSummary( $context ) === null ) {
845  return 1;
846  }
847  // Dummy that is > 1
848  return 2;
849  }
850 
861  return false;
862  }
863 
865  private static $jsParser;
866  private static $parseCacheVersion = 1;
867 
876  protected function validateScriptFile( $fileName, $contents ) {
877  if ( $this->getConfig()->get( 'ResourceLoaderValidateJS' ) ) {
878  // Try for cache hit
880  $key = $cache->makeKey(
881  'resourceloader',
882  'jsparse',
883  self::$parseCacheVersion,
884  md5( $contents )
885  );
886  $cacheEntry = $cache->get( $key );
887  if ( is_string( $cacheEntry ) ) {
888  return $cacheEntry;
889  }
890 
891  $parser = self::javaScriptParser();
892  try {
893  $parser->parse( $contents, $fileName, 1 );
894  $result = $contents;
895  } catch ( Exception $e ) {
896  // We'll save this to cache to avoid having to validate broken JS over and over...
897  $err = $e->getMessage();
898  $result = "mw.log.error(" .
899  Xml::encodeJsVar( "JavaScript parse error: $err" ) . ");";
900  }
901 
902  $cache->set( $key, $result );
903  return $result;
904  } else {
905  return $contents;
906  }
907  }
908 
912  protected static function javaScriptParser() {
913  if ( !self::$jsParser ) {
914  self::$jsParser = new JSParser();
915  }
916  return self::$jsParser;
917  }
918 
926  protected static function safeFilemtime( $filePath ) {
927  MediaWiki\suppressWarnings();
928  $mtime = filemtime( $filePath ) ?: 1;
929  MediaWiki\restoreWarnings();
930  return $mtime;
931  }
932 
941  protected static function safeFileHash( $filePath ) {
942  return FileContentsHasher::getFileContentsHash( $filePath );
943  }
944 }
isRaw()
Whether this module's JS expects to work without the client-side ResourceLoader module.
static getMainWANInstance()
Get the main WAN cache object.
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
the array() calling protocol came about after MediaWiki 1.4rc1.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
getMessages()
Get the messages needed for this module.
$context
Definition: load.php:44
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
$IP
Definition: WebStart.php:58
error also a ContextSource you ll probably need to make sure the header is varied on such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition: hooks.txt:2418
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1932
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their contents
Definition: database.txt:2
getModifiedHash(ResourceLoaderContext $context)
Helper method for providing a version hash to getVersionHash().
if(!isset($args[0])) $lang
buildContent(ResourceLoaderContext $context)
Bundle all resources attached to this module into an array.
getMessageBlob(ResourceLoaderContext $context)
Get the hash of the message blob.
getHashMtime(ResourceLoaderContext $context)
Back-compat dummy for old subclass implementations of getModifiedTime().
getStyleURLsForDebug(ResourceLoaderContext $context)
Get the URL or URLs to load for this module's CSS in debug mode.
setFileDependencies(ResourceLoaderContext $context, $files)
Set in-object cache for file dependencies.
$files
static getLocalClusterInstance()
Get the main cluster-local cache object.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
magic word & $parser
Definition: hooks.txt:2321
static safeFilemtime($filePath)
Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist...
static makeHash($value)
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1796
static getFileContentsHash($filePaths, $algo= 'md4')
Get a hash of the combined contents of one or more files, either by retrieving a previously-computed ...
Allows changing specific properties of a context object, without changing the main one...
getLessVars(ResourceLoaderContext $context)
Get module-specific LESS variables, if any.
static expandRelativePaths(array $filePaths)
Expand directories relative to $IP.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
static getMain()
Static methods.
getFileDependencies(ResourceLoaderContext $context)
Get the files this module depends on indirectly for a given skin.
getVersionHash(ResourceLoaderContext $context)
Get a string identifying the current version of this module in a given context.
getSkipFunction()
Get the skip function.
validateScriptFile($fileName, $contents)
Validate a given script file; if valid returns the original source.
getSource()
Get the origin of this module.
getTemplates()
Takes named templates by the module and returns an array mapping.
enableModuleContentVersion()
Whether to generate version hash based on module content.
$summary
getPosition()
Where on the HTML page should this module's JS be loaded?
static encode($value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
$cache
Definition: mcc.php:33
const DB_SLAVE
Definition: Defines.php:46
static getRelativePaths(array $filePaths)
Make file paths relative to MediaWiki directory.
setName($name)
Set this module's name.
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
getTargets()
Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].
getModifiedTime(ResourceLoaderContext $context)
Get this module's last modification timestamp for a given context.
static getDefaultInstance()
static JSParser $jsParser
Lazy-initialized; use self::javaScriptParser()
getDefinitionSummary(ResourceLoaderContext $context)
Get the definition summary for this module.
getDefinitionMtime(ResourceLoaderContext $context)
Back-compat dummy for old subclass implementations of getModifiedTime().
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
static safeFileHash($filePath)
Compute a non-cryptographic string hash of a file's contents.
isKnownEmpty(ResourceLoaderContext $context)
Check whether this module is known to be empty.
static filter($filter, $data, array $options=[])
Run JavaScript or CSS data through a filter, caching the filtered result for future calls...
getScript(ResourceLoaderContext $context)
Get all JS for this module for a given language and skin.
static encodeJsVar($value, $pretty=false)
Encode a variable of arbitrary type to JavaScript.
Definition: Xml.php:664
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1004
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
setOrigin($origin)
Set this module's origin.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
getGroup()
Get the group this module is in.
static consume(ScopedCallback &$sc=null)
Trigger a scoped callback and destroy it.
getStyles(ResourceLoaderContext $context)
Get all CSS for this module for a given skin.
const DB_MASTER
Definition: Defines.php:47
getHash()
All factors that uniquely identify this request, except 'modules'.
getDependencies(ResourceLoaderContext $context=null)
Get a list of modules this module depends on.
setMessageBlob($blob, $lang)
Set in-object cache for message blobs.
static decode($value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
setLogger(LoggerInterface $logger)
saveFileDependencies(ResourceLoaderContext $context, $localFileRefs)
Set the files this module depends on indirectly for a given skin.
supportsURLLoading()
Whether this module supports URL loading.
getOrigin()
Get this module's origin.
getScriptURLsForDebug(ResourceLoaderContext $context)
Get the URL or URLs to load for this module's JS in debug mode.
getModuleContent(ResourceLoaderContext $context)
Get an array of this module's resources.
getName()
Get this module's name.
Object passed around to modules which contains information about the state of a specific loader reque...