README

Helper library for processing search M2 SearchCriteria in custom repositories/queries.

License: MIT

Why?

"But why? You can always use the default magento models & collections, yada yada" Yeah, I know, but I don't really like them, as they are really bloated (my opinion)

Features

This library contains processor classes which will add the following things to queries:

Filtering (Filters & FilterGroups)
Sorting
Pagination
Automatic joins*

(*kind of)

Basics

This library brings a set of Processor, which add conditions, limits etc. to an Magento\Framework\DB\Select instance. Every Processor implements Renttek\SearchCriteriaProcessor\ProcessorInterface.

There are the following implementations of Renttek\SearchCriteriaProcessor\ProcessorInterface are provided:

(Every Processor is in the Renttek\SearchCriteriaProcessor\ namespace)

The except for the JoinProcessor all processors should be are pretty simple and self-explanatory.

JoinProcessor

The JoinProcessor extracts used tables from the Magento\Framework\DB\Select and adds the joins to the query.

To achieve this, the JoinProcessor takes 2 parameters:

A FieldExtractor (Renttek\SearchCriteriaProcessor\FieldExtractor\FieldExtractorInterface)
A list of Joins (Renttek\SearchCriteriaProcessor\Join\JoinInterface)

When processing the SearchCriteria, the processor runs the field extractor to get a list of used tables and fields. This list is then matched the list of Joins to find an instance which supports the given table. The Join itself is then added by the Join-Instance. If no matching Join is found, an \RuntimeException is thrown.

List of provided FieldExtractors:

(Every Processor is in the Renttek\SearchCriteriaProcessor\FieldExtractor namespace)

List of provided Joins:

(Every Join is in the Renttek\SearchCriteriaProcessor\Join namespace)

Usage

In the most simple cases, the DefaultSearchCriteria is all that is needed:

class Bar
{
    // ...
    /** @var DefaultSearchCriteriaProcessor */
    private $searchCriteriaProcessor;

    public function getList(SearchCriteriaInterface $searchCriteria)
    {
        $select = $this->getBaseSelect();
        $select = $this->searchCriteriaProcessor->process($select, $searchCriteria);

        return $this->fetchResult($select);
    }
    // ...
}

If you want to customize the behaviour, simply implement a custom Processor using the ProcessorInterface.

Joins

To enable automatic Joins you have to use the JoinProcessor (directly or indirectly using the Default- or ChainProcessor) and provide it with a FieldExtractor (e.g. Renttek\SearchCriteriaProcessor\FieldExtractor\DefaultFieldExtractor) and a list of of Join-Instances. This Library currently only provides a LeftJoin class.

The LeftJoin takes 3 parameters:

Name of the field in the main-table to join by
Name of the foreign table to join
Name of the field in the foreign-table to join by

Installation

Via composer:

composer require renttek/magento2-search-criteria-processor

Contributing

You want to improve this library, report or even fix a bug? Awesome! Please, do it :)

You got questions? You can reach me here:

Twitter: @Renttek92
E-Mail: juliann+github@renttek.de

renttek / magento2-search-criteria-processor

Maintainers

Details