MediaWiki  1.30.0
CiteDataModule.php
Go to the documentation of this file.
1 <?php
14 
15  /* Protected Members */
16 
18  protected $targets = [ 'desktop', 'mobile' ];
19 
20  /* Methods */
21 
23  $citationDefinition = json_decode(
24  $context->msg( 'cite-tool-definition.json' )
25  ->inContentLanguage()
26  ->plain()
27  );
28 
29  if ( $citationDefinition === null ) {
30  $citationDefinition = json_decode(
31  $context->msg( 'visualeditor-cite-tool-definition.json' )
32  ->inContentLanguage()
33  ->plain()
34  );
35  }
36 
37  $citationTools = [];
38  if ( is_array( $citationDefinition ) ) {
39  foreach ( $citationDefinition as $tool ) {
40  if ( !isset( $tool->title ) ) {
41  $tool->title = $context->msg( 'visualeditor-cite-tool-name-' . $tool->name )
42  ->text();
43  }
44  $citationTools[] = $tool;
45  }
46  }
47 
48  return
49  've.init.platform.addMessages(' . FormatJson::encode(
50  [
51  'cite-tool-definition.json' => json_encode( $citationTools )
52  ],
53  ResourceLoader::inDebugMode()
54  ) . ');';
55  }
56 
57  public function getDependencies( ResourceLoaderContext $context = null ) {
58  return [
59  'ext.visualEditor.base',
60  'ext.visualEditor.mediawiki',
61  ];
62  }
63 
65  $summary = parent::getDefinitionSummary( $context );
66  $summary[] = [
67  'script' => $this->getScript( $context ),
68  ];
69  return $summary;
70  }
71 }
ResourceLoaderContext
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
$context
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:2581
ResourceLoaderModule\ORIGIN_USER_SITEWIDE
const ORIGIN_USER_SITEWIDE
Definition: ResourceLoaderModule.php:54
php
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
CiteDataModule
Definition: CiteDataModule.php:13
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
CiteDataModule\$origin
$origin
Definition: CiteDataModule.php:17
CiteDataModule\$targets
$targets
Definition: CiteDataModule.php:18
CiteDataModule\getDependencies
getDependencies(ResourceLoaderContext $context=null)
Get a list of modules this module depends on.
Definition: CiteDataModule.php:57
ResourceLoaderModule
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
Definition: ResourceLoaderModule.php:34
as
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
CiteDataModule\getScript
getScript(ResourceLoaderContext $context)
Get all JS for this module for a given language and skin.
Definition: CiteDataModule.php:22
CiteDataModule\getDefinitionSummary
getDefinitionSummary(ResourceLoaderContext $context)
Get a list of resources that web browsers may preload.
Definition: CiteDataModule.php:64