Remove getUnsortedSqlAndSortByKeyDropDown()

kamil-tekiela · kamil-tekiela · commit e2dc2a9c8638 · 2021-12-26T23:10:34.000Z
This was stupid abstraction. This method did 2 things. When the code that prepares unsorted SQL is moved out of this method, the rest can be absorbed by getSortByKeyDropDown(). This method didn't declare any local variables, it took parameters that were just passed along to other methods. The code to get unsorted SQL was just a single instruction that was self-explanatory. Indexes relied on properties so they didn't need to be a parameter to the other method.

This method only added complexity instead of reducing it.

Signed-off-by: Kamil Tekiela &lt;tekiela246@gmail.com&gt;
diff --git a/libraries/classes/Display/Results.php b/libraries/classes/Display/Results.php
@@ -1176,61 +1176,29 @@ private function getTableHeaders(
         ];
     }
 
-    /**
-     * Prepare unsorted sql query and sort by key drop down
-     *
-     * @see getTableHeaders()
-     *
-     * @param array      $analyzedSqlResults analyzed sql results
-     * @param array|null $sortExpression     sort expression
-     *
-     * @return array     two element array - $unsorted_sql_query, $drop_down_html
-     * @psalm-return array{string, array{hidden_fields?: array, options?: array}}
-     */
-    private function getUnsortedSqlAndSortByKeyDropDown(
-        array $analyzedSqlResults,
-        ?array $sortExpression
-    ) {
-        $dropDownData = [];
-
-        $unsortedSqlQuery = Query::replaceClause(
-            $analyzedSqlResults['statement'],
-            $analyzedSqlResults['parser']->list,
-            'ORDER BY',
-            ''
-        );
-
-        // Data is sorted by indexes only if it there is only one table.
-        if ($this->isSelect($analyzedSqlResults)) {
-            // grab indexes data:
-            $indexes = Index::getFromTable($this->properties['table'], $this->properties['db']);
-
-            // do we have any index?
-            if ($indexes !== []) {
-                $dropDownData = $this->getSortByKeyDropDown($indexes, $sortExpression, $unsortedSqlQuery);
-            }
-        }
-
-        return [$unsortedSqlQuery, $dropDownData];
-    }
-
     /**
      * Prepare sort by key dropdown - html code segment
      *
      * @see getTableHeaders()
      *
-     * @param Index[]    $indexes          the indexes of the table for sort criteria
      * @param array|null $sortExpression   the sort expression
      * @param string     $unsortedSqlQuery the unsorted sql query
      *
      * @return array[]
-     * @psalm-return array{hidden_fields:array, options:array}
+     * @psalm-return array{hidden_fields?:array, options?:array}
      */
     private function getSortByKeyDropDown(
-        $indexes,
         ?array $sortExpression,
-        $unsortedSqlQuery
+        string $unsortedSqlQuery
     ): array {
+        // grab indexes data:
+        $indexes = Index::getFromTable($this->properties['table'], $this->properties['db']);
+
+        // do we have any index?
+        if ($indexes === []) {
+            return [];
+        }
+
         $hiddenFields = [
             'db' => $this->properties['db'],
             'table' => $this->properties['table'],
@@ -3706,11 +3674,20 @@ public function getTable(
         $sortByKeyData = [];
         // can the result be sorted?
         if ($displayParts['sort_lnk'] == '1' && isset($analyzedSqlResults['statement'])) {
-            // At this point, $sort_expression is an array
-            [$unsortedSqlQuery, $sortByKeyData] = $this->getUnsortedSqlAndSortByKeyDropDown(
-                $analyzedSqlResults,
-                $sortExpression
+            $unsortedSqlQuery = Query::replaceClause(
+                $analyzedSqlResults['statement'],
+                $analyzedSqlResults['parser']->list,
+                'ORDER BY',
+                ''
             );
+
+            // Data is sorted by indexes only if there is only one table.
+            if ($this->isSelect($analyzedSqlResults)) {
+                $sortByKeyData = $this->getSortByKeyDropDown(
+                    $sortExpression,
+                    $unsortedSqlQuery
+                );
+            }
         }
 
         $navigation = [];
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -3455,21 +3455,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Display/Results.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\Display\\\\Results\\:\\:getUnsortedSqlAndSortByKeyDropDown\\(\\) has parameter \\$analyzedSqlResults with no value type specified in iterable type array\\.$#"
-			count: 1
-			path: libraries/classes/Display/Results.php
-
-		-
-			message: "#^Method PhpMyAdmin\\\\Display\\\\Results\\:\\:getUnsortedSqlAndSortByKeyDropDown\\(\\) has parameter \\$sortExpression with no value type specified in iterable type array\\.$#"
-			count: 1
-			path: libraries/classes/Display/Results.php
-
-		-
-			message: "#^Method PhpMyAdmin\\\\Display\\\\Results\\:\\:getUnsortedSqlAndSortByKeyDropDown\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 2
-			path: libraries/classes/Display/Results.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Display\\\\Results\\:\\:getUrlSqlQuery\\(\\) has parameter \\$analyzedSqlResults with no value type specified in iterable type array\\.$#"
 			count: 1
