MediaWiki  1.32.5
ApiPrefixUniquenessTest.php
Go to the documentation of this file.
1 <?php
2 
10 
11  public function testPrefixes() {
12  $main = new ApiMain( new FauxRequest() );
13  $query = new ApiQuery( $main, 'foo' );
14  $moduleManager = $query->getModuleManager();
15 
16  $modules = $moduleManager->getNames();
17  $prefixes = [];
18 
19  foreach ( $modules as $name ) {
20  $module = $moduleManager->getModule( $name );
21  $class = get_class( $module );
22 
23  $prefix = $module->getModulePrefix();
24  if ( $prefix === '' /* HACK: T196962 */ || $prefix === 'wbeu' ) {
25  continue;
26  }
27 
28  if ( isset( $prefixes[$prefix] ) ) {
29  $this->fail(
30  "Module prefix '{$prefix}' is shared between {$class} and {$prefixes[$prefix]}"
31  );
32  }
33  $prefixes[$module->getModulePrefix()] = $class;
34 
35  if ( $module instanceof ApiQueryGeneratorBase ) {
36  // namespace with 'g', a generator can share a prefix with a module
37  $prefix = 'g' . $prefix;
38  if ( isset( $prefixes[$prefix] ) ) {
39  $this->fail(
40  "Module prefix '{$prefix}' is shared between {$class} and {$prefixes[$prefix]}" .
41  " (as a generator)"
42  );
43  }
44  $prefixes[$module->getModulePrefix()] = $class;
45  }
46  }
47  $this->assertTrue( true ); // dummy call to make this test non-incomplete
48  }
49 }
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
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
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1627
MediaWikiTestCase
Definition: MediaWikiTestCase.php:16
$modules
$modules
Definition: HTMLFormElement.php:12
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiPrefixUniquenessTest\testPrefixes
testPrefixes()
Definition: ApiPrefixUniquenessTest.php:11
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
ApiPrefixUniquenessTest
Checks that all API query modules, core and extensions, have unique prefixes.
Definition: ApiPrefixUniquenessTest.php:9