MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / extensions / Gadgets / includes / GadgetResourceLoaderModule.php

diff --git a/extensions/Gadgets/includes/GadgetResourceLoaderModule.php b/extensions/Gadgets/includes/GadgetResourceLoaderModule.php
new file mode 100644 (file)
index 0000000..e1b2602
--- /dev/null
+++ b/extensions/Gadgets/includes/GadgetResourceLoaderModule.php
@@ -0,0 +1,95 @@
+<?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;
+
+       /**
+        * Creates an instance of this class
+        *
+        * @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 $context
+        * @return string[] Names of resources this module depends on
+        */
+       public function getDependencies( ResourceLoaderContext $context = null ) {
+               return $this->getGadget()->getDependencies();
+       }
+
+       /**
+        * 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';
+       }
+}