[FrameworkBundle] Allow configuring serializer mapping paths

Author: chalasr

CHANGELOG.md

@@ -35,6 +35,8 @@ CHANGELOG
    `server:status` console commands have been moved to a dedicated bundle. 
    Require `symfony/web-server-bundle` in your composer.json and register 
    `Symfony\Bundle\WebServerBundle\WebServerBundle` in your AppKernel to use them.
+ * Added `framework.serializer.mapping` config option allowing to define custom 
+   serialization mapping files and directories
 
 3.2.0
 -----

DependencyInjection/Configuration.php

@@ -686,6 +686,15 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode)
                         ->booleanNode('enable_annotations')->{!class_exists(FullStack::class) && class_exists(Annotation::class) ? 'defaultTrue' : 'defaultFalse'}()->end()
                         ->scalarNode('cache')->end()
                         ->scalarNode('name_converter')->end()
+                        ->arrayNode('mapping')
+                            ->addDefaultsIfNotSet()
+                            ->fixXmlConfig('path')
+                            ->children()
+                                ->arrayNode('paths')
+                                    ->prototype('scalar')->end()
+                                ->end()
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()

DependencyInjection/FrameworkExtension.php

@@ -986,8 +986,7 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
         $container->setParameter('validator.translation_domain', $config['translation_domain']);
 
         $files = array('xml' => array(), 'yml' => array());
-        $this->getValidatorMappingFiles($container, $files);
-        $this->getValidatorMappingFilesFromConfig($container, $config, $files);
+        $this->registerValidatorMapping($container, $config, $files);
 
         if (!empty($files['xml'])) {
             $validatorBuilder->addMethodCall('addXmlMappings', array($files['xml']));
@@ -1028,51 +1027,54 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
         }
     }
 
-    private function getValidatorMappingFiles(ContainerBuilder $container, array &$files)
+    private function registerValidatorMapping(ContainerBuilder $container, array $config, array &$files)
     {
+        $fileRecorder = function ($extension, $path) use (&$files) {
+            $files['yaml' === $extension ? 'yml' : $extension][] = $path;
+        };
+
         if (interface_exists('Symfony\Component\Form\FormInterface')) {
             $reflClass = new \ReflectionClass('Symfony\Component\Form\FormInterface');
-            $files['xml'][] = dirname($reflClass->getFileName()).'/Resources/config/validation.xml';
+            $fileRecorder('xml', dirname($reflClass->getFileName()).'/Resources/config/validation.xml');
         }
 
         foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
             $dirname = $bundle['path'];
 
             if ($container->fileExists($file = $dirname.'/Resources/config/validation.yml', false)) {
-                $files['yml'][] = $file;
+                $fileRecorder('yml', $file);
             }
 
             if ($container->fileExists($file = $dirname.'/Resources/config/validation.xml', false)) {
-                $files['xml'][] = $file;
+                $fileRecorder('xml', $file);
             }
 
             if ($container->fileExists($dir = $dirname.'/Resources/config/validation', '/^$/')) {
-                $this->getValidatorMappingFilesFromDir($dir, $files);
+                $this->registerMappingFilesFromDir($dir, $fileRecorder);
             }
         }
+
+        $this->registerMappingFilesFromConfig($container, $config, $fileRecorder);
     }
 
-    private function getValidatorMappingFilesFromDir($dir, array &$files)
+    private function registerMappingFilesFromDir($dir, callable $fileRecorder)
     {
         foreach (Finder::create()->followLinks()->files()->in($dir)->name('/\.(xml|ya?ml)$/') as $file) {
-            $extension = $file->getExtension();
-            $files['yaml' === $extension ? 'yml' : $extension][] = $file->getRealpath();
+            $fileRecorder($file->getExtension(), $file->getRealPath());
         }
     }
 
-    private function getValidatorMappingFilesFromConfig(ContainerBuilder $container, array $config, array &$files)
+    private function registerMappingFilesFromConfig(ContainerBuilder $container, array $config, callable $fileRecorder)
     {
         foreach ($config['mapping']['paths'] as $path) {
             if (is_dir($path)) {
-                $this->getValidatorMappingFilesFromDir($path, $files);
+                $this->registerMappingFilesFromDir($path, $fileRecorder);
                 $container->addResource(new DirectoryResource($path, '/^$/'));
             } elseif ($container->fileExists($path, false)) {
-                if (preg_match('/\.(xml|ya?ml)$/', $path, $matches)) {
-                    $extension = $matches[1];
-                    $files['yaml' === $extension ? 'yml' : $extension][] = $path;
-                } else {
+                if (!preg_match('/\.(xml|ya?ml)$/', $path, $matches)) {
                     throw new \RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & Yaml.', $path));
                 }
+                $fileRecorder($matches[1], $path);
             } else {
                 throw new \RuntimeException(sprintf('Could not open file or directory "%s".', $path));
             }
@@ -1230,39 +1232,30 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
             $serializerLoaders[] = $annotationLoader;
         }
 
+        $fileRecorder = function ($extension, $path) use (&$serializerLoaders) {
+            $definition = new Definition(in_array($extension, array('yaml', 'yml')) ? 'Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader' : 'Symfony\Component\Serializer\Mapping\Loader\XmlFileLoader', array($path));
+            $definition->setPublic(false);
+            $serializerLoaders[] = $definition;
+        };
+
         foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
             $dirname = $bundle['path'];
 
             if ($container->fileExists($file = $dirname.'/Resources/config/serialization.xml', false)) {
-                $definition = new Definition('Symfony\Component\Serializer\Mapping\Loader\XmlFileLoader', array($file));
-                $definition->setPublic(false);
-
-                $serializerLoaders[] = $definition;
+                $fileRecorder('xml', $file);
             }
 
             if ($container->fileExists($file = $dirname.'/Resources/config/serialization.yml', false)) {
-                $definition = new Definition('Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader', array($file));
-                $definition->setPublic(false);
-
-                $serializerLoaders[] = $definition;
+                $fileRecorder('yml', $file);
             }
 
             if ($container->fileExists($dir = $dirname.'/Resources/config/serialization')) {
-                foreach (Finder::create()->followLinks()->files()->in($dir)->name('*.xml') as $file) {
-                    $definition = new Definition('Symfony\Component\Serializer\Mapping\Loader\XmlFileLoader', array($file->getPathname()));
-                    $definition->setPublic(false);
-
-                    $serializerLoaders[] = $definition;
-                }
-                foreach (Finder::create()->followLinks()->files()->in($dir)->name('*.yml') as $file) {
-                    $definition = new Definition('Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader', array($file->getPathname()));
-                    $definition->setPublic(false);
-
-                    $serializerLoaders[] = $definition;
-                }
+                $this->registerMappingFilesFromDir($dir, $fileRecorder);
             }
         }
 
+        $this->registerMappingFilesFromConfig($container, $config, $fileRecorder);
+
         $chainLoader->replaceArgument(0, $serializerLoaders);
         $container->getDefinition('serializer.mapping.cache_warmer')->replaceArgument(0, $serializerLoaders);
 

Resources/config/schema/symfony-1.0.xsd

@@ -176,7 +176,7 @@
     <xsd:complexType name="validation">
         <xsd:choice minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="static-method" type="xsd:string" />
-            <xsd:element name="mapping" type="validation_mapping" />
+            <xsd:element name="mapping" type="file_mapping" />
         </xsd:choice>
 
         <xsd:attribute name="enabled" type="xsd:boolean" />
@@ -185,7 +185,7 @@
         <xsd:attribute name="static-method" type="xsd:boolean" />
     </xsd:complexType>
 
-    <xsd:complexType name="validation_mapping">
+    <xsd:complexType name="file_mapping">
         <xsd:sequence>
             <xsd:element name="path" type="xsd:string" minOccurs="1" maxOccurs="unbounded" />
         </xsd:sequence>
@@ -204,6 +204,9 @@
     </xsd:complexType>
 
     <xsd:complexType name="serializer">
+        <xsd:choice minOccurs="0" maxOccurs="unbounded">
+            <xsd:element name="mapping" type="file_mapping" />
+        </xsd:choice>
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="cache" type="xsd:string" />
         <xsd:attribute name="enable-annotations" type="xsd:boolean" />

Tests/DependencyInjection/ConfigurationTest.php

@@ -226,6 +226,7 @@ protected static function getBundleDefaultConfig()
             'serializer' => array(
                 'enabled' => !class_exists(FullStack::class),
                 'enable_annotations' => !class_exists(FullStack::class),
+                'mapping' => array('paths' => array()),
             ),
             'property_access' => array(
                 'magic_call' => false,