README

Feature complete, object oriented, composable, extendable Elasticsearch query DSL builder for PHP.

Features

Dependency free
Can be used with any PHP Elasticsearch client
Fully interfaced, ready for custom classes and
Explicit class and property naming, fully matches produced JSON and Elasticsearch docs
All configuration options are listed inside classes, links to documentation
Classes can be easily composed, extended
Usage of setters/getters so that everything can be inlined and chained.
Fully working ::__clone() methods
Extendable code: no usage of private, final or readonly
Basic objects created on __construct, no unnecessary body build logic until jsonSerialize() is called

Versions

Most of the classes should be compatible with any Elasticsearch versions. If something is not compatible or not supported, Raw* or custom classes can be used.

Because major version number follows Elasticsearch major version number, second number is reserved for breaking changes.

Install

composer require gskema/elasticsearch-query-dsl-php 6.* # match your Elasticsearch version

Usage

$searchRequest = new SearchRequest();
$searchRequest->setOption('min_score', 3.5);
$searchRequest->setSize(10);
$searchRequest->setQuery(
    (new BoolMatcher())->addMustNot(new TermMatcher('field1', 'value1'))
);
$searchRequest->addStatGroup('stat_group_1');
$searchRequest->setAgg(
    'agg1',
    (new FilterAggregation(new MatchAllMatcher()))
        ->setAgg('agg2', TermsAggregation::fromField('field2', 'value2'))
);

(new ElasticsearchClient())->search($searchRequest->jsonSerialize());

All classes match naming in official Elasticsearch documentation. Each class has a list of possible configuration options listed above class using attributes:

#[Options([
    'flags' => 'ALL|ANYSTRING|COMPLEMENT|EMPTY|INTERSECTION|INTERVAL|NONE',
    'max_determinized_states' => 2000,
    ...
])]
class RegexpMatcher implements MultiTermMatcherInterface {}

Similarly, SearchRequest class also has possible URL parameters listed:

#[Parameters([
    'timeout' => '2s',
    'terminate_after' => 1,
    'max_concurrent_shard_requests' => 2,
    ...
])]
class SearchRequest implements SearchRequestInterface {}

Matcher?

Request object that is received by Elasticsearch /_search/ has many properties and sub-properties like query, filter, post_filter, etc.

To avoid convoluted expressions like

(new SearchRequest())->setQuery(
    (new BoolQuery()->addFilter(new TermQuery('x')
)->setPostFilter(new BoolQuery(...)))

keyword matcher was explicitly chosen.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

gskema / elasticsearch-query-dsl-php

Maintainers

Details