Improve type declaration of Index::getCompareData method

MauricioFauth · MauricioFauth · commit 746d1696b703 · 2022-09-09T09:04:21.000-03:00
Signed-off-by: Maurício Meneghini Fauth &lt;mauricio@fauth.dev&gt;
diff --git a/libraries/classes/Index.php b/libraries/classes/Index.php
@@ -548,9 +548,20 @@ public function getColumns()
     /**
      * Gets the properties in an array for comparison purposes
      *
-     * @return array an array containing the properties of the index
-     */
-    public function getCompareData()
+     * @return array<string, array<int, array<string, int|string|null>>|string|null>
+     * @psalm-return array{
+     *   Packed: string|null,
+     *   Index_choice: string,
+     *   columns?: list<array{
+     *     Column_name: string,
+     *     Seq_in_index: int,
+     *     Collation: string|null,
+     *     Sub_part: int|null,
+     *     Null: string
+     *   }>
+     * }
+     */
+    public function getCompareData(): array
     {
         $data = [
             'Packed' => $this->packed,
diff --git a/libraries/classes/IndexColumn.php b/libraries/classes/IndexColumn.php
@@ -191,9 +191,16 @@ public function getSubPart()
     /**
      * Gets the properties in an array for comparison purposes
      *
-     * @return array an array containing the properties of the index column
+     * @return array<string, int|string|null>
+     * @psalm-return array{
+     *   Column_name: string,
+     *   Seq_in_index: int,
+     *   Collation: string|null,
+     *   Sub_part: int|null,
+     *   Null: string
+     * }
      */
-    public function getCompareData()
+    public function getCompareData(): array
     {
         return [
             'Column_name' => $this->name,
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -4210,11 +4210,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Index.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\Index\\:\\:getCompareData\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: libraries/classes/Index.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Index\\:\\:set\\(\\) has parameter \\$params with no value type specified in iterable type array\\.$#"
 			count: 1
@@ -4225,11 +4220,6 @@ parameters:
 			count: 1
 			path: libraries/classes/IndexColumn.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\IndexColumn\\:\\:getCompareData\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: libraries/classes/IndexColumn.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\IndexColumn\\:\\:set\\(\\) has parameter \\$params with no value type specified in iterable type array\\.$#"
 			count: 1
diff --git a/test/classes/IndexColumnTest.php b/test/classes/IndexColumnTest.php
@@ -45,7 +45,7 @@ public function testGetSubPart(): void
 
     public function testGetCompareData(): void
     {
-        $this->assertEquals(
+        $this->assertSame(
             ['Column_name' => '', 'Seq_in_index' => 1, 'Collation' => null, 'Sub_part' => null, 'Null' => ''],
             $this->object->getCompareData()
         );
@@ -56,7 +56,7 @@ public function testGetCompareData(): void
             'Sub_part' => 2,
             'Null' => 'NO',
         ]);
-        $this->assertEquals(
+        $this->assertSame(
             [
                 'Column_name' => 'name',
                 'Seq_in_index' => 2,
