Merge pull request #41 from boesing/deprecate/serializer

Deprecate `Laminas\Serializer\Serializer`

src/ConfigProvider.php

@@ -8,6 +8,9 @@
 
 namespace Laminas\Serializer;
 
+use Laminas\Serializer\Adapter\AdapterInterface;
+use Laminas\Serializer\Adapter\PhpSerialize;
+
 class ConfigProvider
 {
     /**
@@ -34,6 +37,7 @@ public function getDependencyConfig()
             'aliases'   => [],
             'factories' => [
                 'SerializerAdapterManager' => AdapterPluginManagerFactory::class,
+                AdapterInterface::class    => new GenericSerializerFactory(PhpSerialize::class),
             ],
         ];
     }

src/GenericSerializerFactory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\Serializer;
+
+use Laminas\Serializer\Adapter\AdapterInterface;
+use Psr\Container\ContainerInterface;
+
+final class GenericSerializerFactory
+{
+    /**
+     * @param class-string<AdapterInterface> $serializerName
+     * @param array<string,mixed>|null       $options
+     */
+    public function __construct(private string $serializerName, private array|null $options = null)
+    {
+    }
+
+    public function __invoke(ContainerInterface $container): AdapterInterface
+    {
+        $plugins = $container->get(AdapterPluginManager::class);
+
+        return $plugins->build($this->serializerName, $this->options);
+    }
+}

src/Serializer.php

@@ -12,6 +12,9 @@
 use Laminas\ServiceManager\ServiceManager;
 use Traversable;
 
+/**
+ * @deprecated This class will be removed with v3.0.0. Please migrate your code according to the migration guide.
+ */
 // phpcs:ignore
 abstract class Serializer
 {

test/GenericSerializerFactoryTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasTest\Serializer;
+
+use Laminas\Serializer\Adapter\Json;
+use Laminas\Serializer\Adapter\JsonOptions;
+use Laminas\Serializer\AdapterPluginManager;
+use Laminas\Serializer\GenericSerializerFactory;
+use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface;
+
+final class GenericSerializerFactoryTest extends TestCase
+{
+    public function testWillRequestInstanceFromPluginManager(): void
+    {
+        $factory   = new GenericSerializerFactory(Json::class, ['cycle_check' => true]);
+        $container = $this->createMock(ContainerInterface::class);
+        $plugins   = new AdapterPluginManager($container);
+
+        $container
+            ->expects(self::once())
+            ->method('get')
+            ->with(AdapterPluginManager::class)
+            ->willReturn($plugins);
+
+        $adapter = $factory($container);
+        self::assertInstanceOf(Json::class, $adapter);
+        self::assertTrue($adapter->getOptions()->getCycleCheck());
+        // Verify that default of json options is false so that we do not accidentally test for default `true` value
+        self::assertFalse((new JsonOptions())->getCycleCheck());
+    }
+}