karabinse/eloquent-searchable

Easily search eloquent models and their relations

Installation

You can install the package via composer:

composer require karabinse/eloquent-searchable

Usage

Add the trait and add columns that are searchable.

use Karabin\Searchable\Concerns\IsSearchable;

class User extends Authenticatable
{
    use HasFactory, HasRoles, IsSearchable, Notifiable;

    protected $searchable = [
        'name',
        'email',
        'posts.title'
    ];

The package also includes a custom TermSearchFitler to be used with Laravel Query Builder.

use Karabin\Searchable\Filters\TermSearchFilter;

class UserController extends Controller
{
    public function index(Request $request)
    {
        $users = QueryBuilder::for(User::class)
            ->allowedFilters([
                AllowedFilter::custom('search', new TermSearchFilter),
            ])
            ->paginate($request->query('limit', 10));

        return Inertia::render('User/Index', [
            'users' => UserData::collect($users),
        ]);
    }

Testing

composer test

Credits

• Albin N
• Daniel K Modig
• All Contributors

License

The MIT License (MIT). Please see License File for more information.