Update docs

Author: rappasoft

docs/filters/applying-filters.md

@@ -35,16 +35,16 @@ If you don't want to apply at the filter level, you can apply the filter at the
 public function builder(): Builder
 {
     return User::query();
-         ->when($this->getAppliedFilter('active'), fn($query, $active) => $query->where('active', $active === 'yes'));
+         ->when($this->getAppliedFilterWithValue('active'), fn($query, $active) => $query->where('active', $active === 'yes'));
 }
 ```
 
-You can use the `getAppliedFilter()` method to grab the current value of the filter or null if it is not applied.
+You can use the `getAppliedFilterWithValue()` method to grab the current value of the filter or null if it is not applied.
 
 ### A note about integer values
 
 Even if you have your values as strings, but are still using integers, you may have unexpected results when using Eloquent's `when()` method to apply your filters (if going that route).
 
 For example, if you have values of `0 and 1`, the eloquent `when()` method will not execute when the value is '0' as it treats it as false.
 
-So it is better to not use `getAppliedFilter()` or `integer keys` in the situations where you want to apply the filter in the builder method.
+So it is better to not use `getAppliedFilterWithValue()` or `integer keys` in the situations where you want to apply the filter in the builder method.

docs/upgrade-guide.md

@@ -53,5 +53,5 @@ $this->getFilter('active');
 New:
 
 ```php
-$this->getAppliedFilter('active');
+$this->getAppliedFilterWithValue('active');
 ```

src/Traits/Helpers/FilterHelpers.php

@@ -8,153 +8,78 @@
 
 trait FilterHelpers
 {
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFiltersStatus(): bool
     {
         return $this->filtersStatus;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function filtersAreEnabled(): bool
     {
         return $this->getFiltersStatus() === true;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function filtersAreDisabled(): bool
     {
         return $this->getFiltersStatus() === false;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFiltersVisibilityStatus(): bool
     {
         return $this->filtersVisibilityStatus;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function filtersVisibilityIsEnabled(): bool
     {
         return $this->getFiltersVisibilityStatus() === true;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function filtersVisibilityIsDisabled(): bool
     {
         return $this->getFiltersVisibilityStatus() === false;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFilterPillsStatus(): bool
     {
         return $this->filterPillsStatus;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function filterPillsAreEnabled(): bool
     {
         return $this->getFilterPillsStatus() === true;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function filterPillsAreDisabled(): bool
     {
         return $this->getFilterPillsStatus() === false;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function hasFilters(): bool
     {
         return $this->getFilters()->count();
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFilters(): Collection
     {
         return collect($this->filters());
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFiltersCount(): int
     {
         return $this->getFilters()->count();
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFilterByKey(string $key)
     {
         return $this->getFilters()->first(function ($filter) use ($key) {
             return $filter->getKey() === $key;
         });
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function setFilter(string $filterKey, $value)
     {
         return $this->{$this->getTableName()}['filters'][$filterKey] = $value;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function selectAllFilterOptions(string $filterKey): void
     {
         $filter = $this->getFilterByKey($filterKey);
@@ -172,75 +97,40 @@ public function selectAllFilterOptions(string $filterKey): void
         $this->setFilter($filterKey, array_keys($filter->getOptions()));
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function setFilterDefaults(): void
     {
         foreach ($this->getFilters() as $filter) {
             $this->resetFilter($filter);
         }
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getAppliedFilters(): array
     {
         return $this->{$this->getTableName()}['filters'] ?? [];
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function hasAppliedFiltersWithValues(): bool
     {
         return count($this->getAppliedFiltersWithValues());
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getAppliedFiltersWithValues(): array
     {
         return array_filter($this->getAppliedFilters(), function ($item) {
             return is_array($item) ? count($item) : $item !== null;
         });
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getAppliedFilterWithValue(string $filterKey)
     {
         return $this->getAppliedFiltersWithValues()[$filterKey] ?? null;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getAppliedFiltersWithValuesCount(): int
     {
         return count($this->getAppliedFiltersWithValues());
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function resetFilter($filter): void
     {
         if (! $filter instanceof Filter) {
@@ -250,31 +140,16 @@ public function resetFilter($filter): void
         $this->setFilter($filter->getKey(), $filter->getDefaultValue());
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function getFilterLayout(): string
     {
         return $this->filterLayout;
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function isFilterLayoutPopover(): bool
     {
         return $this->getFilterLayout() === 'popover';
     }
 
-    /**
-     * @param string $column
-     * @param string $value
-     * @return array
-     */
     public function isFilterLayoutSlideDown(): bool
     {
         return $this->getFilterLayout() === 'slide-down';