Merge pull request #602 from schmittjoh/private-subscribing-handlers

Allow subscribing handlers to be private

Author: goetas

DependencyInjection/Compiler/CustomHandlersPass.php

@@ -6,6 +6,7 @@
 use JMS\Serializer\Handler\HandlerRegistry;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
 
 class CustomHandlersPass implements CompilerPassInterface
 {
@@ -29,7 +30,11 @@ public function process(ContainerBuilder $container)
 
                 foreach ($directions as $direction) {
                     $method = isset($attrs['method']) ? $attrs['method'] : HandlerRegistry::getDefaultMethod($direction, $attrs['type'], $attrs['format']);
-                    $handlers[$direction][$attrs['type']][$attrs['format']] = array($id, $method);
+                    if ($container->getDefinition($id)->isPublic()) {
+                        $handlers[$direction][$attrs['type']][$attrs['format']] = array($id, $method);
+                    } else {
+                        $handlers[$direction][$attrs['type']][$attrs['format']] = array(new Reference($id), $method);
+                    }
                 }
             }
         }
@@ -53,7 +58,11 @@ public function process(ContainerBuilder $container)
 
                 foreach ($directions as $direction) {
                     $method = isset($methodData['method']) ? $methodData['method'] : HandlerRegistry::getDefaultMethod($direction, $methodData['type'], $methodData['format']);
-                    $handlers[$direction][$methodData['type']][$methodData['format']] = array($id, $method);
+                    if ($container->getDefinition($id)->isPublic()) {
+                        $handlers[$direction][$methodData['type']][$methodData['format']] = array($id, $method);
+                    } else {
+                        $handlers[$direction][$methodData['type']][$methodData['format']] = array(new Reference($id), $method);
+                    }
                 }
             }
         }

Tests/DependencyInjection/CustomHandlerPassTest.php

@@ -27,6 +27,7 @@
 use Symfony\Component\DependencyInjection\Compiler\ResolveParameterPlaceHoldersPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
 
 class CustomHandlerPassTest extends TestCase
 {
@@ -79,12 +80,35 @@ public function testHandler()
 
         $args = $container->getDefinition('jms_serializer.handler_registry')->getArguments();
 
-        $this->assertEquals([
+        $this->assertSame([
             2 => ['DateTime' => ['json' => ['my_service', 'deserializeDateTimeFromjson']]],
             1 => ['DateTime' => ['json' => ['my_service', 'serializeDateTimeTojson']]]
         ], $args[1]);
     }
 
+    public function testHandlerCanBePrivate()
+    {
+        $container = $this->getContainer();
+
+        $def = new Definition('Foo');
+        $def->setPublic(false);
+        $def->addTag('jms_serializer.handler', [
+            'type' => 'DateTime',
+            'format' => 'json',
+        ]);
+        $container->setDefinition('my_service', $def);
+
+        $pass = new CustomHandlersPass();
+        $pass->process($container);
+
+        $args = $container->getDefinition('jms_serializer.handler_registry')->getArguments();
+
+        $this->assertEquals([
+            2 => ['DateTime' => ['json' => [new Reference('my_service'), 'deserializeDateTimeFromjson']]],
+            1 => ['DateTime' => ['json' => [new Reference('my_service'), 'serializeDateTimeTojson']]]
+        ], $args[1]);
+    }
+
     public function testHandlerDirection()
     {
         $container = $this->getContainer();
@@ -102,7 +126,7 @@ public function testHandlerDirection()
 
         $args = $container->getDefinition('jms_serializer.handler_registry')->getArguments();
 
-        $this->assertEquals([
+        $this->assertSame([
             1 => ['DateTime' => ['json' => ['my_service', 'serializeDateTimeTojson']]]
         ], $args[1]);
     }
@@ -156,11 +180,30 @@ public function testSubscribingHandler()
 
         $args = $container->getDefinition('jms_serializer.handler_registry')->getArguments();
 
-        $this->assertEquals([
+        $this->assertSame([
             1 => ['DateTime' => ['json' => ['my_service', 'onDateTime']]]
         ], $args[1]);
     }
 
+    public function testSubscribingHandlerCanBePrivate()
+    {
+        $container = $this->getContainer();
+
+        $def = new Definition('JMS\SerializerBundle\Tests\DependencyInjection\Fixture\SubscribingHandler');
+        $def->addTag('jms_serializer.subscribing_handler');
+        $def->setPublic(false);
+        $container->setDefinition('my_service', $def);
+
+        $pass = new CustomHandlersPass();
+        $pass->process($container);
+
+        $args = $container->getDefinition('jms_serializer.handler_registry')->getArguments();
+
+        $this->assertEquals([
+            1 => ['DateTime' => ['json' => [new Reference('my_service'), 'onDateTime']]]
+        ], $args[1]);
+    }
+
     /**
      * @expectedException RuntimeException
      * @expectedExceptionMessage The service "my_service" must implement the SubscribingHandlerInterface