Added support for YAML and XML mapping

symfony · lrlopez · Mar 4, 2016 · Mar 6, 2016 · Mar 16, 2016 · Mar 17, 2016
commit 5b82237b825195dabb5fb91dfb150d6f19122c9d
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -138,7 +138,7 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         $this->registerAnnotationsConfiguration($config['annotations'], $container, $loader);
-        $this->registerPropertyAccessConfiguration($config['property_access'], $container);
+        $this->registerPropertyAccessConfiguration($config['property_access'], $container, $loader);
 
         if ($this->isConfigEnabled($container, $config['serializer'])) {
             $this->r
8000
egisterSerializerConfiguration($config['serializer'], $container, $loader);
@@ -915,13 +915,90 @@ private function registerAnnotationsConfiguration(array $config, ContainerBuilde
         }
     }
 
-    private function registerPropertyAccessConfiguration(array $config, ContainerBuilder $container)
+    /**
+     * Loads the PropertyAccess configuration.
+     *
+     * @param array            $config    A serializer configuration array
+     * @param ContainerBuilder $container A ContainerBuilder instance
+     * @param XmlFileLoader    $loader    An XmlFileLoader instance
+     */
+    private function registerPropertyAccessConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
     {
         $container
             ->getDefinition('property_accessor')
             ->replaceArgument(0, $config['magic_call'])
             ->replaceArgument(1, $config['throw_exception_on_invalid_index'])
         ;
+
+        if (!$this->isConfigEnabled($container, $config)) {
+            return;
+        }
+
+        $loader->load('property_access.xml');
+        $chainLoader = $container->getDefinition('property_access.mapping.chain_loader');
+
+        $serializerLoaders = array();
+        if (isset($config['enable_annotations']) && $config['enable_annotations']) {
+            $annotationLoader = new Definition(
+                'Symfony\Component\PropertyAccess\Mapping\Loader\AnnotationLoader',
+                array(new Reference('annotation_reader'))
+            );
+            $annotationLoader->setPublic(false);
+
+            $serializerLoaders[] = $annotationLoader;
+        }
+
+        $bundles = $container->getParameter('kernel.bundles');
+        foreach ($bundles as $bundle) {
+            $reflection = new \ReflectionClass($bundle);
+            $dirname = dirname($reflection->getFileName());
+
+            if (is_file($file = $dirname.'/Resources/config/property_access.xml')) {
+                $definition = new Definition('Symfony\Component\PropertyAccess\Mapping\Loader\XmlFileLoader', array(realpath($file)));
+                $definition->setPublic(false);
+
+                $serializerLoaders[] = $definition;
+                $container->addResource(new FileResource($file));
+            }
+
+            if (is_file($file = $dirname.'/Resources/config/property_access.yml')) {
+                $definition = new Definition('Symfony\Component\PropertyAccess\Mapping\Loader\YamlFileLoader', array(realpath($file)));
+                $definition->setPublic(false);
+
+                $serializerLoaders[] = $definition;
+                $container->addResource(new FileResource($file));
+            }
+
+            if (is_dir($dir = $dirname.'/Resources/config/property_access')) {
+                foreach (Finder::create()->files()->in($dir)->name('*.xml') as $file) {
+                    $definition = new Definition('Symfony\Component\PropertyAccess\Mapping\Loader\XmlFileLoader', array($file->getRealpath()));
+                    $definition->setPublic(false);
+
+                    $serializerLoaders[] = $definition;
+                }
+                foreach (Finder::create()->files()->in($dir)->name('*.yml') as $file) {
+                    $definition = new Definition('Symfony\Component\PropertyAccess\Mapping\Loader\YamlFileLoader', array($file->getRealpath()));
+                    $definition->setPublic(false);
+
+                    $serializerLoaders[] = $definition;
+                }
+
+                $container->addResource(new DirectoryResource($dir));
+            }
+        }
+
+        $chainLoader->replaceArgument(0, $serializerLoaders);
+
+        if (isset($config['cache']) && $config['cache']) {
+            $container->setParameter(
+                'property_access.mapping.cache.prefix',
+                'property_access_'.$this->getKernelRootHash($container)
+            );
+
+            $container->getDefinition('property_access.mapping.class_metadata_factory')->replaceArgument(
+                1, new Reference($config['cache'])
+            );
+        }
     }
 
     /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/property_access.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/property_access.xml
@@ -5,11 +5,30 @@
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
+
+        <!-- Loader -->
+        <service id="property_access.mapping.chain_loader" class="Symfony\Component\PropertyAccess\Mapping\Loader\LoaderChain" public="false">
+            <argument type="collection" />
+        </service>
+
+        <!-- Class Metadata Factory -->
+        <service id="property_access.mapping.class_metadata_factory" class="Symfony\Component\PropertyAccess\Mapping\Factory\ClassMetadataFactory" public="false">
+            <argument type="service" id="property_access.mapping.chain_loader" />
+            <argument>null</argument>
+        </service>
+
+        <!-- Cache -->
+        <service id="property_access.mapping.cache.apc" class="Doctrine\Common\Cache\ApcCache" public="false">
+            <call method="setNamespace">
+                <argument>%property_access.mapping.cache.prefix%</argument>
+            </call>
+        </service>
+
         <service id="property_accessor" class="Symfony\Component\PropertyAccess\PropertyAccessor" >
             <argument /> <!-- magicCall, set by the extension -->
             <argument /> <!-- throwExceptionOnInvalidIndex, set by the extension -->
             <argument type="service" id="cache.property_access" on-invalid="ignore" />
-            <argument type="service" id="annotation_reader" on-invalid="ignore" />
+            <argument type="service" id="property_access.mapping.class_metadata_factory" on-invalid="ignore" />
         </service>
     </services>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -225,6 +225,7 @@ protected static function getBundleDefaultConfig()
             'property_access' => array(
                 'magic_call' => false,
                 'throw_exception_on_invalid_index' => false,
+                'enable_annotations' => false,
             ),
             'property_info' => array(
                 'enabled' => false,

diff --git a/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/property_accessor.php b/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/property_accessor.php
@@ -4,5 +4,6 @@
     'property_access' => array(
         'magic_call' => true,
         'throw_exception_on_invalid_index' => true,
+        'enable_annotations' => false,
     ),
 ));
diff --git a/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/property_accessor.yml b/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/property_accessor.yml
@@ -2,3 +2,4 @@ framework:
     property_access:
         magic_call: true
         throw_exception_on_invalid_index: true
+        enable_annotations: true
diff --git a/src/Symfony/Component/PropertyAccess/Annotation/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/Annotation/PropertyAccessor.php
@@ -15,6 +15,7 @@
  * Property accessor configuration annotation.
  *
  * @Annotation
+ * @Target({"PROPERTY"})
  *
  * @author Luis Ramón López <lrlopez@gmail.com>
  */

diff --git a/src/Symfony/Component/PropertyAccess/Exception/MappingException.php b/src/Symfony/Component/PropertyAccess/Exception/MappingException.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyAccess\Exception;
+
+/**
+ * MappingException.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+class MappingException extends RuntimeException
+{
+}
diff --git a/src/Symfony/Component/PropertyAccess/Mapping/AttributeMetadata.php b/src/Symfony/Component/PropertyAccess/Mapping/AttributeMetadata.php
@@ -0,0 +1,177 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyAccess\Mapping;
+
+/**
+ * {@inheritdoc}
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+class AttributeMetadata implements AttributeMetadataInterface
+{
+    /**
+     * @var string
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getName()} instead.
+     */
+    public $name;
+
+    /**
+     * @var string
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getGetter()} instead.
+     */
+    public $getter;
+
+    /**
+     * @var string
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getSetter()} instead.
+     */
+    public $setter;
+
+    /**
+     * @var string
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getAdder()} instead.
+     */
+    public $adder;
+
+    /**
+     * @var string
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getRemover()} instead.
+     */
+    public $remover;
+
+    /**
+     * Constructs a metadata for the given attribute.
+     *
+     * @param string $name
+     */
+    public function __construct($name)
+    {
+        $this->name = $name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSetter()
+    {
+        return $this->setter;
+        }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setSetter($setter)
+    {
+        $this->setter = $setter;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getGetter()
+    {
+        return $this->getter;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setGetter($getter)
+    {
+        $this->getter = $getter;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAdder()
+    {
+        return $this->adder;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setAdder($adder)
+    {
+        $this->adder = $adder;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRemover()
+    {
+        return $this->remover;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setRemover($remover)
+    {
+        $this->remover = $remover;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function merge(AttributeMetadataInterface $attributeMetadata)
+    {
+        // Overwrite only if not defined
+        if (null === $this->getter) {
+            $this->getter = $attributeMetadata->getGetter();
+        }
+        if (null === $this->setter) {
+            $this->setter = $attributeMetadata->getSetter();
+        }
+        if (null === $this->adder) {
+            $this->adder = $attributeMetadata->getAdder();
+        }
+        if (null === $this->remover) {
+            $this->remover = $attributeMetadata->getRemover();
+        }
+    }
+
+    /**
+     * Returns the names of the properties that should be serialized.
+     *
+     * @return string[]
+     */
+    public function __sleep()
+    {
+        return array('name', 'getter', 'setter', 'adder', 'remover');
+    }
+}