mediawiki-extensions-Gadgets/includes/GadgetResourceLoaderModule.php

94 lines
2.1 KiB
PHP
Raw Normal View History

<?php
/**
* Class representing a list of resources for one gadget, basically a wrapper
* around the Gadget class.
*/
class GadgetResourceLoaderModule extends ResourceLoaderWikiModule {
/**
* @var string
*/
private $id;
/**
* @var Gadget
*/
private $gadget;
/**
* @param array $options
*/
public function __construct( array $options ) {
$this->id = $options['id'];
}
/**
* @return Gadget instance this module is about
*/
private function getGadget() {
if ( !$this->gadget ) {
try {
$this->gadget = GadgetRepo::singleton()->getGadget( $this->id );
} catch ( InvalidArgumentException $e ) {
// Fallback to a placeholder object...
$this->gadget = Gadget::newEmptyGadget( $this->id );
}
}
return $this->gadget;
}
/**
* Overrides the function from ResourceLoaderWikiModule class
* @param ResourceLoaderContext $context
* @return array
*/
protected function getPages( ResourceLoaderContext $context ) {
$gadget = $this->getGadget();
$pages = [];
foreach ( $gadget->getStyles() as $style ) {
$pages[$style] = [ 'type' => 'style' ];
}
if ( $gadget->supportsResourceLoader() ) {
foreach ( $gadget->getScripts() as $script ) {
$pages[$script] = [ 'type' => 'script' ];
}
}
return $pages;
}
/**
* Overrides ResourceLoaderModule::getDependencies()
* @param ResourceLoaderContext|null $context
* @return string[] Names of resources this module depends on
*/
public function getDependencies( ResourceLoaderContext $context = null ) {
return $this->getGadget()->getDependencies();
}
Implement support for specifying type=styles T87871 formally introduced the concept of a styles module, which sets mw.loader.state to "ready" when loaded through addModuleStyles(). Previously, addModuleStyles couldn't safely do that because a module may contain scripts also, in which case mw.loader must still load the (rest) of the module (causes styles to load twice). In MediaWiki core or extensions this is easily avoided by calling not calling both addModules() and addModuleStyles(). For Gadgets we call both as a workaround to allow users to provide styles (without a FOUC), but also to provide scripts+styles. Since we don't declare which one is intended (and some gadgets do both), we loaded them both ways. This will no longer be allowed in the future (see T92459). The new 'type=styles' Gadget attribute promises to ResourceLoader that a gadget only contains styles. Impact: * [Bug fix] When mw.loader requires a styles module that already loaded, it will not load again. * [Feature] It is possible for a general scripts+styles gadget to depend on a styles gadget. Previously this caused the styles to load twice. * Specifying type=styles will load the module through addModuleStyles() only. Use this for modules that contain styles that relate to elements already on the page (e.g. when customising the skin, layout, or article content). * Specifying type=general will load the module through addModules() only. Use this if your module contains both scripts and styles and the styles only relate to elements created by the script. This means the styles do not need to be loaded separately through addModuleStyles() and will not apply to noscript mode. Effective difference: * Gadgets with only styles: We assume type=styles. This fixes the main bug (styles loading twice) and requires no migration! * Gadgets with only scripts: We assume type=general. This requires no migration! (And: No more empty stylesheet request) * Gadgets with scripts (with or without styles): We assume type=general, but unless type=general was explicitly set we'll still load it both ways so that the styles apply directly on page load. If this is not needed, set type=general. If this is needed, it should become two separate modules. We do not support a single module having two purposes (1: apply styles to the page, 2: provide scripts+styles). The styles module should be separate. It can be made hidden, and listed as dependency of the other module. The latter case is detected on page load and results in a console warning with a link to T42284. Bug: T42284 Bug: T92459 Change-Id: Ia3c9ddee243f710022144fc2884434350695699a
2016-09-01 23:31:14 +00:00
/**
* Overrides ResourceLoaderWikiModule::getType()
* @return string ResourceLoaderModule::LOAD_STYLES or ResourceLoaderModule::LOAD_GENERAL
*/
public function getType() {
return $this->getGadget()->getType() === 'styles'
? ResourceLoaderModule::LOAD_STYLES
: ResourceLoaderModule::LOAD_GENERAL;
}
public function getMessages() {
return $this->getGadget()->getMessages();
}
public function getTargets() {
return $this->getGadget()->getTargets();
}
public function getGroup() {
return 'site';
}
}