Allow bulk-export of submissions

[tobimori]

Namely in the CSV format.

[medienbaecker]

Did anyone start building something like this (or a hacky workaround for the time being) in the meantime? It should be straight forward because the submissions are regular pages. But I'm not sure how (and where?) to add the "export" button.

[medienbaecker]

I needed a quick & dirty solution for this in my project:

<?php

use Kirby\Cms\App as Kirby;
use Kirby\Cms\Find;
use Kirby\Cms\Response;
use Kirby\Http\Header;

Kirby::plugin('my/dreamform-export', [
  'areas' => [
    'site' => function ($kirby) {
      return [
        'dropdowns' => [
          'page' => function (string $id) {

            $page = Find::page($id);

            // Load the core dropdown definition
            $dropdown = $page->panel()->dropdown();

            if ($page->intendedTemplate() == 'form') {

              array_unshift($dropdown, '-');
              array_unshift($dropdown, [
                'icon'   => 'download',
                'text'   => 'Export submissions',
                'link' => $page->url() . '.csv',
                'target' => '_blank'
              ]);
            }

            return $dropdown;
          }
        ]
      ];
    },
  ],
  'routes' => [
    [
      'pattern' => 'forms/(:any).csv',
      'action'  => function ($form) {

        // Check authentication
        if (!kirby()->user()) {
          $this->next();
        }

        // Get form page
        $page = page('forms/' . $form);
        if (!$page) {
          $this->next();
        }

        // Get sorted submissions
        $submissions = $page->children()->sortBy('dreamform_submitted', 'asc');

        // Set download headers
        Header::download([
          'mime' => 'application/csv',
          'name' => $page->title() . '.csv'
        ]);

        // Build fields array
        $fields = ['dreamform_submitted'];
        $firstSubmission = $submissions->first();
        if ($firstSubmission && $firstSubmission->form()->fields()) {
          foreach ($firstSubmission->form()->fields() as $field) {
            $fields[] = $field->key();
          }
        }

        // Build headers array
        $headers = ['Datum'];
        if ($page->fields()) {
          foreach ($page->fields() as $field) {
            $headers[] = $field->label();
          }
        }

        // Build CSV data array
        $csvData = [];
        $csvData[] = '"' . implode('";"', $headers) . '"';

        foreach ($submissions as $submission) {
          $row = [];
          foreach ($fields as $field) {
            $value = $submission->$field();
            // Sanitize value
            $value = str_replace('"', '""', $value); // Escape quotes
            $value = trim($value);
            $row[] = $value;
          }
          $csvData[] = '"' . implode('";"', $row) . '"';
        }

        // Join with newlines
        $output = implode("\n", $csvData);

        return new Response($output, 'application/csv');
      }
    ],
  ]
]);

This simple plugin adds a dropdown option in form pages, downloading a CSV file.