pass CSV headers via context to CsvEncoder

Oliver Hoff · Oliver Hoff · commit dd8de088f5fa · 2017-09-19T12:43:11.000+02:00
diff --git a/src/Symfony/Component/Serializer/Encoder/CsvEncoder.php b/src/Symfony/Component/Serializer/Encoder/CsvEncoder.php
@@ -26,6 +26,7 @@ class CsvEncoder implements EncoderInterface, DecoderInterface
     const ENCLOSURE_KEY = 'csv_enclosure';
     const ESCAPE_CHAR_KEY = 'csv_escape_char';
     const KEY_SEPARATOR_KEY = 'csv_key_separator';
+    const HEADERS_KEY = 'csv_headers';
 
     private $delimiter;
     private $enclosure;
@@ -70,7 +71,7 @@ public function encode($data, $format, array $context = array())
             }
         }
 
-        list($delimiter, $enclosure, $escapeChar, $keySeparator) = $this->getCsvOptions($context);
+        list($delimiter, $enclosure, $escapeChar, $keySeparator, $headers) = $this->getCsvOptions($context);
 
         foreach ($data as &$value) {
             $flattened = array();
@@ -79,7 +80,7 @@ public function encode($data, $format, array $context = array())
         }
         unset($value);
 
-        $headers = $this->extractHeaders($data);
+        $headers = array_merge(array_values($headers), array_diff($this->extractHeaders($data), $headers));
 
         fputcsv($handle, $headers, $delimiter, $enclosure, $escapeChar);
 
@@ -196,8 +197,13 @@ protected function getCsvOptions(array $context)
         $enclosure = isset($context[self::ENCLOSURE_KEY]) ? $context[self::ENCLOSURE_KEY] : $this->enclosure;
         $escapeChar = isset($context[self::ESCAPE_CHAR_KEY]) ? $context[self::ESCAPE_CHAR_KEY] : $this->escapeChar;
         $keySeparator = isset($context[self::KEY_SEPARATOR_KEY]) ? $context[self::KEY_SEPARATOR_KEY] : $this->keySeparator;
+        $headers = isset($context[self::HEADERS_KEY]) ? $context[self::HEADERS_KEY] : array();
+
+        if (!is_array($headers)) {
+            throw new InvalidArgumentException(sprintf('The "%s" context variable must be an array or null, given "%s".', self::HEADERS_KEY, gettype($headers)));
+        }
 
-        return array($delimiter, $enclosure, $escapeChar, $keySeparator);
+        return array($delimiter, $enclosure, $escapeChar, $keySeparator, $headers);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/CsvEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/CsvEncoderTest.php
@@ -153,6 +153,26 @@ public function testEncodeVariableStructure()
         $this->assertEquals($csv, $this->encoder->encode($value, 'csv'));
     }
 
+    public function testEncodeCustomHeaders()
+    {
+        $context = array(
+            CsvEncoder::HEADERS_KEY => array(
+                'b',
+                'c',
+            ),
+        );
+        $value = array(
+            array('a' => 'foo', 'b' => 'bar'),
+        );
+        $csv = <<<CSV
+b,c,a
+bar,,foo
+
+CSV;
+
+        $this->assertEquals($csv, $this->encoder->encode($value, 'csv', $context));
+    }
+
     public function testSupportsDecoding()
     {
         $this->assertTrue($this->encoder->supportsDecoding('csv'));
