[4.x] Allow custom form exporters to be defined

config/forms.php

@@ -48,27 +48,21 @@
 
     /*
     |--------------------------------------------------------------------------
-    | CSV Export Delimiter
+    | Exporters
     |--------------------------------------------------------------------------
     |
-    | Statamic will use this character as delimiter for csv exports.
+    | Here you may define all the available form submission exporters.
+    | You may customize the options within each exporter's array.
     |
     */
 
-    'csv_delimiter' => ',',
-
-    /*
-    |--------------------------------------------------------------------------
-    | CSV Export Headings
-    |--------------------------------------------------------------------------
-    |
-    | The values to be used in the csv export header rows.
-    | Can be the field handle or the field display text.
-    |
-    | Supported values: "handle", "display"
-    |
-    */
-
-    'csv_headers' => 'handle',
+    'exporters' => [
+        'csv' => [
+            'class' => Statamic\Forms\Exporters\CsvExporter::class,
+        ],
+        'json' => [
+            'class' => Statamic\Forms\Exporters\JsonExporter::class,
+        ],
+    ],
 
 ];

resources/views/forms/show.blade.php

@@ -30,11 +30,17 @@
                 @endcan
             </dropdown-list>
 
+            @if ($exporters = $form->exporters())
             <dropdown-list>
                 <button class="btn" slot="trigger">{{ __('Export Submissions') }}</button>
-                <dropdown-item :text="__('Export as CSV')" redirect="{{ cp_route('forms.export', ['type' => 'csv', 'form' => $form->handle()]) }}?download=true"></dropdown-item>
-                <dropdown-item :text="__('Export as JSON')" redirect="{{ cp_route('forms.export', ['type' => 'json', 'form' => $form->handle()]) }}?download=true"></dropdown-item>
+                @foreach ($exporters as $exporter)
+                    <dropdown-item
+                        text="{{ $exporter->title() }}"
+                        redirect="{{ $exporter->downloadUrl() }}"
+                    ></dropdown-item>
+                @endforeach
             </dropdown-list>
+            @endif
         </div>
     </header>
 

src/Forms/Exporters/CsvExporter.php

@@ -4,58 +4,40 @@
 
 use League\Csv\Writer;
 use SplTempFileObject;
+use Statamic\Support\Arr;
 
-class CsvExporter extends AbstractExporter
+class CsvExporter extends Exporter
 {
-    /**
-     * @var Writer
-     */
-    private $writer;
-
-    /**
-     * Create a new CsvExporter.
-     */
-    public function __construct()
+    private Writer $writer;
+    protected static string $title = 'CSV';
+
+    public function export(): string
     {
         $this->writer = Writer::createFromFileObject(new SplTempFileObject);
-        $this->writer->setDelimiter(config('statamic.forms.csv_delimiter', ','));
-    }
+        $this->writer->setDelimiter(Arr::get($this->config, 'delimiter', config('statamic.forms.csv_delimiter', ',')));
 
-    /**
-     * Perform the export.
-     *
-     * @return string
-     */
-    public function export()
-    {
         $this->insertHeaders();
 
         $this->insertData();
 
         return (string) $this->writer;
     }
 
-    /**
-     * Insert the headers into the CSV.
-     */
     private function insertHeaders()
     {
-        $key = config('statamic.forms.csv_headers', 'handle');
+        $key = Arr::get($this->config, 'headers', config('statamic.forms.csv_headers', 'handle'));
 
-        $headers = $this->form()->fields()
+        $headers = $this->form->fields()
             ->map(fn ($field) => $key === 'display' ? $field->display() : $field->handle())
             ->push($key === 'display' ? __('Date') : 'date')
             ->values()->all();
 
         $this->writer->insertOne($headers);
     }
 
-    /**
-     * Insert the submission data into the CSV.
-     */
     private function insertData()
     {
-        $data = $this->form()->submissions()->map(function ($submission) {
+        $data = $this->form->submissions()->map(function ($submission) {
             $submission = $submission->toArray();
 
             $submission['date'] = (string) $submission['date'];
@@ -69,4 +51,9 @@ private function insertData()
 
         $this->writer->insertAll($data);
     }
+
+    public function extension(): string
+    {
+        return 'csv';
+    }
 }

src/Forms/Exporters/Exporter.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Statamic\Forms\Exporters;
+
+use Illuminate\Http\Response;
+use Statamic\Contracts\Forms\Form;
+use Statamic\Facades\File;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+abstract class Exporter
+{
+    protected static string $title;
+    protected array $config;
+    protected string $handle;
+    protected Form $form;
+
+    abstract public function export(): string;
+
+    public function setHandle(string $handle)
+    {
+        $this->handle = $handle;
+
+        return $this;
+    }
+
+    public function setConfig(array $config)
+    {
+        $this->config = $config;
+
+        return $this;
+    }
+
+    public function setForm(Form $form)
+    {
+        $this->form = $form;
+
+        return $this;
+    }
+
+    public function contentType(): string
+    {
+        return 'text/plain';
+    }
+
+    public function extension(): string
+    {
+        return 'txt';
+    }
+
+    public function title(): string
+    {
+        return __($this->config['title'] ?? static::$title);
+    }
+
+    public function allowedOnForm(Form $form)
+    {
+        return ! isset($this->config['forms']) || in_array($form->handle(), $this->config['forms']);
+    }
+
+    public function downloadUrl()
+    {
+        return cp_route('forms.export', [
+            'type' => $this->handle,
+            'form' => $this->form->handle(),
+            'download' => true,
+        ]);
+    }
+
+    public function response(): Response
+    {
+        return response($this->export())->header('Content-Type', $this->contentType());
+    }
+
+    public function download(): BinaryFileResponse
+    {
+        $content = $this->export();
+
+        $path = storage_path('statamic/tmp/forms/'.$this->form->handle().'-'.time().'.'.$this->extension());
+
+        File::put($path, $content);
+
+        return response()->download($path)->deleteFileAfterSend();
+    }
+}

src/Forms/Exporters/ExporterRepository.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Statamic\Forms\Exporters;
+
+use Exception;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Support\Collection;
+use Statamic\Support\Arr;
+
+class ExporterRepository
+{
+    public function all(): Collection
+    {
+        return collect(config('statamic.forms.exporters', []))
+            ->map(function ($config, $handle) {
+                try {
+                    $exporter = app($class = Arr::pull($config, 'class'));
+                } catch (BindingResolutionException $e) {
+                    throw new Exception("Class [$class] does not exist, defined in exporter [$handle].");
+                }
+
+                return $exporter->setHandle($handle)->setConfig($config);
+            });
+    }
+}

src/Forms/Exporters/JsonExporter.php

@@ -2,27 +2,24 @@
 
 namespace Statamic\Forms\Exporters;
 
-class JsonExporter extends AbstractExporter
+class JsonExporter extends Exporter
 {
-    /**
-     * Perform the export.
-     *
-     * @return string
-     */
-    public function export()
+    protected static string $title = 'JSON';
+
+    public function export(): string
     {
-        $submissions = $this->form()->submissions()->toArray();
+        $submissions = $this->form->submissions()->toArray();
 
         return json_encode($submissions);
     }
 
-    /**
-     * Get the content type.
-     *
-     * @return string
-     */
-    public function contentType()
+    public function contentType(): string
     {
         return 'application/json';
     }
+
+    public function extension(): string
+    {
+        return 'json';
+    }
 }

src/Forms/Form.php

@@ -19,6 +19,7 @@
 use Statamic\Facades\Form as FormFacade;
 use Statamic\Facades\YAML;
 use Statamic\Forms\Exceptions\BlueprintUndefinedException;
+use Statamic\Forms\Exporters\Exporter;
 use Statamic\Statamic;
 use Statamic\Support\Arr;
 use Statamic\Support\Traits\FluentlyGetsAndSets;
@@ -389,4 +390,17 @@ public function actionUrl()
     {
         return route('statamic.forms.submit', $this->handle());
     }
+
+    public function exporters()
+    {
+        return FormFacade::exporters()
+            ->all()
+            ->filter->allowedOnForm($this)
+            ->each->setForm($this);
+    }
+
+    public function exporter(string $handle): ?Exporter
+    {
+        return $this->exporters()->get($handle);
+    }
 }