Skip to content

feature Add the possibility by filtering csv values by headers #48448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 7.4
Choose a base branch
from
+59 −3
Open

feature Add the possibility by filtering csv values by headers #48448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions src/Symfony/Component/Serializer/Encoder/CsvEncoder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ class CsvEncoder implements EncoderInterface, DecoderInterface
public const ESCAPE_CHAR_KEY = 'csv_escape_char';
public const KEY_SEPARATOR_KEY = 'csv_key_separator';
public const HEADERS_KEY = 'csv_headers';
public const CSV_FILTER_VALUES_BY_HEADERS_KEY = 'csv_filter_values_by_headers';
public const ESCAPE_FORMULAS_KEY = 'csv_escape_formulas';
public const AS_COLLECTION_KEY = 'as_collection';
public const NO_HEADERS_KEY = 'no_headers';
Expand All @@ -47,6 +48,7 @@ class CsvEncoder implements EncoderInterface, DecoderInterface
self::HEADERS_KEY => [],
self::KEY_SEPARATOR_KEY => '.',
self::NO_HEADERS_KEY => false,
self::CSV_FILTER_VALUES_BY_HEADERS_KEY => false,
self::AS_COLLECTION_KEY => true,
self::OUTPUT_UTF8_BOM_KEY => false,
];
Expand Down Expand Up @@ -86,10 +88,17 @@ public function encode(mixed $data, string $format, array $context = []): string
}
unset($value);

$headers = array_merge(array_values($headers), array_diff($this->extractHeaders($data), $headers));
$noHeaders = $context[self::NO_HEADERS_KEY] ?? $this->defaultContext[self::NO_HEADERS_KEY];
$filterByHeaders = !$noHeaders ? $context[self::CSV_FILTER_VALUES_BY_HEADERS_KEY] ??
$this->defaultContext[self::CSV_FILTER_VALUES_BY_HEADERS_KEY] : false;

$headers = array_merge(
array_values($headers),
$filterByHeaders ? [] : array_diff($this->extractHeaders($data), $headers)
);
$endOfLine = $context[self::END_OF_LINE] ?? $this->defaultContext[self::END_OF_LINE];

if (!($context[self::NO_HEADERS_KEY] ?? $this->defaultContext[self::NO_HEADERS_KEY])) {
if (!$noHeaders) {
fputcsv($handle, $headers, $delimiter, $enclosure, $escapeChar);
if ("\n" !== $endOfLine && 0 === fseek($handle, -1, \SEEK_CUR)) {
fwrite($handle, $endOfLine);
Expand All @@ -98,7 +107,9 @@ public function encode(mixed $data, string $format, array $context = []): string

$headers = array_fill_keys($headers, '');
foreach ($data as $row) {
fputcsv($handle, array_replace($headers, $row), $delimiter, $enclosure, $escapeChar);
$fields = $filterByHeaders ? array_replace($headers, array_intersect_key($row, $headers)) :
array_replace($headers, $row);
fputcsv($handle, $fields, $delimiter, $enclosure, $escapeChar);
if ("\n" !== $endOfLine && 0 === fseek($handle, -1, \SEEK_CUR)) {
fwrite($handle, $endOfLine);
}
Expand Down
45 changes: 45 additions & 0 deletions src/Symfony/Component/Serializer/Tests/Encoder/CsvEncoderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,51 @@ public function testEncodeCustomHeaders()
$this->assertEquals($csv, $this->encoder->encode($value, 'csv', $context));
}

public function testEncodeCustomHeadersWithFilteringValuesByHeaders()
{
$context = [
CsvEncoder::HEADERS_KEY => [
'c',
'd',
'b',
],
CsvEncoder::CSV_FILTER_VALUES_BY_HEADERS_KEY => true,
];
$value = [
['a' => 'foo', 'b' => 'bar', 'd' => 'hey ho'],
];
$csv = <<<CSV
c,d,b
,"hey ho",bar

CSV;

$this->assertEquals($csv, $this->encoder->encode($value, 'csv', $context));
}

public function testEncodeWithoutHeadersAndWithFilteringValuesByHeadersShouldIgnoreFiltering()
{
$this->assertSame(<<<'CSV'
a,b
c,d

CSV
, $this->encoder->encode([['a', 'b'], ['c', 'd']], 'csv', [
CsvEncoder::NO_HEADERS_KEY => true,
CsvEncoder::CSV_FILTER_VALUES_BY_HEADERS_KEY => true,
]));
$encoder = new CsvEncoder([CsvEncoder::NO_HEADERS_KEY => true]);
$this->assertSame(<<<'CSV'
a,b
c,d

CSV
, $encoder->encode([['a', 'b'], ['c', 'd']], 'csv', [
CsvEncoder::NO_HEADERS_KEY => true,
CsvEncoder::CSV_FILTER_VALUES_BY_HEADERS_KEY => true,
]));
}

public function testEncodeFormulas()
{
$this->encoder = new CsvEncoder([CsvEncoder::ESCAPE_FORMULAS_KEY => true]);
Expand Down