Add scalar type hints, slight change of wording

Author: paveq

lib/internal/Magento/Framework/Lock/Backend/Database.php

@@ -4,15 +4,18 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
 namespace Magento\Framework\lock\Backend;
 
+use Magento\Framework\App\ResourceConnection;
+
 class Database implements \Magento\Framework\Lock\LockManagerInterface
 {
-    /** @var \Magento\Framework\App\ResourceConnection */
+    /** @var ResourceConnection */
     private $resource;
 
     public function __construct(
-        \Magento\Framework\App\ResourceConnection $resource
+        ResourceConnection $resource
     )
     {
         $this->resource = $resource;
@@ -22,9 +25,10 @@ public function __construct(
      * Sets a lock for name
      *
      * @param string $name lock name
+     * @param int $timeout How long to wait lock acquisition in seconds, negative value means infinite timeout
      * @return bool
      */
-    public function setLock($name, $timeout = -1)
+    public function setLock(string $name, int $timeout = -1): bool
     {
         return (bool)$this->resource->getConnection()->query("SELECT GET_LOCK(?, ?);", array((string)$name, (int)$timeout))
             ->fetchColumn();
@@ -36,7 +40,7 @@ public function setLock($name, $timeout = -1)
      * @param string $name lock name
      * @return bool
      */
-    public function releaseLock($name)
+    public function releaseLock(string $name): bool
     {
         return (bool)$this->resource->getConnection()->query("SELECT RELEASE_LOCK(?);", array((string)$name))->fetchColumn();
     }
@@ -47,7 +51,7 @@ public function releaseLock($name)
      * @param string $name lock name
      * @return bool
      */
-    public function isLocked($name)
+    public function isLocked(string $name): bool
     {
         return (bool)$this->resource->getConnection()->query("SELECT IS_USED_LOCK(?);", array((string)$name))->fetchColumn();
     }

lib/internal/Magento/Framework/Lock/LockManagerInterface.php

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+declare(strict_types=1);
 namespace Magento\Framework\Lock;
 
 /**
@@ -13,29 +15,30 @@
 interface LockManagerInterface
 {
     /**
-     * Sets a lock for name
+     * Sets a lock
      *
      * @param string $name lock name
-     * @param int $timeout Timeout in seconds, negative value means infinite timeout
+     * @param int $timeout How long to wait lock acquisition in seconds, negative value means infinite timeout
      * @return bool
+     * @api
      */
-    public function setLock($name, $timeout = -1);
+    public function setLock(string $name, int $timeout = -1): bool;
 
     /**
-     * Releases a lock for name
+     * Releases a lock
      *
      * @param string $name lock name
      * @return bool
      * @api
      */
-    public function releaseLock($name);
+    public function releaseLock(string $name): bool;
 
     /**
-     * Tests of lock is set for name
+     * Tests if lock is set
      *
      * @param string $name lock name
      * @return bool
      * @api
      */
-    public function isLocked($name);
+    public function isLocked(string $name): bool;
 }