Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #19197 [Serializer][FrameworkBundle] Add a CSV encoder (dunglas)
This PR was squashed before being merged into the 3.2-dev branch (closes #19197). Discussion ---------- [Serializer][FrameworkBundle] Add a CSV encoder | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | todo Usage: ```php use Symfony\Component\Serializer\Serializer; use Symfony\Component\Serializer\Encoder\CsvEncoder; use Symfony\Component\Serializer\Normalizer\ObjectNormalizer; $serializer = new Serializer(array(new ObjectNormalizer()), array(new CsvEncoder())); // or $serializer = $container->get('serializer'); when using the full stack framework $serializer->encode($something, 'csv'); $serializer->decode(<<<'CSV' id,name 1,Kévin CSV , 'csv'); ``` CSV files must contain a header line with property names as keys. ping @clementtalleu @Simperfit @gorghoa Commits ------- e71f5be [Serializer][FrameworkBundle] Add a CSV encoder
- Loading branch information
Showing
3 changed files
with
419 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
181 changes: 181 additions & 0 deletions
181
src/Symfony/Component/Serializer/Encoder/CsvEncoder.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,181 @@ | ||
<?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\Serializer\Encoder; | ||
|
||
use Symfony\Component\Serializer\Exception\InvalidArgumentException; | ||
|
||
/** | ||
* Encodes CSV data. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class CsvEncoder implements EncoderInterface, DecoderInterface | ||
{ | ||
const FORMAT = 'csv'; | ||
|
||
private $delimiter; | ||
private $enclosure; | ||
private $escapeChar; | ||
private $keySeparator; | ||
|
||
/** | ||
* @param string $delimiter | ||
* @param string $enclosure | ||
* @param string $escapeChar | ||
* @param string $keySeparator | ||
*/ | ||
public function __construct($delimiter = ',', $enclosure = '"', $escapeChar = '\\', $keySeparator = '.') | ||
{ | ||
$this->delimiter = $delimiter; | ||
$this->enclosure = $enclosure; | ||
$this->escapeChar = $escapeChar; | ||
$this->keySeparator = $keySeparator; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function encode($data, $format, array $context = array()) | ||
{ | ||
$handle = fopen('php://temp,', 'w+'); | ||
|
||
if (!is_array($data)) { | ||
$data = array(array($data)); | ||
} elseif (empty($data)) { | ||
$data = array(array()); | ||
} else { | ||
// Sequential arrays of arrays are considered as collections | ||
$i = 0; | ||
foreach ($data as $key => $value) { | ||
if ($i !== $key || !is_array($value)) { | ||
$data = array($data); | ||
break; | ||
} | ||
|
||
++$i; | ||
} | ||
} | ||
|
||
$headers = null; | ||
foreach ($data as $value) { | ||
$result = array(); | ||
$this->flatten($value, $result); | ||
|
||
if (null === $headers) { | ||
$headers = array_keys($result); | ||
fputcsv($handle, $headers, $this->delimiter, $this->enclosure, $this->escapeChar); | ||
} elseif (array_keys($result) !== $headers) { | ||
throw new InvalidArgumentException('To use the CSV encoder, each line in the data array must have the same structure. You may want to use a custom normalizer class to normalize the data format before passing it to the CSV encoder.'); | ||
} | ||
|
||
fputcsv($handle, $result, $this->delimiter, $this->enclosure, $this->escapeChar); | ||
} | ||
|
||
rewind($handle); | ||
$value = stream_get_contents($handle); | ||
fclose($handle); | ||
|
||
return $value; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function supportsEncoding($format) | ||
{ | ||
return self::FORMAT === $format; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function decode($data, $format, array $context = array()) | ||
{ | ||
$handle = fopen('php://temp', 'r+'); | ||
fwrite($handle, $data); | ||
rewind($handle); | ||
|
||
$headers = null; | ||
$nbHeaders = 0; | ||
$result = array(); | ||
|
||
while (false !== ($cols = fgetcsv($handle, 0, $this->delimiter, $this->enclosure, $this->escapeChar))) { | ||
$nbCols = count($cols); | ||
|
||
if (null === $headers) { | ||
$nbHeaders = $nbCols; | ||
|
||
foreach ($cols as $col) { | ||
$headers[] = explode($this->keySeparator, $col); | ||
} | ||
|
||
continue; | ||
} | ||
|
||
$item = array(); | ||
for ($i = 0; ($i < $nbCols) && ($i < $nbHeaders); ++$i) { | ||
$depth = count($headers[$i]); | ||
$arr = &$item; | ||
for ($j = 0; $j < $depth; ++$j) { | ||
// Handle nested arrays | ||
if ($j === ($depth - 1)) { | ||
$arr[$headers[$i][$j]] = $cols[$i]; | ||
|
||
continue; | ||
} | ||
|
||
if (!isset($arr[$headers[$i][$j]])) { | ||
$arr[$headers[$i][$j]] = array(); | ||
} | ||
|
||
$arr = &$arr[$headers[$i][$j]]; | ||
} | ||
} | ||
|
||
$result[] = $item; | ||
} | ||
fclose($handle); | ||
|
||
if (empty($result) || isset($result[1])) { | ||
return $result; | ||
} | ||
|
||
// If there is only one data line in the document, return it (the line), the result is not considered as a collection | ||
return $result[0]; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function supportsDecoding($format) | ||
{ | ||
return self::FORMAT === $format; | ||
} | ||
|
||
/** | ||
* Flattens an array and generates keys including the path. | ||
* | ||
* @param array $array | ||
* @param array $result | ||
* @param string $parentKey | ||
*/ | ||
private function flatten(array $array, array &$result, $parentKey = '') | ||
{ | ||
foreach ($array as $key => $value) { | ||
if (is_array($value)) { | ||
$this->flatten($value, $result, $parentKey.$key.$this->keySeparator); | ||
} else { | ||
$result[$parentKey.$key] = $value; | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.