m6web/elasticsearch-bundle

Symfony2 Bundle on top of elasticsearch/elasticsearch-php

ElasticsearchBundle

Integration of the Elasticsearch official PHP client within a Symfony Project., _(*1)

Features

This bundle creates one or more Elasticsearch client services from settings defined in the application configuration., _(*2)

Usage

Installation

You must first add the bundle to your composer.json:, _(*3)

    "require": {
        "m6web/elasticsearch-bundle": "dev-master"
    }

Then register the bundle in your AppKernel class:, _(*4)

<?php
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new M6Web\Bundle\ElasticsearchBundle\M6WebElasticsearchBundle(),
        );
        // ...
    }

Configuration

In your config.yml, you can configure one or more Elasticsearch clients:, _(*5)

``` yml m6web_elasticsearch: default_client: my_client clients: my_client: hosts: - 'localhost:9200' - 'http://other_host:9201' my_other_client: hosts: - 'other_server:9200', <sub>(*6)</sub>

From this configuration, the bundle will create two services : 

- `m6web_elasticsearch.client.my_client` that will connect to two Elasticsearch instances: `localhost` on port 9200 and `other_host` on port 9201
- `m6web_elasticsearch.client.my_other_client` that will connect to one Elasticsearch instances: `other_server` on port 9200

It will also create `m6web_elasticsearch.client.default` which is an alias for `m6web_elasticsearch.client.my_client` 

### Additional configuration

Each client can have additional configuration parameters that will be used to instantiate the `\Elasticsearch\Client`. Ex:

``` yml
m6web_elasticsearch:
    clients:
        my_client:
            hosts:
                - 'https://username:password@localhost:9200'
            headers:
                'Accept-Encoding': ['gzip']
            retries: 2
            logger: monolog.logger.custom
            connectionPoolClass: '\Elasticsearch\ConnectionPool\StaticConnectionPool'
            selectorClass: '\Elasticsearch\ConnectionPool\Selectors\RandomSelector'
            connectionParams:
                client:
                    timeout: 3
                    connect_timeout: 1

Events

The bundle dispatches \M6Web\Bundle\ElasticsearchBundle\EventDispatcher\ElasticsearchEvent events containing various information about the Elasticsearch requests., <sub>(*7)</sub>

Events are fired with the name m6web.elasticsearch., <sub>(*8)</sub>

Tests

You can launch the unit tests using:, <sub>(*9)</sub>

./vendor/bin/atoum

License

ElasticsearchBundle is licensed under the MIT license., <sub>(*10)</sub>