Added a callback to the perform search method.

[tlaverdure]

I'm a huge fan of Scout! It's really simple to use, love that it supports a paid and open-source driver, and that it's built with the intention of being a simple search implementation.

With that being said, I think that it would be feasible to add a callback to the performSearch() method of each engine that allows the developer more flexibility in terms of building a search query that is relevant to their application. While both Agolia and Elasticsearch have a vast amount of parameters, I don' think this package needs to re-invent those through additional methods or through arbitrary option arrays. This can be accomplished with a simple callback that provides a filter where you can bring your own query into the mix.
  
Example Implementation

App\Users::search($request->search, function($engine, $query, $options) {         

        // Do stuff with the engine or with the query/options.

        return $engine->search($query); // Must return a search()

});

  

Agolia Example

Route::post('/search/users', function (Request $request) {

    return App\Users::search($request->search, function($engine, $query, $options) {

        $options['attributesToRetrieve'] = ['first_name', 'last_name'];

        $options['attributesToHighlight'] = ['first_name'];

        return $engine->search($query, $options); // Perform search and return results.

    })->paginate();
});

  

Elasticsearch Example

Route::post('/search/users', function (Request $request) {

    return App\Users::search($request->search, function($engine, $query) {

        $query['body']  = // Change the default query as needed...

        return $engine->search($query); // Perform search and return results.

    })->paginate();
});