You are viewing documentation for an outdated version. It is no longer supported!

Search Processor

The SearchProcessor creates a simple search query filter. It compares a search term against one or more table columns, using SQL's like operator. If you do not have a huge amount of records, then this processor might be a good starting point.

Setup

In your builder, specify the http query parameter name and the database table columns that the search filter must compare a search term against.

Note: You should only specify numeric or string datatype columns. Other types of columns might not yield positive results.

use Aedart\Filters\Processors\SearchProcessor;

class UserFilterBuilder extends BaseBuilder
{
    public function processors(): array
    {
        return [
            'search' => SearchProcessor::make()
                ->columns([ 'id', 'name', 'email' ]),
            
            // ...etc
        ];
    }
}

Maximum length of search term

By default, the processor will raise a validation exception (results in a 422 Unprocessable Entity http response), if the submitted search term is more than 100 characters. To change this behaviour, use maxSearchLength() to specify a different maximum length.

return [
    'search' => SearchProcessor::make()
        ->columns([ 'id', 'name', 'email' ])
        ->maxSearchLength(150),
];

Custom Queries

You may also specify custom queries instead of column names, to build a more advanced search query. The callback is given the current query scope and search term as arguments. Furthermore, the callback MUST return a query instance.

use Illuminate\Contracts\Database\Query\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder as EloquentBuilder;

$processor = SearchProcessor::make()
        ->columns(function(Builder|EloquentBuilder $query, string $search) {
            return $query
                ->orWhere($column, 'like', "{$search}%");
        });

You may also wrap your custom search query into an invokable class, e.g.:

use Aedart\Filters\Query\Filters\BaseSearchQuery;
use Illuminate\Contracts\Database\Query\Builder;
use Illuminate\Contracts\Database\Eloquent\Builder as EloquentBuilder;

class MyCustomSearch extends BaseSearchQuery
{
    public function __invoke(
        Builder|EloquentBuilder $query,
        string $search
    ): Builder|EloquentBuilder
    {
            return $query->orWhere($column, 'like', "{$search}%");
    }
}

// ...In your search processor
$processor = SearchProcessor::make()
        ->columns(new MyCustomSearch());