symfony · dunglas · Jul 3, 2015 · weaverryan · Sep 26, 2015 · dupuchba
diff --git a/src/Symfony/Component/Serializer/Annotation/Alias.php b/src/Symfony/Component/Serializer/Annotation/Alias.php
@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * Annotation class for @Alias().
+ *
+ * @Annotation
+ * @Target({"PROPERTY", "METHOD"})
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class Alias
+{
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @param array $data
+     *
+     * @throws InvalidArgumentException
+     */
+    public function __construct(array $data)
+    {
+        if (!isset($data['value']) || !$data['value']) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));
+        }
+
+        if (!is_string($data['value'])) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string.', get_class($this)));
+        }
+
+        $this->name = $data['value'];
+    }
+
+    /**
+     * Gets name.
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php b/src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php
@@ -36,6 +36,15 @@ class AttributeMetadata implements AttributeMetadataInterface
      */
     public $groups = array();
 
+    /**
+     * @var string|null
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getAlias()} instead.
+     */
+    public $alias;
+
     /**
      * Constructs a metadata for the given attribute.
      *
@@ -72,6 +81,22 @@ public function getGroups()
         return $this->groups;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function setAlias($alias)
+    {
+        $this->alias = $alias;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAlias()
+    {
+        return $this->alias;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -80,6 +105,10 @@ public function merge(AttributeMetadataInterface $attributeMetadata)
         foreach ($attributeMetadata->getGroups() as $group) {
             $this->addGroup($group);
         }
+
+        if (!$this->alias) {
+            $this->alias = $attributeMetadata->getAlias();
+        }
     }
 
     /**
@@ -89,6 +118,6 @@ public function merge(AttributeMetadataInterface $attributeMetadata)
      */
     public function __sleep()
     {
-        return array('name', 'groups');
+        return array('name', 'groups', 'alias');
     }
 }
diff --git a/src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php b/src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php
@@ -41,6 +41,20 @@ public function addGroup($group);
      */
     public function getGroups();
 
+    /**
+     * Sets the normalization alias of this attribute.
+     *
+     * @param string|null $alias
+     */
+    public function setAlias($alias);
+
+    /**
+     * Gets the normalization alias of this attribute.
+     *
+     * @return string|null
+     */
+    public function getAlias();
+
     /**
      * Merges an {@see AttributeMetadataInterface} with in the current one.
      *

diff --git a/src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php b/src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Serializer\Mapping\Loader;
 
 use Doctrine\Common\Annotations\Reader;
+use Symfony\Component\Serializer\Annotation\Alias;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Serializer\Exception\MappingException;
 use Symfony\Component\Serializer\Mapping\AttributeMetadata;
@@ -55,13 +56,17 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata)
             }
 
             if ($property->getDeclaringClass()->name === $className) {
-                foreach ($this->reader->getPropertyAnnotations($property) as $groups) {
-                    if ($groups instanceof Groups) {
-                        foreach ($groups->getGroups() as $group) {
+                foreach ($this->reader->getPropertyAnnotations($property) as $annotation) {
+                    if ($annotation instanceof Groups) {
+                        foreach ($annotation->getGroups() as $group) {
                             $attributesMetadata[$property->name]->addGroup($group);
                         }
                     }
 
+                    if ($annotation instanceof Alias) {
+                        $attributesMetadata[$property->name]->setAlias($annotation->getName());
+                    }
+
                     $loaded = true;
                 }
             }
@@ -70,25 +75,29 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata)
         foreach ($reflectionClass->getMethods() as $method) {
             if ($method->getDeclaringClass()->name === $className) {
                 foreach ($this->reader->getMethodAnnotations($method) as $groups) {
+                    if (!preg_match('/^(get|is|has|set)(.+)$/i', $method->name, $matches)) {
+                        continue;
+                    }
+
+                    $attributeName = lcfirst($matches[2]);
+
+                    if (isset($attributesMetadata[$attributeName])) {
+                        $attributeMetadata = $attributesMetadata[$attributeName];
+                    } else {
+                        $attributesMetadata[$attributeName] = $attributeMetadata = new AttributeMetadata($attributeName);
+                        $classMetadata->addAttributeMetadata($attributeMetadata);
+                    }
+
                     if ($groups instanceof Groups) {
-                        if (preg_match('/^(get|is|has|set)(.+)$/i', $method->name, $matches)) {
-                            $attributeName = lcfirst($matches[2]);
-
-                            if (isset($attributesMetadata[$attributeName])) {
-                                $attributeMetadata = $attributesMetadata[$attributeName];
-                            } else {
-                                $attributesMetadata[$attributeName] = $attributeMetadata = new AttributeMetadata($attributeName);
-                                $classMetadata->addAttributeMetadata($attributeMetadata);
-                            }
-
-                            foreach ($groups->getGroups() as $group) {
-                                $attributeMetadata->addGroup($group);
-                            }
-                        } else {
-                            throw new MappingException(sprintf('Groups on "%s::%s" cannot be added. Groups can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
+                        foreach ($groups->getGroups() as $group) {
+                            $attributeMetadata->addGroup($group);
                         }
                     }
 
+                    if ($annotation instanceof Alias) {
+                        $attributeMetadata[$property->name]->setAlias($annotation->getName());
+                    }
+
                     $loaded = true;
                 }
             }

diff --git a/src/Symfony/Component/Serializer/Mapping/Loader/XmlFileLoader.php b/src/Symfony/Component/Serializer/Mapping/Loader/XmlFileLoader.php
@@ -62,6 +62,10 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata)
                 foreach ($attribute->group as $group) {
                     $attributeMetadata->addGroup((string) $group);
                 }
+
+                if ($alias = (string) $attribute->alias) {
+                    $attributeMetadata->setAlias($alias);
+                }
             }
 
             return true;

diff --git a/src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php b/src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php
@@ -78,6 +78,10 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata)
                             $attributeMetadata->addGroup($group);
                         }
                     }
+
+                    if (isset($data['alias'])) {
+                        $attributeMetadata->setAlias($data['alias']);
+                    }
                 }
             }
 

diff --git a/...ponent/Serializer/Mapping/Loader/schema/dic/serializer-mapping/serializer-mapping-1.0.xsd b/...ponent/Serializer/Mapping/Loader/schema/dic/serializer-mapping/serializer-mapping-1.0.xsd
@@ -44,11 +44,14 @@
     <xsd:complexType name="attribute">
         <xsd:annotation>
             <xsd:documentation><![CDATA[
-        Contains serialization groups for a attributes. The name of the attribute should be given in the "name" option.
+        Contains serialization metadata for a attributes. The name of the attribute should be given in the "name" attribute.
       ]]></xsd:documentation>
         </xsd:annotation>
         <xsd:sequence>
-            <xsd:element name="group" type="xsd:string" maxOccurs="unbounded" />
+            <xsd:choice>
+                <xsd:element name="group" type="xsd:string" maxOccurs="unbounded" />
+            </xsd:choice>
+            <xsd:element name="alias" minOccurs="0" maxOccurs="1" />
         </xsd:sequence>
         <xsd:attribute name="name" type="xsd:string" use="required" />
     </xsd:complexType>

diff --git a/src/Symfony/Component/Serializer/NameConverter/AliasNameConverter.php b/src/Symfony/Component/Serializer/NameConverter/AliasNameConverter.php
@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\NameConverter;
+
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
+
+/**
+ * Converts name of properties using the alias specified in the attribute metadata.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class AliasNameConverter implements NameConverterInterface
+{
+    /**
+     * @var ClassMetadataFactoryInterface
+     */
+    private $classMetadataFactory;
+
+    public function __construct(ClassMetadataFactoryInterface $classMetadataFactory)
+    {
+        $this->classMetadataFactory = $classMetadataFactory;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function normalize($object, $propertyName)
+    {
+        $attributesMetadata = $this->getAttributesMetadata($object);
+
+        if (isset($attributesMetadata[$propertyName]) && $alias = $attributesMetadata[$propertyName]->getAlias()) {
+            return $alias;
+        }
+
+        return $propertyName;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function denormalize($object, $propertyName)
+    {
+        $attributesMetadata = $this->getAttributesMetadata($object);
+
+        // TODO: cache that
+        foreach ($attributesMetadata as $attributeMetadata) {
+            $alias = $attributeMetadata->getAlias();
+            if ($propertyName === $alias) {
+                return $alias;
+            }
+        }
+
+        return $propertyName;
+    }
+
+    /**
+     * Gets attributes metadata.
+     *
+     * @param string|object $class
+     *
+     * @return array
+     */
+    private function getAttributesMetadata($class)
+    {
+        if (is_object($class)) {
+            $class = get_class($class);
+        }
+
+        return $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata();
+    }
+}
diff --git a/src/Symfony/Component/Serializer/NameConverter/CamelCaseToSnakeCaseNameConverter.php b/src/Symfony/Component/Serializer/NameConverter/CamelCaseToSnakeCaseNameConverter.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\NameConverter;
 
 /**
- * CamelCase to Underscore name converter.
+ * Converts names of properties from CamelCase to Underscore.
  *
  * @author Kévin Dunglas <[email protected]>
  */
@@ -40,7 +40,7 @@ public function __construct(array $attributes = null, $lowerCamelCase = true)
     /**
      * {@inheritdoc}
      */
-    public function normalize($propertyName)
+    public function normalize($object, $propertyName)
     {
         if (null === $this->attributes || in_array($propertyName, $this->attributes)) {
             $snakeCasedName = '';
@@ -63,7 +63,7 @@ public function normalize($propertyName)
     /**
      * {@inheritdoc}
      */
-    public function denormalize($propertyName)
+    public function denormalize($object, $propertyName)
     {
         $camelCasedName = preg_replace_callback('/(^|_|\.)+(.)/', function ($match) {
             return ('.' === $match[1] ? '_' : '').strtoupper($match[2]);

diff --git a/src/Symfony/Component/Serializer/NameConverter/NameConverterInterface.php b/src/Symfony/Component/Serializer/NameConverter/NameConverterInterface.php
@@ -21,16 +21,20 @@ interface NameConverterInterface
     /**
      * Converts a property name to its normalized value.
      *
-     * @param string $propertyName
+     * @param string|object $class
+     * @param string        $propertyName
+     *
      * @return string
      */
-    public function normalize($propertyName);
+    public function normalize($class, $propertyName);
 
     /**
      * Converts a property name to its denormalized value.
      *
-     * @param string $propertyName
+     * @param string|object $class
+     * @param string        $propertyName
+     *
      * @return string
      */
-    public function denormalize($propertyName);
+    public function denormalize($class, $propertyName);
 }
-Original file line number
+Diff line change
@@ Expand Up @@
                                 $attributeMetadata->addGroup($group);
                             }
                         }
+                        if (isset($data['alias'])) {
+                            $attributeMetadata->setAlias($data['alias']);
+                        }
                     }
                 }
@@ Expand Down @@