[Searchable Traits] Simple searchable traits for laravel model #laravel #search #simpleSearch #traits

Customer.php

<?php

namespace App\Models;

use App\Models\Traits\Searchable;
use Illuminate\Database\Eloquent\Model;

class Customer extends Model
{
	use Searchable;
  
  	private $searchable = [
    	'name',
      	'email'
    ];
  
  	....

}

Searchable.php

<?php

namespace App\Models\Traits;

use Illuminate\Database\Eloquent\Builder;

trait Searchable
{
    public function scopeSearch(Builder $query, $filter)
    {
        $query->when(!empty($filter['q']), function ($query) use ($filter) {
            $keyword = $filter['q'];

            $query->where(function (Builder $query) use ($keyword) {
                foreach ($this->getSearchable() as $attribute) {
                    $query->orWhere($attribute, 'LIKE', "%{$keyword}%");
                }
            });
        });

        return $query;
    }

    public function getSearchable()
    {
        if (empty($this->searchable)) {
            throw new \Exception('Please define searchable params');
        }

        return $this->searchable;
    }
}