Save filter selection to session (BETA) (#1910)

* Initial Commit

* Fix styling

* Initial Commit

* Fix styling

* Fix nullable return

* Add Initial Tests - Remove Non-Required Method

* Fix styling

* Swap methods

* Add default docs

* Remove errant note

* Adjust docs

* Adjust Docs for storeFiltersInSessionEnabled

---------

Co-authored-by: lrljoe <[email protected]>

docs/filters/available-methods.md

@@ -182,6 +182,30 @@ public function configure(): void
 }
 ```
 
+### storeFiltersInSessionEnabled
+
+Optional behaviour - stores filter values in the session (specific to table - based on the table name)
+
+#### Exercise Caution 
+If re-using the same Livewire Table Component multiple times in your site, with the same table name, this may cause clashes in filter values
+
+```php
+public function configure(): void
+{
+    $this->storeFiltersInSessionEnabled();
+}
+```
+### storeFiltersInSessionDisabled
+
+Default behaviour - does not store filters in the session
+
+```php
+public function configure(): void
+{
+    $this->storeFiltersInSessionDisabled();
+}
+```
+
 
 ----
 

src/Traits/Configuration/SessionStorageConfiguration.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Configuration;
+
+trait SessionStorageConfiguration
+{
+    protected function storeFiltersInSessionStatus(bool $status): self
+    {
+        $this->sessionStorageStatus['filters'] = $status;
+
+        return $this;
+    }
+
+    public function storeFiltersInSessionEnabled(): self
+    {
+        return $this->storeFiltersInSessionStatus(true);
+    }
+
+    public function storeFiltersInSessionDisabled(): self
+    {
+        return $this->storeFiltersInSessionStatus(false);
+    }
+}

src/Traits/HasAllTraits.php

@@ -27,6 +27,7 @@ trait HasAllTraits
         WithRefresh,
         WithReordering,
         WithSecondaryHeader,
+        WithSessionStorage,
         WithTableAttributes,
         WithTools;
 }

src/Traits/Helpers/FilterHelpers.php

@@ -18,6 +18,8 @@ trait FilterHelpers
      */
     public function mountFilterHelpers(): void
     {
+        $this->restoreFilterValues();
+
         foreach ($this->getFilters() as $filter) {
             if (! isset($this->appliedFilters[$filter->getKey()])) {
                 if ($filter->hasFilterDefaultValue()) {
@@ -145,6 +147,8 @@ public function setFilter(string $filterKey, string|array|null $value): void
             event(new FilterApplied($this->getTableName(), $filterKey, $value));
         }
         $this->dispatch('filter-was-set', tableName: $this->getTableName(), filterKey: $filterKey, value: $value);
+        $this->storeFilterValues();
+
     }
 
     public function selectAllFilterOptions(string $filterKey): void
@@ -173,6 +177,7 @@ public function setFilterDefaults(): void
                 $this->resetFilter($filter);
             }
         }
+
     }
 
     /**
@@ -252,6 +257,7 @@ public function resetFilter($filter): void
         $this->callHook('filterReset', ['filter' => $filter->getKey()]);
         $this->callTraitHook('filterReset', ['filter' => $filter->getKey()]);
         $this->setFilter($filter->getKey(), $filter->getDefaultValue());
+
     }
 
     public function getFilterLayout(): string

src/Traits/Helpers/SessionStorageHelpers.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Helpers;
+
+trait SessionStorageHelpers
+{
+    protected function getSessionStorageStatus(string $name): bool
+    {
+        return $this->sessionStorageStatus[$name] ?? false;
+    }
+
+    public function shouldStoreFiltersInSession(): bool
+    {
+        return $this->getSessionStorageStatus('filters');
+    }
+
+    public function getFilterSessionKey(): string
+    {
+        return $this->getTableName().'-stored-filters';
+    }
+
+    public function storeFilterValues(): void
+    {
+        if ($this->shouldStoreFiltersInSession()) {
+            $this->clearStoredFilterValues();
+            session([$this->getFilterSessionKey() => $this->appliedFilters]);
+        }
+    }
+
+    public function restoreFilterValues(): void
+    {
+        if (empty($this->filterComponents) || empty($this->appliedFilters)) {
+            $this->filterComponents = $this->appliedFilters = $this->getStoredFilterValues();
+        }
+    }
+
+    public function getStoredFilterValues(): array
+    {
+        if ($this->shouldStoreFiltersInSession() && session()->has($this->getFilterSessionKey())) {
+            return session()->get($this->getFilterSessionKey());
+        }
+
+        return [];
+    }
+
+    public function clearStoredFilterValues(): void
+    {
+        if ($this->shouldStoreFiltersInSession() && session()->has($this->getFilterSessionKey())) {
+            session()->forget($this->getFilterSessionKey());
+        }
+    }
+}

src/Traits/WithFilters.php

@@ -78,6 +78,7 @@ public function applyFilters(): Builder
                     }
                 }
             }
+            $this->storeFilterValues();
         }
 
         return $this->getBuilder();
@@ -110,5 +111,6 @@ public function updatedFilterComponents(string|array|null $value, string $filter
             $this->dispatch('filter-was-set', tableName: $this->getTableName(), filterKey: $filter->getKey(), value: $value);
 
         }
+
     }
 }

src/Traits/WithSessionStorage.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits;
+
+use Rappasoft\LaravelLivewireTables\Traits\Configuration\SessionStorageConfiguration;
+use Rappasoft\LaravelLivewireTables\Traits\Helpers\SessionStorageHelpers;
+
+trait WithSessionStorage
+{
+    use SessionStorageConfiguration,
+        SessionStorageHelpers;
+
+    public array $sessionStorageStatus = [
+        'filters' => false,
+    ];
+}

tests/Traits/Helpers/SessionStorageHelpersTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Traits\Helpers;
+
+use Rappasoft\LaravelLivewireTables\Tests\TestCase;
+
+final class SessionStorageHelpersTest extends TestCase
+{
+    public function test_can_get_session_storage_status_for_filters(): void
+    {
+        $this->assertFalse($this->basicTable->shouldStoreFiltersInSession());
+
+        $this->basicTable->storeFiltersInSessionEnabled();
+
+        $this->assertTrue($this->basicTable->shouldStoreFiltersInSession());
+
+        $this->basicTable->storeFiltersInSessionDisabled();
+
+        $this->assertFalse($this->basicTable->shouldStoreFiltersInSession());
+
+    }
+
+    public function test_can_get_session_storage_status_filter_key(): void
+    {
+        $this->assertSame($this->basicTable->getTableName().'-stored-filters', $this->basicTable->getFilterSessionKey());
+    }
+}