Apply PHP 7.4 syntax and typed property

Signed-off-by: Abdul Malik Ikhsan <samsonasik@gmail.com>
laminas · Aug 11, 2022 · ee55742 · ee55742
1 parent 458095e
commit ee55742
Show file tree

Hide file tree

Showing 33 changed files with 99 additions and 106 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -928,7 +928,7 @@
       <code>$event</code>
     </MissingClosureParamType>
     <MissingClosureReturnType occurrences="1">
-      <code>function ($event) use ($retVal) {</code>
+      <code>static function ($event) use ($retVal) {</code>
     </MissingClosureReturnType>
     <MixedArgument occurrences="1">
       <code>$success</code>

diff --git a/src/Command/DeprecatedStorageFactoryConfigurationCheckCommand.php b/src/Command/DeprecatedStorageFactoryConfigurationCheckCommand.php
@@ -44,10 +44,9 @@ final class DeprecatedStorageFactoryConfigurationCheckCommand extends Command
     . ' https://docs.laminas.dev/laminas-cache/storage/adapter/#quick-start';
 
     /** @var ArrayAccess<string,mixed> */
-    private $projectConfiguration;
+    private ArrayAccess $projectConfiguration;
 
-    /** @var DeprecatedSchemaDetectorInterface */
-    private $deprecatedSchemaDetector;
+    private DeprecatedSchemaDetectorInterface $deprecatedSchemaDetector;
 
     public function __construct(
         ArrayAccess $projectConfiguration,

diff --git a/src/Pattern/CaptureCache.php b/src/Pattern/CaptureCache.php
@@ -40,7 +40,7 @@ public function start($pageId = null)
             $pageId = $this->detectPageId();
         }
 
-        ob_start(function ($content) use ($pageId) {
+        ob_start(function ($content) use ($pageId): bool {
             $this->set($content, $pageId);
 
             // http://php.net/manual/function.ob-start.php

diff --git a/src/Psr/CacheItemPool/CacheItem.php b/src/Psr/CacheItemPool/CacheItem.php
@@ -16,10 +16,8 @@ final class CacheItem implements CacheItemInterface
 {
     /**
      * Cache key
-     *
-     * @var string
      */
-    private $key;
+    private string $key;
 
     /**
      * Cache value
@@ -30,20 +28,15 @@ final class CacheItem implements CacheItemInterface
 
     /**
      * True if the cache item lookup resulted in a cache hit or if they item is deferred or successfully saved
-     *
-     * @var bool
      */
-    private $isHit = false;
+    private bool $isHit = false;
 
     /**
      * Timestamp item will expire at if expiresAt() called, null otherwise
-     *
-     * @var int|null
      */
-    private $expiration;
+    private ?int $expiration = null;
 
-    /** @var DateTimeZone */
-    private $utc;
+    private DateTimeZone $utc;
 
     /**
      * @param string $key

diff --git a/src/Psr/CacheItemPool/CacheItemPoolDecorator.php b/src/Psr/CacheItemPool/CacheItemPoolDecorator.php
@@ -41,11 +41,10 @@ class CacheItemPoolDecorator implements CacheItemPoolInterface
     use MaximumKeyLengthTrait;
     use SerializationTrait;
 
-    /** @var StorageInterface */
-    private $storage;
+    private StorageInterface $storage;
 
     /** @var array<string,CacheItem> */
-    private $deferred = [];
+    private array $deferred = [];
 
     /**
      * PSR-6 requires that all implementing libraries support TTL so the given storage adapter must also support static

diff --git a/src/Psr/SimpleCache/SimpleCacheDecorator.php b/src/Psr/SimpleCache/SimpleCacheDecorator.php
@@ -42,22 +42,21 @@ class SimpleCacheDecorator implements SimpleCacheInterface
      */
     public const INVALID_KEY_CHARS = ':@{}()/\\';
 
-    /** @var bool */
-    private $providesPerItemTtl = true;
+    private bool $providesPerItemTtl = true;
 
-    /** @var StorageInterface */
-    private $storage;
+    private StorageInterface $storage;
 
     /**
      * Reference used by storage when calling getItem() to indicate status of
      * operation.
      *
      * @var null|bool
+     *
+     * Use ?bool type make it unserialized, even with null initialized
      */
     private $success;
 
-    /** @var DateTimeZone */
-    private $utc;
+    private DateTimeZone $utc;
 
     public function __construct(StorageInterface $storage)
     {
@@ -92,7 +91,7 @@ public function get($key, $default = null)
             throw static::translateThrowable($e);
         }
 
-        $result = $result ?? $default;
+        $result ??= $default;
         return $this->success ? $result : $default;
     }
 

diff --git a/src/Service/StorageAdapterFactory.php b/src/Service/StorageAdapterFactory.php
@@ -6,6 +6,7 @@
 
 use InvalidArgumentException;
 use Laminas\Cache\Exception;
+use Laminas\Cache\Service\StoragePluginFactoryInterface;
 use Laminas\Cache\Storage\PluginAwareInterface;
 use Laminas\Cache\Storage\StorageInterface;
 use Laminas\ServiceManager\PluginManagerInterface;
@@ -23,11 +24,9 @@ final class StorageAdapterFactory implements StorageAdapterFactoryInterface
 {
     public const DEFAULT_PLUGIN_PRIORITY = 1;
 
-    /** @var PluginManagerInterface */
-    private $adapters;
+    private PluginManagerInterface $adapters;
 
-    /** @var StoragePluginFactoryInterface */
-    private $pluginFactory;
+    private StoragePluginFactoryInterface $pluginFactory;
 
     public function __construct(PluginManagerInterface $adapters, StoragePluginFactoryInterface $pluginFactory)
     {

diff --git a/src/Service/StoragePluginFactory.php b/src/Service/StoragePluginFactory.php
@@ -14,8 +14,7 @@
 
 final class StoragePluginFactory implements StoragePluginFactoryInterface
 {
-    /** @var PluginManagerInterface */
-    private $plugins;
+    private PluginManagerInterface $plugins;
 
     public function __construct(PluginManagerInterface $plugins)
     {

diff --git a/src/Storage/Adapter/AdapterOptions.php b/src/Storage/Adapter/AdapterOptions.php
@@ -288,7 +288,7 @@ protected function normalizeTtl(&$ttl)
     public function toArray()
     {
         $array     = [];
-        $transform = function ($letters) {
+        $transform = static function ($letters): string {
             $letter = array_shift($letters);
             return '_' . strtolower($letter);
         };

diff --git a/src/Storage/PluginManager.php b/src/Storage/PluginManager.php
@@ -64,7 +64,7 @@ final class PluginManager extends AbstractPluginManager
      */
     public function build($name, ?array $options = null)
     {
-        $options = $options ?? [];
+        $options ??= [];
         /** @psalm-suppress MixedAssignment */
         $plugin = parent::build($name);
         if ($options !== [] && $plugin instanceof PluginInterface) {

diff --git a/test/Pattern/CallbackCacheTest.php b/test/Pattern/CallbackCacheTest.php
@@ -79,7 +79,7 @@ public function testGenerateKey(): void
 
         $generatedKey = $this->pattern->generateKey($callback, $args);
         $usedKey      = null;
-        $this->storage->getEventManager()->attach('setItem.pre', function ($event) use (&$usedKey) {
+        $this->storage->getEventManager()->attach('setItem.pre', static function ($event) use (&$usedKey): void {
             $params  = $event->getParams();
             $usedKey = $params['key'];
         });

diff --git a/test/Pattern/ObjectCacheTest.php b/test/Pattern/ObjectCacheTest.php
@@ -71,7 +71,7 @@ public function testGenerateKey(): void
 
         $generatedKey = $this->pattern->generateKey('emptyMethod', $args);
         $usedKey      = null;
-        $this->storage->getEventManager()->attach('setItem.pre', function ($event) use (&$usedKey) {
+        $this->storage->getEventManager()->attach('setItem.pre', static function ($event) use (&$usedKey): void {
             $params  = $event->getParams();
             $usedKey = $params['key'];
         });

diff --git a/test/Psr/CacheItemPool/CacheItemPoolDecoratorTest.php b/test/Psr/CacheItemPool/CacheItemPoolDecoratorTest.php
@@ -35,11 +35,10 @@ final class CacheItemPoolDecoratorTest extends TestCase
     /** @var StorageInterface&FlushableInterface&MockObject */
     private $storage;
 
-    /** @var CacheItemPoolDecorator */
-    private $adapter;
+    private ?CacheItemPoolDecorator $adapter;
 
     /** @var array<string,bool|string> */
-    private $requiredTypes = [
+    private array $requiredTypes = [
         'NULL'     => true,
         'boolean'  => true,
         'integer'  => true,
@@ -163,6 +162,8 @@ public function testGetDeferredItem(): void
             ->with('foo')
             ->willReturnOnConsecutiveCalls(null);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         $item    = $adapter->getItem('foo');
         $item->set('bar');
@@ -240,6 +241,8 @@ public function testGetDeferredItems(): void
             ->with($keys)
             ->willReturn([]);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         $items   = $adapter->getItems($keys);
         foreach ($items as $item) {
@@ -275,6 +278,8 @@ public function testGetItemsInvalidKeyThrowsException(): void
     {
         $this->expectException(InvalidArgumentException::class);
         $keys = ['ok'] + $this->getInvalidKeys();
+
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         $this->adapter->getItems($keys);
     }
 
@@ -412,6 +417,8 @@ public function testSaveForeignItemThrowsException(): void
     {
         $this->expectException(InvalidArgumentException::class);
         $item = $this->createMock(CacheItemInterface::class);
+
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         $this->adapter->save($item);
     }
 
@@ -490,6 +497,8 @@ public function testHasDeferredItemReturnsTrue(): void
             ->with('foo')
             ->willReturn(null);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         $item    = $adapter->getItem('foo');
         $adapter->saveDeferred($item);
@@ -511,6 +520,8 @@ public function testHasExpiredDeferredItemReturnsFalse(): void
             ->with('foo')
             ->willReturn(false);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         $item    = $adapter->getItem('foo');
         $item->set('bar');
@@ -526,6 +537,7 @@ public function testHasExpiredDeferredItemReturnsFalse(): void
     public function testHasItemInvalidKeyThrowsException($key)
     {
         $this->expectException(InvalidArgumentException::class);
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         $this->adapter->hasItem($key);
     }
 
@@ -714,6 +726,7 @@ public function testDeleteDeferredItem(): void
     public function testDeleteItemInvalidKeyThrowsException($key)
     {
         $this->expectException(InvalidArgumentException::class);
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         $this->adapter->deleteItem($key);
     }
 
@@ -760,6 +773,8 @@ public function testDeleteDeferredItems(): void
             ->withConsecutive(['foo'], ['bar'])
             ->willReturn(false);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         foreach ($keys as $key) {
             $item = $adapter->getItem($key);
@@ -777,6 +792,7 @@ public function testDeleteItemsInvalidKeyThrowsException(): void
     {
         $this->expectException(InvalidArgumentException::class);
         $keys = ['ok'] + $this->getInvalidKeys();
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         $this->adapter->deleteItems($keys);
     }
 
@@ -803,6 +819,8 @@ public function testDeleteItemsInvalidArgumentExceptionRethrown(): void
 
     public function testSaveDeferredReturnsTrue(): void
     {
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         $item    = $adapter->getItem('foo');
         self::assertTrue($adapter->saveDeferred($item));
@@ -812,6 +830,7 @@ public function testSaveDeferredForeignItemThrowsException(): void
     {
         $this->expectException(InvalidArgumentException::class);
         $item = $this->createMock(CacheItemInterface::class);
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         $this->adapter->saveDeferred($item);
     }
 
@@ -832,6 +851,7 @@ public function testCommitReturnsTrue(): void
 
     public function testCommitEmptyReturnsTrue(): void
     {
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         self::assertTrue($this->adapter->commit());
     }
 
@@ -843,6 +863,8 @@ public function testCommitRuntimeExceptionReturnsFalse(): void
             ->method('setItems')
             ->willThrowException(new Exception\RuntimeException());
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $adapter = $this->adapter;
         $item    = $adapter->getItem('foo');
         $adapter->saveDeferred($item);
@@ -855,9 +877,7 @@ public function testCommitRuntimeExceptionReturnsFalse(): void
      */
     public function invalidKeyProvider(): array
     {
-        return array_map(function ($v) {
-            return [$v];
-        }, $this->getInvalidKeys());
+        return array_map(static fn($v) => [$v], $this->getInvalidKeys());
     }
 
     /**
@@ -887,6 +907,7 @@ private function getAdapter(StorageInterface $storage): CacheItemPoolDecorator
     protected function tearDown(): void
     {
         try {
+            assert($this->adapter instanceof CacheItemPoolDecorator);
             $this->adapter->clear();
         } catch (Throwable $throwable) {
             /** Cleanup deferred items as {@see CacheItemPoolDecorator::__destruct} is gonna try to store them. */
@@ -909,6 +930,7 @@ public function testCanHandleRemoveItemsReturningNonArray(): void
             ->with(['foo'])
             ->willReturn(null);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         self::assertFalse($this->adapter->deleteItems(['foo']));
     }
 
@@ -931,6 +953,7 @@ public function testWillVerifyKeyExistenceByUsingHasItemsWhenDeletionWasNotSucce
             ->with(['foo'])
             ->willReturn(['foo' => $exists]);
 
+        assert($this->adapter instanceof CacheItemPoolDecorator);
         self::assertEquals($successful, $this->adapter->deleteItems(['foo']));
     }
 
@@ -1039,6 +1062,9 @@ public function testKeepsDeferredItemsWhenCommitFails(): void
         $failedItem1   = new CacheItem('keyOfFailedItem1', 'foo', false);
         $failedItem2   = new CacheItem('keyOfFailedItem2', 'foo', false);
         $succeededItem = new CacheItem('keyOfSucceededItem', 'foo', false);
+
+        assert($this->adapter instanceof CacheItemPoolDecorator);
+
         $this->adapter->saveDeferred($failedItem1);
         $this->adapter->saveDeferred($failedItem2);
         $this->adapter->saveDeferred($succeededItem);

diff --git a/test/Psr/CacheItemPool/CacheItemTest.php b/test/Psr/CacheItemPool/CacheItemTest.php
@@ -14,8 +14,7 @@
 
 class CacheItemTest extends TestCase
 {
-    /** @var string */
-    private $tz;
+    private string $tz;
 
     protected function setUp(): void
     {