kevinpijning/laravel-searchable

Easy table searching for Laravel

Searchable Laravel (5.*)

This package let you easily search through models by a Searchable trait., _(*1)

Setup

Composer

Pull this package in through Composer, _(*2)

{
    "require": {
        "kevinpijning/laravel-searchable": "dev-master"
    }
}

$ composer update, _(*3)

Add the package to your application service providers in config/app.php, _(*4)

'providers' => [

    App\Providers\RouteServiceProvider::class,

    /*
     * Third Party Service Providers...
     */
     KevinPijning\LaravelSearchable\LaravelSearchableServiceProvider::class,
],

Publish the view:, _(*5)

php artisan vendor:publish

Usage

Use Searchable trait inside your Eloquent model(s). Define $searchable array (see example code below)., _(*6)

use KevinPijning\LaravelSearchable\Searchable;

class User extends Model implements AuthenticatableContract, CanResetPasswordContract 
{
    use Authenticatable, CanResetPassword, Searchable;
    ...

    public $searchable = ['id',
                        'name',
                        'email',
                        'created_at',
                        'updated_at'];

    ...
}

Searchable trait adds Searchable scope to the models so you can use it with paginate., _(*7)

Blade extension

There is one blade extension for you to use @searchableform, _(*8)

@searchableform, _(*9)

This will include a search form to your page., _(*10)

Full example

Routes

Route::get('users', ['as' => 'users.index', 'uses' => 'HomeController@index']);

Controller

use App\User;

public function index()
{
    $users = User::searchable()->paginate(10);

    return view('user.index')->withUsers($users);
}

View

Pagination included, _(*11)

@searchableform

@foreach($users as $user)
    {{ $user->name }}
@endforeach

{!! $users->appends(\Request::except('page'))->render() !!}