Add AdvancedNamingStrategyInterface

src/JMS/Serializer/AbstractVisitor.php

@@ -20,7 +20,6 @@
 
 use JMS\Serializer\Accessor\AccessorStrategyInterface;
 use JMS\Serializer\Accessor\DefaultAccessorStrategy;
-use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
 
 abstract class AbstractVisitor implements VisitorInterface
 {
@@ -31,7 +30,7 @@ abstract class AbstractVisitor implements VisitorInterface
      */
     protected $accessor;
 
-    public function __construct(PropertyNamingStrategyInterface $namingStrategy, AccessorStrategyInterface $accessorStrategy = null)
+    public function __construct($namingStrategy, AccessorStrategyInterface $accessorStrategy = null)
     {
         $this->namingStrategy = $namingStrategy;
         $this->accessor = $accessorStrategy ?: new DefaultAccessorStrategy();

src/JMS/Serializer/GenericDeserializationVisitor.php

@@ -21,6 +21,8 @@
 use JMS\Serializer\Exception\RuntimeException;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
+use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
 
 /**
  * Generic Deserialization Visitor.
@@ -160,7 +162,11 @@ public function startVisitingObject(ClassMetadata $metadata, $object, array $typ
 
     public function visitProperty(PropertyMetadata $metadata, $data, Context $context)
     {
-        $name = $this->namingStrategy->translateName($metadata);
+        if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+            $name = $this->namingStrategy->getPropertyName($metadata, $context);
+        } else {
+            $name = $this->namingStrategy->translateName($metadata);
+        }
 
         if (null === $data) {
             return;

src/JMS/Serializer/GenericSerializationVisitor.php

@@ -21,6 +21,7 @@
 use JMS\Serializer\Exception\InvalidArgumentException;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
 
 /**
  * @deprecated
@@ -157,7 +158,11 @@ public function visitProperty(PropertyMetadata $metadata, $data, Context $contex
             return;
         }
 
-        $k = $this->namingStrategy->translateName($metadata);
+        if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+            $k = $this->namingStrategy->getPropertyName($metadata, $context);
+        } else {
+            $k = $this->namingStrategy->translateName($metadata);
+        }
 
         if ($metadata->inline) {
             if (is_array($v)) {

src/JMS/Serializer/JsonSerializationVisitor.php

@@ -21,6 +21,7 @@
 use JMS\Serializer\Exception\InvalidArgumentException;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
 
 class JsonSerializationVisitor extends GenericSerializationVisitor
 {
@@ -164,7 +165,11 @@ public function visitProperty(PropertyMetadata $metadata, $data, Context $contex
             return;
         }
 
-        $k = $this->namingStrategy->translateName($metadata);
+        if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+            $k = $this->namingStrategy->getPropertyName($metadata, $context);
+        } else {
+            $k = $this->namingStrategy->translateName($metadata);
+        }
 
         if ($metadata->inline) {
             if (is_array($v) || ($v instanceof \ArrayObject)) {

src/JMS/Serializer/Naming/AdvancedNamingStrategyInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * Copyright 2016 Johannes M. Schmitt <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace JMS\Serializer\Naming;
+
+use JMS\Serializer\Context;
+use JMS\Serializer\Metadata\PropertyMetadata;
+
+/**
+ * Interface for advanced property naming strategies.
+ *
+ * Implementations translate the property name to a serialized name that is
+ * displayed. It allows advanced strategy thanks to context parameter.
+ *
+ * @author Vincent Rasquier <[email protected]>
+ */
+interface AdvancedNamingStrategyInterface
+{
+    /**
+     * Translates the name of the property to the serialized version.
+     *
+     * @param PropertyMetadata $property
+     * @param Context $context
+     *
+     * @return string
+     */
+    public function getPropertyName(PropertyMetadata $property, Context $context);
+}

src/JMS/Serializer/SerializerBuilder.php

@@ -44,6 +44,7 @@
 use JMS\Serializer\Handler\PhpCollectionHandler;
 use JMS\Serializer\Handler\PropelCollectionHandler;
 use JMS\Serializer\Handler\StdClassHandler;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
 use JMS\Serializer\Naming\CamelCaseNamingStrategy;
 use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
 use JMS\Serializer\Naming\SerializedNameAnnotationStrategy;
@@ -205,6 +206,13 @@ public function setPropertyNamingStrategy(PropertyNamingStrategyInterface $prope
         return $this;
     }
 
+    public function setAdvancedNamingStrategy(AdvancedNamingStrategyInterface $advancedNamingStrategy)
+    {
+        $this->propertyNamingStrategy = $advancedNamingStrategy;
+
+        return $this;
+    }
+
     public function setSerializationVisitor($format, VisitorInterface $visitor)
     {
         $this->visitorsAdded = true;

src/JMS/Serializer/XmlDeserializationVisitor.php

@@ -24,6 +24,7 @@
 use JMS\Serializer\Exception\XmlErrorException;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
 
 class XmlDeserializationVisitor extends AbstractVisitor implements NullAwareVisitorInterface
 {
@@ -232,7 +233,11 @@ public function startVisitingObject(ClassMetadata $metadata, $object, array $typ
 
     public function visitProperty(PropertyMetadata $metadata, $data, Context $context)
     {
-        $name = $this->namingStrategy->translateName($metadata);
+        if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+            $name = $this->namingStrategy->getPropertyName($metadata, $context);
+        } else {
+            $name = $this->namingStrategy->translateName($metadata);
+        }
 
         if (!$metadata->type) {
             throw new RuntimeException(sprintf('You must define a type for %s::$%s.', $metadata->reflection->class, $metadata->name));

src/JMS/Serializer/XmlSerializationVisitor.php

@@ -22,6 +22,7 @@
 use JMS\Serializer\Exception\RuntimeException;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
 use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
 
 /**
@@ -49,7 +50,7 @@ class XmlSerializationVisitor extends AbstractVisitor
     /** @var boolean */
     private $formatOutput;
 
-    public function __construct(PropertyNamingStrategyInterface $namingStrategy, AccessorStrategyInterface $accessorStrategy = null)
+    public function __construct($namingStrategy, AccessorStrategyInterface $accessorStrategy = null)
     {
         parent::__construct($namingStrategy, $accessorStrategy);
         $this->objectMetadataStack = new \SplStack;
@@ -244,7 +245,11 @@ public function visitProperty(PropertyMetadata $metadata, $object, Context $cont
             if (!$node instanceof \DOMCharacterData) {
                 throw new RuntimeException(sprintf('Unsupported value for XML attribute for %s. Expected character data, but got %s.', $metadata->name, json_encode($v)));
             }
-            $attributeName = $this->namingStrategy->translateName($metadata);
+            if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+                $attributeName = $this->namingStrategy->getPropertyName($metadata, $context);
+            } else {
+                $attributeName = $this->namingStrategy->translateName($metadata);
+            }
             $this->setAttributeOnNode($this->currentNode, $attributeName, $node->nodeValue, $metadata->xmlNamespace);
 
             return;
@@ -293,7 +298,11 @@ public function visitProperty(PropertyMetadata $metadata, $object, Context $cont
         }
 
         if ($addEnclosingElement = !$this->isInLineCollection($metadata) && !$metadata->inline) {
-            $elementName = $this->namingStrategy->translateName($metadata);
+            if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+                $elementName = $this->namingStrategy->getPropertyName($metadata, $context);
+            } else {
+                $elementName = $this->namingStrategy->translateName($metadata);
+            }
 
             $namespace = null !== $metadata->xmlNamespace
                 ? $metadata->xmlNamespace

src/JMS/Serializer/YamlSerializationVisitor.php

@@ -21,6 +21,7 @@
 use JMS\Serializer\Accessor\AccessorStrategyInterface;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
 use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
 use JMS\Serializer\Util\Writer;
 use Symfony\Component\Yaml\Inline;
@@ -40,7 +41,7 @@ class YamlSerializationVisitor extends AbstractVisitor
     private $metadataStack;
     private $currentMetadata;
 
-    public function __construct(PropertyNamingStrategyInterface $namingStrategy, AccessorStrategyInterface $accessorStrategy = null)
+    public function __construct($namingStrategy, AccessorStrategyInterface $accessorStrategy = null)
     {
         parent::__construct($namingStrategy, $accessorStrategy);
 
@@ -165,7 +166,11 @@ public function visitProperty(PropertyMetadata $metadata, $data, Context $contex
             return;
         }
 
-        $name = $this->namingStrategy->translateName($metadata);
+        if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
+            $name = $this->namingStrategy->getPropertyName($metadata, $context);
+        } else {
+            $name = $this->namingStrategy->translateName($metadata);
+        }
 
         if (!$metadata->inline) {
             $this->writer

tests/Fixtures/ContextualNamingStrategy.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * Copyright 2016 Johannes M. Schmitt <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace JMS\Serializer\Tests\Fixtures;
+
+use JMS\Serializer\Context;
+use JMS\Serializer\GraphNavigator;
+use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
+
+/**
+ * Class ContextualNamingStrategy
+ *
+ * Only use this class for testing purpose
+ */
+class ContextualNamingStrategy implements AdvancedNamingStrategyInterface
+{
+    public function getPropertyName(PropertyMetadata $property, Context $context)
+    {
+        if ($context->getDirection() == GraphNavigator::DIRECTION_SERIALIZATION) {
+            return strtoupper($property->name);
+        }
+        return ucfirst($property->name);
+    }
+}

tests/SerializerBuilderTest.php

@@ -25,6 +25,8 @@
 use JMS\Serializer\Naming\CamelCaseNamingStrategy;
 use JMS\Serializer\SerializationContext;
 use JMS\Serializer\SerializerBuilder;
+use JMS\Serializer\Tests\Fixtures\ContextualNamingStrategy;
+use JMS\Serializer\Tests\Fixtures\Person;
 use JMS\Serializer\Tests\Fixtures\PersonSecret;
 use JMS\Serializer\Tests\Fixtures\PersonSecretWithVariables;
 use Symfony\Component\ExpressionLanguage\ExpressionFunction;
@@ -249,6 +251,22 @@ public function testExpressionEngineWhenDeserializing()
         $this->assertEquals($person, $object);
     }
 
+    public function testAdvancedNamingStrategy()
+    {
+        $this->builder->setAdvancedNamingStrategy(new ContextualNamingStrategy());
+        $serializer = $this->builder->build();
+
+        $person = new Person();
+        $person->name = "bar";
+
+        $json = $serializer->serialize($person, "json");
+        $this->assertEquals('{"NAME":"bar"}', $json);
+
+        $json = '{"Name": "bar"}';
+        $person = $serializer->deserialize($json, Person::class, "json");
+        $this->assertEquals("bar", $person->name);
+    }
+
     protected function setUp()
     {
         $this->builder = SerializerBuilder::create();