Migrating Search Methods into Separate Traits

Author: lrljoe

src/Traits/Core/Search/HandlesSearchFieldStyling.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search;
+
+use Rappasoft\LaravelLivewireTables\Traits\Core\Search\Styling\{HasSearchIcon, HasSearchInput};
+
+trait HandlesSearchFieldStyling
+{
+    use HasSearchIcon,
+    HasSearchInput;
+
+}

src/Traits/Configuration/SearchConfiguration.php renamed to src/Traits/Core/Search/HandlesSearchModifiers.php

@@ -1,68 +1,91 @@
 <?php
 
-namespace Rappasoft\LaravelLivewireTables\Traits\Configuration;
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search;
 
 use Rappasoft\LaravelLivewireTables\Exceptions\DataTableConfigurationException;
 
-trait SearchConfiguration
+trait HandlesSearchModifiers
 {
-    public function setSearch(string $query): self
-    {
-        if ($this->shouldTrimSearchString()) {
-            $this->search = trim($query);
-        } else {
-            $this->search = $query;
-        }
+    protected ?bool $searchFilterBlur = null;
 
-        return $this;
-    }
+    protected ?int $searchFilterDebounce = null;
 
-    public function setSearchStatus(bool $status): self
-    {
-        $this->searchStatus = $status;
+    protected ?bool $searchFilterDefer = null;
 
-        return $this;
-    }
+    protected ?bool $searchFilterLazy = null;
 
-    public function setSearchEnabled(): self
+    protected ?bool $searchFilterLive = null;
+
+    protected ?int $searchFilterThrottle = null;
+
+    public function hasSearchDebounce(): bool
     {
-        $this->setSearchStatus(true);
+        return $this->searchFilterDebounce !== null;
+    }
 
-        return $this;
+    public function getSearchDebounce(): ?int
+    {
+        return $this->searchFilterDebounce;
     }
 
-    /**
-     * @return $this
-     */
-    public function setSearchDisabled(): self
+    public function hasSearchDefer(): bool
     {
-        $this->setSearchStatus(false);
-        $this->search = '';
+        return $this->searchFilterDefer !== null;
+    }
 
-        return $this;
+    public function hasSearchLazy(): bool
+    {
+        return $this->searchFilterLazy !== null;
     }
 
-    public function setSearchVisibilityStatus(bool $status): self
+    public function hasSearchLive(): bool
     {
-        $this->searchVisibilityStatus = $status;
+        return $this->searchFilterLive !== null;
+    }
 
-        return $this;
+    public function hasSearchThrottle(): bool
+    {
+        return $this->searchFilterThrottle !== null;
     }
 
-    public function setSearchVisibilityEnabled(): self
+    public function getSearchThrottle(): ?int
     {
-        $this->setSearchVisibilityStatus(true);
+        return $this->searchFilterThrottle;
+    }
 
-        return $this;
+    public function hasSearchBlur(): bool
+    {
+        return $this->searchFilterBlur !== null;
     }
 
-    public function setSearchVisibilityDisabled(): self
+    public function getSearchOptions(): string
     {
-        $this->setSearchVisibilityStatus(false);
+        if ($this->hasSearchDebounce()) {
+            return '.live.debounce.'.$this->getSearchDebounce().'ms';
+        }
 
-        return $this;
-    }
+        if ($this->hasSearchDefer()) {
+            return '';
+        }
+
+        if ($this->hasSearchLive()) {
+            return '.live';
+        }
+
+        if ($this->hasSearchBlur()) {
+            return '.blur';
+        }
 
+        if ($this->hasSearchLazy()) {
+            return '.live.lazy';
+        }
+
+        if ($this->hasSearchThrottle()) {
+            return '.live.throttle.'.$this->getSearchThrottle().'ms';
+        }
+
+        return '.live';
+    }
     /**
      * @throws DataTableConfigurationException
      */
@@ -147,24 +170,5 @@ public function setSearchLazy(): self
         return $this;
     }
 
-    public function setTrimSearchString(bool $status): self
-    {
-        $this->trimSearchString = $status;
-
-        return $this;
-    }
-
-    public function setTrimSearchStringEnabled(): self
-    {
-        $this->setTrimSearchString(true);
-
-        return $this;
-    }
-
-    public function setTrimSearchStringDisabled(): self
-    {
-        $this->setTrimSearchString(false);
 
-        return $this;
-    }
-}
+}

src/Traits/Core/Search/HandlesSearchStatus.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search;
+
+use Livewire\Attributes\{Computed, Locked};
+
+trait HandlesSearchStatus
+{
+    #[Locked]
+    public bool $searchStatus = true;
+
+    public function getSearchStatus(): bool
+    {
+        return $this->searchStatus;
+    }
+
+    #[Computed]
+    public function searchIsEnabled(): bool
+    {
+        return $this->getSearchStatus() === true;
+    }
+
+    public function searchIsDisabled(): bool
+    {
+        return $this->getSearchStatus() === false;
+    }
+
+    public function setSearchStatus(bool $status): self
+    {
+        $this->searchStatus = $status;
+
+        return $this;
+    }
+
+    public function setSearchEnabled(): self
+    {
+        return $this->setSearchStatus(true);
+    }
+
+    /**
+     * @return $this
+     */
+    public function setSearchDisabled(): self
+    {
+        $this->search = '';
+
+        return $this->setSearchStatus(false);
+    }
+}

src/Traits/Core/Search/HandlesSearchTrim.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search;
+
+trait HandlesSearchTrim
+{
+    protected bool $trimSearchString = false;
+
+    public function shouldTrimSearchString(): bool
+    {
+        return $this->trimSearchString ?? false;
+    }
+
+    public function setTrimSearchString(bool $status): self
+    {
+        $this->trimSearchString = $status;
+
+        return $this;
+    }
+
+    public function setTrimSearchStringEnabled(): self
+    {
+        $this->setTrimSearchString(true);
+
+        return $this;
+    }
+
+    public function setTrimSearchStringDisabled(): self
+    {
+        $this->setTrimSearchString(false);
+
+        return $this;
+    }
+}

src/Traits/Core/Search/HandlesSearchVisibility.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search;
+
+use Livewire\Attributes\Computed;
+
+trait HandlesSearchVisibility
+{
+    protected bool $searchVisibilityStatus = true;
+
+    public function getSearchVisibilityStatus(): bool
+    {
+        return $this->searchVisibilityStatus;
+    }
+
+    #[Computed]
+    public function searchVisibilityIsEnabled(): bool
+    {
+        return $this->getSearchVisibilityStatus() === true;
+    }
+
+    public function searchVisibilityIsDisabled(): bool
+    {
+        return $this->getSearchVisibilityStatus() === false;
+    }
+
+    public function setSearchVisibilityStatus(bool $status): self
+    {
+        $this->searchVisibilityStatus = $status;
+
+        return $this;
+    }
+
+    public function setSearchVisibilityEnabled(): self
+    {
+        return $this->setSearchVisibilityStatus(true);
+    }
+
+    public function setSearchVisibilityDisabled(): self
+    {
+        return $this->setSearchVisibilityStatus(false);
+    }
+
+}

src/Traits/Styling/Search/HasSearchIcon.php renamed to src/Traits/Core/Search/Styling/HasSearchIcon.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Rappasoft\LaravelLivewireTables\Traits\Styling\Search;
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search\Styling;
 
 use Livewire\Attributes\Computed;
 

src/Traits/Styling/Search/HasSearchInput.php renamed to src/Traits/Core/Search/Styling/HasSearchInput.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Rappasoft\LaravelLivewireTables\Traits\Styling\Search;
+namespace Rappasoft\LaravelLivewireTables\Traits\Core\Search\Styling;
 
 trait HasSearchInput
 {