[5.x] Add Form submissions query builder / facade

config/stache.php

@@ -89,6 +89,11 @@
             'directory' => base_path('users'),
         ],
 
+        'form-submissions' => [
+            'class' => Stores\SubmissionsStore::class,
+            'directory' => storage_path('forms'),
+        ],
+
     ],
 
     /*

src/Contracts/Forms/SubmissionQueryBuilder.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Statamic\Contracts\Forms;
+
+interface SubmissionQueryBuilder
+{
+    //
+}

src/Contracts/Forms/SubmissionRepository.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Statamic\Contracts\Forms;
+
+interface SubmissionRepository
+{
+    public function all();
+
+    public function whereForm(string $handle);
+
+    public function whereInForm(array $handles);
+
+    public function find($id);
+
+    public function make();
+
+    public function query();
+
+    public function save($entry);
+
+    public function delete($entry);
+}

src/Facades/FormSubmission.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Statamic\Facades;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Facade;
+use Statamic\Contracts\Forms\Submission as SubmissionContract;
+use Statamic\Contracts\Forms\SubmissionRepository;
+use Statamic\Stache\Query\SubmissionQueryBuilder;
+
+/**
+ * @method static Collection all()
+ * @method static Collection whereForm(string $handle)
+ * @method static Collection whereInForm(array $handles)
+ * @method static SubmissionContract find($id)
+ * @method static SubmissionContract make()
+ * @method static SubmissionQueryBuilder query()
+ * @method static save()
+ * @method static delete()
+ *
+ * @see \Statamic\Contracts\Forms\FormRepository
+ */
+class FormSubmission extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return SubmissionRepository::class;
+    }
+}

src/Forms/Form.php

@@ -3,7 +3,6 @@
 namespace Statamic\Forms;
 
 use Illuminate\Contracts\Support\Arrayable;
-use Illuminate\Support\Facades\Log;
 use Statamic\Contracts\Data\Augmentable;
 use Statamic\Contracts\Data\Augmented;
 use Statamic\Contracts\Forms\Form as FormContract;
@@ -18,15 +17,14 @@
 use Statamic\Events\FormSaving;
 use Statamic\Facades\Blueprint;
 use Statamic\Facades\File;
-use Statamic\Facades\Folder;
 use Statamic\Facades\Form as FormFacade;
+use Statamic\Facades\FormSubmission;
 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;
-use Statamic\Yaml\ParseException;
 
 class Form implements Arrayable, Augmentable, FormContract
 {
@@ -295,20 +293,7 @@ public function metrics($metrics = null)
      */
     public function submissions()
     {
-        $path = config('statamic.forms.submissions').'/'.$this->handle();
-
-        return collect(Folder::getFilesByType($path, 'yaml'))->map(function ($file) {
-            try {
-                $data = YAML::parse(File::get($file));
-            } catch (ParseException $e) {
-                $data = [];
-                Log::warning('Could not parse form submission file: '.$file);
-            }
-
-            return $this->makeSubmission()
-                ->id(pathinfo($file)['filename'])
-                ->data($data);
-        });
+        return FormSubmission::whereForm($this->handle());
     }
 
     /**
@@ -319,9 +304,7 @@ public function submissions()
      */
     public function submission($id)
     {
-        return $this->submissions()->filter(function ($submission) use ($id) {
-            return $submission->id() === $id;
-        })->first();
+        return FormSubmission::find($id);
     }
 
     /**
@@ -331,7 +314,7 @@ public function submission($id)
      */
     public function makeSubmission()
     {
-        $submission = app(Submission::class);
+        $submission = FormSubmission::make();
 
         $submission->form($this);
 

src/Forms/Submission.php

@@ -6,23 +6,26 @@
 use Statamic\Contracts\Data\Augmentable;
 use Statamic\Contracts\Forms\Submission as SubmissionContract;
 use Statamic\Data\ContainsData;
+use Statamic\Data\ExistsAsFile;
 use Statamic\Data\HasAugmentedData;
+use Statamic\Data\TracksQueriedColumns;
+use Statamic\Data\TracksQueriedRelations;
 use Statamic\Events\SubmissionCreated;
 use Statamic\Events\SubmissionCreating;
 use Statamic\Events\SubmissionDeleted;
 use Statamic\Events\SubmissionSaved;
 use Statamic\Events\SubmissionSaving;
 use Statamic\Facades\Asset;
 use Statamic\Facades\File;
-use Statamic\Facades\YAML;
+use Statamic\Facades\FormSubmission;
+use Statamic\Facades\Stache;
 use Statamic\Forms\Uploaders\AssetsUploader;
 use Statamic\Forms\Uploaders\FilesUploader;
-use Statamic\Support\Arr;
 use Statamic\Support\Traits\FluentlyGetsAndSets;
 
 class Submission implements Augmentable, SubmissionContract
 {
-    use ContainsData, FluentlyGetsAndSets, HasAugmentedData;
+    use ContainsData, ExistsAsFile, FluentlyGetsAndSets, HasAugmentedData, TracksQueriedColumns, TracksQueriedRelations;
 
     /**
      * @var string
@@ -167,7 +170,7 @@ public function save()
             }
         }
 
-        File::put($this->getPath(), YAML::dump(Arr::removeNullValues($this->data()->all())));
+        FormSubmission::save($this);
 
         foreach ($afterSaveCallbacks as $callback) {
             $callback($this);
@@ -187,7 +190,7 @@ public function save()
      */
     public function delete()
     {
-        File::delete($this->getPath());
+        FormSubmission::delete($this);
 
         SubmissionDeleted::dispatch($this);
     }
@@ -199,7 +202,16 @@ public function delete()
      */
     public function getPath()
     {
-        return config('statamic.forms.submissions').'/'.$this->form()->handle().'/'.$this->id().'.yaml';
+        return $this->path();
+    }
+
+    public function path()
+    {
+        return vsprintf('%s/%s/%s.yaml', [
+            rtrim(Stache::store('form-submissions')->directory(), '/'),
+            $this->form()->handle(),
+            $this->id(),
+        ]);
     }
 
     /**
@@ -237,6 +249,11 @@ public function blueprint()
         return $this->form->blueprint();
     }
 
+    public function fileData()
+    {
+        return $this->data()->all();
+    }
+
     public function __get($key)
     {
         return $this->get($key);

src/Providers/AppServiceProvider.php

@@ -121,6 +121,7 @@ public function register()
             \Statamic\Contracts\Structures\NavigationRepository::class => \Statamic\Stache\Repositories\NavigationRepository::class,
             \Statamic\Contracts\Assets\AssetRepository::class => \Statamic\Assets\AssetRepository::class,
             \Statamic\Contracts\Forms\FormRepository::class => \Statamic\Forms\FormRepository::class,
+            \Statamic\Contracts\Forms\SubmissionRepository::class => \Statamic\Stache\Repositories\SubmissionRepository::class,
         ])->each(function ($concrete, $abstract) {
             if (! $this->app->bound($abstract)) {
                 Statamic::repository($abstract, $concrete);
@@ -155,6 +156,7 @@ public function register()
 
         collect([
             'entries' => fn () => Facades\Entry::query(),
+            'form-submissions' => fn () => Facades\FormSubmission::query(),
             'terms' => fn () => Facades\Term::query(),
             'assets' => fn () => Facades\Asset::query(),
             'users' => fn () => Facades\User::query(),

src/Stache/Query/SubmissionQueryBuilder.php

@@ -0,0 +1,125 @@
+<?php
+
+namespace Statamic\Stache\Query;
+
+use Illuminate\Support\Collection;
+use Statamic\Contracts\Forms\SubmissionQueryBuilder as QueryBuilderContract;
+use Statamic\Facades;
+
+class SubmissionQueryBuilder extends Builder implements QueryBuilderContract
+{
+    protected $forms;
+
+    public function where($column, $operator = null, $value = null, $boolean = 'and')
+    {
+        if ($column === 'form') {
+            $this->forms[] = $operator;
+
+            return $this;
+        }
+
+        return parent::where($column, $operator, $value, $boolean);
+    }
+
+    public function whereIn($column, $values, $boolean = 'and')
+    {
+        if (in_array($column, ['form', 'forms'])) {
+            $this->forms = array_merge($this->forms ?? [], $values);
+
+            return $this;
+        }
+
+        return parent::whereIn($column, $values, $boolean);
+    }
+
+    protected function collect($items = [])
+    {
+        return Collection::make($items);
+    }
+
+    protected function getFilteredKeys()
+    {
+        $forms = empty($this->forms)
+            ? Facades\Form::all()->map->handle()
+            : $this->forms;
+
+        return empty($this->wheres)
+            ? $this->getKeysFromForms($forms)
+            : $this->getKeysFromFormsWithWheres($forms, $this->wheres);
+    }
+
+    protected function getKeysFromForms($forms)
+    {
+        return collect($forms)->flatMap(function ($form) {
+            $keys = $this->store->store($form)->paths()->keys();
+
+            return collect($keys)->map(function ($key) use ($form) {
+                return "{$form}::{$key}";
+            });
+        });
+    }
+
+    protected function getKeysFromFormsWithWheres($forms, $wheres)
+    {
+        return collect($wheres)->reduce(function ($ids, $where) use ($forms) {
+            $keys = $where['type'] == 'Nested'
+                ? $this->getKeysFromFormsWithWheres($forms, $where['query']->wheres)
+                : $this->getKeysFromFormsWithWhere($forms, $where);
+
+            return $this->intersectKeysFromWhereClause($ids, $keys, $where);
+        });
+    }
+
+    protected function getKeysFromFormsWithWhere($forms, $where)
+    {
+        $items = collect($forms)->flatMap(function ($form) use ($where) {
+            return $this->getWhereColumnKeysFromStore($form, $where);
+        });
+
+        $method = 'filterWhere'.$where['type'];
+
+        return $this->{$method}($items, $where)->keys();
+    }
+
+    protected function getOrderKeyValuesByIndex()
+    {
+        $forms = empty($this->forms)
+            ? Facades\Form::all()->map->handle()
+            : $this->forms;
+
+        // First, we'll get the values from each index grouped by form
+        $keys = collect($forms)->map(function ($form) {
+            $store = $this->store->store($form);
+
+            return collect($this->orderBys)->mapWithKeys(function ($orderBy) use ($form, $store) {
+                $items = $store->index($orderBy->sort)
+                    ->items()
+                    ->mapWithKeys(function ($item, $key) use ($form) {
+                        return ["{$form}::{$key}" => $item];
+                    })->all();
+
+                return [$orderBy->sort => $items];
+            });
+        });
+
+        // Then, we'll merge all the corresponding index values together from each form.
+        return $keys->reduce(function ($carry, $form) {
+            foreach ($form as $sort => $values) {
+                $carry[$sort] = array_merge($carry[$sort] ?? [], $values);
+            }
+
+            return $carry;
+        }, collect());
+    }
+
+    protected function getWhereColumnKeyValuesByIndex($column)
+    {
+        $forms = empty($this->forms)
+            ? Facades\Form::all()->map->handle()
+            : $this->forms;
+
+        return collect($forms)->flatMap(function ($form) use ($column) {
+            return $this->getWhereColumnKeysFromStore($form, ['column' => $column]);
+        });
+    }
+}