https://github.com/akki-io/laravel-nova-search
This package provides a trait that extends the search behaviour of laravel nova resource.
https://github.com/akki-io/laravel-nova-search
laravel nova php search
Last synced: 6 months ago
JSON representation
This package provides a trait that extends the search behaviour of laravel nova resource.
- Host: GitHub
- URL: https://github.com/akki-io/laravel-nova-search
- Owner: akki-io
- License: mit
- Created: 2020-08-29T05:46:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T11:07:06.000Z (7 months ago)
- Last Synced: 2025-04-11T22:09:19.601Z (6 months ago)
- Topics: laravel, nova, php, search
- Language: PHP
- Homepage:
- Size: 173 KB
- Stars: 23
- Watchers: 1
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Nova Search
[](https://github.com/akki-io/laravel-nova-search/releases)
[](LICENSE.md)
[](https://styleci.io/repos/291209513)
[](https://packagist.org/packages/akki-io/laravel-nova-search)
### Testing Statuses
MySQL - 
SQLite - 
pgSQL - 
This package provides a trait that extends the search behaviour of laravel nova resource.
## Installation
You can install the package via composer:
```bash
composer require akki-io/laravel-nova-search
```
Next, add `AkkiIo\LaravelNovaSearch\LaravelNovaSearchable` trait to your base resource `App\Nova\Resource` class.
```php
use AkkiIo\LaravelNovaSearch\LaravelNovaSearchable;
abstract class Resource extends NovaResource
{
use LaravelNovaSearchable;
// ...
}
```
## Usage
This package DOES NOT have fuzzy matching capabilities. If you are looking for robust fuzzy matching capabilities provided by "real" search engines, you should look into [Laravel Scout](https://laravel.com/docs/scout).
This package adds the following types of search to your laravel nova resource.
- Search multiple columns using concatenation.
- Search every word in columns.
- Search relationship columns.
### Search multiple columns using concatenation.
To define which resource fields are searchable, you may assign a two-dimensional array of database columns in the `public static $searchConcatenation` property of your resource class.
Each array in the array are names of columns that are concatenated using whitespace.
``` php
/**
* The columns that should be concatenated and searched.
*
* @var array
*/
public static $searchConcatenation = [
['first_name', 'last_name'],
['first_name', 'company'],
];
```
### Search every word in columns.
To define which resource fields are searchable, you may assign an array of database columns in the `public static $searchMatchingAny` property of your resource class.
Every word in your input is searched for across all these columns.
```php
/**
* The columns that should be searched for any matching entry.
*
* @var array
*/
public static $searchMatchingAny = [
'first_name',
'last_name',
'email',
];
```
### Search relationship columns.
To define which resource fields are searchable, you may assign an array of database columns in the `public static $searchRelations` property of your resource class.
These database columns are from the related table that is used for searching.
This array has a relationship name as a key, and an array of columns to search for as a value.
```php
/**
* The relationship columns that should be searched.
*
* @var array
*/
public static $searchRelations = [
'posts' => ['title', 'sub_title'],
];
```
#### Nested relationships
You may search nested relationships using dot notation.
```php
/**
* The relationship columns that should be searched.
*
* @var array
*/
public static $searchRelations = [
'user.location' => ['state_abbr', 'country_abbr'],
];
```
#### Search multiple columns in relationship using concatenation.
To define which resource fields are searchable, you may assign a two-dimensional array of database columns in the `public static $searchRelationsConcatenation` property of your resource class.
Each array in the array are names of columns that are concatenated using whitespace.
``` php
/**
* The relationship columns that should to be concatenated and searched.
*
* @var array
*/
public static $searchRelationsConcatenation = [
'user' => [
['first_name', 'last_name'],
['email']
],
];
```
#### Search every word in columns of a relationship.
To define which resource fields are searchable, you may assign an array of database columns in the `public static $searchRelationsMatchingAny` property of your resource class.
Every word in your input is searched for across all these columns.
```php
/**
* The relationship columns that should be searched for any matching entry.
*
* @var array
*/
public static $searchRelationsMatchingAny = [
'user' => ['first_name', 'last_name'],
];
```
### Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email hello@akki.io instead of using the issue tracker.
## Credits
- [Akki Khare](https://github.com/akki-io)
- [Nova Search Relationship Package](https://github.com/TitasGailius/nova-search-relations)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.