Adds an option to export CSV with labels as heading

Controller/DynamicController.php

@@ -64,32 +64,40 @@ class DynamicController implements ClassResourceInterface
      */
     private $viewHandler;
 
+    /**
+     * @var bool
+     */
+    private $prefersLabeledExports;
+
     public function __construct(
         DynamicRepository $dynamicRepository,
         DynamicListFactory $dynamicListFactory,
         MediaManagerInterface $mediaManager,
         EntityManager $entityManager,
         FormRepository $formRepository,
-        ViewHandler $viewHandler
+        ViewHandler $viewHandler,
+        bool $prefersLabeledExports
     ) {
         $this->dynamicRepository = $dynamicRepository;
         $this->dynamicListFactory = $dynamicListFactory;
         $this->mediaManager = $mediaManager;
         $this->entityManager = $entityManager;
         $this->formRepository = $formRepository;
         $this->viewHandler = $viewHandler;
+        $this->prefersLabeledExports = $prefersLabeledExports;
     }
 
     /**
      * Return dynamic form entries.
      */
     public function cgetAction(Request $request): Response
     {
+        $locale = $this->getLocale($request);
         $filters = $this->getFilters($request);
+        $view = $this->getView($request);
         $page = $request->get('page', 1);
         $limit = $request->get('limit');
         $offset = (int) (($page - 1) * $limit);
-        $view = $request->get('view', 'default');
         $sortOrder = $request->get('sortOrder', 'asc');
         $sortBy = $request->get('sortBy', 'created');
 
@@ -100,7 +108,7 @@ public function cgetAction(Request $request): Response
             $offset
         );
 
-        $entries = $this->dynamicListFactory->build($entries, $view);
+        $entries = $this->dynamicListFactory->build($entries, $locale, $view);
 
         // avoid total request when entries < limit
         if (\count($entries) == $limit) {
@@ -185,4 +193,11 @@ public function getLocale(Request $request): ?string
     {
         return $request->get('locale', $request->getLocale());
     }
+
+    public function getView(Request $request): string
+    {
+        $defaultView = ($this->prefersLabeledExports && $request->getRequestFormat() === 'csv') ? 'labeled' : 'default';
+
+        return $request->get('view', $defaultView);
+    }
 }

DependencyInjection/Configuration.php

@@ -145,6 +145,10 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->arrayNode('dynamic_disabled_types')
                 ->prototype('scalar')->end()->defaultValue([])
             ->end()
+            ->booleanNode('dynamic_labeled_exports')
+                ->info('Prefers labels instead of fields key as headings during export.')
+                ->defaultFalse()
+            ->end()
         ;
 
         return $treeBuilder;

DependencyInjection/SuluFormExtension.php

@@ -151,6 +151,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('sulu_form.media_collection_strategy', $mediaCollectionStrategy);
         $container->setParameter('sulu_form.static_forms', $config['static_forms']);
         $container->setParameter('sulu_form.dynamic_disabled_types', $config['dynamic_disabled_types']);
+        $container->setParameter('sulu_form.dynamic_labeled_exports', $config['dynamic_labeled_exports']);
 
         // Default Media Collection Strategy
         $container->setAlias(

ListBuilder/DynamicLabeledListBuilder.php

@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\FormBundle\ListBuilder;
+
+use Sulu\Bundle\FormBundle\Entity\Dynamic;
+use Sulu\Bundle\FormBundle\Entity\Form;
+
+class DynamicLabeledListBuilder extends DynamicListBuilder
+{
+    private $formFieldsLabelCache = [];
+
+    public function build(Dynamic $dynamic, string $locale): array
+    {
+        $entry = parent::build($dynamic, $locale);
+
+        if (empty($entry)) {
+            return $entry;
+        }
+
+        $labels = $this->getLabels($dynamic->getForm(), $locale);
+        $entryLabeled = [];
+
+        foreach ($entry[0] as $key => $value) {
+            $entryLabeled[$labels[$key] ?? $key] = $value;
+        }
+
+        return [$entryLabeled];
+    }
+
+    private function getLabels(Form $form, string $locale): array
+    {
+        if (!isset($this->formFieldsLabelCache[$form->getId()])) {
+            $labels = [];
+
+            foreach ($form->getFields() as $field) {
+                $label = '';
+                $translation = $field->getTranslation($locale, false, true);
+
+                if ($translation) {
+                    $label = $translation->getShortTitle() ?: \strip_tags($translation->getTitle());
+                }
+
+                $labels[$field->getKey()] = $label;
+            }
+
+            $this->formFieldsLabelCache[$form->getId()] = $labels;
+        }
+
+        return $this->formFieldsLabelCache[$form->getId()];
+    }
+}

Resources/config/services.xml

@@ -120,6 +120,14 @@
             <tag name="sulu_form.dynamic_list_builder" alias="simple" />
         </service>
 
+        <service id="sulu_form.list_builder.dynamic_labeled_list_builder"
+                 class="Sulu\Bundle\FormBundle\ListBuilder\DynamicLabeledListBuilder">
+            <argument>%sulu_form.dynamic_list_builder.delimiter%</argument>
+            <argument type="service" id="router" />
+
+            <tag name="sulu_form.dynamic_list_builder" alias="labeled" />
+        </service>
+
         <!-- Repositories -->
         <service id="sulu_form.repository.form" class="Sulu\Bundle\FormBundle\Repository\FormRepository">
             <factory service="doctrine.orm.entity_manager" method="getRepository"/>
@@ -197,6 +205,7 @@
             <argument type="service" id="doctrine.orm.entity_manager"/>
             <argument type="service" id="sulu_form.repository.form"/>
             <argument type="service" id="fos_rest.view_handler"/>
+            <argument>%sulu_form.dynamic_labeled_exports%</argument>
         </service>
 
         <!-- Form Controller -->

Resources/doc/dynamic.md

@@ -241,6 +241,14 @@ sulu_form:
         protected: true
 ```
 
+## Export to CSV with labels as heading
+By default, forms are exported with the first row filled with the field keys. Enable the following option to fill it with field labels instead:
+
+```yml
+sulu_form:
+    dynamic_labeled_exports: true
+```
+
 ## Test Checklist
 
 The following things you should check when implement the dynamic form type on your website.