algolia/laravel-scout-algolia-macros

A collection macros to extend Laravel Scout with more Algolia capabilities

DEPRECATED: Use of this repository is deprecated. Please use Scout Extended - https://github.com/algolia/scout-extended instead., _(*1)

Laravel Scout Algolia Macros

A collection of useful macros to extend Laravel Scout capabilities when using the Algolia engine., _(*2)

This package aims to provide a set of macros to take advantage of the Algolia-specific feature., _(*3)

Installation

Pull the package using composer, _(*4)

composer require algolia/laravel-scout-algolia-macros

Next, you should add the Algolia\ScoutMacros\ServiceProvider to the providers array of your config/app.php configuration file:, _(*5)

Algolia\ScoutMacros\ServiceProvider::class

Usage

count

The count method will return the number of results after the request to Algolia., _(*6)

The point is to avoid pull data from the database and building the collection., _(*7)

$nbHits = Model::search('query')->count();

hydrate

The hydrate method is similar to the standard get() method, except it hydrates the models from your Algolia index., _(*8)

By default, Scout will use the IDs of the results from Algolia and pull the data from the local database to create the collection., _(*9)

Hence, hydrate will be much faster than get., _(*10)

Note: By using this method you must be sure that you are correctly keeping your algolia index in sync with your database to avoid populating stale data., _(*11)

Restrict attributes

By default, this method will add all attributes from Algolia's record to your model. If you want to remove sensitive or irrelevant data from your model, you have two options., _(*12)

You can set a list of retrievable attributes in your Algolia dashboard. In this case, Algolia will only return these attributes while still searching every searchableAttributes., _(*13)

You may as well use the laravel $guarded attributes of your model class. For instance, if you don't want to see the _h attribute in your collection, you will have the following., _(*14)

namespace App;

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

class People extends Model
{
    use Searchable;

    protected $guarded = ['_highlightResult'];
}

with

The with method gives you complete access to the Algolia options parameter. This allows you to customise the search parameters exactly the same as you would using the algolia php library directly., _(*15)

Simple example

$result = Model::search('')
                    ->with(['hitsPerPage' => 30])
                    ->get();

Advanced example

$filters = [
    'averge_ratings >= 3',
    'total_reviews >= 1'
];

$filterString = implode(' AND ', $filters);

$params = [
            'aroundLatLng' => $lat.','.$lon,
            'hitsPerPage' => 30,
            'page' => 0,
            'aroundRadius' => 30000, //30km
            'aroundPrecision' => 200, //200 Meters
            'getRankingInfo' => true, //return ranking information in results
            'filters' => $filterString // add filters
        ];

$result = Model::search('')->with($params)->get();

aroundLatLng

ThearoundLatLng method will add geolocation parameter to the search request. You can define a point with its coordinate., _(*16)

Note that this method is pure syntactic sugar, you can use with to specify more location details (like radius for instance), _(*17)

// Models around Paris latitude and longitude
Model::search('query')->aroundLatLng(48.8588536, 2.3125377)->get();

Where clauses can also be added, _(*18)

Model::search('query')
    ->aroundLatLng(48.8588536, 2.3125377)
    ->where('something_id', 1)
    ->get();

Contributing

Feel free to open an issue to request a macro., _(*19)

Open any pull request you want, so we can talk about it and improve the package. :tada:, _(*20)