MediaWiki  1.30.0
GadgetRepo.php
Go to the documentation of this file.
1 <?php
2 
3 abstract class GadgetRepo {
4 
8  private static $instance;
9 
18  abstract public function getGadgetIds();
19 
27  abstract public function getGadget( $id );
28 
34  public function getStructuredList() {
35  $list = [];
36  foreach ( $this->getGadgetIds() as $id ) {
37  try {
38  $gadget = $this->getGadget( $id );
39  } catch ( InvalidArgumentException $e ) {
40  continue;
41  }
42  $list[$gadget->getCategory()][$gadget->getName()] = $gadget;
43  }
44 
45  return $list;
46  }
47 
53  public static function singleton() {
54  if ( self::$instance === null ) {
55  global $wgGadgetsRepoClass; // @todo use Config here
56  self::$instance = new $wgGadgetsRepoClass();
57  }
58  return self::$instance;
59  }
60 
66  public static function setSingleton( $repo = null ) {
67  self::$instance = $repo;
68  }
69 }
GadgetRepo\getGadgetIds
getGadgetIds()
Get the ids of the gadgets provided by this repository.
GadgetRepo\getGadget
getGadget( $id)
Get the Gadget object for a given gadget id.
GadgetRepo\$instance
static GadgetRepo null $instance
Definition: GadgetRepo.php:8
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
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
GadgetRepo\singleton
static singleton()
Get the configured default GadgetRepo.
Definition: GadgetRepo.php:53
GadgetRepo
Definition: GadgetRepo.php:3
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2141
GadgetRepo\setSingleton
static setSingleton( $repo=null)
Should only be used by unit tests.
Definition: GadgetRepo.php:66
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
GadgetRepo\getStructuredList
getStructuredList()
Get a list of gadgets sorted by category.
Definition: GadgetRepo.php:34