Merge pull request #214 from rappasoft/DeltaSystems-feature-autodefine-filters-property

Delta systems feature autodefine filters property

Author: rappasoft

CHANGELOG.md

@@ -8,7 +8,8 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ### Added
 
-- `$searchFilterDebounce`, `$searchFilterDefer`, `$searchFilterLazy`, for defining the search input data binding property.
+- `$searchFilterDebounce`, `$searchFilterDefer`, `$searchFilterLazy`, for defining the search input data binding property. https://github.com/rappasoft/laravel-livewire-tables/pull/211
+- Remove ability to need to define filters if not defining defaults. https://github.com/rappasoft/laravel-livewire-tables/pull/213
 
 ## [1.0.3] - 2021-04-18
 

README.md

@@ -234,22 +234,7 @@ You will see how to get more out of this base query using filters and search bel
 
 Creating filters is not required, and the filters box will be hidden if none are defined.
 
-Creating filters requires a few easy steps.
-
-#### Adding to the filters array
-
-You must first define a filter key in the **$filters** array, this tells the component to save the filter status in the query string for page reloads, as well as let you set a default.
-
-```php
-public array $filters = [
-    'type' => null,
-    'active' => null,
-];
-```
-
-#### Defining the filter UI
-
-After you define the filters for the component, you must specify their options using the **filters()** method.
+#### Defining the filters
 
 Right now the only supported filter type is a select dropdown.
 
@@ -273,10 +258,21 @@ public function filters(): array
 }
 ```
 
-You specify your filters array using the **key** as the filter name supplied in the **$filters** array on the component.
-
 The keys of the options you supply will be validated on select to make sure they match one of the options on the backend, otherwise it will be changed to _null_ for safety.
 
+#### Setting filter defaults
+
+When you define the filters, a class property of $filters is generated for you.
+
+```php
+public array $filters = [
+    'type' => null,
+    'active' => null,
+];
+```
+
+You may overwrite this property to set defaults to your filters if you would like.
+
 #### Alternate: Defining a filter view
 
 If you want full control over your filters, you can omit the **filters()** method and instead add a **filtersView()** method that return the string view name, which will be included in the master component on render. This is useful when you have different types of filters than the package offers:

resources/views/tailwind/includes/filters.blade.php

@@ -51,6 +51,7 @@ class="origin-top-right absolute right-0 mt-2 w-full md:w-56 rounded-md shadow-l
                                 <div class="mt-1 relative rounded-md shadow-sm">
                                     <select
                                         wire:model="filters.{{ $key }}"
+                                        wire:key="filter-{{ $key }}"
                                         id="filter-{{ $key }}"
                                         class="rounded-md shadow-sm block w-full pl-3 pr-10 py-2 text-base leading-6 border-gray-300 focus:outline-none focus:border-indigo-300 focus:shadow-outline-indigo sm:text-sm sm:leading-5"
                                     >

src/DataTableComponent.php

@@ -136,6 +136,7 @@ public function __construct($id = null)
         parent::__construct($id);
 
         $theme = config('livewire-tables.theme');
+
         if ($theme === 'bootstrap-4' || $theme === 'bootstrap-5') {
             $this->paginationTheme = 'bootstrap';
         }

src/Traits/WithFilters.php

@@ -45,6 +45,18 @@ trait WithFilters
      */
     public ?bool $searchFilterLazy = null;
 
+    /**
+     * Prebuild the $filters array
+     */
+    public function mountWithFilters(): void
+    {
+        foreach ($this->filters() as $filter => $default) {
+            if (! isset($this->filters[$filter])) {
+                $this->filters[$filter] = null;
+            }
+        }
+    }
+
     /**
      * Build Livewire model options for the search input
      *
@@ -67,65 +79,143 @@ public function getSearchFilterOptionsProperty(): string
         return '';
     }
 
+    /**
+     * Reset the filters array but keep the value for search
+     */
     public function resetFilters(): void
     {
         $search = $this->filters['search'] ?? null;
+
         $this->reset('filters');
+
         $this->filters['search'] = $search;
     }
 
+    /**
+     * Reset the page if the filters are updated
+     */
     public function updatingFilters(): void
     {
         $this->resetPage();
     }
 
+    /**
+     * Reset all the filters
+     */
     public function resetAll(): void
     {
         $this->resetFilters();
         $this->resetSorts();
         $this->resetBulk();
     }
 
+    /**
+     * Define the filters array
+     *
+     * @return array
+     */
     public function filters(): array
     {
         return [];
     }
 
+    /**
+     * Cleans $filter property of any values that don't exist
+     * in the filter() definition.
+     */
     public function cleanFilters(): void
     {
-        foreach ($this->filters() as $key => $filter) {
-            if (
-                $filter->isSelect() &&
-                $this->hasFilter($key) &&
-                ! in_array($this->getFilter($key), $this->getFilterOptions($key), true)
-            ) {
-                $this->removeFilter($key);
+        // Filter $filters values
+        $this->filters = collect($this->filters)->filter(function ($filterValue, $filterName) {
+            $filterDefinitions = $this->filters();
+
+            // Ignore search
+            if ($filterName === 'search') {
+                return true;
             }
-        }
+
+            // Filter out any keys that weren't defined as a filter
+            if (! isset($filterDefinitions[$filterName])) {
+                return false;
+            }
+
+            // Ignore null values
+            if (is_null($filterValue)) {
+                return true;
+            }
+
+            // Handle 'select' filters
+            if ($filterDefinitions[$filterName]->isSelect()) {
+                foreach ($this->getFilterOptions($filterName) as $optionValue) {
+                    // If the option is an integer, typecast filter value
+                    if (is_int($optionValue) && $optionValue === (int)$filterValue) {
+                        return true;
+                    }
+
+                    // Strict check the value
+                    if ($optionValue === $filterValue) {
+                        return true;
+                    }
+                }
+            }
+
+            return false;
+        })->toArray();
     }
 
+    /**
+     * Define the string location to a view to be included as the filters view
+     *
+     * @return string|null
+     */
     public function filtersView(): ?string
     {
         return null;
     }
 
+    /**
+     * Check if a filter exists and isn't null
+     *
+     * @param  string  $filter
+     *
+     * @return bool
+     */
     public function hasFilter(string $filter): bool
     {
         return isset($this->filters[$filter]) && $this->filters[$filter] !== null;
     }
 
+    /**
+     * Get the value of a given filter
+     *
+     * @param  string  $filter
+     *
+     * @return string|null
+     */
     public function getFilter(string $filter): ?string
     {
         return $this->filters[$filter] ?? null;
     }
 
+    /**
+     * Set a given filter to null
+     *
+     * @param $filter
+     */
     public function removeFilter($filter): void
     {
         if (isset($this->filters[$filter])) {
             $this->filters[$filter] = null;
         }
     }
 
+    /**
+     * Get the options for a given filter if they exist
+     *
+     * @param  string  $filter
+     *
+     * @return array
+     */
     public function getFilterOptions(string $filter): array
     {
         return array_filter(array_keys($this->filters()[$filter]->options() ?? []));