Extract method for adding script files

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Jul 12, 2020 · 1dccc10 · 1dccc10
1 parent f832095
commit 1dccc10
Show file tree

Hide file tree

Showing 53 changed files with 138 additions and 252 deletions.
diff --git a/libraries/classes/Controllers/AbstractController.php b/libraries/classes/Controllers/AbstractController.php
@@ -45,4 +45,12 @@ protected function render(string $template, array $data = []): void
     {
         $this->response->addHTML($this->template->render($template, $data));
     }
+
+    /** @param string[] $files */
+    protected function addScriptFiles(array $files): void
+    {
+        $header = $this->response->getHeader();
+        $scripts = $header->getScripts();
+        $scripts->addFiles($files);
+    }
 }
diff --git a/libraries/classes/Controllers/Database/CentralColumnsController.php b/libraries/classes/Controllers/Database/CentralColumnsController.php
@@ -90,11 +90,11 @@ public function index(): void
             ]);
         }
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('vendor/jquery/jquery.uitablefilter.js');
-        $scripts->addFile('vendor/jquery/jquery.tablesorter.js');
-        $scripts->addFile('database/central_columns.js');
+        $this->addScriptFiles([
+            'vendor/jquery/jquery.uitablefilter.js',
+            'vendor/jquery/jquery.tablesorter.js',
+            'database/central_columns.js',
+        ]);
 
         if (isset($_POST['edit_central_columns_page'])) {
             $this->response->addHTML($this->editPage([

diff --git a/libraries/classes/Controllers/Database/DesignerController.php b/libraries/classes/Controllers/Database/DesignerController.php
@@ -210,14 +210,15 @@ public function index(): void
         $header = $this->response->getHeader();
         $header->setBodyId('designer_body');
 
-        $scripts = $header->getScripts();
-        $scripts->addFile('vendor/jquery/jquery.fullscreen.js');
-        $scripts->addFile('designer/database.js');
-        $scripts->addFile('designer/objects.js');
-        $scripts->addFile('designer/page.js');
-        $scripts->addFile('designer/history.js');
-        $scripts->addFile('designer/move.js');
-        $scripts->addFile('designer/init.js');
+        $this->addScriptFiles([
+            'vendor/jquery/jquery.fullscreen.js',
+            'designer/database.js',
+            'designer/objects.js',
+            'designer/page.js',
+            'designer/history.js',
+            'designer/move.js',
+            'designer/init.js',
+        ]);
 
         [
             $tables,

diff --git a/libraries/classes/Controllers/Database/ExportController.php b/libraries/classes/Controllers/Database/ExportController.php
@@ -46,9 +46,7 @@ public function index(): void
         $this->response->addHTML($pageSettings->getErrorHTML());
         $this->response->addHTML($pageSettings->getHTML());
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('export.js');
+        $this->addScriptFiles(['export.js']);
 
         // $sub_part is used in Util::getDbInfo() to see if we are coming from
         // /database/export, in which case we don't obey $cfg['MaxTableList']

diff --git a/libraries/classes/Controllers/Database/ImportController.php b/libraries/classes/Controllers/Database/ImportController.php
@@ -20,9 +20,7 @@ public function index(): void
         $this->response->addHTML($pageSettings->getErrorHTML());
         $this->response->addHTML($pageSettings->getHTML());
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('import.js');
+        $this->addScriptFiles(['import.js']);
 
         /**
          * Gets tables information and displays top links

diff --git a/libraries/classes/Controllers/Database/MultiTableQueryController.php b/libraries/classes/Controllers/Database/MultiTableQueryController.php
@@ -16,11 +16,11 @@ class MultiTableQueryController extends AbstractController
 {
     public function index(): void
     {
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('vendor/jquery/jquery.md5.js');
-        $scripts->addFile('database/multi_table_query.js');
-        $scripts->addFile('database/query_generator.js');
+        $this->addScriptFiles([
+            'vendor/jquery/jquery.md5.js',
+            'database/multi_table_query.js',
+            'database/query_generator.js',
+        ]);
 
         $queryInstance = new MultiTableQuery($this->dbi, $this->template, $this->db);
 

diff --git a/libraries/classes/Controllers/Database/OperationsController.php b/libraries/classes/Controllers/Database/OperationsController.php
@@ -77,9 +77,7 @@ public function index(): void
 
         $this->checkUserPrivileges->getPrivileges();
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('database/operations.js');
+        $this->addScriptFiles(['database/operations.js']);
 
         $sql_query = '';
 

diff --git a/libraries/classes/Controllers/Database/QueryByExampleController.php b/libraries/classes/Controllers/Database/QueryByExampleController.php
@@ -47,9 +47,7 @@ public function index(): void
         $savedSearch = null;
         $currentSearchId = null;
         if ($cfgRelation['savedsearcheswork']) {
-            $header = $this->response->getHeader();
-            $scripts = $header->getScripts();
-            $scripts->addFile('database/qbe.js');
+            $this->addScriptFiles(['database/qbe.js']);
 
             //Get saved search list.
             $savedSearch = new SavedSearches($GLOBALS, $this->relation);

diff --git a/libraries/classes/Controllers/Database/SearchController.php b/libraries/classes/Controllers/Database/SearchController.php
@@ -17,11 +17,7 @@ public function index(): void
         global $cfg, $db, $err_url, $url_query, $url_params, $tables, $num_tables, $total_num_tables, $sub_part;
         global $is_show_stats, $db_is_system_schema, $tooltip_truename, $tooltip_aliasname, $pos;
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('database/search.js');
-        $scripts->addFile('sql.js');
-        $scripts->addFile('makegrid.js');
+        $this->addScriptFiles(['database/search.js', 'sql.js', 'makegrid.js']);
 
         Common::database();
 

diff --git a/libraries/classes/Controllers/Database/SqlController.php b/libraries/classes/Controllers/Database/SqlController.php
@@ -38,11 +38,7 @@ public function index(): void
     {
         global $goto, $back;
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('makegrid.js');
-        $scripts->addFile('vendor/jquery/jquery.uitablefilter.js');
-        $scripts->addFile('sql.js');
+        $this->addScriptFiles(['makegrid.js', 'vendor/jquery/jquery.uitablefilter.js', 'sql.js']);
 
         $pageSettings = new PageSettings('Sql');
         $this->response->addHTML($pageSettings->getErrorHTML());

diff --git a/libraries/classes/Controllers/Database/StructureController.php b/libraries/classes/Controllers/Database/StructureController.php
@@ -140,10 +140,7 @@ public function index(): void
 
         Common::database();
 
-        $this->response->getHeader()->getScripts()->addFiles([
-            'database/structure.js',
-            'table/change.js',
-        ]);
+        $this->addScriptFiles(['database/structure.js', 'table/change.js']);
 
         // Gets the database structure
         $this->getDatabaseInfo('_structure');

diff --git a/libraries/classes/Controllers/Database/TrackingController.php b/libraries/classes/Controllers/Database/TrackingController.php
@@ -46,11 +46,7 @@ public function index(): void
         global $total_num_tables, $sub_part, $is_show_stats, $pos, $data, $cfg;
         global $db_is_system_schema, $tooltip_truename, $tooltip_aliasname;
 
-        //Get some js files needed for Ajax requests
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('vendor/jquery/jquery.tablesorter.js');
-        $scripts->addFile('database/tracking.js');
+        $this->addScriptFiles(['vendor/jquery/jquery.tablesorter.js', 'database/tracking.js']);
 
         /**
          * If we are not in an Ajax request, then do the common work and show the links etc.

diff --git a/libraries/classes/Controllers/ExportController.php b/libraries/classes/Controllers/ExportController.php
@@ -67,9 +67,7 @@ public function index(): void
         global $active_page, $do_relation, $do_comments, $do_mime, $do_dates, $whatStrucOrData, $db_select;
         global $table_structure, $table_data, $lock_tables, $allrows, $limit_to, $limit_from;
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('export_output.js');
+        $this->addScriptFiles(['export_output.js']);
 
         //check if it's the GET request to check export time out
         if (isset($_GET['check_time_out'])) {

diff --git a/libraries/classes/Controllers/NormalizationController.php b/libraries/classes/Controllers/NormalizationController.php
@@ -103,10 +103,8 @@ public function index(): void
             return;
         }
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('normalization.js');
-        $scripts->addFile('vendor/jquery/jquery.uitablefilter.js');
+        $this->addScriptFiles(['normalization.js', 'vendor/jquery/jquery.uitablefilter.js']);
+
         $normalForm = '1nf';
         if (Core::isValid($_POST['normalizeTo'], ['1nf', '2nf', '3nf'])) {
             $normalForm = $_POST['normalizeTo'];

diff --git a/libraries/classes/Controllers/Preferences/ExportController.php b/libraries/classes/Controllers/Preferences/ExportController.php
@@ -88,10 +88,7 @@ public function index(): void
             $error = $result;
         }
 
-        // display forms
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Preferences/FeaturesController.php b/libraries/classes/Controllers/Preferences/FeaturesController.php
@@ -88,10 +88,7 @@ public function index(): void
             $error = $result;
         }
 
-        // display forms
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Preferences/ImportController.php b/libraries/classes/Controllers/Preferences/ImportController.php
@@ -88,10 +88,7 @@ public function index(): void
             $error = $result;
         }
 
-        // display forms
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Preferences/MainPanelController.php b/libraries/classes/Controllers/Preferences/MainPanelController.php
@@ -88,10 +88,7 @@ public function index(): void
             $error = $result;
         }
 
-        // display forms
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Preferences/ManageController.php b/libraries/classes/Controllers/Preferences/ManageController.php
@@ -239,9 +239,7 @@ public function index(): void
             return;
         }
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Preferences/NavigationController.php b/libraries/classes/Controllers/Preferences/NavigationController.php
@@ -88,10 +88,7 @@ public function index(): void
             $error = $result;
         }
 
-        // display forms
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Preferences/SqlController.php b/libraries/classes/Controllers/Preferences/SqlController.php
@@ -88,10 +88,7 @@ public function index(): void
             $error = $result;
         }
 
-        // display forms
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('config.js');
+        $this->addScriptFiles(['config.js']);
 
         $cfgRelation = $this->relation->getRelationsParam();
 

diff --git a/libraries/classes/Controllers/Server/DatabasesController.php b/libraries/classes/Controllers/Server/DatabasesController.php
@@ -98,9 +98,7 @@ public function index(): void
             'sort_order' => $_REQUEST['sort_order'] ?? null,
         ];
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('server/databases.js');
+        $this->addScriptFiles(['server/databases.js']);
 
         Common::server();
         ReplicationInfo::load();

diff --git a/libraries/classes/Controllers/Server/ExportController.php b/libraries/classes/Controllers/Server/ExportController.php
@@ -40,9 +40,7 @@ public function index(): void
         $this->response->addHTML($pageSettings->getErrorHTML());
         $this->response->addHTML($pageSettings->getHTML());
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('export.js');
+        $this->addScriptFiles(['export.js']);
 
         $export_page_title = __('View dump (schema) of databases') . "\n";
 

diff --git a/libraries/classes/Controllers/Server/ImportController.php b/libraries/classes/Controllers/Server/ImportController.php
@@ -19,9 +19,7 @@ public function index(): void
         $this->response->addHTML($pageSettings->getErrorHTML());
         $this->response->addHTML($pageSettings->getHTML());
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('import.js');
+        $this->addScriptFiles(['import.js']);
 
         Common::server();
 

diff --git a/libraries/classes/Controllers/Server/PluginsController.php b/libraries/classes/Controllers/Server/PluginsController.php
@@ -43,10 +43,7 @@ public function index(): void
     {
         Common::server();
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('vendor/jquery/jquery.tablesorter.js');
-        $scripts->addFile('server/plugins.js');
+        $this->addScriptFiles(['vendor/jquery/jquery.tablesorter.js', 'server/plugins.js']);
 
         $plugins = [];
         $serverPlugins = $this->plugins->getAll();

diff --git a/libraries/classes/Controllers/Server/PrivilegesController.php b/libraries/classes/Controllers/Server/PrivilegesController.php
@@ -71,13 +71,7 @@ public function index(): void
 
         $cfgRelation = $this->relation->getRelationsParam();
 
-        /**
-         * Does the common work
-         */
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('server/privileges.js');
-        $scripts->addFile('vendor/zxcvbn.js');
+        $this->addScriptFiles(['server/privileges.js', 'vendor/zxcvbn.js']);
 
         $relationCleanup = new RelationCleanup($this->dbi, $this->relation);
         $serverPrivileges = new Privileges($this->template, $this->dbi, $this->relation, $relationCleanup);

diff --git a/libraries/classes/Controllers/Server/ReplicationController.php b/libraries/classes/Controllers/Server/ReplicationController.php
@@ -50,11 +50,7 @@ public function index(): void
         Common::server();
         ReplicationInfo::load();
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('server/privileges.js');
-        $scripts->addFile('replication.js');
-        $scripts->addFile('vendor/zxcvbn.js');
+        $this->addScriptFiles(['server/privileges.js', 'replication.js', 'vendor/zxcvbn.js']);
 
         if (isset($params['url_params']) && is_array($params['url_params'])) {
             $url_params = $params['url_params'];

diff --git a/libraries/classes/Controllers/Server/SqlController.php b/libraries/classes/Controllers/Server/SqlController.php
@@ -37,11 +37,7 @@ public function __construct($response, $dbi, Template $template, SqlQueryForm $s
 
     public function index(): void
     {
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('makegrid.js');
-        $scripts->addFile('vendor/jquery/jquery.uitablefilter.js');
-        $scripts->addFile('sql.js');
+        $this->addScriptFiles(['makegrid.js', 'vendor/jquery/jquery.uitablefilter.js', 'sql.js']);
 
         $pageSettings = new PageSettings('Sql');
         $this->response->addHTML($pageSettings->getErrorHTML());

diff --git a/libraries/classes/Controllers/Server/Status/MonitorController.php b/libraries/classes/Controllers/Server/Status/MonitorController.php
@@ -39,21 +39,21 @@ public function index(): void
     {
         Common::server();
 
-        $header = $this->response->getHeader();
-        $scripts = $header->getScripts();
-        $scripts->addFile('vendor/jquery/jquery.tablesorter.js');
-        $scripts->addFile('vendor/jquery/jquery.sortableTable.js');
-        $scripts->addFile('vendor/jqplot/jquery.jqplot.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.pieRenderer.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.enhancedPieLegendRenderer.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.canvasTextRenderer.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.canvasAxisLabelRenderer.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.dateAxisRenderer.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.highlighter.js');
-        $scripts->addFile('vendor/jqplot/plugins/jqplot.cursor.js');
-        $scripts->addFile('jqplot/plugins/jqplot.byteFormatter.js');
-        $scripts->addFile('server/status/monitor.js');
-        $scripts->addFile('server/status/sorter.js');
+        $this->addScriptFiles([
+            'vendor/jquery/jquery.tablesorter.js',
+            'vendor/jquery/jquery.sortableTable.js',
+            'vendor/jqplot/jquery.jqplot.js',
+            'vendor/jqplot/plugins/jqplot.pieRenderer.js',
+            'vendor/jqplot/plugins/jqplot.enhancedPieLegendRenderer.js',
+            'vendor/jqplot/plugins/jqplot.canvasTextRenderer.js',
+            'vendor/jqplot/plugins/jqplot.canvasAxisLabelRenderer.js',
+            'vendor/jqplot/plugins/jqplot.dateAxisRenderer.js',
+            'vendor/jqplot/plugins/jqplot.highlighter.js',
+            'vendor/jqplot/plugins/jqplot.cursor.js',
+            'jqplot/plugins/jqplot.byteFormatter.js',
+            'server/status/monitor.js',
+            'server/status/sorter.js',
+        ]);
 
         $form = [
             'server_time' => (int) (microtime(true) * 1000),