A simplified global search URL endpoint for your application.
You are required to install Laravel Scout first, then choose which driver you preferred to use:
Then you can install the package via composer:
composer require cleaniquecoders/global-searchYou can publish the config file with:
php artisan vendor:publish --tag="global-search-config"Configure your model so that it's searchable.
Next, add the following in your routes/api.php:
use CleaniqueCoders\GlobalSearch\GlobalSearch;
GlobalSearch::routes();You may now use the API search route in your front-end:
axios.get('search', {
'type' => 'user',
'keyword' => 'nasrul'
})
.then(...)If you need to call within your application, from the back-end, you can use the search() helper:
// get the first result
search(\App\Models\User::class, 'nasrul');
// get all possible result by passing true to the third argument
// this will return a paginated result
search(\App\Models\User::class, 'nasrul', true);To add more search capabilities, you may add more enum values as in app/Enums/SearchType class.
<?php
namespace App\Enums;
use Spatie\Enum\Laravel\Enum;
/**
* @method static self user()
* @method static self profile()
*/
class SearchType extends Enum
{
public static function values(): array
{
return [
'user' => \App\Models\User::class,
'profile' => \App\Models\Profile::class,
];
}
protected static function labels(): array
{
return [
'user' => __('User'),
'profile' => __('Profile'),
];
}
}composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent