SearchHandler can now be replaced by you own implementation while is it now resolved via the Laravel container (#2099)

Author: edwinheij

src/DataSource/Processors/Database/Handlers/SearchHandler.php

@@ -11,10 +11,10 @@
 use stdClass;
 use Throwable;
 
-class SearchHandler
+class SearchHandler implements SearchHandlerContract
 {
     public function __construct(
-        private readonly PowerGridComponent $component
+        protected readonly PowerGridComponent $component
     ) {}
 
     public function apply(EloquentBuilder|QueryBuilder $query): EloquentBuilder|QueryBuilder
@@ -56,7 +56,7 @@ public function apply(EloquentBuilder|QueryBuilder $query): EloquentBuilder|Quer
         return $query;
     }
 
-    private function filterRelation(EloquentBuilder $query, string $search): void
+    protected function filterRelation(EloquentBuilder $query, string $search): void
     {
         foreach ($this->component->relationSearch() as $table => $columns) {
             if (is_array($columns)) {
@@ -72,7 +72,7 @@ private function filterRelation(EloquentBuilder $query, string $search): void
         }
     }
 
-    private function filterNestedRelation(EloquentBuilder $query, string $table, array $columns, string $search): void
+    protected function filterNestedRelation(EloquentBuilder $query, string $table, array $columns, string $search): void
     {
         foreach ($columns as $nestedTable => $nestedColumns) {
             if (is_array($nestedColumns)) {
@@ -113,7 +113,7 @@ private function filterNestedRelation(EloquentBuilder $query, string $table, arr
         }
     }
 
-    private function getColumnList(EloquentBuilder|QueryBuilder $query, string $modelTable): array
+    protected function getColumnList(EloquentBuilder|QueryBuilder $query, string $modelTable): array
     {
         $connection = $query instanceof EloquentBuilder
             ? $query->getModel()->getConnection()->getName()
@@ -131,12 +131,12 @@ private function getColumnList(EloquentBuilder|QueryBuilder $query, string $mode
         }
     }
 
-    private function getDataField(Column|stdClass|array $column): string
+    protected function getDataField(Column|stdClass|array $column): string
     {
         return strval(data_get($column, 'dataField')) ?: strval(data_get($column, 'field'));
     }
 
-    private function getBeforeSearchMethod(string $field, ?string $search): ?string
+    protected function getBeforeSearchMethod(string $field, ?string $search): ?string
     {
         $method = 'beforeSearch'.str($field)->headline()->replace(' ', '');
 
@@ -151,7 +151,7 @@ private function getBeforeSearchMethod(string $field, ?string $search): ?string
         return $search;
     }
 
-    private function splitField(EloquentBuilder|QueryBuilder $query, string $field): array
+    protected function splitField(EloquentBuilder|QueryBuilder $query, string $field): array
     {
         $table = $query instanceof QueryBuilder ? $query->from : $query->getModel()->getTable();
 

src/DataSource/Processors/Database/Handlers/SearchHandlerContract.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace PowerComponents\LivewirePowerGrid\DataSource\Processors\Database\Handlers;
+
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Query\Builder as QueryBuilder;
+
+interface SearchHandlerContract
+{
+    public function apply(EloquentBuilder|QueryBuilder $query): EloquentBuilder|QueryBuilder;
+}

src/DataSource/Processors/Database/Pipelines/Filters.php

@@ -3,7 +3,7 @@
 namespace PowerComponents\LivewirePowerGrid\DataSource\Processors\Database\Pipelines;
 
 use Closure;
-use PowerComponents\LivewirePowerGrid\DataSource\Processors\Database\Handlers\{FilterHandler, SearchHandler};
+use PowerComponents\LivewirePowerGrid\DataSource\Processors\Database\Handlers\{FilterHandler, SearchHandlerContract};
 use PowerComponents\LivewirePowerGrid\PowerGridComponent;
 
 class Filters
@@ -12,7 +12,9 @@ public function __construct(protected PowerGridComponent $component) {}
 
     public function handle(mixed $query, Closure $next): mixed
     {
-        (new SearchHandler($this->component))->apply($query);
+        app()->makeWith(SearchHandlerContract::class, [
+            'component' => $this->component,
+        ])->apply($query);
         (new FilterHandler($this->component))->apply($query);
 
         return $next($query);

src/Providers/PowerGridServiceProvider.php

@@ -11,7 +11,9 @@
 use PowerComponents\LivewirePowerGrid\Commands\{CreateCommand, PublishCommand, UpdateCommand};
 use PowerComponents\LivewirePowerGrid\Components\Filters\FilterManager;
 use PowerComponents\LivewirePowerGrid\Components\Rules\RuleManager;
-use PowerComponents\LivewirePowerGrid\{Livewire\Detail,
+use PowerComponents\LivewirePowerGrid\{DataSource\Processors\Database\Handlers\SearchHandler,
+    DataSource\Processors\Database\Handlers\SearchHandlerContract,
+    Livewire\Detail,
     Livewire\LazyChild,
     Livewire\PerformanceCard,
     PowerGridManager,
@@ -70,6 +72,10 @@ public function register(): void
         Macros::builder();
 
         $this->app->singleton(SupportLivewireVersions::class, fn () => new SupportLivewireVersions());
+
+        $this->app->bind(SearchHandlerContract::class, function ($app, array $params) {
+            return new SearchHandler($params['component']);
+        });
     }
 
     private function publishViews(): void

src/Traits/ExportableJob.php

@@ -7,7 +7,7 @@
 use PowerComponents\LivewirePowerGrid\{DataSource\DataTransformer,
     DataSource\ProcessDataSource,
     DataSource\Processors\Database\Handlers\FilterHandler,
-    DataSource\Processors\Database\Handlers\SearchHandler,
+    DataSource\Processors\Database\Handlers\SearchHandlerContract,
     PowerGridComponent};
 
 /** @codeCoverageIgnore */
@@ -63,7 +63,9 @@ private function prepareToExport(array $properties = []): Eloquent\Collection|Co
 
         $results = $this->componentTable->datasource($this->properties ?? []) // @phpstan-ignore-line
             ->where(function ($query) {
-                (new SearchHandler($this->componentTable))->apply($query);
+                app()->makeWith(SearchHandlerContract::class, [
+                    'component' => $this->componentTable,
+                ])->apply($query);
                 (new FilterHandler($this->componentTable))->apply($query);
             })
             ->when($filtered, function ($query, $filtered) use ($property) {

src/Traits/WithExport.php

@@ -13,7 +13,7 @@
     DataSource\DataTransformer,
     DataSource\ProcessDataSource,
     DataSource\Processors\Database\Handlers\FilterHandler,
-    DataSource\Processors\Database\Handlers\SearchHandler};
+    DataSource\Processors\Database\Handlers\SearchHandlerContract};
 use PowerComponents\LivewirePowerGrid\Jobs\ExportJob;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Throwable;
@@ -197,7 +197,9 @@ public function prepareToExport(bool $selected = false): Eloquent\Collection|Col
 
         $results = $processDataSource->component->datasource()
             ->where(function ($query) {
-                (new SearchHandler($this))->apply($query);
+                app()->makeWith(SearchHandlerContract::class, [
+                    'component' => $this,
+                ])->apply($query);
                 (new FilterHandler($this))->apply($query);
             })
             ->when($filtered, function ($query, $filtered) use ($property) {