Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 2.18 KB

ruflin_elastica.md

File metadata and controls

77 lines (55 loc) · 2.18 KB
Raw

Using Elasticsearch and ruflin/Elastica

ruflin/Elastica is one of the targets supported by RulerZ. It allows the engine to query an Elasticsearch server.

This cookbook will show you how to retrieve objects using ruflin/Elastica and RulerZ.

Here is a summary of what you will have to do:

Configure ruflin/Elastica

This subject won't be directly treated here. You can either follow the official documentation or use a bundle/module/whatever the framework you're using promotes.

Configure RulerZ

Once ruflin/elastica is installed and configured we can the RulerZ engine:

$rulerz = new RulerZ(
    $compiler, [
        new \RulerZ\Compiler\Target\Elasticsearch\Elastica(), // this line is Elastica-specific
        // other compilation targets...
    ]
);

The only Elastica-related configuration is the Elastica target being added to the list of the known compilation targets.

Filter your target

Now that both ruflin/Elastica and RulerZ are ready, you can use them to retrieve data.

The Elastica instance that we previously injected into the RulerZ engine knows how to use the following objects:

  • Elastica\Search;
  • Elastica\SearchableInterface.

So as long as you provide RulerZ with an object satisfying the previous type-constraints, it will be able to use Elastica.

This example will show you how to use RulerZ in conjunction with a Search object:

$search = new Elastica\Search($client);

And as usual, we call RulerZ with our target (the Search object) and our rule. RulerZ will build the right executor for the given target and use it to filter the data, or in our case to retrieve data from Elasticsearch.

$rule  = 'gender = :gender and points > :points';
$parameters = [
    'points' => 30,
    'gender' => 'M',
];

var_dump($rulerz->filter($search, $rule, $parameters));

That was it!

Return to the index to explore the other possibilities of the library