Add better type description for Index::$columns

MauricioFauth · MauricioFauth · commit a3ba333bfc93 · 2022-09-07T14:50:35.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
@@ -40,7 +40,7 @@ class Index
     /**
      * Columns in index
      *
-     * @var array
+     * @var array<string, IndexColumn>
      */
     private $columns = [];
 
@@ -239,7 +239,7 @@ private static function loadIndexes($table, $schema): bool
     /**
      * Add column to index
      *
-     * @param array $params column params
+     * @param string[] $params column params
      */
     public function addColumn(array $params): void
     {
@@ -556,7 +556,7 @@ public function setName($name): void
     /**
      * Returns the columns of the index
      *
-     * @return IndexColumn[] the columns of the index
+     * @return array<string, IndexColumn>
      */
     public function getColumns()
     {
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -4215,11 +4215,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Index.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\Index\\:\\:addColumn\\(\\) has parameter \\$params with no value type specified in iterable type array\\.$#"
-			count: 1
-			path: libraries/classes/Index.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Index\\:\\:addColumns\\(\\) has parameter \\$columns with no value type specified in iterable type array\\.$#"
 			count: 1
@@ -4235,11 +4230,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Index.php
 
-		-
-			message: "#^Property PhpMyAdmin\\\\Index\\:\\:\\$columns type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: libraries/classes/Index.php
-
 		-
 			message: "#^Static property PhpMyAdmin\\\\Index\\:\\:\\$registry \\(array\\<string, array\\<string, array\\<string, PhpMyAdmin\\\\Index\\>\\>\\>\\) does not accept array\\<string, array\\<string, array\\<int\\|string, PhpMyAdmin\\\\Index\\>\\>\\>\\.$#"
 			count: 1
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -7719,11 +7719,10 @@
     <DocblockTypeContradiction occurrences="1">
       <code>$this-&gt;packed === null</code>
     </DocblockTypeContradiction>
-    <MixedArgument occurrences="5">
+    <MixedArgument occurrences="4">
       <code>$_each_index</code>
       <code>$_each_index</code>
       <code>$column</code>
-      <code>$key</code>
       <code>$params['columns']</code>
     </MixedArgument>
     <MixedArrayAccess occurrences="1">
@@ -7737,11 +7736,8 @@
       <code>self::$registry[$schema][$table][$keyName]</code>
       <code>self::$registry[$schema][$table][$keyName]</code>
     </MixedArrayOffset>
-    <MixedAssignment occurrences="19">
-      <code>$column</code>
+    <MixedAssignment occurrences="16">
       <code>$column</code>
-      <code>$data['columns'][]</code>
-      <code>$key</code>
       <code>$key</code>
       <code>$keyName</code>
       <code>$name</code>
@@ -7758,19 +7754,9 @@
       <code>$this-&gt;table</code>
       <code>$this-&gt;type</code>
     </MixedAssignment>
-    <MixedMethodCall occurrences="1">
-      <code>getCompareData</code>
-    </MixedMethodCall>
-    <MixedOperand occurrences="1">
-      <code>$key</code>
-    </MixedOperand>
     <MixedPropertyTypeCoercion occurrences="1">
       <code>self::$registry</code>
     </MixedPropertyTypeCoercion>
-    <MixedReturnTypeCoercion occurrences="2">
-      <code>$this-&gt;columns</code>
-      <code>IndexColumn[]</code>
-    </MixedReturnTypeCoercion>
     <PossiblyNullPropertyAssignmentValue occurrences="3">
       <code>null</code>
       <code>null</code>
@@ -12797,9 +12783,6 @@
       <code>$_SESSION['tmpval']['pos']</code>
       <code>$_SESSION['tmpval']['possible_as_geometry']</code>
     </MixedArrayAssignment>
-    <MixedArrayTypeCoercion occurrences="1">
-      <code>$columns[$indexColumnName]</code>
-    </MixedArrayTypeCoercion>
     <MixedAssignment occurrences="16">
       <code>$maxRows</code>
       <code>$oneFieldMeta</code>

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ class Index`
`40`	`40`	`/**`
`41`	`41`	`* Columns in index`
`42`	`42`	`*`
`43`		`- * @var array`
	`43`	`+ * @var array<string, IndexColumn>`
`44`	`44`	`*/`
`45`	`45`	`private $columns = [];`
`46`	`46`
`@@ -239,7 +239,7 @@ private static function loadIndexes($table, $schema): bool`
`239`	`239`	`/**`
`240`	`240`	`* Add column to index`
`241`	`241`	`*`
`242`		`- * @param array $params column params`
	`242`	`+ * @param string[] $params column params`
`243`	`243`	`*/`
`244`	`244`	`public function addColumn(array $params): void`
`245`	`245`	`{`
`@@ -556,7 +556,7 @@ public function setName($name): void`
`556`	`556`	`/**`
`557`	`557`	`* Returns the columns of the index`
`558`	`558`	`*`
`559`		`- * @return IndexColumn[] the columns of the index`
	`559`	`+ * @return array<string, IndexColumn>`
`560`	`560`	`*/`
`561`	`561`	`public function getColumns()`
`562`	`562`	`{`