id = $options['id']; } /** * @return Gadget instance this module is about */ private function getGadget() { if ( !$this->gadget ) { /** @var GadgetRepo $repo */ $repo = MediaWikiServices::getInstance()->getService( 'GadgetsRepo' ); try { $this->gadget = $repo->getGadget( $this->id ); } catch ( InvalidArgumentException $e ) { // Fallback to a placeholder object... $this->gadget = Gadget::newEmptyGadget( $this->id ); } } return $this->gadget; } /** * Overrides the function from RL\WikiModule class * @param RL\Context $context * @return array */ protected function getPages( RL\Context $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' ]; } if ( $gadget->isPackaged() ) { foreach ( $gadget->getJSONs() as $json ) { $pages[$json] = [ 'type' => 'data' ]; } } } return $pages; } /** * Overrides RL\WikiModule::getRequireKey() * @param string $titleText * @return string */ public function getRequireKey( $titleText ): string { /** @var GadgetRepo $repo */ $repo = MediaWikiServices::getInstance()->getService( 'GadgetsRepo' ); return $repo->titleWithoutPrefix( $titleText, $this->id ); } /** * @param string $fileName * @param string $contents * @return string */ protected function validateScriptFile( $fileName, $contents ) { // Temporary solution to support gadgets in ES6 by disabling validation // for them and putting them in a separate resource group to avoid a syntax error in them // from corrupting core/extension-loaded scripts or other non-ES6 gadgets. if ( $this->requiresES6() ) { return $contents; } return parent::validateScriptFile( $fileName, $contents ); } /** * Overrides RL\WikiModule::isPackaged() * Returns whether this gadget is packaged. * @return bool */ public function isPackaged(): bool { return $this->getGadget()->isPackaged(); } /** * Overrides RL\Module::getDependencies() * @param RL\Context|null $context * @return string[] Names of resources this module depends on */ public function getDependencies( ?RL\Context $context = null ) { return $this->getGadget()->getDependencies(); } /** * Overrides RL\WikiModule::getType() * @return string RL\Module::LOAD_STYLES or RL\Module::LOAD_GENERAL */ public function getType() { return $this->getGadget()->getType() === 'styles' ? RL\Module::LOAD_STYLES : RL\Module::LOAD_GENERAL; } public function getMessages() { return $this->getGadget()->getMessages(); } public function getSkins(): ?array { return $this->getGadget()->getRequiredSkins() ?: null; } public function requiresES6(): bool { return $this->getGadget()->requiresES6(); } public function getGroup() { return $this->requiresES6() ? 'es6-gadget' : self::GROUP_SITE; } }