fix: incorrect phpdoc for Mutations (#220)

fix/mutations-phpdoc
colopl · Jun 11, 2024 · 1c46ef7 · 1c46ef7
1 parent 60d8e79
commit 1c46ef7
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/src/Concerns/ManagesMutations.php b/src/Concerns/ManagesMutations.php
@@ -37,7 +37,7 @@ abstract protected function getDatabaseContext(): Database|Transaction;
 
     /**
      * @param string $table
-     * @param array $dataSet
+     * @param list<array<string, mixed>>|array<string, mixed> $dataSet
      * @return void
      */
     public function insertUsingMutation(string $table, array $dataSet)
@@ -51,7 +51,7 @@ public function insertUsingMutation(string $table, array $dataSet)
 
     /**
      * @param string $table
-     * @param array $dataSet
+     * @param list<array<string, mixed>>|array<string, mixed> $dataSet
      * @return void
      */
     public function updateUsingMutation(string $table, array $dataSet)
@@ -65,7 +65,7 @@ public function updateUsingMutation(string $table, array $dataSet)
 
     /**
      * @param string $table
-     * @param array<string, mixed> $dataSet
+     * @param list<array<string, mixed>>|array<string, mixed> $dataSet
      * @return void
      */
     public function insertOrUpdateUsingMutation(string $table, array $dataSet)
@@ -109,8 +109,8 @@ protected function withTransactionEvents(callable $mutationCall)
     }
 
     /**
-     * @param array $dataSet
-     * @return array
+     * @param list<array<string, mixed>>|array<string, mixed> $dataSet
+     * @return list<array<string, mixed>>
      */
     protected function prepareForMutation(array $dataSet): array
     {
@@ -122,6 +122,7 @@ protected function prepareForMutation(array $dataSet): array
             $dataSet = [$dataSet];
         }
 
+        /** @var list<array<string, mixed>> $dataSet */
         foreach ($dataSet as $index => $values) {
             foreach ($values as $name => $value) {
                 if ($value instanceof DateTimeInterface) {

diff --git a/src/Events/MutatingData.php b/src/Events/MutatingData.php
@@ -33,15 +33,15 @@ class MutatingData extends ConnectionEvent
     public $command;
 
     /**
-     * @var array
+     * @var list<array<string, mixed>>
      */
     public $values;
 
     /**
      * @param Connection $connection
      * @param string $tableName
      * @param string $command
-     * @param array $values
+     * @param list<array<string, mixed>> $values
      */
     public function __construct($connection, string $tableName, string $command, array $values)
     {

diff --git a/src/Query/Concerns/UsesMutations.php b/src/Query/Concerns/UsesMutations.php
@@ -26,7 +26,7 @@
 trait UsesMutations
 {
     /**
-     * @param array<string, mixed> $values
+     * @param list<array<string, mixed>>|array<string, mixed> $values
      * @return void
      */
     public function insertUsingMutation(array $values)
@@ -35,7 +35,7 @@ public function insertUsingMutation(array $values)
     }
 
     /**
-     * @param array<string, mixed> $values
+     * @param list<array<string, mixed>>|array<string, mixed> $values
      * @return void
      */
     public function updateUsingMutation(array $values)
@@ -44,7 +44,7 @@ public function updateUsingMutation(array $values)
     }
 
     /**
-     * @param array<string, mixed> $values
+     * @param list<array<string, mixed>>|array<string, mixed> $values
      * @return void
      */
     public function insertOrUpdateUsingMutation(array $values)