Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shift31/laravel-elasticsearch
Elasticsearch for Laravel
https://github.com/shift31/laravel-elasticsearch
elasticsearch-client laravel laravel-elasticsearch php
Last synced: about 2 months ago
JSON representation
Elasticsearch for Laravel
- Host: GitHub
- URL: https://github.com/shift31/laravel-elasticsearch
- Owner: shift31
- License: mit
- Created: 2013-10-27T06:45:06.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-08-24T20:48:39.000Z (about 7 years ago)
- Last Synced: 2024-07-29T01:44:46.040Z (about 2 months ago)
- Topics: elasticsearch-client, laravel, laravel-elasticsearch, php
- Language: PHP
- Homepage:
- Size: 59.6 KB
- Stars: 195
- Watchers: 12
- Forks: 40
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-laravel4 - Elastic Search
README
Laravel Elasticsearch Service Provider (4.5.0)
================================================
[](https://packagist.org/packages/shift31/laravel-elasticsearch)
[](https://packagist.org/packages/shift31/laravel-elasticsearch)
[](https://travis-ci.org/shift31/laravel-elasticsearch)
[](https://coveralls.io/github/shift31/laravel-elasticsearch?branch=master)
[](https://packagist.org/packages/shift31/laravel-elasticsearch)
This is a Laravel (4.2) Service Provider for the [official Elasticsearch low-level client](http://www.elasticsearch.org/guide/en/elasticsearch/client/php-api/5.0/index.html).
Version Matrix
------------------
Since there are breaking changes in Elasticsearch versions, your version of Elasticsearch must match the version of this
library, which matches the version of the Elasticsearch low-level client.
|Shift31/laravel-elasticsearch| Elasticsearch | Laravel |
| :---: | :---: | :---: |
| 0.4| <= 0.90.* | 4.2 |
| 1.0, 2.0| \>= 1.0 | 4.x, 5.x |
|4.0| <= 0.90.* | 4.2|
|4.1| \>= 1.0 <= 2.0 | 4.2|
|4.2| \>= 2.0 <= 5.0| 4.2|
|4.5| \>= 5.0| 4.2|
|5.0| <= 0.90.* | 5.x|
|5.1| \>= 1.0 <= 2.0 | 5.x|
|5.2| \>= 2.0 <= 5.0| 5.x|
|5.5| \>= 5.0| 5.x|
Attention: Until we launch new versions please keep using old stable versions (which are created as a branch) and don't use dev-master branch!
Usage
-----
1. Run `composer require shift31/laravel-elasticsearch:~4.5.0`
2. Publish config file
Laravel artisan command
```
$ php artisan config:publish shift31/laravel-elasticsearch
```
You can always read config parameters with:
```php
\Config::get('shift31::elasticsearch');
```
Note: The keys of this array should be named according the parameters supported by [Elasticsearch\ClientBuilder](https://github.com/elastic/elasticsearch-php/blob/5.0/src/Elasticsearch/ClientBuilder.php#L119).
3. In the `'providers'` array in app/config/app.php, add `'Shift31\LaravelElasticsearch\ElasticsearchServiceProvider'`.
4. Use the `Es` facade to access any method from the `Elasticsearch\Client` class, for example:
```php
$searchParams['index'] = 'your_index';
$searchParams['size'] = 50;
$searchParams['body']['query']['query_string']['query'] = 'foofield:barstring';
$result = Es::search($searchParams);
```
Default Configuration
---------------------
If you return an empty array in the config file, Service provider [merges default config with custom config variables](src/Shift31/LaravelElasticsearch/ElasticsearchServiceProvider.php).
For custom config file question please see [this](https://www.elastic.co/guide/en/elasticsearch/client/php-api/5.0/_configuration.html#_building_the_client_from_a_configuration_hash) elastic search configuration page.
[Default config file](src/config/elasticsearch.php) which is publishing by artisan command.
Contributing
---------------------
Please see [CONTRIBUTING.md](CONTRIBUTING.md).