Simple Laravel Search Trait

README.md

Usage

Put SearchTrait.php in app directory. Then use SearchTrait in your model, like so

use App\SearchTrait;
use Illuminate\Database\Eloquent\Model;

class Article extends Model 
{
    use SearchTrait; // Add this
    
    // Optional properties
    protected $search = ['title', 'content'];

}

Somewhere in your controller

$keyword = 'lorem';

// Match any fields
Article::search($keyword)->paginate();

// Match all fields
Article::search($keyword, true)->paginate();

SearchTrait.php

<?php

namespace App;

use Illuminate\Support\Facades\Schema;

trait SearchTrait
{
    /**
     * @param \Illuminate\Database\Eloquent\Builder|static  $query
     * @param string  $keyword
     * @param boolean  $matchAllFields
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public static function scopeSearch($query, $keyword, $matchAllFields = false)
    {
        return static::where(function ($query) use ($keyword, $matchAllFields) {

            foreach (static::getSearchableFields() as $field) {
                if ($matchAllFields) {
                    $query->where($field, 'LIKE', "%$keyword%");
                } else {
                    $query->orWhere($field, 'LIKE', "%$keyword%");
                }
            }

        });
    }

    /**
     * Get all searchable fields
     *
     * @return array
     */
    public static function getSearchableFields()
    {
        $model = new static;

        $fields = $model->search;

        if (empty($fields)) {
            $fields = Schema::getColumnListing($model->getTable());

            $ignoredColumns = [
                $model->getKeyName(),
                $model->getUpdatedAtColumn(),
                $model->getCreatedAtColumn(),
            ];

            if (method_exists($model, 'getDeletedAtColumn')) {
                $ignoredColumns[] = $model->getDeletedAtColumn();
            }

            $fields = array_diff($fields, $model->getHidden(), $ignoredColumns);
        }

        return $fields;
    }
}

great. useful. more helpful than 30 minutes cbt clips

i think this is new great idea for developers... instead of hours of video in youtube. we can read it more rapid

Mantap, sangat memudahkan

Any idea on how to extend this trait to handle search on relationships? I.e. on belongsTo relationship

Thanks for sharing this..