Weave Code
Solr Php Client Laravel Package
reprovinci/solr-php-client
Laravel-friendly PHP client for Apache Solr. Simple configuration and API for querying, indexing, and managing documents, with clean integration into modern PHP apps. Ideal for adding Solr-powered search without heavy setup.
A PHP library for indexing and searching documents within an Apache Solr installation. Supports both Solr 3 and 4. — Fork of the solr-php-client project on Google Code.
Frequently asked questions about Solr Php Client
- How do I install this Solr client in a Laravel project?
- Use Composer to install the package with `composer require reprovinci/solr-php-client`. Then configure the Solr connection in your Laravel service provider or config file, specifying the Solr server URL and any authentication credentials. The package provides a `SolrClient` class that can be instantiated and injected into controllers or services.
- Does this package support Laravel Scout for Algolia/Meilisearch?
- No, this package is specifically for Apache Solr and does not integrate with Laravel Scout. Scout is designed for Algolia and Meilisearch, while this client provides direct Solr functionality. You’ll need to manage indexing and queries manually or build a custom bridge between the two.
- What Laravel versions does this package support?
- The package is PHP 5.3+ compatible, which aligns with older Laravel versions. However, for Laravel 9+ (PHP 7.4+), you may need to handle dependency conflicts, such as older Guzzle versions. Test thoroughly in your Laravel environment, as some features may require PHP 7+ syntax or extensions.
- Can I use this client with Solr 8 or newer versions?
- This package only supports Solr 3 and 4, so it won’t work with Solr 8+. Solr 8 introduced breaking changes like a JSON API and new query parsers. If you need Solr 8+, consider alternatives like the official `solr-php-client` (if available) or a more modern fork, or evaluate whether the package’s limitations align with your project’s long-term needs.
- How do I index Eloquent models into Solr using this client?
- You’ll need to manually create a mapping between Eloquent models and Solr documents. Use the `Document` class from the package to define fields, then push updates via `UpdateRequest`. For automation, consider using Laravel events (e.g., `ModelSaved`) to trigger Solr indexing via observers or listeners. There’s no built-in Eloquent integration, so you’ll handle schema synchronization yourself.
- What’s the best way to handle Solr errors in Laravel?
- Solr errors (like timeouts or schema mismatches) may not map cleanly to Laravel’s exceptions. Wrap Solr client calls in try-catch blocks and throw custom exceptions (e.g., `SolrException`) that extend Laravel’s `Exception` class. Log errors using Laravel’s logging system and consider implementing retry logic for transient failures, such as network issues.
- How do I mock Solr responses for unit testing?
- To mock Solr responses, use PHPUnit’s mocking capabilities or libraries like Mockery. Create a mock `SolrClient` instance and stub methods like `query()` or `addDocument()` to return predefined responses. For integration tests, you can spin up a local Solr instance using Docker or a testing framework like Pest, but this adds setup complexity.
- Are there performance concerns with this PHP client vs. direct HTTP calls?
- Yes, the PHP client adds serialization/deserialization overhead compared to raw HTTP requests (e.g., using `curl`). Benchmark your queries to compare performance with direct Solr HTTP calls. If latency is critical, consider caching frequent queries or using Solr’s native JSON API for high-throughput applications.
- How do I secure Solr credentials in Laravel?
- Store Solr credentials (e.g., Basic Auth username/password) in Laravel’s `.env` file using variables like `SOLR_USERNAME` and `SOLR_PASSWORD`. Pass these values to the `SolrClient` constructor or configure them in your service provider. Avoid hardcoding credentials in config files or version-controlled files.
- What alternatives exist for Solr integration in Laravel?
- Alternatives include the official `solr-php-client` (if updated for modern Solr), Laravel Scout with Algolia/Meilisearch, or building a custom HTTP client using Guzzle. For legacy Solr systems, this package may suffice, but for newer Solr versions, evaluate whether the package’s maintenance status aligns with your needs or if forking it in-house is viable.
Weaver
How can I help you explore Laravel packages today?