FLAG_DO_NOT_THROW_EXCEPTIONS

Author: cheprasov

README.md

@@ -57,7 +57,7 @@ $Redis = ClientFactory::create([
  */
 function updateJsonInRedis(RedisClient $Redis, $key, array $array) {
     // Create new Lock instance
-    $Lock = new RedisLock($Redis, 'Lock_'.$key, RedisLock::FLAG_CATCH_EXCEPTIONS);
+    $Lock = new RedisLock($Redis, 'Lock_'.$key, RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS);
 
     // Acquire lock for 2 sec.
     // If lock has acquired in another thread then we will wait 3 second,
@@ -102,22 +102,22 @@ Create a new instance of RedisLock.
 1. RedisClient **$Redis** - Instanse of [RedisClient](https://github.com/cheprasov/php-redis-client)
 2. string **$key** - name of key in Redis storage. Only locks with the same name will compete with each other for lock.
 3. int **$flags**, default = 0
-   * `RedisLock::FLAG_CATCH_EXCEPTIONS` - use this flag, if you don't want catch exceptions by yourself. Do not use this flag, if you want have a full control on situation with locks. Default behavior without this flag - all Exceptions will be thrown.
+   * `RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS` - use this flag, if you don't want catch exceptions by yourself. Do not use this flag, if you want have a full control on situation with locks. Default behavior without this flag - all Exceptions will be thrown.
 
 ##### Example
 
 ```php
 $Lock = new RedisLock($Redis, 'lockName');
 // or
-$Lock = new RedisLock($Redis, 'lockName', RedisLock::FLAG_CATCH_EXCEPTIONS);
+$Lock = new RedisLock($Redis, 'lockName', RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS);
 
 ```
 
 #### `bool` RedisLock :: acquire ( `int|float` **$lockTime** , [ `float` **$waitTime** = 0 [, `float` **$sleep** = 0.005 ] ] )
 ---
 Try to acquire lock for `$lockTime` seconds.
 If lock has acquired in another thread then we will wait `$waitTime` seconds, until another thread release the lock.
-Otherwise method throws a exception (if `FLAG_CATCH_EXCEPTIONS` is not set) or result.
+Otherwise method throws a exception (if `FLAG_DO_NOT_THROW_EXCEPTIONS` is not set) or result.
 Returns `true` on success or `false` on failure.
 
 ##### Method Pameters

src/RedisLock/RedisLock.php

@@ -22,10 +22,17 @@ class RedisLock implements LockInterface {
     const VERSION = '1.0.1';
 
     /**
+     * @deprecated
+     * @see FLAG_DO_NOT_THROW_EXCEPTIONS
      * Catch Lock exceptions and return false or null as result
      */
     const FLAG_CATCH_EXCEPTIONS = 1;
 
+    /**
+     * Do not throw exception, return false or null as result
+     */
+    const FLAG_DO_NOT_THROW_EXCEPTIONS = 1;
+
     /**
      * Sleep time between wait iterations, in seconds
      */

test/Integration/RedisLockTest.php

@@ -113,7 +113,7 @@ public function test_RedisLock() {
 
     public function test_RedisLock_WithoutExceptions() {
         $key = static::TEST_KEY;
-        $RedisLock = new RedisLock(static::$Redis, $key, RedisLock::FLAG_CATCH_EXCEPTIONS);
+        $RedisLock = new RedisLock(static::$Redis, $key, RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS);
 
         $this->assertFalse($RedisLock->acquire(RedisLock::LOCK_MIN_TIME * 0.9));
         $this->assertTrue($RedisLock->acquire(self::LOCK_MIN_TIME * 2));

test/Unit/RedisLockTest.php

@@ -68,16 +68,16 @@ public function testMethod_isFlagExist() {
         $RedisLock = new RedisLock($this->getRedis(), $key);
         $this->assertSame(false, $Method->invoke(
             $RedisLock,
-            RedisLock::FLAG_CATCH_EXCEPTIONS
+            RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS
         ));
 
         $RedisLock = new RedisLock(
             $this->getRedis(), $key,
-            RedisLock::FLAG_CATCH_EXCEPTIONS
+            RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS
         );
         $this->assertSame(true, $Method->invoke(
             $RedisLock,
-            RedisLock::FLAG_CATCH_EXCEPTIONS
+            RedisLock::FLAG_DO_NOT_THROW_EXCEPTIONS
         ));
     }