thuyld_rabiloo/searchy

This is my package searchy

v1.0.0 2022-12-26 08:58 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^9.0
• spatie/laravel-package-tools: ^1.13.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^6.0
• orchestra/testbench: ^7.0
• pestphp/pest: ^1.21
• pestphp/pest-plugin-laravel: ^1.1
• phpunit/phpunit: ^9.5

MIT

• ThuyLD

• laravel
• rabiloo
• modelsearchy

README

Installation

You can install the package via composer:

composer require thuyld_rabiloo/searchy

You can publish the config file with:

php artisan vendor:publish --tag="searchy-config"

This is the contents of the published config file:

return [
    'default' => 'fuzzy',
    'fieldName' => 'relevance',
    'drivers' => [
        'fuzzy' => [
            'class' => 'Rabiloo\Searchy\SearchDrivers\FuzzySearchDriver',
        ],
        'ufuzzy' => [
            'class' => 'Rabiloo\Searchy\SearchDrivers\FuzzySearchUnicodeDriver',
        ],
        'simple' => [
            'class' => 'Rabiloo\Searchy\SearchDrivers\SimpleSearchDriver',
        ],
        'levenshtein' => [
            'class' => 'Rabiloo\Searchy\SearchDrivers\LevenshteinSearchDriver',
        ],
    ],
];

Usage

use Rabiloo\Searchy\Traits\Searchable;
class SearchableModel extends Model 
{
    use Searchable;
    
    public function searchableColumns() 
    {
        return ['field_1', 'field_2'];
    }
}

Default search

$search = SearchableModel::search('keyword')->get();

Fuzzy search

$search = SearchableModel::fuzzySearch('keyword')->get();
$search = SearchableModel::uFuzzySearch('keyword')->get();

Simple search

$search = SearchableModel::simpleSearch('keyword')->get();

Levenshtein search

$search = SearchableModel::levenshteinSearch('keyword')->get();

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• ThuyLD
• All Contributors

License

The MIT License (MIT). Please see License File for more information.