Merge pull request #273 from jockri/replace_data

Allow Post Serialize Event to overwrite existing data
schmittjoh · Sep 9, 2016 · 447c7d3 · schmittjoh · Sep 10, 2016 · 447c7d3
2 parents b359a1b + 6314d9f
commit 447c7d3
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 3 deletions.
diff --git a/src/JMS/Serializer/GenericSerializationVisitor.php b/src/JMS/Serializer/GenericSerializationVisitor.php
@@ -163,8 +163,8 @@ public function visitProperty(PropertyMetadata $metadata, $data, Context $contex
      * Allows you to add additional data to the current object/root element.
      *
      * @param string $key
-     * @param integer|float|boolean|string|array $value This value must either be a regular scalar, or an array.
-     *                                                  It must not contain any objects anymore.
+     * @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
+     *                                                       It must not contain any objects anymore.
      */
     public function addData($key, $value)
     {
@@ -174,7 +174,7 @@ public function addData($key, $value)
 
         $this->data[$key] = $value;
     }
-    
+
     /**
      * Checks if some data key exists.
      *
@@ -186,6 +186,18 @@ public function hasData($key)
         return isset($this->data[$key]);
     }
 
+    /**
+     * Allows you to replace existing data on the current object/root element.
+     *
+     * @param string $key
+     * @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
+     *                                                       It must not contain any objects anymore.
+     */
+    public function replaceData($key, $value)
+    {
+        $this->data[$key] = $value;
+    }
+
     public function getRoot()
     {
         return $this->root;

diff --git a/tests/JMS/Serializer/Tests/Serializer/JsonSerializationTest.php b/tests/JMS/Serializer/Tests/Serializer/JsonSerializationTest.php
@@ -134,6 +134,21 @@ function(VisitorInterface $visitor, AuthorList $data, array $type, Context $cont
         $this->assertEquals('[{"full_name":"foo","_links":{"details":"http:\/\/foo.bar\/details\/foo","comments":"http:\/\/foo.bar\/details\/foo\/comments"}},{"full_name":"bar","_links":{"details":"http:\/\/foo.bar\/details\/bar","comments":"http:\/\/foo.bar\/details\/bar\/comments"}}]', $this->serialize($list));
     }
 
+    public function testReplaceNameInOutput()
+    {
+        $this->dispatcher->addSubscriber(new ReplaceNameSubscriber());
+        $this->handlerRegistry->registerHandler(GraphNavigator::DIRECTION_SERIALIZATION, 'JMS\Serializer\Tests\Fixtures\AuthorList', 'json',
+            function(VisitorInterface $visitor, AuthorList $data, array $type, Context $context) {
+                return $visitor->visitArray(iterator_to_array($data), $type, $context);
+            }
+        );
+
+        $list = new AuthorList();
+        $list->add(new Author('foo'));
+        $list->add(new Author('bar'));
+
+        $this->assertEquals('[{"full_name":"new name"},{"full_name":"new name"}]', $this->serialize($list));
+    }
 
     /**
      * @expectedException RuntimeException
@@ -268,3 +283,18 @@ public static function getSubscribedEvents()
         );
     }
 }
+
+class ReplaceNameSubscriber implements EventSubscriberInterface
+{
+    public function onPostSerialize(Event $event)
+    {
+        $event->getVisitor()->replaceData('full_name', 'new name');
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return array(
+            array('event' => 'serializer.post_serialize', 'method' => 'onPostSerialize', 'format' => 'json', 'class' => 'JMS\Serializer\Tests\Fixtures\Author'),
+        );
+    }
+}