template return callable types

Author: mvorisek

src/mutex/CASMutex.php

@@ -68,10 +68,11 @@ public function notify(): void
      * });
      * </code>
      *
-     * @param callable $code The synchronized execution block.
+     * @template T
+     * @param callable(): T $code The synchronized execution block.
      * @throws \Exception The execution block threw an exception.
      * @throws TimeoutException The timeout was reached.
-     * @return mixed The return value of the execution block.
+     * @return T The return value of the execution block.
      *
      */
     public function synchronized(callable $code)

src/mutex/Mutex.php

@@ -21,15 +21,16 @@ abstract class Mutex
      * The code block may throw an exception. In this case the lock will be
      * released as well.
      *
-     * @param callable $code The synchronized execution callback.
+     * @template T
+     * @param callable(): T $code The synchronized execution callback.
      * @throws \Exception The execution callback threw an exception.
      * @throws \malkusch\lock\exception\LockAcquireException The mutex could not
      * be acquired, no further side effects.
      * @throws \malkusch\lock\exception\LockReleaseException The mutex could not
      * be released, the code was already executed.
      * @throws \malkusch\lock\exception\ExecutionOutsideLockException Some code
      * has been executed outside of the lock.
-     * @return mixed The return value of the execution callback.
+     * @return T The return value of the execution callback.
      */
     abstract public function synchronized(callable $code);
 
@@ -48,7 +49,7 @@ abstract public function synchronized(callable $code);
      * });
      * </code>
      *
-     * @param callable $check Callback that decides if the lock should be
+     * @param callable(): bool $check Callback that decides if the lock should be
      * acquired and if the synchronized callback should be executed after
      * acquiring the lock.
      * @return \malkusch\lock\util\DoubleCheckedLocking The double-checked

src/mutex/TransactionalMutex.php

@@ -97,10 +97,11 @@ private static function checkAutocommit(\PDO $pdo): void
      * If the code throws any other exception, the transaction is rolled back
      * and won't  be replayed.
      *
-     * @param callable $code The synchronized execution block.
+     * @template T
+     * @param callable(): T $code The synchronized execution block.
      * @throws \Exception The execution block threw an exception.
      * @throws LockAcquireException The transaction was not commited.
-     * @return mixed The return value of the execution block.
+     * @return T The return value of the execution block.
      * @SuppressWarnings(PHPMD)
      */
     public function synchronized(callable $code)

src/util/DoubleCheckedLocking.php

@@ -20,7 +20,7 @@ class DoubleCheckedLocking
     private $mutex;
 
     /**
-     * @var callable The check.
+     * @var callable(): bool The check.
      */
     private $check;
 
@@ -29,7 +29,7 @@ class DoubleCheckedLocking
      *
      * @param \malkusch\lock\mutex\Mutex $mutex Provides methods for exclusive
      * code execution.
-     * @param callable $check Callback that decides if the lock should be
+     * @param callable(): bool $check Callback that decides if the lock should be
      * acquired and if the critical code callback should be executed after
      * acquiring the lock.
      */
@@ -48,7 +48,8 @@ public function __construct(Mutex $mutex, callable $check)
      * critical code callback to indicate that processing did not occure or has
      * failed. It is up to the user to decide the last point.
      *
-     * @param callable $code The critical code callback.
+     * @template T
+     * @param callable(): T $code The critical code callback.
      * @throws \Exception The execution callback or the check threw an
      * exception.
      * @throws \malkusch\lock\exception\LockAcquireException The mutex could not
@@ -57,7 +58,7 @@ public function __construct(Mutex $mutex, callable $check)
      * be released.
      * @throws \malkusch\lock\exception\ExecutionOutsideLockException Some code
      * has been executed outside of the lock.
-     * @return mixed Boolean false if check did not pass or mixed for what ever
+     * @return T|false Boolean false if check did not pass or mixed for what ever
      * the critical code callback returns.
      */
     public function then(callable $code)

src/util/Loop.php

@@ -76,11 +76,12 @@ public function end(): void
      *
      * If the code throws an exception it will stop repeating the execution.
      *
-     * @param callable $code The to be executed code callback.
+     * @template T
+     * @param callable(): T $code The to be executed code callback.
      * @throws \Exception The execution callback threw an exception.
      * @throws \malkusch\lock\exception\TimeoutException The timeout has been
      * reached.
-     * @return mixed The return value of the executed code callback.
+     * @return T The return value of the executed code callback.
      *
      */
     public function execute(callable $code)

src/util/PcntlTimeout.php

@@ -55,12 +55,13 @@ public function __construct(int $timeout)
      * method. It will interfer with your application and lead to unexpected
      * behaviour.
      *
-     * @param  callable $code Executed code block
+     * @template T
+     * @param  callable(): T $code Executed code block
      * @throws \malkusch\lock\exception\DeadlineException Running the code hit
      * the deadline.
      * @throws \malkusch\lock\exception\LockAcquireException Installing the
      * timeout failed.
-     * @return mixed Return value of the executed block
+     * @return T Return value of the executed block
      */
     public function timeBoxed(callable $code)
     {