Refactor NDB_Page::getCSS/JSDependencies()

modules/acknowledgements/php/acknowledgements.class.inc

@@ -212,24 +212,14 @@ class Acknowledgements extends \NDB_Menu_Filter_Form
     }
 
     /**
-     * Add dependency on default acknowledgements.js
+     * Add Javascript dependencies
      *
-     * @return array of javascript files to be included
+     * @return array The list of Javascript files this page depends on
      */
-    function getJSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseurl = $factory->settings()->getBaseURL();
-
-        $baseDeps = parent::getJSDependencies();
-
-        return array_merge(
-            $baseDeps,
-            [
-                $baseurl . '/acknowledgements/js/acknowledgementsIndex.js',
-            ]
-        );
-
+        return [
+            '/acknowledgements/js/acknowledgementsIndex.js',
+        ];
     }
-
 }

modules/api_docs/php/api_docs.class.inc

@@ -84,23 +84,14 @@ class API_Docs extends \NDB_Page
     }
 
     /**
-     * Add JS dependency
+     * Add Javascript dependencies
      *
-     * @return array of javascript files to be included
+     * @return array The list of Javascript files this page depends on
      */
-    function getJSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseurl = $factory->settings()->getBaseURL();
-
-        $baseDeps = parent::getJSDependencies();
-
-        return array_merge(
-            $baseDeps,
-            [
-                $baseurl . '/api_docs/js/swagger-ui_custom.js',
-            ]
-        );
-
+        return [
+            '/api_docs/js/swagger-ui_custom.js',
+        ];
     }
 }

modules/battery_manager/php/battery_manager.class.inc

@@ -59,21 +59,14 @@ class Battery_Manager extends \NDB_Page
     }
 
     /**
-     * Include additional JS files.
+     * Add Javascript dependencies
      *
-     * @return array of javascript to be inserted
+     * @return array The list of Javascript files this page depends on
      */
-    public function getJSDependencies() : array
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . "/battery_manager/js/batteryManagerIndex.js",
-            ]
-        );
+        return [
+            '/battery_manager/js/batteryManagerIndex.js',
+        ];
     }
 }
-

modules/behavioural_qc/php/behavioural_qc.class.inc

@@ -41,22 +41,27 @@ class Behavioural_QC extends \NDB_Form
     }
 
     /**
-     * Include the column formatter required to display the feedback link colours
-     * in the candidate_list menu
+     * Add Javascript dependencies
      *
-     * @return array of javascript to be inserted
+     * @return array The list of Javascript files this page depends on
      */
-    function getJSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . '/behavioural_qc/js/behaviouralQCIndex.js',
-            ]
-        );
+        return [
+            '/behavioural_qc/js/behaviouralQCIndex.js',
+        ];
+    }
+
+    /**
+     * Add CSS dependencies
+     *
+     * @return array The list of CSS files this page depends on
+     */
+    function getCSSDependencies(): array
+    {
+        return [
+            '/behavioural_qc/css/behavioural_qc.css'
+        ];
     }
 
     /**
@@ -73,21 +78,4 @@ class Behavioural_QC extends \NDB_Form
             )
         );
     }
-
-    /**
-     * Include additional CSS files:
-     *  1. behavioural_qc
-     *
-     * @return array of CSS to be inserted
-     */
-    function getCSSDependencies()
-    {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getCSSDependencies();
-        return array_merge(
-            $deps,
-            [$baseURL . '/behavioural_qc/css/behavioural_qc.css']
-        );
-    }
 }

modules/brainbrowser/php/brainbrowser.class.inc

@@ -50,51 +50,33 @@ class Brainbrowser extends \NDB_Page
     }
 
     /**
-     * Override base function to include brainbrowser javascript files
-     * and dependencies
+     * Add CSS dependencies
      *
-     * @return array of javascript files to be included
+     * @return array The list of CSS files this page depends on
      */
-    function getJSDependencies()
+    function getCSSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-
-        $deps = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . "/brainbrowser/js/Brainbrowser.js",
-                $baseURL . "/brainbrowser/js/jquery.mousewheel.min.js",
-                $baseURL . "/brainbrowser/js/three.min.js",
-                $baseURL . "/brainbrowser/js/brainbrowser.volume-viewer.min.js",
-                $baseURL . "/brainbrowser/js/brainbrowser.config.js",
-                $baseURL . "/brainbrowser/js/brainbrowser.loris.js",
-            ]
-        );
+        return [
+            '/css/loris-jquery/jquery-ui-1.10.4.custom.min.css',
+            '/brainbrowser/css/volume-viewer-demo.css',
+            '/brainbrowser/css/brainbrowser.css',
+        ];
     }
 
     /**
-     * Include additional CSS files:
-     *  1. jQuery UI
-     *  2. volume-viewer-demo.css
-     *  3. brainbrowser.css
+     * Add Javascript dependencies
      *
-     * @return array of javascript to be inserted
+     * @return array The list of Javascript files this page depends on
      */
-    function getCSSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getCSSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . "/css/loris-jquery/jquery-ui-1.10.4.custom.min.css",
-                $baseURL . "/brainbrowser/css/volume-viewer-demo.css",
-                $baseURL . "/brainbrowser/css/brainbrowser.css",
-            ]
-        );
+        return [
+            '/brainbrowser/js/Brainbrowser.js',
+            '/brainbrowser/js/jquery.mousewheel.min.js',
+            '/brainbrowser/js/three.min.js',
+            '/brainbrowser/js/brainbrowser.volume-viewer.min.js',
+            '/brainbrowser/js/brainbrowser.config.js',
+            '/brainbrowser/js/brainbrowser.loris.js',
+        ];
     }
 }
-

modules/candidate_list/php/candidate_list.class.inc

@@ -124,22 +124,15 @@ class Candidate_List extends \DataFrameworkMenu
     }
 
     /**
-     * Include the column formatter required to display the feedback link colours
-     * in the candidate_list menu
+     * Add Javascript dependencies
      *
-     * @return array of javascript to be inserted
+     * @return array The list of Javascript files this page depends on
      */
-    function getJSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . "/candidate_list/js/candidateListIndex.js",
-            ]
-        );
+        return [
+            '/candidate_list/js/candidateListIndex.js',
+        ];
     }
 
     /**

modules/candidate_parameters/php/candidate_parameters.class.inc

@@ -64,21 +64,15 @@ class Candidate_Parameters extends \NDB_Form
     }
 
     /**
-     * Include the Tabs.js and index.js (entry point of the module)
+     * Add Javascript dependencies
      *
-     * @return array of javascript to be inserted
+     * @return array The list of Javascript files this page depends on
      */
-    function getJSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . "/candidate_parameters/js/CandidateParameters.js",
-            ]
-        );
+        return [
+            '/candidate_parameters/js/CandidateParameters.js',
+        ];
     }
 
     /**

modules/candidate_profile/php/candidate_profile.class.inc

@@ -103,19 +103,15 @@ class Candidate_Profile extends \NDB_Page
     }
 
     /**
-     * Add CSSGrid dependency for the module.
+     * Add Javascript dependencies
      *
-     * @return array
+     * @return array The list of Javascript files this page depends on
      */
-    function getJSDependencies()
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [$baseURL . '/js/components/CSSGrid.js']
-        );
+        return [
+            '/js/components/CSSGrid.js',
+        ];
     }
 
     /**

modules/configuration/php/configuration.class.inc

@@ -106,8 +106,8 @@ class Configuration extends \NDB_Form
         $DB = $this->loris->getDatabaseConnection();
 
         $parentConfigItems = $DB->pselect(
-            "SELECT Label, Name 
-             FROM ConfigSettings 
+            "SELECT Label, Name
+             FROM ConfigSettings
              WHERE Parent IS NULL AND Visible=1 ORDER BY OrderNumber",
             []
         );
@@ -184,38 +184,26 @@ class Configuration extends \NDB_Form
     }
 
     /**
-     * Include the column formatter required to display the feedback link colours
-     * in the candidate_list menu
+     * Add CSS dependencies
      *
-     * @return array of javascript to be inserted
+     * @return array The list of CSS files this page depends on
      */
-    function getJSDependencies()
+    function getCSSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getJSDependencies();
-        return array_merge(
-            $deps,
-            [
-                $baseURL . "/configuration/js/configuration_helper.js",
-            ]
-        );
+        return [
+            '/configuration/css/configuration.css',
+        ];
     }
 
-     /**
-      * Include additional CSS files:
-      *  1. configuration
-      *
-      * @return array of CSS to be inserted
-      */
-    function getCSSDependencies()
+    /**
+     * Add Javascript dependencies
+     *
+     * @return array The list of Javascript files this page depends on
+     */
+    function getJSDependencies(): array
     {
-        $factory = \NDB_Factory::singleton();
-        $baseURL = $factory->settings()->getBaseURL();
-        $deps    = parent::getCSSDependencies();
-        return array_merge(
-            $deps,
-            [$baseURL . "/configuration/css/configuration.css"]
-        );
+        return [
+            '/configuration/js/configuration_helper.js',
+        ];
     }
 }