mabadir/elastic-laravel

Elastic Search Indexer for Laravel 5

elastic-laravel

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Elastic Search Indexer for Laravel 5., _(*2)

Structure

If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following., _(*3)

config/
src/
tests/
vendor/

Install

Via Composer, _(*4)

``` bash $ composer require mabadir/elastic-laravel, <sub>(*5)</sub>

## Usage
Add the `ElasticLaravelServiceProvider` to your `config/app.php`.
``` php
'providers' => [
//Other providers
    MAbadir\ElasticLaravel\ElasticLaravelServiceProvider::class,
],

Publish the elastic.php to your configuration. ``` bash $ php artisan vendor:publish, <sub>(*6)</sub>

Add the ElasticEloquent trait to your Eloquent model to have it indexed.

``` php
namespace App;

use MAbadir\ElasticLaravel\ElasticEloquent;

class User extends Authenticatable
{
    use ElasticEloquent;

}

For searching the index, you can run search with different approaches. The first step is to add the Facade to your config/app.php:, <sub>(*7)</sub>

``` php 'aliases' => [ //Other Facades 'ElasticSearcher' => MAbadir\ElasticLaravel\ElasticSearcher::class, ],, <sub>(*8)</sub>

1. Simple term search:

```php
ElasticSearcher::search('simple term');

1. Simple term search on specific model type:

$user = App\User::first();
ElasticSearcher::search('Simple Term', $user);

This will search the Elastic Search index for the simple term with type=users., <sub>(*9)</sub>

1. Search index on specific parameter:

ElasticSearcher::search(['name' => 'First Name']);

This will search the complete Search Index for the parameter name with value First Name, <sub>(*10)</sub>

1. Search index on specific parameter and specific model type:

$user = App\User::first();
ElasticSearcher::search(['name' => 'First Name'], $user);

This will search the Search Index for the parameter name with value First Name on type=users., <sub>(*11)</sub>

1. Advanced Search:

$params = [
            'body' => [
                'query' => [
                    'match' => [
                        '_all' => 'Simple Term'
                    ]
                ]
            ]
        ];
ElasticSearcher::advanced($params);

This exposes the complete Elastic Search powerful query DSL interface, this will accept any acceptable Elastic Search DSL query., <sub>(*12)</sub>

1. Advanced Search:

$user = User::first();
$params = [
            'body' => [
                'query' => [
                    'match' => [
                        '_all' => 'Simple Term'
                    ]
                ]
            ]
        ];
ElasticSearcher::advanced($params, $user);

This will search the index using the advanced query for type=users., <sub>(*13)</sub>

For the different functions, the class name can be used instead of the object itself, the object or the class should be extending Eloquent Model class \Illuminate\Database\Eloquent\Model. For example:, <sub>(*14)</sub>

ElasticSearcher::search(['name' => 'First Name'], User::class);

ElasticSearch Indexing Console Command

By default the package provides a default index initialization command:, <sub>(*15)</sub>

$ php artisan es:init

The default command will initialize the index with very basic settings. If it is required to initialize the index with more advanced settings and custom mappings: Create a new Console Command in your application:, <sub>(*16)</sub>

$ php artisan make:command IndexIntializationCommand

Import the IndexInitializationTrait class, and overload the $params attribute:, <sub>(*17)</sub>

namespace App\Console\Commands;

use Illuminate\Console\Command;
use MAbadir\ElasticLaravel\Console\IndexInitializationTrait;

class IndexIntializationCommand extends Command
{
    use IndexInitializationTrait;

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'es:initialize';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Initialize ElasticSearch Index';

    /**
     * Parameters array
     * 
     * @var array
     */
    protected $params = [
        //Custom Settings
    ];
}

For more details on the configuration parameters, check the official ElasticSearch documentation., <sub>(*18)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*19)</sub>

Testing

bash $ composer test, <sub>(*20)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*21)</sub>

Security

If you discover any security related issues, please email mina@abadir.email instead of using the issue tracker., <sub>(*22)</sub>

Credits

• Mina Abadir
• All Contributors

License

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