MediaWiki  1.28.0
ResourceLoaderModule.php
Go to the documentation of this file.
1 <?php
29 
33 abstract class ResourceLoaderModule implements LoggerAwareInterface {
34  # Type of resource
35  const TYPE_SCRIPTS = 'scripts';
36  const TYPE_STYLES = 'styles';
37  const TYPE_COMBINED = 'combined';
38 
39  # Desired load type
40  // Module only has styles (loaded via <style> or <link rel=stylesheet>)
41  const LOAD_STYLES = 'styles';
42  // Module may have other resources (loaded via mw.loader from a script)
43  const LOAD_GENERAL = 'general';
44 
45  # sitewide core module like a skin file or jQuery component
47 
48  # per-user module generated by the software
50 
51  # sitewide module generated from user-editable files, like MediaWiki:Common.js, or
52  # modules accessible to multiple users, such as those generated by the Gadgets extension.
54 
55  # per-user module generated from user-editable files, like User:Me/vector.js
57 
58  # an access constant; make sure this is kept as the largest number in this group
59  const ORIGIN_ALL = 10;
60 
61  # script and style modules form a hierarchy of trustworthiness, with core modules like
62  # skins and jQuery as most trustworthy, and user scripts as least trustworthy. We can
63  # limit the types of scripts and styles we allow to load on, say, sensitive special
64  # pages like Special:UserLogin and Special:Preferences
65  protected $origin = self::ORIGIN_CORE_SITEWIDE;
66 
67  /* Protected Members */
68 
69  protected $name = null;
70  protected $targets = [ 'desktop' ];
71 
72  // In-object cache for file dependencies
73  protected $fileDeps = [];
74  // In-object cache for message blob (keyed by language)
75  protected $msgBlobs = [];
76  // In-object cache for version hash
77  protected $versionHash = [];
78  // In-object cache for module content
79  protected $contents = [];
80 
84  protected $config;
85 
89  protected $deprecated = false;
90 
94  protected $logger;
95 
96  /* Methods */
97 
104  public function getName() {
105  return $this->name;
106  }
107 
114  public function setName( $name ) {
115  $this->name = $name;
116  }
117 
125  public function getOrigin() {
126  return $this->origin;
127  }
128 
133  public function getFlip( $context ) {
135 
136  return $wgContLang->getDir() !== $context->getDirection();
137  }
138 
144  protected function getDeprecationInformation() {
145  $deprecationInfo = $this->deprecated;
146  if ( $deprecationInfo ) {
147  $name = $this->getName();
148  $warning = 'This page is using the deprecated ResourceLoader module "' . $name . '".';
149  if ( !is_bool( $deprecationInfo ) && isset( $deprecationInfo['message'] ) ) {
150  $warning .= "\n" . $deprecationInfo['message'];
151  }
152  return Xml::encodeJsCall(
153  'mw.log.warn',
154  [ $warning ]
155  );
156  } else {
157  return '';
158  }
159  }
160 
169  // Stub, override expected
170  return '';
171  }
172 
178  public function getTemplates() {
179  // Stub, override expected.
180  return [];
181  }
182 
187  public function getConfig() {
188  if ( $this->config === null ) {
189  // Ugh, fall back to default
190  $this->config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
191  }
192 
193  return $this->config;
194  }
195 
200  public function setConfig( Config $config ) {
201  $this->config = $config;
202  }
203 
209  public function setLogger( LoggerInterface $logger ) {
210  $this->logger = $logger;
211  }
212 
217  protected function getLogger() {
218  if ( !$this->logger ) {
219  $this->logger = new NullLogger();
220  }
221  return $this->logger;
222  }
223 
239  $resourceLoader = $context->getResourceLoader();
240  $derivative = new DerivativeResourceLoaderContext( $context );
241  $derivative->setModules( [ $this->getName() ] );
242  $derivative->setOnly( 'scripts' );
243  $derivative->setDebug( true );
244 
245  $url = $resourceLoader->createLoaderURL(
246  $this->getSource(),
247  $derivative
248  );
249 
250  return [ $url ];
251  }
252 
259  public function supportsURLLoading() {
260  return true;
261  }
262 
272  // Stub, override expected
273  return [];
274  }
275 
286  $resourceLoader = $context->getResourceLoader();
287  $derivative = new DerivativeResourceLoaderContext( $context );
288  $derivative->setModules( [ $this->getName() ] );
289  $derivative->setOnly( 'styles' );
290  $derivative->setDebug( true );
291 
292  $url = $resourceLoader->createLoaderURL(
293  $this->getSource(),
294  $derivative
295  );
296 
297  return [ 'all' => [ $url ] ];
298  }
299 
307  public function getMessages() {
308  // Stub, override expected
309  return [];
310  }
311 
317  public function getGroup() {
318  // Stub, override expected
319  return null;
320  }
321 
327  public function getSource() {
328  // Stub, override expected
329  return 'local';
330  }
331 
339  public function getPosition() {
340  return 'bottom';
341  }
342 
350  public function isRaw() {
351  return false;
352  }
353 
366  public function getDependencies( ResourceLoaderContext $context = null ) {
367  // Stub, override expected
368  return [];
369  }
370 
376  public function getTargets() {
377  return $this->targets;
378  }
379 
386  public function getType() {
387  return self::LOAD_GENERAL;
388  }
389 
404  public function getSkipFunction() {
405  return null;
406  }
407 
417  $vary = $context->getSkin() . '|' . $context->getLanguage();
418 
419  // Try in-object cache first
420  if ( !isset( $this->fileDeps[$vary] ) ) {
421  $dbr = wfGetDB( DB_REPLICA );
422  $deps = $dbr->selectField( 'module_deps',
423  'md_deps',
424  [
425  'md_module' => $this->getName(),
426  'md_skin' => $vary,
427  ],
428  __METHOD__
429  );
430 
431  if ( !is_null( $deps ) ) {
432  $this->fileDeps[$vary] = self::expandRelativePaths(
433  (array)FormatJson::decode( $deps, true )
434  );
435  } else {
436  $this->fileDeps[$vary] = [];
437  }
438  }
439  return $this->fileDeps[$vary];
440  }
441 
452  $vary = $context->getSkin() . '|' . $context->getLanguage();
453  $this->fileDeps[$vary] = $files;
454  }
455 
463  protected function saveFileDependencies( ResourceLoaderContext $context, $localFileRefs ) {
464  // Normalise array
465  $localFileRefs = array_values( array_unique( $localFileRefs ) );
466  sort( $localFileRefs );
467 
468  try {
469  // If the list has been modified since last time we cached it, update the cache
470  if ( $localFileRefs !== $this->getFileDependencies( $context ) ) {
472  $key = $cache->makeKey( __METHOD__, $this->getName() );
473  $scopeLock = $cache->getScopedLock( $key, 0 );
474  if ( !$scopeLock ) {
475  return; // T124649; avoid write slams
476  }
477 
478  $vary = $context->getSkin() . '|' . $context->getLanguage();
479  $dbw = wfGetDB( DB_MASTER );
480  $dbw->replace( 'module_deps',
481  [ [ 'md_module', 'md_skin' ] ],
482  [
483  'md_module' => $this->getName(),
484  'md_skin' => $vary,
485  // Use relative paths to avoid ghost entries when $IP changes (T111481)
486  'md_deps' => FormatJson::encode( self::getRelativePaths( $localFileRefs ) ),
487  ]
488  );
489 
490  if ( $dbw->trxLevel() ) {
491  $dbw->onTransactionResolution(
492  function () use ( &$scopeLock ) {
493  ScopedCallback::consume( $scopeLock ); // release after commit
494  },
495  __METHOD__
496  );
497  }
498  }
499  } catch ( Exception $e ) {
500  wfDebugLog( 'resourceloader', __METHOD__ . ": failed to update DB: $e" );
501  }
502  }
503 
514  public static function getRelativePaths( array $filePaths ) {
515  global $IP;
516  return array_map( function ( $path ) use ( $IP ) {
517  return RelPath\getRelativePath( $path, $IP );
518  }, $filePaths );
519  }
520 
528  public static function expandRelativePaths( array $filePaths ) {
529  global $IP;
530  return array_map( function ( $path ) use ( $IP ) {
531  return RelPath\joinPath( $IP, $path );
532  }, $filePaths );
533  }
534 
543  if ( !$this->getMessages() ) {
544  // Don't bother consulting MessageBlobStore
545  return null;
546  }
547  // Message blobs may only vary language, not by context keys
548  $lang = $context->getLanguage();
549  if ( !isset( $this->msgBlobs[$lang] ) ) {
550  $this->getLogger()->warning( 'Message blob for {module} should have been preloaded', [
551  'module' => $this->getName(),
552  ] );
553  $store = $context->getResourceLoader()->getMessageBlobStore();
554  $this->msgBlobs[$lang] = $store->getBlob( $this, $lang );
555  }
556  return $this->msgBlobs[$lang];
557  }
558 
568  public function setMessageBlob( $blob, $lang ) {
569  $this->msgBlobs[$lang] = $blob;
570  }
571 
580  return [];
581  }
582 
591  $contextHash = $context->getHash();
592  // Cache this expensive operation. This calls builds the scripts, styles, and messages
593  // content which typically involves filesystem and/or database access.
594  if ( !array_key_exists( $contextHash, $this->contents ) ) {
595  $this->contents[$contextHash] = $this->buildContent( $context );
596  }
597  return $this->contents[$contextHash];
598  }
599 
607  final protected function buildContent( ResourceLoaderContext $context ) {
608  $rl = $context->getResourceLoader();
609  $stats = RequestContext::getMain()->getStats();
610  $statStart = microtime( true );
611 
612  // Only include properties that are relevant to this context (e.g. only=scripts)
613  // and that are non-empty (e.g. don't include "templates" for modules without
614  // templates). This helps prevent invalidating cache for all modules when new
615  // optional properties are introduced.
616  $content = [];
617 
618  // Scripts
619  if ( $context->shouldIncludeScripts() ) {
620  // If we are in debug mode, we'll want to return an array of URLs if possible
621  // However, we can't do this if the module doesn't support it
622  // We also can't do this if there is an only= parameter, because we have to give
623  // the module a way to return a load.php URL without causing an infinite loop
624  if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
625  $scripts = $this->getScriptURLsForDebug( $context );
626  } else {
627  $scripts = $this->getScript( $context );
628  // rtrim() because there are usually a few line breaks
629  // after the last ';'. A new line at EOF, a new line
630  // added by ResourceLoaderFileModule::readScriptFiles, etc.
631  if ( is_string( $scripts )
632  && strlen( $scripts )
633  && substr( rtrim( $scripts ), -1 ) !== ';'
634  ) {
635  // Append semicolon to prevent weird bugs caused by files not
636  // terminating their statements right (bug 27054)
637  $scripts .= ";\n";
638  }
639  }
640  $content['scripts'] = $scripts;
641  }
642 
643  // Styles
644  if ( $context->shouldIncludeStyles() ) {
645  $styles = [];
646  // Don't create empty stylesheets like [ '' => '' ] for modules
647  // that don't *have* any stylesheets (bug 38024).
648  $stylePairs = $this->getStyles( $context );
649  if ( count( $stylePairs ) ) {
650  // If we are in debug mode without &only= set, we'll want to return an array of URLs
651  // See comment near shouldIncludeScripts() for more details
652  if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
653  $styles = [
654  'url' => $this->getStyleURLsForDebug( $context )
655  ];
656  } else {
657  // Minify CSS before embedding in mw.loader.implement call
658  // (unless in debug mode)
659  if ( !$context->getDebug() ) {
660  foreach ( $stylePairs as $media => $style ) {
661  // Can be either a string or an array of strings.
662  if ( is_array( $style ) ) {
663  $stylePairs[$media] = [];
664  foreach ( $style as $cssText ) {
665  if ( is_string( $cssText ) ) {
666  $stylePairs[$media][] =
667  ResourceLoader::filter( 'minify-css', $cssText );
668  }
669  }
670  } elseif ( is_string( $style ) ) {
671  $stylePairs[$media] = ResourceLoader::filter( 'minify-css', $style );
672  }
673  }
674  }
675  // Wrap styles into @media groups as needed and flatten into a numerical array
676  $styles = [
677  'css' => $rl->makeCombinedStyles( $stylePairs )
678  ];
679  }
680  }
681  $content['styles'] = $styles;
682  }
683 
684  // Messages
685  $blob = $this->getMessageBlob( $context );
686  if ( $blob ) {
687  $content['messagesBlob'] = $blob;
688  }
689 
690  $templates = $this->getTemplates();
691  if ( $templates ) {
692  $content['templates'] = $templates;
693  }
694 
695  $statTiming = microtime( true ) - $statStart;
696  $statName = strtr( $this->getName(), '.', '_' );
697  $stats->timing( "resourceloader_build.all", 1000 * $statTiming );
698  $stats->timing( "resourceloader_build.$statName", 1000 * $statTiming );
699 
700  return $content;
701  }
702 
726  // The startup module produces a manifest with versions representing the entire module.
727  // Typically, the request for the startup module itself has only=scripts. That must apply
728  // only to the startup module content, and not to the module version computed here.
729  $context = new DerivativeResourceLoaderContext( $context );
730  $context->setModules( [] );
731  // Version hash must cover all resources, regardless of startup request itself.
732  $context->setOnly( null );
733  // Compute version hash based on content, not debug urls.
734  $context->setDebug( false );
735 
736  // Cache this somewhat expensive operation. Especially because some classes
737  // (e.g. startup module) iterate more than once over all modules to get versions.
738  $contextHash = $context->getHash();
739  if ( !array_key_exists( $contextHash, $this->versionHash ) ) {
740 
741  if ( $this->enableModuleContentVersion() ) {
742  // Detect changes directly
743  $str = json_encode( $this->getModuleContent( $context ) );
744  } else {
745  // Infer changes based on definition and other metrics
746  $summary = $this->getDefinitionSummary( $context );
747  if ( !isset( $summary['_cacheEpoch'] ) ) {
748  throw new LogicException( 'getDefinitionSummary must call parent method' );
749  }
750  $str = json_encode( $summary );
751 
752  $mtime = $this->getModifiedTime( $context );
753  if ( $mtime !== null ) {
754  // Support: MediaWiki 1.25 and earlier
755  $str .= strval( $mtime );
756  }
757 
758  $mhash = $this->getModifiedHash( $context );
759  if ( $mhash !== null ) {
760  // Support: MediaWiki 1.25 and earlier
761  $str .= strval( $mhash );
762  }
763  }
764 
765  $this->versionHash[$contextHash] = ResourceLoader::makeHash( $str );
766  }
767  return $this->versionHash[$contextHash];
768  }
769 
779  public function enableModuleContentVersion() {
780  return false;
781  }
782 
827  return [
828  '_class' => get_class( $this ),
829  '_cacheEpoch' => $this->getConfig()->get( 'CacheEpoch' ),
830  ];
831  }
832 
841  return null;
842  }
843 
852  return null;
853  }
854 
867  if ( !is_string( $this->getModifiedHash( $context ) ) ) {
868  return 1;
869  }
870  // Dummy that is > 1
871  return 2;
872  }
873 
883  if ( $this->getDefinitionSummary( $context ) === null ) {
884  return 1;
885  }
886  // Dummy that is > 1
887  return 2;
888  }
889 
900  return false;
901  }
902 
904  private static $jsParser;
905  private static $parseCacheVersion = 1;
906 
915  protected function validateScriptFile( $fileName, $contents ) {
916  if ( $this->getConfig()->get( 'ResourceLoaderValidateJS' ) ) {
917  // Try for cache hit
919  $key = $cache->makeKey(
920  'resourceloader',
921  'jsparse',
922  self::$parseCacheVersion,
923  md5( $contents )
924  );
925  $cacheEntry = $cache->get( $key );
926  if ( is_string( $cacheEntry ) ) {
927  return $cacheEntry;
928  }
929 
930  $parser = self::javaScriptParser();
931  try {
932  $parser->parse( $contents, $fileName, 1 );
933  $result = $contents;
934  } catch ( Exception $e ) {
935  // We'll save this to cache to avoid having to validate broken JS over and over...
936  $err = $e->getMessage();
937  $result = "mw.log.error(" .
938  Xml::encodeJsVar( "JavaScript parse error: $err" ) . ");";
939  }
940 
941  $cache->set( $key, $result );
942  return $result;
943  } else {
944  return $contents;
945  }
946  }
947 
951  protected static function javaScriptParser() {
952  if ( !self::$jsParser ) {
953  self::$jsParser = new JSParser();
954  }
955  return self::$jsParser;
956  }
957 
965  protected static function safeFilemtime( $filePath ) {
966  MediaWiki\suppressWarnings();
967  $mtime = filemtime( $filePath ) ?: 1;
968  MediaWiki\restoreWarnings();
969  return $mtime;
970  }
971 
980  protected static function safeFileHash( $filePath ) {
981  return FileContentsHasher::getFileContentsHash( $filePath );
982  }
983 }
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.
getMessages()
Get the messages needed for this module.
getDeprecationInformation()
Get JS representing deprecation information for the current module if available.
$context
Definition: load.php:50
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:2573
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:2102
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:2487
const DB_MASTER
Definition: defines.php:23
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':DEPRECATED!Use HtmlPageLinkRendererBegin instead.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:1934
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
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().
getType()
Get the module's load type.
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:1046
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
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.
getStyles(ResourceLoaderContext $context)
Get all CSS for this module for a given skin.
getHash()
All factors that uniquely identify this request, except 'modules'.
const DB_REPLICA
Definition: defines.php:22
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
static encodeJsCall($name, $args, $pretty=false)
Create a call to a JavaScript function.
Definition: Xml.php:682
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...