MediaWiki  1.29.2
GadgetResourceLoaderModule.php
Go to the documentation of this file.
1 <?php
2 
11  private $id;
12 
16  private $gadget;
17 
23  public function __construct( array $options ) {
24  $this->id = $options['id'];
25  }
26 
30  private function getGadget() {
31  if ( !$this->gadget ) {
32  try {
33  $this->gadget = GadgetRepo::singleton()->getGadget( $this->id );
34  } catch ( InvalidArgumentException $e ) {
35  // Fallback to a placeholder object...
36  $this->gadget = Gadget::newEmptyGadget( $this->id );
37  }
38  }
39 
40  return $this->gadget;
41  }
42 
48  protected function getPages( ResourceLoaderContext $context ) {
49  $gadget = $this->getGadget();
50  $pages = [];
51 
52  foreach ( $gadget->getStyles() as $style ) {
53  $pages[$style] = [ 'type' => 'style' ];
54  }
55 
57  foreach ( $gadget->getScripts() as $script ) {
58  $pages[$script] = [ 'type' => 'script' ];
59  }
60  }
61 
62  return $pages;
63  }
64 
70  public function getDependencies( ResourceLoaderContext $context = null ) {
71  return $this->getGadget()->getDependencies();
72  }
73 
78  public function getType() {
79  return $this->getGadget()->getType() === 'styles'
82  }
83 
84  public function getMessages() {
85  return $this->getGadget()->getMessages();
86  }
87 
88  public function getTargets() {
89  return $this->getGadget()->getTargets();
90  }
91 }
ResourceLoaderModule\LOAD_GENERAL
const LOAD_GENERAL
Definition: ResourceLoaderModule.php:44
GadgetResourceLoaderModule\getPages
getPages(ResourceLoaderContext $context)
Overrides the function from ResourceLoaderWikiModule class.
Definition: GadgetResourceLoaderModule.php:48
ResourceLoaderContext
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
GadgetResourceLoaderModule\getDependencies
getDependencies(ResourceLoaderContext $context=null)
Overrides ResourceLoaderModule::getDependencies()
Definition: GadgetResourceLoaderModule.php:70
GadgetResourceLoaderModule\getTargets
getTargets()
Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].
Definition: GadgetResourceLoaderModule.php:88
Gadget\supportsResourceLoader
supportsResourceLoader()
Definition: Gadgets_body.php:195
Gadget\getStyles
getStyles()
Definition: Gadgets_body.php:225
ResourceLoaderWikiModule
Abstraction for ResourceLoader modules which pull from wiki pages.
Definition: ResourceLoaderWikiModule.php:48
Gadget\getScripts
getScripts()
Definition: Gadgets_body.php:218
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
Gadget
Wrapper for one gadget.
Definition: Gadgets_body.php:18
GadgetResourceLoaderModule\getGadget
getGadget()
Definition: GadgetResourceLoaderModule.php:30
GadgetResourceLoaderModule\$id
string $id
Definition: GadgetResourceLoaderModule.php:11
GadgetRepo\singleton
static singleton()
Get the configured default GadgetRepo.
Definition: GadgetRepo.php:53
GadgetResourceLoaderModule\getType
getType()
Overrides ResourceLoaderWikiModule::getType()
Definition: GadgetResourceLoaderModule.php:78
Gadget\newEmptyGadget
static newEmptyGadget( $id)
Get a placeholder object to use if a gadget doesn't exist.
Definition: Gadgets_body.php:106
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
GadgetResourceLoaderModule
Class representing a list of resources for one gadget, basically a wrapper around the Gadget class.
Definition: GadgetResourceLoaderModule.php:7
ResourceLoaderModule\LOAD_STYLES
const LOAD_STYLES
Definition: ResourceLoaderModule.php:42
GadgetResourceLoaderModule\$gadget
Gadget $gadget
Definition: GadgetResourceLoaderModule.php:16
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
GadgetResourceLoaderModule\getMessages
getMessages()
Get the messages needed for this module.
Definition: GadgetResourceLoaderModule.php:84
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 as context as context $options
Definition: hooks.txt:1049
array
the array() calling protocol came about after MediaWiki 1.4rc1.
GadgetResourceLoaderModule\__construct
__construct(array $options)
Creates an instance of this class.
Definition: GadgetResourceLoaderModule.php:23