Legal Things - Elasticsearch PHP
This library aims to provide you with a simplified interface to use Elasticsearch.
Internally it uses the original elastic/elasticsearch-php library., (*1)
The client of the original library is exposed and can be used if needed., (*2)
Requirements
Required PHP extensions are marked by composer, (*3)
Installation
The library can be installed using composer., (*4)
composer require legalthings/elasticsearch-php
Client
To create a client you need to pass configuration options.
If no options are given, localhost:9200 is automatically used as the host., (*5)
use LegalThings/Elasticsearch;
$config = ['hosts' => 'elasticsearch.example.com:9200'];
$es = new Elasticsearch($config);
You can use the original elastic/elasticsearch-php client directly if you need its functionality., (*6)
$info = $es->client->info();
Configuration
Configuration is passed to Elasticsearch's configuration builder, which means you can provide any configuration options that it accepts.
See this link for more information., (*7)
Add ["quiet" => true] to the config if you want to add custom keys to the configuration.
If quiet isn't provided, Elasticsearch will throw an exception if it encounters keys unrelated to the Elasticsearch client., (*8)
[
'hosts' => ['localhost:9200'],
'retries' => 2
]
Search
The search() method is used to perform common, basic search operations in Elasticsearch., (*9)
The method automatically transforms filters and text searches to the correct Elasticsearch equivalent,
so you don't have to do that manually., (*10)
use LegalThings/Elasticsearch;
$es = new Elasticsearch($config);
$index = 'books';
$type = 'ancient';
$text = 'My book';
$fields = ['name'];
$filter = [
'id' => '0001',
'updated(max)' => '2017-01-01T00:00:00',
'year(min)' => 1973,
'published' => false
];
$sort = ['^year'];
$limit = 15;
$offset = 0;
$result = $es->search($index, $type, $text, $fields, $filter, $sort, $limit, $offset);
{
"took": 1,
"timed_out": false,
"_shards": {
"total": 5,
"successful": 5,
"failed": 0
},
"hits": {
"total": 1,
"max_score": null,
"hits": [{
"_index": "books",
"_type": "ancient",
"_id": "0001",
"_score": null,
"_source": {
"id": "0001",
"updated": "2017-01-01T00:00:00",
"year": 1980,
"published": false,
"name": "My book two"
},
"sort": [1980]
}]
}
}
Index
The index() method is used to perform common, basic index operations in Elasticsearch, (*11)
use LegalThings/Elasticsearch;
$es = new Elasticsearch($config);
$index = 'books';
$type = 'ancient';
$id = '0001';
$data = [
'id' => '0001',
'updated' => '2017-01-01T00:00:00',
'year' => 1980,
'published' => false,
'name' => 'My book two'
];
$result = $es->index($index, $type, $id, $data);
{
"_index": "books",
"_type": "ancient",
"_id": "0001",
"_version": 1,
"result": "created",
"_shards": {
"total": 2,
"successful": 1,
"failed": 0
},
"created": true
}
Update
The update() method is used to perform common, basic update operations in Elasticsearch, which partially updates a document, (*12)
use LegalThings/Elasticsearch;
$es = new Elasticsearch($config);
$index = 'books';
$type = 'ancient';
$id = '0001';
$data = [
'name' => 'My book three'
];
$result = $es->update($index, $type, $id, $data);
{
"_index": "books",
"_type": "ancient",
"_id": "0001",
"_version": 2,
"result": "updated",
"_shards": {
"total": 0,
"successful": 0,
"failed": 0
}
}
Get
The get() method is used to perform common, basic get operations in Elasticsearch., (*13)
use LegalThings/Elasticsearch;
$es = new Elasticsearch($config);
$index = 'books';
$type = 'ancient';
$id = '0001';
$result = $es->get($index, $type, $id);
{
"_index": "books",
"_type": "ancient",
"_id": "0001",
"_version": 1,
"found": true,
"_source": {
"id": "0001",
"updated": "2017-01-01T00:00:00",
"year": 1980,
"published": false,
"name": "My book two"
}
}
Delete
The delete() method is used to perform common, basic delete operations in Elasticsearch., (*14)
use LegalThings/Elasticsearch;
$es = new Elasticsearch($config);
$index = 'books';
$type = 'ancient';
$id = '0001';
$result = $es->delete($index, $type, $id);
{
"found": true,
"_index": "books",
"_type": "ancient",
"_id": "0001",
"_version": 1,
"result": "deleted",
"_shards": {
"total": 2,
"successful": 1,
"failed": 0
}
}
Filters
This library makes it easy to filter for data in Elasicsearch, because you don't have to transform the filter in a specific structure.
See the tests for more examples.
See jasny filter for more information about the syntax., (*15)
use LegalThings/ElasticFilter;
$filter = [
'id' => '0001',
'authors' => ['John', 'Jane'],
'deleted' => null,
'start_date(min)' => '2017-01-01T00:00:00',
'end_date(max)' => '2018-01-01T00:00:00',
'age(min)' => 25,
'tags(not)' => ['foo', 'bar'],
'published(not)' => null,
'colors(any)' => ['blue', 'green'],
'colors(none)' => ['red'],
'category(all)' => ['A', 'B', 'C']
];
$ef = new ElasticFilter($filter);
$query = $ef->transform();
$this->assertEquals([
'bool' => [
'must' => [
[ 'term' => [ 'id' => '0001' ] ],
[ 'terms' => [ 'authors' => ['John', 'Jane'] ] ],
[ 'missing' => [ 'field' => 'deleted' ] ],
[ 'range' => [ 'start_date' => [ 'gte' => '2017-01-01T00:00:00' ] ] ],
[ 'range' => [ 'end_date' => [ 'lte' => '2018-01-01T00:00:00' ] ] ],
[ 'range' => [ 'age' => [ 'gte' => 25 ] ] ],
[ 'terms' => [ 'colors' => [ 'blue', 'green' ] ] ],
[ 'term' => [ 'category' => [ 'A', 'B', 'C' ] ] ]
],
'must_not' => [
[ 'terms' => [ 'tags' => [ 'foo', 'bar' ] ] ],
[ 'missing' => [ 'field' => 'published' ] ],
[ 'term' => [ 'colors' => [ 'red' ] ] ]
]
]
], $query);
Alternatively the filter can be composed using a fluent interface.
This will output the same query as the example above., (*16)
use LegalThings/ElasticFilter;
$ef = new ElasticFilter();
$query = $ef->addDefaultFilter('id', '0001')
->addDefaultFilter('authors', ['John', 'Jane'])
->addDefaultFilter('deleted', null)
->addMinFilter('start_date', '2017-01-01T00:00:00')
->addMaxFilter('end_date', '2018-01-01T00:00:00')
->addMinFilter('age', 25)
->addNotFilter('tags', ['foo', 'bar'])
->addNotFilter('published', null)
->addAnyFilter('colors', ['blue', 'green'])
->addNoneFilter('colors', ['red'])
->addAllFilter('category', ['A', 'B', 'C'])
->transform();
$this->assertEquals([...], $query); // same output as first example
Mapping
The library comes with predefined Elasticsearch mappings that you can use.
See this file for more maps., (*17)
use LegalThings/ElasticMap;
$es = new Elasticsearch($config);
$result = $es->client->indices()->create([
'index' => 'my_index',
'body' => ElasticMap::getFullTextSearchMapping()
]);
Wallogit.com
