Merge pull request #85 from otoso/master

Add BOM handling for all platforms

Author: dereuromark

src/View/CsvView.php

@@ -99,6 +99,13 @@ class CsvView extends View
      */
     const EXTENSION_MBSTRING = 'mbstring';
 
+    /**
+     * List of bom signs for encodings.
+     *
+     * @var array
+     */
+    protected $bomMap;
+
     /**
      * List of special view vars.
      *
@@ -135,6 +142,14 @@ public function __construct(
         EventManager $eventManager = null,
         array $viewOptions = []
     ) {
+        $this->bomMap = [
+            'UTF-32BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
+            'UTF-32LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
+            'UTF-16BE' => chr(0xFE) . chr(0xFF),
+            'UTF-16LE' => chr(0xFF) . chr(0xFE),
+            'UTF-8' => chr(0xEF) . chr(0xBB) . chr(0xBF),
+        ];
+
         parent::__construct($request, $response, $eventManager, $viewOptions);
 
         if ($response && $response instanceof Response) {
@@ -388,9 +403,6 @@ protected function _generateRow($row = null)
         if ($fp === false) {
             $fp = fopen('php://temp', 'r+');
 
-            if ($this->viewVars['_bom']) {
-                fwrite($fp, chr(0xEF) . chr(0xBB) . chr(0xBF));
-            }
             if ($this->viewVars['_setSeparator']) {
                 fwrite($fp, "sep=" . $this->viewVars['_delimiter'] . "\n");
             }
@@ -445,6 +457,24 @@ protected function _generateRow($row = null)
             }
         }
 
+        //bom must be added after encoding
+        if ($this->viewVars['_bom']) {
+            $csv = $this->getBom($this->viewVars['_csvEncoding']) . $csv;
+        }
+
         return $csv;
     }
+
+    /**
+     * Returns the BOM for the encoding given.
+     *
+     * @param string $csvEncoding The encoding you want the BOM for
+     * @return string
+     */
+    protected function getBom($csvEncoding)
+    {
+        $csvEncoding = strtoupper($csvEncoding);
+
+        return isset($this->bomMap[$csvEncoding]) ? $this->bomMap[$csvEncoding] : '';
+    }
 }

tests/TestCase/View/CsvViewTest.php

@@ -41,6 +41,27 @@ public function testRenderWithoutView()
         $this->assertSame('text/csv', $this->response->getType());
     }
 
+    /**
+     * testBom method
+     *
+     * @return void
+     */
+    public function testBom()
+    {
+        if (!extension_loaded('mbstring')) {
+            $this->markTestSkipped(
+                'The mbstring extension is not available.'
+            );
+        }
+
+        $data = [['test']];
+        $this->view->set(['data' => $data, '_serialize' => 'data', '_bom' => true, '_csvEncoding' => 'UTF-16LE']);
+        $output = $this->view->render(false);
+
+        $expected = chr(0xFF) . chr(0xFE) . mb_convert_encoding('test' . PHP_EOL, 'UTF-16LE', 'UTF-8');
+        $this->assertSame($expected, $output);
+    }
+
     /**
      * Test render with an array in _serialize
      *