feature #17728 [Yaml] add option to dump objects as maps (xabbuh)

fabpot · fabpot · commit 34f3294336f2 · 2016-02-28T11:09:55.000+01:00
This PR was merged into the 3.1-dev branch. Discussion ---------- [Yaml] add option to dump objects as maps | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #9870, #12860, #15781, #15937, #16266 | License | MIT | Doc PR | TODO Commits ------- 3941d2e [Yaml] add option to dump objects as maps
diff --git a/src/Symfony/Component/Yaml/Inline.php b/src/Symfony/Component/Yaml/Inline.php
@@ -159,6 +159,10 @@ public static function dump($value, $flags = 0)
                     return '!php/object:'.serialize($value);
                 }
 
+                if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($value instanceof \stdClass || $value instanceof \ArrayObject)) {
+                    return self::dumpArray((array) $value, $flags);
+                }
+
                 if (Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE & $flags) {
                     throw new DumpException('Object support when dumping a YAML file has been disabled.');
                 }
diff --git a/src/Symfony/Component/Yaml/Tests/DumperTest.php b/src/Symfony/Component/Yaml/Tests/DumperTest.php
@@ -292,6 +292,46 @@ public function testBinaryDataIsDumpedBase64EncodedWithFlag()
 
         $this->assertSame($expected, $this->dumper->dump(array('data' => $binaryData), 0, 0, Yaml::DUMP_BASE64_BINARY_DATA));
     }
+
+    /**
+     * @dataProvider objectAsMapProvider
+     */
+    public function testDumpObjectAsMap($object, $expected)
+    {
+
+        $yaml = $this->dumper->dump($object, 0, 0, Yaml::DUMP_OBJECT_AS_MAP);
+
+        $this->assertEquals($expected, Yaml::parse($yaml, Yaml::PARSE_OBJECT_FOR_MAP));
+    }
+
+    public function objectAsMapProvider()
+    {
+        $tests = array();
+
+        $bar = new \stdClass();
+        $bar->class = 'classBar';
+        $bar->args = array('bar');
+        $zar = new \stdClass();
+        $foo = new \stdClass();
+        $foo->bar = $bar;
+        $foo->zar = $zar;
+        $object = new \stdClass();
+        $object->foo = $foo;
+        $tests['stdClass'] = array($object, $object);
+
+        $arrayObject = new \ArrayObject();
+        $arrayObject['foo'] = 'bar';
+        $arrayObject['baz'] = 'foobar';
+        $parsedArrayObject = new \stdClass();
+        $parsedArrayObject->foo = 'bar';
+        $parsedArrayObject->baz = 'foobar';
+        $tests['ArrayObject'] = array($arrayObject, $parsedArrayObject);
+
+        $a = new A();
+        $tests['arbitrary-object'] = array($a, null);
+
+        return $tests;
+    }
 }
 
 class A
diff --git a/src/Symfony/Component/Yaml/Yaml.php b/src/Symfony/Component/Yaml/Yaml.php
@@ -27,6 +27,7 @@ class Yaml
     const DUMP_EXCEPTION_ON_INVALID_TYPE = 16;
     const PARSE_DATETIME = 32;
     const DUMP_BASE64_BINARY_DATA = 64;
+    const DUMP_OBJECT_AS_MAP = 128;
 
     /**
      * Parses YAML into a PHP value.

Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,10 @@ public static function dump($value, $flags = 0)`
`159`	`159`	`return '!php/object:'.serialize($value);`
`160`	`160`	`}`
`161`	`161`
	`162`	`+ if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($value instanceof \stdClass \|\| $value instanceof \ArrayObject)) {`
	`163`	`+ return self::dumpArray((array) $value, $flags);`
	`164`	`+ }`
	`165`	`+`
`162`	`166`	`if (Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE & $flags) {`
`163`	`167`	`throw new DumpException('Object support when dumping a YAML file has been disabled.');`
`164`	`168`	`}`