https://github.com/elastic/enterprise-search-php

Elastic Enterprise Search Official PHP Client
https://github.com/elastic/enterprise-search-php

app-search appsearch client elastic elastic-app-search elastic-enterprise-search elastic-workplace-search enterprise-search php workplace-search

Last synced: 2 days ago
JSON representation

Elastic Enterprise Search Official PHP Client

• Host: GitHub
• URL: https://github.com/elastic/enterprise-search-php
• Owner: elastic
• License: mit
• Created: 2019-10-09T08:39:45.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-20T12:06:38.000Z (about 1 month ago)
• Last Synced: 2024-12-16T15:17:00.591Z (7 days ago)
• Topics: app-search, appsearch, client, elastic, elastic-app-search, elastic-enterprise-search, elastic-workplace-search, enterprise-search, php, workplace-search
• Language: PHP
• Homepage: https://www.elastic.co/guide/en/enterprise-search-clients/index.html
• Size: 730 KB
• Stars: 25
• Watchers: 198
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Elastic Enterprise Search Client for PHP

> A first-party PHP client to interface with [Elastic Enterpise Search](https://www.elastic.co/enterprise-search)

including [Elastic App Search](https://www.elastic.co/app-search/) and [Elastic Workplace Search](https://www.elastic.co/workplace-search).

## Installation

The package can be installed using [composer](https://getcomposer.org/):

```bash

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](http://httplug.io/)

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](https://github.com/guzzle/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:

```php

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](https://github.com/php-http/guzzle6-adapter)

as composer requirement.

## Documentation

[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/php) 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](CONTRIBUTING.md)

to ensure your first contribution goes smoothly.

## License

`enterprise-search-php` is available under the MIT license.

For more details see [LICENSE](LICENSE).