Add the void return type in Lock interfaces

Author: stof

BlockingSharedLockStoreInterface.php

@@ -21,6 +21,8 @@ interface BlockingSharedLockStoreInterface extends SharedLockStoreInterface
     /**
      * Waits until a key becomes free for reading, then stores the resource.
      *
+     * @return void
+     *
      * @throws LockConflictedException
      */
     public function waitAndSaveRead(Key $key);

BlockingStoreInterface.php

@@ -21,6 +21,8 @@ interface BlockingStoreInterface extends PersistingStoreInterface
     /**
      * Waits until a key becomes free, then stores the resource.
      *
+     * @return void
+     *
      * @throws LockConflictedException
      */
     public function waitAndSave(Key $key);

LockInterface.php

@@ -36,6 +36,8 @@ public function acquire(bool $blocking = false): bool;
      *
      * @param float|null $ttl Maximum expected lock duration in seconds
      *
+     * @return void
+     *
      * @throws LockConflictedException If the lock is acquired by someone else
      * @throws LockAcquiringException  If the lock cannot be refreshed
      */
@@ -49,6 +51,8 @@ public function isAcquired(): bool;
     /**
      * Release the lock.
      *
+     * @return void
+     *
      * @throws LockReleasingException If the lock cannot be released
      */
     public function release();

PersistingStoreInterface.php

@@ -23,6 +23,8 @@ interface PersistingStoreInterface
     /**
      * Stores the resource if it's not locked by someone else.
      *
+     * @return void
+     *
      * @throws LockAcquiringException
      * @throws LockConflictedException
      */
@@ -31,6 +33,8 @@ public function save(Key $key);
     /**
      * Removes a resource from the storage.
      *
+     * @return void
+     *
      * @throws LockReleasingException
      */
     public function delete(Key $key);
@@ -45,6 +49,8 @@ public function exists(Key $key): bool;
      *
      * @param float $ttl amount of seconds to keep the lock in the store
      *
+     * @return void
+     *
      * @throws LockConflictedException
      */
     public function putOffExpiration(Key $key, float $ttl);

SharedLockStoreInterface.php

@@ -21,6 +21,8 @@ interface SharedLockStoreInterface extends PersistingStoreInterface
     /**
      * Stores the resource if it's not locked for reading by someone else.
      *
+     * @return void
+     *
      * @throws LockConflictedException
      */
     public function saveRead(Key $key);

Tests/LockTest.php

@@ -472,16 +472,14 @@ public function testAcquireReadTwiceWithExpiration()
             private $keys = [];
             private $initialTtl = 30;
 
-            public function save(Key $key)
+            public function save(Key $key): void
             {
                 $key->reduceLifetime($this->initialTtl);
                 $this->keys[spl_object_hash($key)] = $key;
                 $this->checkNotExpired($key);
-
-                return true;
             }
 
-            public function delete(Key $key)
+            public function delete(Key $key): void
             {
                 unset($this->keys[spl_object_hash($key)]);
             }
@@ -491,7 +489,7 @@ public function exists(Key $key): bool
                 return isset($this->keys[spl_object_hash($key)]);
             }
 
-            public function putOffExpiration(Key $key, $ttl)
+            public function putOffExpiration(Key $key, $ttl): void
             {
                 $key->reduceLifetime($ttl);
                 $this->checkNotExpired($key);