Merge pull request #711 from schmittjoh/exp-function-provider-tag

Allow to add expression function providers using DI tags
schmittjoh · Dec 23, 2018 · 3185c1f · 3185c1f
2 parents d6bae34 + a557bfe
commit 3185c1f
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 7 deletions.
diff --git a/DependencyInjection/Compiler/ExpressionFunctionProviderPass.php b/DependencyInjection/Compiler/ExpressionFunctionProviderPass.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace JMS\SerializerBundle\DependencyInjection\Compiler;
+
+use Hateoas\Configuration\Provider\RelationProviderInterface;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+use Symfony\Component\DependencyInjection\Reference;
+
+class ExpressionFunctionProviderPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        try {
+            $registryDefinition = $container->findDefinition('jms_serializer.expression_language');
+
+            foreach (array_keys($container->findTaggedServiceIds('jms.expression.function_provider')) as $id) {
+                $registryDefinition->addMethodCall('registerProvider', [new Reference($id)]);
+            }
+        } catch (ServiceNotFoundException $exception){
+
+        }
+    }
+}
diff --git a/JMSSerializerBundle.php b/JMSSerializerBundle.php
@@ -5,6 +5,7 @@
 use JMS\DiExtraBundle\DependencyInjection\Compiler\LazyServiceMapPass;
 use JMS\SerializerBundle\DependencyInjection\Compiler\CustomHandlersPass;
 use JMS\SerializerBundle\DependencyInjection\Compiler\DoctrinePass;
+use JMS\SerializerBundle\DependencyInjection\Compiler\ExpressionFunctionProviderPass;
 use JMS\SerializerBundle\DependencyInjection\Compiler\FormErrorHandlerTranslationDomainPass;
 use JMS\SerializerBundle\DependencyInjection\Compiler\RegisterEventListenersAndSubscribersPass;
 use JMS\SerializerBundle\DependencyInjection\Compiler\ServiceMapPass;
@@ -31,6 +32,7 @@ function (ContainerBuilder $container, $def) {
 
         $builder->addCompilerPass(new FormErrorHandlerTranslationDomainPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION);
         $builder->addCompilerPass(new TwigExtensionPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION);
+        $builder->addCompilerPass(new ExpressionFunctionProviderPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION);
         $builder->addCompilerPass(new RegisterEventListenersAndSubscribersPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $builder->addCompilerPass(new CustomHandlersPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $builder->addCompilerPass(new DoctrinePass(), PassConfig::TYPE_BEFORE_REMOVING);

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -171,12 +171,11 @@
                 <argument type="service" key="container" id="service_container"/>
             </argument>
         </service>
-        <service id="jms_serializer.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" public="false">
-            <call method="registerProvider">
-                <argument type="service" id="jms_serializer.expression_language.function_provider" />
-            </call>
+        <service id="jms_serializer.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" public="false"/>
+
+        <service id="jms_serializer.expression_language.function_provider" class="JMS\SerializerBundle\ExpressionLanguage\BasicSerializerFunctionsProvider" public="false">
+            <tag name="jms.expression.function_provider"/>
         </service>
-        <service id="jms_serializer.expression_language.function_provider" class="JMS\SerializerBundle\ExpressionLanguage\BasicSerializerFunctionsProvider" public="false"/>
 
         <!-- Twig Extension -->
         <service id="jms_serializer.twig_extension.serializer" class="JMS\Serializer\Twig\SerializerExtension" public="false">

diff --git a/Tests/DependencyInjection/Fixture/ObjectUsingExpressionLanguage.php b/Tests/DependencyInjection/Fixture/ObjectUsingExpressionLanguage.php
@@ -4,6 +4,9 @@
 
 use JMS\Serializer\Annotation as Serializer;
 
+/**
+ * @Serializer\VirtualProperty(exp="parameter('foo')", name="virtual")
+ */
 class ObjectUsingExpressionLanguage
 {
     /**

diff --git a/Tests/DependencyInjection/JMSSerializerExtensionTest.php b/Tests/DependencyInjection/JMSSerializerExtensionTest.php
@@ -392,9 +392,9 @@ public function testExpressionLanguage()
         $serializer = $container->get('jms_serializer');
         // test that all components have been wired correctly
         $object = new ObjectUsingExpressionLanguage('foo', true);
-        $this->assertEquals('{"name":"foo"}', $serializer->serialize($object, 'json'));
+        $this->assertEquals('{"virtual":"bar","name":"foo"}', $serializer->serialize($object, 'json'));
         $object = new ObjectUsingExpressionLanguage('foo', false);
-        $this->assertEquals('{}', $serializer->serialize($object, 'json'));
+        $this->assertEquals('{"virtual":"bar"}', $serializer->serialize($object, 'json'));
     }
 
     public function testExpressionLanguageVirtualProperties()
@@ -530,6 +530,7 @@ private function getContainerForConfigLoad(array $configs, callable $configurato
         $container->setParameter('kernel.debug', true);
         $container->setParameter('kernel.cache_dir', sys_get_temp_dir() . '/serializer');
         $container->setParameter('kernel.bundles', array());
+        $container->setParameter('foo', 'bar');
         $container->set('annotation_reader', new AnnotationReader());
         $container->setDefinition('doctrine', new Definition(Registry::class));
         $container->set('translator', $this->getMockBuilder('Symfony\\Component\\Translation\\TranslatorInterface')->getMock());