Upgrade Scout Extended

composer require "algolia/scout-extended:^5.0"

​

Upgrade from version 4 to version 5

• The engine sends the filters search parameter instead of numericFilters Scout Extended computes filters from your where, whereIn, and whereNotIn clauses and overwrites any value you pass manually. If you combined with(['filters' => ...]) with where clauses, move all filter conditions into the builder methods:
  PHP

  $articles = Article::search('Star Trek')
      ->where('views', '>', 100)
      ->with(['filters' => 'id:1 OR id:2']) 
      ->whereIn('id', [1, 2]) 
      ->get();
  
• filters() returns a string instead of an array If you subclass Algolia\ScoutExtended\Engines\AlgoliaEngine and override the filters() method, update it to return a boolean filter expression string, such as views > 100 AND (id=1 OR id=2), instead of an array.

​

Upgrade from version 3 to version 4

• Upgrade the PHP API client to version 4 The version 4 client uses a flat API: the SearchIndex class no longer exists, and all index operations take the index name as their first argument directly on the client. If you access the API directly, upgrade your code. The Algolia::index facade method now returns the index name as a string instead of a SearchIndex instance:
  PHP

  use Algolia\ScoutExtended\Facades\Algolia;
  
  $index = Algolia::index(App\Models\Article::class); 
  $synonym = $index->getSynonym('a-unique-identifier'); 
  $client = Algolia::client(); 
  $indexName = Algolia::index(App\Models\Article::class); 
  $synonym = $client->getSynonym($indexName, 'a-unique-identifier'); 
  
• Search callbacks receive the search client instead of an index The first argument passed to search callbacks is now the SearchClient. Update any callback that used the index object’s methods:
  PHP

  $articles = Article::search('Star Trek', function ($algolia, $query, $options) {
      return $algolia->search($query, $options); 
      return $algolia->searchSingleIndex( 
          (new Article)->searchableAs(), 
          array_merge(['query' => $query], $options), 
      ); 
  })->get();
  
• Record deletion no longer uses deleteBy by default Deleting records now uses the browseObjects and deleteObjects operations, so your API key needs the browse permission. To restore the previous behavior, set use_deprecated_delete_by to true in the algolia section of your config/scout.php file:
  PHP

  'algolia' => [
      'id' => env('ALGOLIA_APP_ID', ''),
      'secret' => env('ALGOLIA_SECRET', ''),
      'use_deprecated_delete_by' => true,
  ],