IBX-1687: Added Ibexa\Contracts\Core\FieldType\StorageGatewayInterface

ibexa · Dec 13, 2021 · 3d4ee58 · 3d4ee58
1 parent ada0655
commit 3d4ee58
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 17 deletions.
diff --git a/src/contracts/FieldType/GatewayBasedStorage.php b/src/contracts/FieldType/GatewayBasedStorage.php
@@ -12,23 +12,23 @@
 /**
  * Field Type External Storage gateway base class.
  *
- * @template T of \Ibexa\Contracts\Core\FieldType\StorageGateway
+ * @template T of \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface
  */
 abstract class GatewayBasedStorage implements FieldStorage
 {
     /**
      * Field Type External Storage Gateway.
      *
-     * @var \Ibexa\Contracts\Core\FieldType\StorageGateway
+     * @var \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface
      * @phpstan-var T
      */
     protected $gateway;
 
     /**
-     * @param \Ibexa\Contracts\Core\FieldType\StorageGateway $gateway
+     * @param \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface $gateway
      * @phpstan-param T $gateway
      */
-    public function __construct(StorageGateway $gateway)
+    public function __construct(StorageGatewayInterface $gateway)
     {
         $this->gateway = $gateway;
     }

diff --git a/src/contracts/FieldType/StorageGateway.php b/src/contracts/FieldType/StorageGateway.php
@@ -9,7 +9,7 @@
 /**
  * Base class for FieldType external storage gateways.
  */
-abstract class StorageGateway
+abstract class StorageGateway implements StorageGatewayInterface
 {
     /**
      * Get sequence name bound to database table and column.

diff --git a/src/contracts/FieldType/StorageGatewayInterface.php b/src/contracts/FieldType/StorageGatewayInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\FieldType;
+
+interface StorageGatewayInterface
+{
+}
diff --git a/src/lib/FieldType/BinaryBase/BinaryBaseStorage.php b/src/lib/FieldType/BinaryBase/BinaryBaseStorage.php
@@ -9,7 +9,7 @@
 use Ibexa\Contracts\Core\FieldType\BinaryBase\PathGenerator;
 use Ibexa\Contracts\Core\FieldType\BinaryBase\RouteAwarePathGenerator;
 use Ibexa\Contracts\Core\FieldType\GatewayBasedStorage;
-use Ibexa\Contracts\Core\FieldType\StorageGateway;
+use Ibexa\Contracts\Core\FieldType\StorageGatewayInterface;
 use Ibexa\Contracts\Core\IO\MimeTypeDetector;
 use Ibexa\Contracts\Core\Persistence\Content\Field;
 use Ibexa\Contracts\Core\Persistence\Content\VersionInfo;
@@ -42,13 +42,13 @@ class BinaryBaseStorage extends GatewayBasedStorage
     /**
      * Construct from gateways.
      *
-     * @param \Ibexa\Contracts\Core\FieldType\StorageGateway $gateway
+     * @param \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface $gateway
      * @param \Ibexa\Core\IO\IOServiceInterface $ioService
      * @param \Ibexa\Contracts\Core\FieldType\BinaryBase\PathGenerator $pathGenerator
      * @param \Ibexa\Contracts\Core\IO\MimeTypeDetector $mimeTypeDetector
      */
     public function __construct(
-        StorageGateway $gateway,
+        StorageGatewayInterface $gateway,
         IOServiceInterface $ioService,
         PathGenerator $pathGenerator,
         MimeTypeDetector $mimeTypeDetector

diff --git a/src/lib/FieldType/Image/ImageStorage.php b/src/lib/FieldType/Image/ImageStorage.php
@@ -7,7 +7,7 @@
 namespace Ibexa\Core\FieldType\Image;
 
 use Ibexa\Contracts\Core\FieldType\GatewayBasedStorage;
-use Ibexa\Contracts\Core\FieldType\StorageGateway;
+use Ibexa\Contracts\Core\FieldType\StorageGatewayInterface;
 use Ibexa\Contracts\Core\Persistence\Content\Field;
 use Ibexa\Contracts\Core\Persistence\Content\VersionInfo;
 use Ibexa\Core\Base\Exceptions\InvalidArgumentException;
@@ -43,7 +43,7 @@ class ImageStorage extends GatewayBasedStorage
     protected $filePathNormalizer;
 
     public function __construct(
-        StorageGateway $gateway,
+        StorageGatewayInterface $gateway,
         IOServiceInterface $ioService,
         PathGenerator $pathGenerator,
         MetadataHandler $imageSizeMetadataHandler,

diff --git a/src/lib/FieldType/StorageGateway.php b/src/lib/FieldType/StorageGateway.php
@@ -11,7 +11,7 @@
 /**
  * Abstract base class for storage gateways.
  *
- * @deprecated Since 6.11. Extend {@link \Ibexa\Contracts\Core\FieldType\StorageGateway} class instead.
+ * @deprecated Since 6.11. Extend {@link \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface} class instead.
  */
 abstract class StorageGateway extends SPIStorageGateway
 {

diff --git a/src/lib/FieldType/Url/UrlStorage.php b/src/lib/FieldType/Url/UrlStorage.php
@@ -7,7 +7,7 @@
 namespace Ibexa\Core\FieldType\Url;
 
 use Ibexa\Contracts\Core\FieldType\GatewayBasedStorage;
-use Ibexa\Contracts\Core\FieldType\StorageGateway;
+use Ibexa\Contracts\Core\FieldType\StorageGatewayInterface;
 use Ibexa\Contracts\Core\Persistence\Content\Field;
 use Ibexa\Contracts\Core\Persistence\Content\VersionInfo;
 use Psr\Log\LoggerInterface;
@@ -26,10 +26,10 @@ class UrlStorage extends GatewayBasedStorage
     /**
      * Construct from gateways.
      *
-     * @param \Ibexa\Contracts\Core\FieldType\StorageGateway $gateway
+     * @param \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface $gateway
      * @param \Psr\Log\LoggerInterface $logger
      */
-    public function __construct(StorageGateway $gateway, LoggerInterface $logger = null)
+    public function __construct(StorageGatewayInterface $gateway, LoggerInterface $logger = null)
     {
         parent::__construct($gateway);
         $this->logger = $logger;

diff --git a/tests/lib/FieldType/Url/UrlStorageTest.php b/tests/lib/FieldType/Url/UrlStorageTest.php
@@ -6,7 +6,7 @@
  */
 namespace Ibexa\Tests\Core\FieldType\Url;
 
-use Ibexa\Contracts\Core\FieldType\StorageGateway;
+use Ibexa\Contracts\Core\FieldType\StorageGatewayInterface;
 use Ibexa\Contracts\Core\Persistence\Content\Field;
 use Ibexa\Contracts\Core\Persistence\Content\FieldValue;
 use Ibexa\Contracts\Core\Persistence\Content\VersionInfo;
@@ -211,11 +211,11 @@ public function testHasFieldData()
     }
 
     /**
-     * @param \Ibexa\Contracts\Core\FieldType\StorageGateway $gateway
+     * @param \Ibexa\Contracts\Core\FieldType\StorageGatewayInterface $gateway
      *
      * @return \Ibexa\Core\FieldType\Url\UrlStorage|\PHPUnit\Framework\MockObject\MockObject
      */
-    protected function getPartlyMockedStorage(StorageGateway $gateway)
+    protected function getPartlyMockedStorage(StorageGatewayInterface $gateway)
     {
         return $this->getMockBuilder(UrlStorage::class)
             ->setMethods(null)