elastic / enterprise-search
Enterprise Search official PHP client
Installs: 450 006
Dependents: 9
Suggesters: 0
Security: 0
Stars: 25
Watchers: 200
Forks: 14
Open Issues: 3
Requires
- php: ^7.4 || ^8.0
- elastic/transport: ^8.0.0
- nyholm/psr7: ^1.3
Requires (Dev)
- guzzlehttp/guzzle: ^7.0
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^9.5
Suggests
- guzzlehttp/guzzle: We suggest to use Guzzle as PSR-18 HTTP library
- dev-main
- 9.0.x-dev
- 8.x-dev
- 8.18.x-dev
- v8.18.0
- 8.17.x-dev
- 8.16.x-dev
- 8.15.x-dev
- 8.14.x-dev
- 8.13.x-dev
- 8.12.x-dev
- 8.11.x-dev
- 8.10.x-dev
- v8.10.0
- 8.9.x-dev
- v8.9.0
- 8.8.x-dev
- v8.8.1
- v8.8.0
- 8.7.x-dev
- v8.7.0
- 8.6.x-dev
- v8.6.0
- 8.5.x-dev
- v8.5.0
- 8.4.x-dev
- v8.4.0
- 8.3.x-dev
- v8.3.0
- 8.2.x-dev
- v8.2.0
- 8.1.x-dev
- v8.1.0
- 8.0.x-dev
- v8.0.0
- 7.x-dev
- 7.17.x-dev
- v7.17.1
- v7.17.0
- 7.16.x-dev
- v7.16.0
- 7.15.x-dev
- v7.15.0
- 7.14.x-dev
- v7.14.1
- v7.14.0
- 7.13.x-dev
- v7.13.1
- v7.13.0
- v7.12.0beta2
- v7.12.0beta1
- dev-renovate/configure
- dev-fix/psr-18-issues-not-found-library
- dev-default-http-guzzle
- dev-improve-workplace-docs
- dev-add-make.sh-skel
- dev-old-repository
This package is auto-updated.
Last update: 2025-04-18 15:20:46 UTC
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.