[ValueExporter] added TraversableToStringFormatter

symfony · HeahDude · Apr 4, 2016 · Apr 5, 2016 · Apr 9, 2016 · Apr 9, 2016
commit 845aea1f65b20ab895e0aa61872dff3c08a02968
diff --git a/src/Symfony/Component/ValueExporter/Formatter/TraversableToStringFormatter.php b/src/Symfony/Component/ValueExporter/Formatter/TraversableToStringFormatter.php
@@ -0,0 +1,41 @@
+<?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\ValueExporter\Formatter;
+
+/**
+ * Returns a string representation of an instance implementing \Traversable.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class TraversableToStringFormatter extends ExpandedFormatter implements StringFormatterInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($value)
+    {
+        return $value instanceof \Traversable;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function formatToString($value)
+    {
+        $nested = array();
+        foreach ($value as $k => $v) {
+            $nested[] = sprintf('%s => %s', is_string($k) ? sprintf("'%s'", $k) : $k, $this->export($v));
+        }
+
+        return sprintf("Traversable:\"%s\"(\n  %s\n)", get_class($value), implode(",\n  ", $nested));
+    }
+}
diff --git a/src/Symfony/Component/ValueExporter/Tests/Fixtures/TraversableInstance.php b/src/Symfony/Component/ValueExporter/Tests/Fixtures/TraversableInstance.php
@@ -0,0 +1,31 @@
+<?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\ValueExporter\Tests\Fixtures;
+
+/**
+ * TraversableInstance.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class TraversableInstance implements \IteratorAggregate
+{
+    public $property1 = 'value1';
+    public $property2 = 'value2';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator($this);
+    }
+}
diff --git a/src/Symfony/Component/ValueExporter/Tests/ValueExporterTest.php b/src/Symfony/Component/ValueExporter/Tests/ValueExporterTest.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\ValueExporter\Tests;
 
+use Symfony\Component\ValueExporter\Formatter\TraversableToStringFormatter;
+use Symfony\Component\ValueExporter\Tests\Fixtures\TraversableInstance;
 use Symfony\Component\ValueExporter\ValueExporter;
 
 class ValueExporterTest extends \PHPUnit_Framework_TestCase
@@ -46,6 +48,21 @@ public function testExportValueExpanded()
         $this->assertSame($exportedValue, ValueExporter::export($value, 1, true));
     }
 
+    public function testExportTraversable()
+    {
+        ValueExporter::appendFormatter(new TraversableToStringFormatter());
+
+        $value = new TraversableInstance();
+        $exportedValue = <<<EOT
+Traversable:"Symfony\Component\ValueExporter\Tests\Fixtures\TraversableInstance"(
+  'property1' => "value1",
+  'property2' => "value2"
+)
+EOT;
+
+        $this->assertSame($exportedValue, ValueExporter::export($value));
+    }
+
     public function valueProvider()
     {
         $foo = new \__PHP_Incomplete_Class();