return types iter

php-lock · Dec 3, 2024 · 7942bf1 · 7942bf1
1 parent 384e47b
commit 7942bf1
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 12 deletions.
diff --git a/src/exception/PhpLockException.php b/src/exception/PhpLockException.php
@@ -7,13 +7,13 @@
 /**
  * Common php-lock/lock exception interface.
  *
- * @method string          getMessage()
- * @method int             getCode()
- * @method string          getFile()
- * @method int             getLine()
- * @method array           getTrace()
- * @method string          getTraceAsString()
- * @method \Throwable|null getPrevious()
- * @method string          __toString()
+ * @method string                     getMessage()
+ * @method int                        getCode()
+ * @method string                     getFile()
+ * @method int                        getLine()
+ * @method list<array<string, mixed>> getTrace()
+ * @method string                     getTraceAsString()
+ * @method \Throwable|null            getPrevious()
+ * @method string                     __toString()
  */
 interface PhpLockException {}
diff --git a/tests/mutex/FlockMutexTest.php b/tests/mutex/FlockMutexTest.php
@@ -36,7 +36,7 @@ protected function tearDown(): void
     /**
      * @param FlockMutex::STRATEGY_* $strategy
      *
-     * @dataProvider dpTimeoutableStrategiesCases
+     * @dataProvider provideTimeoutableStrategiesCases
      */
     public function testCodeExecutedOutsideLockIsNotThrown(int $strategy): void
     {
@@ -52,7 +52,7 @@ public function testCodeExecutedOutsideLockIsNotThrown(int $strategy): void
     /**
      * @param FlockMutex::STRATEGY_* $strategy
      *
-     * @dataProvider dpTimeoutableStrategiesCases
+     * @dataProvider provideTimeoutableStrategiesCases
      */
     public function testTimeoutOccurs(int $strategy): void
     {
@@ -75,7 +75,10 @@ static function () {
         }
     }
 
-    public static function dpTimeoutableStrategiesCases(): iterable
+    /**
+     * @return iterable<list<mixed>>
+     */
+    public static function provideTimeoutableStrategiesCases(): iterable
     {
         return [
             [FlockMutex::STRATEGY_PCNTL],

diff --git a/tests/mutex/MutexConcurrencyTest.php b/tests/mutex/MutexConcurrencyTest.php
@@ -103,6 +103,8 @@ public function testHighContention(callable $code, callable $mutexFactory): void
 
     /**
      * Returns test cases for testHighContention().
+     *
+     * @return iterable<list<mixed>>
      */
     public function provideHighContentionCases(): iterable
     {

diff --git a/tests/mutex/PHPRedisMutexTest.php b/tests/mutex/PHPRedisMutexTest.php
@@ -220,6 +220,9 @@ public function testResistantToPartialClusterFailuresForReleasingLock(): void
         }));
     }
 
+    /**
+     * @return iterable<list<mixed>>
+     */
     public static function provideSerializersAndCompressorsCases(): iterable
     {
         if (!class_exists(\Redis::class)) {

diff --git a/tests/mutex/RedisMutexTest.php b/tests/mutex/RedisMutexTest.php
@@ -190,7 +190,7 @@ public function testTimingOut(int $count, float $timeout, float $delay): void
     /**
      * Returns test cases for testTimingOut().
      *
-     * @return array test cases
+     * @return iterable<list<mixed>>
      */
     public static function provideTimingOutCases(): iterable
     {

diff --git a/tests/mutex/TransactionalMutexTest.php b/tests/mutex/TransactionalMutexTest.php
@@ -30,6 +30,8 @@ public function testInvalidErrorMode(int $mode): void
 
     /**
      * Returns test cases for testInvalidErrorMode().
+     *
+     * @return iterable<list<mixed>>
      */
     public static function provideInvalidErrorModeCases(): iterable
     {
-Original file line number
+Diff line change
@@ Expand Up @@
         /**
          * Returns test cases for testHighContention().
+         *
+         * @return iterable<list<mixed>>
          */
         public function provideHighContentionCases(): iterable
         {
@@ Expand Down @@