README

Warning

Enterprise Search will be discontinued in 9.0.

Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes. Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.

Here are some useful links with more information:

• Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
• Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html

A first-party PHP client to interface with Elastic Enterpise Search including Elastic App Search and Elastic Workplace Search.

Installation

The package can be installed using composer:

composer require elastic/enterprise-search

The version follows the Elastic Stack version so 8.0 is compatible with Enterprise Search released in Elastic Stack 8.0.

PSR-18 HTTP library

This project uses elastic-transport-php as HTTP library. This is a component that abstracts the usage of any PSR-18 client libraries. It uses the autodiscovery feature of HTTPlug to find a compliant library already installed in your vendor. If you receive an error like No PSR-18 clients found this means you don't have any PSR-18 library installed. We suggest to use Guzzle v7+ as HTTP library. You can require it using composer:

composer require guzzlehttp/guzzle

If you want to be sure to use a specific HTTP library you need to pass it in the Client constructor, as follows:

use Elastic\EnterpriseSearch\Client;

$client = new Client([
    'client' => new GuzzleHttp\Client,
   // ...
]);

Guzzle v6

If you want to use Guzzle v6, you need to add the php-http/guzzle6-adapter as composer requirement.

Documentation

See the documentation for how to get started, compatibility info, configuring, and an API reference.

Contributing

If you'd like to make a contribution to enterprise-search-php we provide contributing documentation to ensure your first contribution goes smoothly.

License

enterprise-search-php is available under the MIT license. For more details see LICENSE.