Fix typo

symfony · jderusse · Dec 28, 2016 · Feb 17, 2017 · Feb 22, 2017 · Feb 28, 2017
commit 48c998a097e8c71d90c5e8b508d21c8b866f2db1
diff --git a/src/Symfony/Component/Lock/Exception/NotSupportedException.php b/src/Symfony/Component/Lock/Exception/NotSupportedException.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Lock\Exception;
 
 /**
- * NotSupportedException is thrown when a unsupported method is called.
+ * NotSupportedException is thrown when an unsupported method is called.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */

diff --git a/src/Symfony/Component/Lock/Factory.php b/src/Symfony/Component/Lock/Factory.php
@@ -16,7 +16,7 @@
 use Psr\Log\NullLogger;
 
 /**
- * Factory provide method to create locks.
+ * Factory provides method to create locks.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
@@ -34,12 +34,12 @@ public function __construct(StoreInterface $store)
     }
 
     /**
-     * Create a lock for the given resource.
+     * Creates a lock for the given resource.
      *
      * @param string $resource The resource to lock
      * @param float  $ttl      maximum expected lock duration
      *
-     * @return LockInterface
+     * @return Lock
      */
     public function createLock($resource, $ttl = 300.0)
     {

diff --git a/src/Symfony/Component/Lock/Key.php b/src/Symfony/Component/Lock/Key.php
@@ -61,6 +61,11 @@ public function removeState($stateKey)
         unset($this->state[$stateKey]);
     }
 
+    /**
+     * @param $stateKey
+     *
+     * @return mixed
+     */
     public function getState($stateKey)
     {
         return $this->state[$stateKey];

diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -58,23 +58,23 @@ public function acquire($blocking = false)
                 $this->store->waitAndSave($this->key);
             }
 
-            $this->logger->info('Lock successfully acquired for "{resource}"', array('resource' => $this->key));
+            $this->logger->info('Lock successfully acquired for "{resource}".', array('resource' => $this->key));
 
             if ($this->ttl) {
                 $this->refresh();
             }
 
             return true;
         } catch (LockConflictedException $e) {
-            $this->logger->warning('Failed to lock the "{resource}". Someone else already acquired the lock', array('resource' => $this->key));
+            $this->logger->warning('Failed to lock the "{resource}". Someone else already acquired the lock.', array('resource' => $this->key));
 
             if ($blocking) {
                 throw $e;
             }
 
             return false;
         } catch (\Exception $e) {
-            $this->logger->warning('Failed to lock the "{resource}"', array('resource' => $this->key, 'exception' => $e));
+            $this->logger->warning('Failed to lock the "{resource}".', array('resource' => $this->key, 'exception' => $e));
             throw new LockAcquiringException('', 0, $e);
         }
     }
@@ -85,17 +85,17 @@ public function acquire($blocking = false)
     public function refresh()
     {
         if (!$this->ttl) {
-            throw new InvalidArgumentException('You have to define an expiration duration');
+            throw new InvalidArgumentException('You have to define an expiration duration.');
         }
 
         try {
             $this->store->putOffExpiration($this->key, $this->ttl);
-            $this->logger->info('Expiration defined for "{resource}" lock for "{ttl}" seconds', array('resource' => $this->key, 'ttl' => $this->ttl));
+            $this->logger->info('Expiration defined for "{resource}" lock for "{ttl}" seconds.', array('resource' => $this->key, 'ttl' => $this->ttl));
         } catch (LockConflictedException $e) {
-            $this->logger->warning('Failed to define an expiration for the "{resource}" lock, someone else acquired the lock', array('resource' => $this->key));
+            $this->logger->warning('Failed to define an expiration for the "{resource}" lock, someone else acquired the lock.', array('resource' => $this->key));
             throw $e;
         } catch (\Exception $e) {
-            $this->logger->warning('Failed to define an expiration for the "{resource}" lock', array('resource' => $this->key, 'exception' => $e));
+            $this->logger->warning('Failed to define an expiration for the "{resource}" lock.', array('resource' => $this->key, 'exception' => $e));
             throw new LockAcquiringException('', 0, $e);
         }
     }
@@ -116,7 +116,7 @@ public function release()
         $this->store->delete($this->key);
 
         if ($this->store->exists($this->key)) {
-            $this->logger->warning('Failed to release the "{resource}" lock', array('resource' => $this->key));
+            $this->logger->warning('Failed to release the "{resource}" lock.', array('resource' => $this->key));
             throw new LockReleasingException();
         }
     }

diff --git a/src/Symfony/Component/Lock/Store/CombinedStore.php b/src/Symfony/Component/Lock/Store/CombinedStore.php
@@ -81,7 +81,7 @@ public function save(Key $key)
             return;
         }
 
-        $this->logger->warning('Failed to store the "{resource}" lock. Quorum has not been met', array('resource' => $key, 'success' => $successCount, 'failure' => $failureCount));
+        $this->logger->warning('Failed to store the "{resource}" lock. Quorum has not been met.', array('resource' => $key, 'success' => $successCount, 'failure' => $failureCount));
 
         // clean up potential locks
         $this->delete($key);
@@ -91,7 +91,7 @@ public function save(Key $key)
 
     public function waitAndSave(Key $key)
     {
-        throw new NotSupportedException(sprintf('The store "%s" does not supports blocking locks', get_class($this)));
+        throw new NotSupportedException(sprintf('The store "%s" does not supports blocking locks.', get_class($this)));
     }
 
     /**
@@ -121,7 +121,7 @@ public function putOffExpiration(Key $key, $ttl)
             return;
         }
 
-        $this->logger->warning('Failed to define the expiration for the "{resource}" lock. Quorum has not been met', array('resource' => $key, 'success' => $successCount, 'failure' => $failureCount));
+        $this->logger->warning('Failed to define the expiration for the "{resource}" lock. Quorum has not been met.', array('resource' => $key, 'success' => $successCount, 'failure' => $failureCount));
 
         // clean up potential locks
         $this->delete($key);

diff --git a/src/Symfony/Component/Lock/Store/MemcachedStore.php b/src/Symfony/Component/Lock/Store/MemcachedStore.php
@@ -68,7 +68,7 @@ public function save(Key $key)
 
     public function waitAndSave(Key $key)
     {
-        throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks', get_class($this)));
+        throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks.', get_class($this)));
     }
 
     /**
@@ -80,7 +80,7 @@ public function putOffExpiration(Key $key, $ttl)
             throw new InvalidArgumentException(sprintf('%s() expects a TTL greater or equals to 1. Got %s.', __METHOD__, $ttl));
         }
 
-        // Interface define a float value but Store required an integer.
+        // Interface defines a float value but Store required an integer.
         $ttl = (int) ceil($ttl);
 
         $token = $this->getToken($key);

diff --git a/src/Symfony/Component/Lock/Store/RedisStore.php b/src/Symfony/Component/Lock/Store/RedisStore.php
@@ -65,7 +65,7 @@ public function save(Key $key)
 
     public function waitAndSave(Key $key)
     {
-        throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks', get_class($this)));
+        throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks.', get_class($this)));
     }
 
     /**
@@ -112,7 +112,7 @@ public function exists(Key $key)
     }
 
     /**
-     * Evaluate a script in the corresponding redis client.
+     * Evaluates a script in the corresponding redis client.
      *
      * @param string $script
      * @param string $resource
@@ -135,7 +135,7 @@ private function evaluate($script, $resource, array $args)
     }
 
     /**
-     * Retrieve an unique token for the given key.
+     * Retrieves an unique token for the given key.
      *
      * @param Key $key
      *

diff --git a/src/Symfony/Component/Lock/Store/SemaphoreStore.php b/src/Symfony/Component/Lock/Store/SemaphoreStore.php
@@ -62,7 +62,7 @@ private function lock(Key $key, $blocking)
 
         if (PHP_VERSION_ID < 50601) {
             if (!$blocking) {
-                throw new NotSupportedException(sprintf('The store "%s" does not supports non blocking locks', get_class($this)));
+                throw new NotSupportedException(sprintf('The store "%s" does not supports non blocking locks.', get_class($this)));
             }
 
             $acquired = sem_acquire($resource);

diff --git a/src/Symfony/Component/Lock/StoreInterface.php b/src/Symfony/Component/Lock/StoreInterface.php
@@ -31,9 +31,9 @@ interface StoreInterface
     public function save(Key $key);
 
     /**
-     * Wait a key becomes free, then stores the resource.
+     * Waits a key becomes free, then stores the resource.
      *
-     * If the store does not supports this feature it should thrown an NotSupportedException.
+     * If the store does not support this feature it should throw a NotSupportedException.
      *
      * @param Key $key key to lock
      *
@@ -45,7 +45,7 @@ public function waitAndSave(Key $key);
     /**
      * Extends the ttl of a resource.
      *
-     * If the store does not supports this feature it should thrown an NotSupportedException.
+     * If the store does not support this feature it should throw a NotSupportedException.
      *
      * @param Key   $key key to lock
      * @param float $ttl amount of second to keep the lock in the store