gnugat/search-engine

Component that tries to help you get the Query part in CQRS right

Search Engine

A Proof Of Concept demonstrating how to handle Interrogatory Messages (Query in CQRS)., _(*1)

The Command / Query Responsibility Segregation principle explains that Imperative and Interrogatory messages shouldn't be mixed together., _(*2)

Note: Learn more about the different messaging flavours., _(*3)

Usually imperative messages are handled using the CommandBus pattern, which leaves us with the following question: how Interrogatory Messages should be handled?, _(*4)

This component tries to explore one of the possible answers: a SearchEngine that would try to return results matching a given criteria., _(*5)

Caution: this component does not provide actual SearchEngine features, if you're looking for one you should rather have a look at ElasticSearch, Solr, etc., _(*6)

Installation

Download SearchEngine using Composer:, _(*7)

composer require gnugat/search-engine:^0.3

You'll also need to choose one of the following implementations:, _(*8)

• PommSearchEngine, a Pomm Foundation implementation
• hey you just met this library, and this is crazy, but it has interfaces, so implement them, maybe?

Other possible implementations: PDO, Doctrine DBAL, Doctrine ORM, etc. In the tests directory you'll find an Array implementation example., _(*9)

More information about implementations, _(*10)

Usage

SearchEngine expects a Criteria object which describes:, _(*11)

• the resource to query
• relations to embed
• filters to apply
• orderings instructions
• pagination parameters

It can be built from query parameters as follow:, _(*12)

// ...
$criteria = $criteriaFactory->fromQueryParameters('blog', [
    // Filters
    'title' => 'IG',
    'author_ids' => '1,3',

    // Pagination
    'page' => '2',
    'per_page' => '3',

    // Ordering
    'sort' => 'author_id,-title',

    // Relation embeding
    'embed' => 'author',
]);
print_r(iterator_to_array(
    $searchEngine
        ->match($criteria)
        ->take(
            $criteria->paginating->offset,
            $criteria->paginating->itemsPerPage
        )
        ->getIterator()
));

In a web context, this $queryParameters array could actually be $_GET, corresponding to the following URL:, _(*13)

/v1/blogs?title=IG&author_ids=1,2&page=1&per_page=3&sort=author_id,-title&embed=author

The result could be the following:, _(*14)

[
    'items' => [
        [
            'id' => 1,
            'title' => 'Big Title',
            'author_id' => 1,
        ],
        [
            'id' => 2,
            'title' => 'Big Header',
            'author_id' => 2,
        ],
    ],
    'page' => [
        'current_page' => 1,
        'per_page' => 3,
        'total_elements' => 2,
        'total_pages' => 1,
    ],
]

Further documentation

You can see the current and past versions using one of the following:, _(*15)

• the git tag command
• the releases page on Github
• the file listing the changes between versions

You can find more documentation at the following links:, _(*16)

• copyright and MIT license
• versioning and branching models
• contribution instructions

Next readings:, _(*17)

• Implementing