Introduce value formatters

src/Bridge/Symfony/DependencyInjection/Configuration.php

@@ -75,6 +75,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                                     ->defaultValue(false)
                                     ->info('include the byte order mark')
                                 ->end()
+                                ->arrayNode('formatters')
+                                    ->defaultValue($this->getDefaultFormatters())
+                                    ->prototype('scalar')->end()
+                                ->end()
                             ->end()
                         ->end()
                         ->arrayNode('json')
@@ -84,6 +88,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                                     ->defaultValue('php://output')
                                     ->info('path to the output file')
                                 ->end()
+                                ->arrayNode('formatters')
+                                    ->defaultValue($this->getDefaultFormatters())
+                                    ->prototype('scalar')->end()
+                                ->end()
                             ->end()
                         ->end()
                         ->arrayNode('xls')
@@ -97,6 +105,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                                     ->defaultValue(true)
                                     ->info('add column names as the first line')
                                 ->end()
+                                ->arrayNode('formatters')
+                                    ->defaultValue($this->getDefaultFormatters())
+                                    ->prototype('scalar')->end()
+                                ->end()
                             ->end()
                         ->end()
                         ->arrayNode('xlsx')
@@ -114,6 +126,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                                     ->defaultValue(true)
                                     ->info('add filters in the first line')
                                 ->end()
+                                ->arrayNode('formatters')
+                                    ->defaultValue($this->getDefaultFormatters())
+                                    ->prototype('scalar')->end()
+                                ->end()
                             ->end()
                         ->end()
                         ->arrayNode('xml')
@@ -135,6 +151,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                                     ->defaultValue('data')
                                     ->info('name of elements corresponding to rows')
                                 ->end()
+                                ->arrayNode('formatters')
+                                    ->defaultValue($this->getDefaultFormatters())
+                                    ->prototype('scalar')->end()
+                                ->end()
                             ->end()
                         ->end()
                     ->end()
@@ -157,4 +177,12 @@ private function getDefaultWriters(): array
 
         return $fields;
     }
+
+    /**
+     * @return string[]
+     */
+    private function getDefaultFormatters(): array
+    {
+        return ['datetime', 'dateinterval', 'bool', 'enum', 'stringable'];
+    }
 }

src/Bridge/Symfony/DependencyInjection/SonataExporterExtension.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
@@ -60,6 +61,14 @@ private function configureExporter(ContainerBuilder $container, array $config):
     private function configureWriters(ContainerBuilder $container, array $config): void
     {
         foreach ($config as $format => $settings) {
+            if ($container->hasDefinition('sonata.exporter.writer.'.$format)) {
+                $writer = $container->getDefinition('sonata.exporter.writer.'.$format);
+
+                foreach ($config[$format]['formatters'] as $formatter) {
+                    $writer->addMethodCall('addFormatter', [new Reference('sonata.exporter.formatter.'.$formatter)]);
+                }
+            }
+
             foreach ($settings as $key => $value) {
                 $container->setParameter(sprintf(
                     'sonata.exporter.writer.%s.%s',

src/Bridge/Symfony/Resources/config/services.php

@@ -16,6 +16,8 @@
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use Sonata\Exporter\Exporter;
 use Sonata\Exporter\ExporterInterface;
+use Sonata\Exporter\Formatter\BoolFormatter;
+use Sonata\Exporter\Formatter\EnumFormatter;
 use Sonata\Exporter\Writer\CsvWriter;
 use Sonata\Exporter\Writer\JsonWriter;
 use Sonata\Exporter\Writer\XlsWriter;
@@ -67,4 +69,9 @@
 
     $services->alias(Exporter::class, 'sonata.exporter.exporter');
     $services->alias(ExporterInterface::class, 'sonata.exporter.exporter');
+
+    $services->set('sonata.exporter.formatter.bool', BoolFormatter::class)
+        ->tag('sonata.exporter.formatter');
+    $services->set('sonata.exporter.formatter.enum', EnumFormatter::class)
+        ->tag('sonata.exporter.formatter');
 };

src/Formatter/BoolFormatter.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+final class BoolFormatter implements FormatterInterface
+{
+    private const LABEL_TRUE = 'yes';
+    private const LABEL_FALSE = 'no';
+
+    public function __construct(
+        private string $trueLabel = self::LABEL_TRUE,
+        private string $falseLabel = self::LABEL_FALSE
+    ) {
+    }
+
+    public function format(array $data): array
+    {
+        foreach ($data as $key => $value) {
+            if (!\is_bool($value)) {
+                continue;
+            }
+
+            $data[$key] = $value ? $this->trueLabel : $this->falseLabel;
+        }
+
+        return $data;
+    }
+}

src/Formatter/DateIntervalFormatter.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+final class DateIntervalFormatter implements FormatterInterface
+{
+    private const DATE_PARTS = [
+        'y' => 'Y',
+        'm' => 'M',
+        'd' => 'D',
+    ];
+    private const TIME_PARTS = [
+        'h' => 'H',
+        'i' => 'M',
+        's' => 'S',
+    ];
+
+    public function format(array $data): array
+    {
+        foreach ($data as $key => $value) {
+            if (!$value instanceof \DateInterval) {
+                continue;
+            }
+
+            $data[$key] = self::getDuration($value);
+        }
+
+        return $data;
+    }
+
+    /**
+     * @return string An ISO8601 duration
+     */
+    private static function getDuration(\DateInterval $interval): string
+    {
+        $datePart = '';
+
+        foreach (self::DATE_PARTS as $datePartAttribute => $datePartAttributeString) {
+            if ($interval->$datePartAttribute !== 0) {
+                $datePart .= $interval->$datePartAttribute.$datePartAttributeString;
+            }
+        }
+
+        $timePart = '';
+
+        foreach (self::TIME_PARTS as $timePartAttribute => $timePartAttributeString) {
+            if ($interval->$timePartAttribute !== 0) {
+                $timePart .= $interval->$timePartAttribute.$timePartAttributeString;
+            }
+        }
+
+        if ('' === $datePart && '' === $timePart) {
+            return 'P0Y';
+        }
+
+        return 'P'.$datePart.('' !== $timePart ? 'T'.$timePart : '');
+    }
+}

src/Formatter/DateTimeFormatter.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+final class DateTimeFormatter implements FormatterInterface
+{
+    public function __construct(
+        private string $dateTimeFormat = \DateTimeInterface::RFC2822
+    ) {
+    }
+
+    public function format(array $data): array
+    {
+        foreach ($data as $key => $value) {
+            if (!$value instanceof \DateTimeInterface) {
+                continue;
+            }
+
+            $data[$key] = $value->format($this->dateTimeFormat);
+        }
+
+        return $data;
+    }
+}

src/Formatter/EnumFormatter.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+final class EnumFormatter implements FormatterInterface
+{
+    public function __construct(
+        private bool $useBackedEnumValue = true
+    ) {
+    }
+
+    public function format(array $data): array
+    {
+        foreach ($data as $key => $value) {
+            if (!$value instanceof \UnitEnum) {
+                continue;
+            }
+
+            if ($this->useBackedEnumValue && $value instanceof \BackedEnum) {
+                $data[$key] = $value->value;
+
+                continue;
+            }
+
+            $data[$key] = $value->name;
+        }
+
+        return $data;
+    }
+}

src/Formatter/FormatterInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+interface FormatterInterface
+{
+    public function format(array $data): array;
+}

src/Formatter/IterableFormatter.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+final class IterableFormatter implements FormatterInterface
+{
+    public function __construct(
+        private array $formatters = []
+    ) {
+    }
+
+    public function format(array $data, array $formatters = []): array
+    {
+        $this->formatters = $formatters;
+        foreach ($data as $key => $value) {
+            if (!is_iterable($value)) {
+                continue;
+            }
+
+            if ($value instanceof \Iterator) {
+                $value = iterator_to_array($value);
+            }
+
+            $data[$key] = '['.implode(', ', array_map([$this, 'formatFromIterable'], $value)).']';
+        }
+
+        return $data;
+    }
+
+    private function formatFromIterable(mixed $value): mixed
+    {
+        foreach ($this->formatters as $formatter) {
+            $value = $formatter->format($value, $this->formatters);
+        }
+
+        return $value;
+    }
+}

src/Formatter/StringableFormatter.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Exporter\Formatter;
+
+final class StringableFormatter implements FormatterInterface
+{
+    public function format(array $data): array
+    {
+        foreach ($data as $key => $value) {
+            if (!$value instanceof \Stringable) {
+                continue;
+            }
+
+            $data[$key] = (string) $value;
+        }
+
+        return $data;
+    }
+}