mgarcia96/laravel-scout-tntsearch-driver

Driver for Laravel Scout search package based on https://github.com/teamtnt/tntsearch

TNTSearch Driver for Laravel Scout - Laravel 5.3/5.4

, _(*1)

This package makes it easy to add full text search support to your models with Laravel 5.3/5.4., _(*2)

Support us on Patreon

• Nenad Ticaric
• Sasa Tokic

Contents

• Installation
• Usage
• Contributing
• Credits
• License

Installation

You can install the package via composer:, _(*3)

``` bash composer require teamtnt/laravel-scout-tntsearch-driver, <sub>(*4)</sub>

Add the service provider:

```php
// config/app.php
'providers' => [
    // ...
    TeamTNT\Scout\TNTSearchScoutServiceProvider::class,
],

Ensure you have Laravel Scout as a provider too otherwise you will get an "unresolvable dependency" error, <sub>(*5)</sub>

// config/app.php
'providers' => [
    // ...
    Laravel\Scout\ScoutServiceProvider::class,
],

Add SCOUT_DRIVER=tntsearch to your .env file, <sub>(*6)</sub>

Then you should publish scout.php configuration file to your config directory, <sub>(*7)</sub>

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"

In your config/scout.php add:, <sub>(*8)</sub>

'tntsearch' => [
    'storage'  => storage_path(), //place where the index files will be stored
    'fuzziness' => env('TNTSEARCH_FUZZINESS', false),
    'fuzzy' => [
        'prefix_length' => 2,
        'max_expansions' => 50,
        'distance' => 2
    ],
    'asYouType' => false,
    'searchBoolean' => env('TNTSEARCH_BOOLEAN', false),
],

The asYouType option can be set per model basis, see example bellow, <sub>(*9)</sub>

Usage

After you have installed scout and the TNTSearch driver, you need to add the Searchable trait to your models that you want to make searchable. Additionaly, define the fields you want to make searchable by defining the toSearchableArray method on the model:, <sub>(*10)</sub>

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

    public $asYouType = true;

    /**
     * Get the indexable data array for the model.
     *
     * @return array
     */
    public function toSearchableArray()
    {
        $array = $this->toArray();

        // Customize array...

        return $array;
    }
}

Then, sync the data with the search service like:, <sub>(*11)</sub>

php artisan scout:import App\\Post, <sub>(*12)</sub>

If you have a lot of records and want to speed it up you can run:, <sub>(*13)</sub>

php artisan tntsearch:import App\\Post, <sub>(*14)</sub>

After that you can search your models with:, <sub>(*15)</sub>

Post::search('Bugs Bunny')->get();, <sub>(*16)</sub>

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor], <sub>(*17)</sub>

Credits

• Nenad Ticaric
• Sasa Tokic
• All Contributors

Contributors

This project exists thanks to all the people who contribute. , <sub>(*18)</sub>

Backers

Thank you to all our backers! 🙏 [Become a backer], <sub>(*19)</sub>

, <sub>(*20)</sub>

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor], <sub>(*21)</sub>

, <sub>(*22)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*23)</sub>