This Laravel package allows you to search through multiple Eloquent models. It supports sorting, pagination, scoped queries, eager load relationships, and searching through single or multiple columns.
Hey! We've built a Docker-based deployment tool to launch apps and sites fully containerized. You can find all features and the roadmap on our website, and we are on Twitter as well!
- PHP 7.4+
- MySQL 5.7+
- Laravel 6.0 and higher
- Search through one or more Eloquent models.
- Support for cross-model pagination.
- Search through single or multiple columns.
- Order by (cross-model) columns or by relevance.
- Use constraints and scoped queries.
- Eager load relationships for each model.
- In-database sorting of the combined result.
- Zero third-party dependencies
📺 Want to watch an implementation of this package? Rewatch the live stream (skip to 13:44 for the good stuff): https://youtu.be/WigAaQsPgSA
If you want to know more about this package's background, please read the blog post.
We proudly support the community by developing Laravel packages and giving them away for free. Keeping track of issues and pull requests takes time, but we're happy to help! If this package saves you time or if you're relying on it professionally, please consider supporting the maintenance and development.
You can install the package via composer:
composer require protonemedia/laravel-cross-eloquent-search
- The
startWithWildcard
method has been renamed tobeginWithWildcard
. - The default order column is now evaluated by the
getUpdatedAtColumn
method. Previously it was hard-coded toupdated_at
. You still can use another column to order by. - The
allowEmptySearchQuery
method andEmptySearchQueryException
class have been removed, but you can still get results without searching.
Start your search query by adding one or more models to search through. Call the add
method with the model's class name and the column you want to search through. Then call the get
method with the search term, and you'll get a \Illuminate\Database\Eloquent\Collection
instance with the results.
The results are sorted in ascending order by the updated column by default. In most cases, this column is updated_at
. If you've customized your model's UPDATED_AT
constant, or overwritten the getUpdatedAtColumn
method, this package will use the customized column. Of course, you can order by another column as well.
use ProtoneMedia\LaravelCrossEloquentSearch\Search;
$results = Search::add(Post::class, 'title')
->add(Video::class, 'title')
->get('howto');
If you care about indentation, you can optionally use the new
method on the facade:
Search::new()
->add(Post::class, 'title')
->add(Video::class, 'title')
->get('howto');
You can add multiple models at once by using the addMany
method:
Search::addMany([
[Post::class, 'title'],
[Video::class, 'title'],
])->get('howto');
There's also an addWhen
method, that adds the model when the first argument given to the method evaluates to true
:
Search::new()
->addWhen($user, Post::class, 'title')
->addWhen($user->isAdmin(), Video::class, 'title')
->get('howto');
By default, we split up the search term, and each keyword will get a wildcard symbol to do partial matching. Practically this means the search term apple ios
will result in apple%
and ios%
. If you want a wildcard symbol to begin with as well, you can call the beginWithWildcard
method. This will result in %apple%
and %ios%
.
Search::add(Post::class, 'title')
->add(Video::class, 'title')
->beginWithWildcard()
->get('os');
Note: in previous versions of this package, this method was called startWithWildcard()
.
If you want to disable the behaviour where a wildcard is appended to the terms, you should call the endWithWildcard
method with false
:
Search::add(Post::class, 'title')
->add(Video::class, 'title')
->beginWithWildcard()
->endWithWildcard(false)
->get('os');
Multi-word search is supported out of the box. Simply wrap your phrase into double-quotes.
Search::add(Post::class, 'title')
->add(Video::class, 'title')
->get('"macos big sur"');
You can disable the parsing of the search term by calling the dontParseTerm
method, which gives you the same results as using double-quotes.
Search::add(Post::class, 'title')
->add(Video::class, 'title')
->dontParseTerm()
->get('macos big sur');
If you want to sort the results by another column, you can pass that column to the add
method as a third parameter. Call the orderByDesc
method to sort the results in descending order.
Search::add(Post::class, 'title', 'published_at')
->add(Video::class, 'title', 'released_at')
->orderByDesc()
->get('learn');
You can call the orderByRelevance
method to sort the results by the number of occurrences of the search terms. Imagine these two sentences:
- Apple introduces iPhone 13 and iPhone 13 mini
- Apple unveils new iPad mini with breakthrough performance in stunning new design
If you search for Apple iPad, the second sentence will come up first, as there are more matches of the search terms.
Search::add(Post::class, 'title')
->beginWithWildcard()
->orderByRelevance()
->get('Apple iPad');
We highly recommend paginating your results. Call the paginate
method before the get
method, and you'll get an instance of \Illuminate\Contracts\Pagination\LengthAwarePaginator
as a result. The paginate
method takes three (optional) parameters to customize the paginator. These arguments are the same as Laravel's database paginator.
Search::add(Post::class, 'title')
->add(Video::class, 'title')
->paginate()
// or
->paginate($perPage = 15, $pageName = 'page', $page = 1)
->get('build');
You may also use simple pagination. This will return an instance of \Illuminate\Contracts\Pagination\Paginator
, which is not length aware:
Search::add(Post::class, 'title')
->add(Video::class, 'title')
->simplePaginate()
// or
->simplePaginate($perPage = 15, $pageName = 'page', $page = 1)
->get('build');
Instead of the class name, you can also pass an instance of the Eloquent query builder to the add
method. This allows you to add constraints to each model.
Search::add(Post::published(), 'title')
->add(Video::where('views', '>', 2500), 'title')
->get('compile');
You can search through multiple columns by passing an array of columns as the second argument.
Search::add(Post::class, ['title', 'body'])
->add(Video::class, ['title', 'subtitle'])
->get('eloquent');
MySQL has a soundex algorithm built-in so you can search for terms that sound almost the same. You can use this feature by calling the soundsLike
method:
Search::new()
->add(Post::class, 'framework')
->add(Video::class, 'framework')
->soundsLike()
->get('larafel');
Not much to explain here, but this is supported as well :)
Search::add(Post::with('comments'), 'title')
->add(Video::with('likes'), 'title')
->get('guitar');
You call the get
method without a term or with an empty term. In this case, you can discard the second argument of the add
method. With the orderBy
method, you can set the column to sort by (previously the third argument):
Search::add(Post::class)
->orderBy('published_at')
->add(Video::class)
->orderBy('released_at')
->get();
You can count the number of results with the count
method:
Search::add(Post::published(), 'title')
->add(Video::where('views', '>', 2500), 'title')
->count('compile');
You can use the parser with the parseTerms
method:
$terms = Search::parseTerms('drums guitar');
You can also pass in a callback as a second argument to loop through each term:
Search::parseTerms('drums guitar', function($term, $key) {
//
});
composer test
Please see CHANGELOG for more information about what has changed recently.
Please see CONTRIBUTING for details.
Laravel Analytics Event Tracking
: Laravel package to easily send events to Google Analytics.Laravel Blade On Demand
: Laravel package to compile Blade templates in memory.Laravel Eloquent Scope as Select
: Stop duplicating your Eloquent query scopes and constraints in PHP. This package lets you re-use your query scopes and constraints by adding them as a subquery.Laravel Eloquent Where Not
: This Laravel package allows you to flip/invert an Eloquent scope, or really any query constraint.Laravel FFMpeg
: This package provides an integration with FFmpeg for Laravel. The storage of the files is handled by Laravel's Filesystem.Laravel Form Components
: Blade components to rapidly build forms with Tailwind CSS Custom Forms and Bootstrap 4. Supports validation, model binding, default values, translations, includes default vendor styling and fully customizable!Laravel Mixins
: A collection of Laravel goodies.Laravel Paddle
: Paddle.com API integration for Laravel with support for webhooks/events.Laravel Verify New Email
: This package adds support for verifying new email addresses: when a user updates its email address, it won't replace the old one until the new one is verified.Laravel WebDAV
: WebDAV driver for Laravel's Filesystem.
If you discover any security-related issues, please email pascal@protone.media instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
This package is Treeware. If you use it in production, we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest, you'll create employment for local families and restoring wildlife habitats.