How do I migrate from algoliasearch-laravel to Laravel Scout?

Algolia provides dedicated documentation for migrating to Laravel Scout, which involves updating dependencies and reconfiguring your models to use Scout's drivers instead of the deprecated trait. Check the official Algolia docs for step-by-step guidance.

Is algoliasearch-laravel compatible with Laravel 8 or later?

Since the package is deprecated, compatibility with newer Laravel versions is not guaranteed. The README notes it was designed for Laravel 5.x, so using it with Laravel 8+ might require manual fixes or could break entirely.

algoliasearch-laravel vs Laravel Scout: which one should I use?

For new projects, always use Laravel Scout as it's actively maintained by the Laravel community and supports multiple search engines. algoliasearch-laravel is only suitable for legacy applications that can't migrate immediately, but it lacks future support.

How to index model relationships in algoliasearch-laravel?

You can index relationships by loading them in the getAlgoliaRecord method of your model, as shown in the README's relationships section. This allows you to include related data, like category names, in the Algolia record by merging arrays.

Can I disable automatic indexing in algoliasearch-laravel?

Yes, you can disable auto-indexing by setting static properties like $autoIndex to false or by defining autoIndex methods in your model, which is useful for batch operations to improve performance, as mentioned in the options section.

What happens if I use algoliasearch-laravel in production now?

Using it in production is risky due to its deprecated status. You might face issues with Laravel updates, lack of security patches, and no official support, potentially leading to downtime or data inconsistencies in search functionality.

Open-Awesome

Algolia Search

MITPHP1.7.1

A deprecated Laravel package for integrating Algolia's search API with Eloquent models.

Visit Website GitHub

238 stars50 forks0 contributors

What is Algolia Search?

Algolia Search API Client for Laravel was a deprecated PHP package that integrated Algolia's hosted search engine with Laravel's Eloquent ORM. It automatically synchronized Eloquent models with Algolia indices, enabling real-time search functionality directly from Laravel applications. The package provided features like automatic indexing, customizable search settings, and manual index management.

Target Audience

Laravel developers building applications that require integrated, real-time search capabilities using Algolia's hosted search engine.

Value Proposition

It offered a straightforward, trait-based integration that automated search indexing and querying within Laravel's ecosystem, reducing the boilerplate needed to connect Eloquent models to Algolia. However, it is now deprecated in favor of the more versatile Laravel Scout.

Overview

[Deprecated] We now recommend using Laravel Scout, see =>

Use Cases

Best For

Adding real-time search to Laravel applications using Algolia
Automatically syncing Eloquent model data with a search index
Configuring custom search relevance and ranking in Laravel
Managing search indices and replicas programmatically
Handling model relationships in search indexing
Performing manual reindexing and clearing of search data

Not Ideal For

New Laravel projects starting with Algolia integration
Teams requiring active maintenance and security updates
Applications needing the flexibility to switch or use multiple search engines
Projects where dependency on deprecated packages poses operational risk

Pros & Cons

Pros

Seamless Eloquent Integration

Automatically syncs Eloquent models with Algolia indices using a trait, as shown in the quick start where adding the trait enables indexing without manual setup.

Customizable Search Settings

Allows per-model configuration of searchable attributes, ranking, and synonyms through the $algoliaSettings property, enabling fine-tuned relevance tuning directly in code.

Granular Indexing Control

Supports manual operations like pushToIndex, removeFromIndex, and reindex, giving developers full control over when and how data is synchronized with Algolia.

Relationship Handling

Can index loaded model relationships by customizing the getAlgoliaRecord method, allowing complex data structures to be included in search indices.

Cons

Deprecated and Unmaintained

The package is officially deprecated in favor of Laravel Scout, meaning no future updates, bug fixes, or security patches, which could lead to compatibility issues.

Potential Breaking Changes

As Laravel evolves, this package may become incompatible with newer versions, risking application instability without community or official support.

Vendor Lock-in to Algolia

Unlike Laravel Scout which supports multiple drivers, this package is tightly coupled to Algolia, reducing flexibility if you need to switch search providers later.

Frequently Asked Questions

Related Projects

LiveWire

A full-stack framework for Laravel that takes the pain out of building dynamic UIs.

Stars23,531

Forks1,737

Last commit10 days ago

Debug Bar

Debugbar for Laravel (Integrates PHP Debug Bar)

Stars19,227

Forks1,605

Last commit24 days ago

IDE Helper

IDE Helper for Laravel

Stars14,917

Forks1,191

Last commit25 days ago

PHP Image Processing

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub