PHP 7.1 changes.

- Add argument and return type hints to all methods and anonymous functions
- Remove usage of call_user_func() where possible
- Update risky tests
- Remove deprecated MemcacheMutex class
- Change constructor of DoubleCheckedLocking to prevent initialization errors

Author: willemstuursma

.gitignore

@@ -1,3 +1,4 @@
+/.idea
 /vendor
 /composer.lock
 /phpunit.xml

classes/mutex/CASMutex.php

@@ -33,15 +33,15 @@ class CASMutex extends Mutex
      * @param int $timeout The timeout in seconds.
      * @throws \LengthException The timeout must be greater than 0.
      */
-    public function __construct($timeout = 3)
+    public function __construct(int $timeout = 3)
     {
         $this->loop = new Loop($timeout);
     }
 
     /**
      * Notifies the Mutex about a successful CAS operation.
      */
-    public function notify()
+    public function notify(): void
     {
         $this->loop->end();
     }

classes/mutex/FlockMutex.php

@@ -58,7 +58,7 @@ class FlockMutex extends LockMutex
      * @param resource $fileHandle The file handle.
      * @param int $timeout
      */
-    public function __construct($fileHandle, $timeout = self::INFINITE_TIMEOUT)
+    public function __construct($fileHandle, int $timeout = self::INFINITE_TIMEOUT)
     {
         if (!is_resource($fileHandle)) {
             throw new \InvalidArgumentException("The file handle is not a valid resource.");
@@ -85,7 +85,7 @@ private function determineLockingStrategy()
     /**
      * @throws LockAcquireException
      */
-    private function lockBlocking()
+    private function lockBlocking(): void
     {
         if (!flock($this->fileHandle, LOCK_EX)) {
             throw new LockAcquireException("Failed to lock the file.");
@@ -96,13 +96,13 @@ private function lockBlocking()
      * @throws LockAcquireException
      * @throws TimeoutException
      */
-    private function lockPcntl()
+    private function lockPcntl(): void
     {
         $timebox = new PcntlTimeout($this->timeout);
 
         try {
             $timebox->timeBoxed(
-                function () {
+                function (): void {
                     $this->lockBlocking();
                 }
             );
@@ -118,7 +118,7 @@ function () {
     private function lockBusy()
     {
         $loop = new Loop($this->timeout);
-        $loop->execute(function () use ($loop) {
+        $loop->execute(function () use ($loop): void {
             if ($this->acquireNonBlockingLock()) {
                 $loop->end();
             }
@@ -129,7 +129,7 @@ private function lockBusy()
      * @return bool
      * @throws LockAcquireException
      */
-    private function acquireNonBlockingLock()
+    private function acquireNonBlockingLock(): bool
     {
         if (!flock($this->fileHandle, LOCK_EX | LOCK_NB, $wouldBlock)) {
             if ($wouldBlock) {
@@ -147,7 +147,7 @@ private function acquireNonBlockingLock()
      * @throws LockAcquireException
      * @throws TimeoutException
      */
-    protected function lock()
+    protected function lock(): void
     {
         switch ($this->strategy) {
             case self::STRATEGY_BLOCK:
@@ -167,7 +167,7 @@ protected function lock()
     /**
      * @throws LockReleaseException
      */
-    protected function unlock()
+    protected function unlock(): void
     {
         if (!flock($this->fileHandle, LOCK_UN)) {
             throw new LockReleaseException("Failed to unlock the file.");

classes/mutex/LockMutex.php

@@ -23,20 +23,20 @@ abstract class LockMutex extends Mutex
      *
      * @throws LockAcquireException The lock could not be acquired.
      */
-    abstract protected function lock();
+    abstract protected function lock(): void;
 
     /**
      * Releases the lock.
      *
      * @throws LockReleaseException The lock could not be released.
      */
-    abstract protected function unlock();
+    abstract protected function unlock(): void;
 
     public function synchronized(callable $code)
     {
         $this->lock();
         try {
-            return call_user_func($code);
+            return $code();
         } finally {
             $this->unlock();
         }

classes/mutex/MemcacheMutex.php

@@ -37,25 +37,19 @@ class MemcachedMutex extends SpinlockMutex
      *
      * @throws \LengthException The timeout must be greater than 0.
      */
-    public function __construct($name, Memcached $memcache, $timeout = 3)
+    public function __construct(string $name, Memcached $memcache, int $timeout = 3)
     {
         parent::__construct($name, $timeout);
 
         $this->memcache = $memcache;
     }
 
-    /**
-     * @internal
-     */
-    protected function acquire($key, $expire)
+    protected function acquire(string $key, int $expire): bool
     {
         return $this->memcache->add($key, true, $expire);
     }
 
-    /**
-     * @internal
-     */
-    protected function release($key)
+    protected function release(string $key): bool
     {
         return $this->memcache->delete($key);
     }

classes/mutex/MemcachedMutex.php

@@ -54,10 +54,8 @@ abstract public function synchronized(callable $code);
      *
      * @return DoubleCheckedLocking The double-checked locking pattern.
      */
-    public function check(callable $check)
+    public function check(callable $check): DoubleCheckedLocking
     {
-        $doubleCheckedLocking = new DoubleCheckedLocking($this);
-        $doubleCheckedLocking->setCheck($check);
-        return $doubleCheckedLocking;
+        return new DoubleCheckedLocking($this, $check);
     }
 }

classes/mutex/Mutex.php

@@ -21,7 +21,7 @@ class MySQLMutex extends LockMutex
      */
     private $timeout;
 
-    public function __construct(\PDO $PDO, $name, $timeout = 0)
+    public function __construct(\PDO $PDO, string $name, int $timeout = 0)
     {
         $this->pdo = $PDO;
 
@@ -36,7 +36,7 @@ public function __construct(\PDO $PDO, $name, $timeout = 0)
     /**
      * @throws LockAcquireException
      */
-    public function lock()
+    public function lock(): void
     {
         $statement = $this->pdo->prepare("SELECT GET_LOCK(?,?)");
 
@@ -65,7 +65,7 @@ public function lock()
         throw TimeoutException::create($this->timeout);
     }
 
-    public function unlock()
+    public function unlock(): void
     {
         $statement = $this->pdo->prepare("DO RELEASE_LOCK(?)");
         $statement->execute([

classes/mutex/MySQLMutex.php

@@ -14,9 +14,9 @@
  */
 class NoMutex extends Mutex
 {
-    
+
     public function synchronized(callable $code)
     {
-        return call_user_func($code);
+        return $code();
     }
 }

classes/mutex/NoMutex.php

@@ -32,15 +32,12 @@ class PHPRedisMutex extends RedisMutex
      *
      * @throws \LengthException The timeout must be greater than 0.
      */
-    public function __construct(array $redisAPIs, $name, $timeout = 3)
+    public function __construct(array $redisAPIs, string $name, int $timeout = 3)
     {
         parent::__construct($redisAPIs, $name, $timeout);
     }
 
-    /**
-     * @internal
-     */
-    protected function add($redis, $key, $value, $expire)
+    protected function add($redis, string $key, string $value, int $expire): bool
     {
         /** @var Redis $redis */
         try {
@@ -56,10 +53,7 @@ protected function add($redis, $key, $value, $expire)
         }
     }
 
-    /**
-     * @internal
-     */
-    protected function evalScript($redis, $script, $numkeys, array $arguments)
+    protected function evalScript($redis, string $script, int $numkeys, array $arguments)
     {
         /** @var Redis $redis */