Download the PHP package renttek/magento2-search-criteria-processor without Composer

On this page you can find all versions of the php package renttek/magento2-search-criteria-processor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of renttek/magento2-search-criteria-processor

Informations about the package magento2-search-criteria-processor

SearchCriteriaProcessor for Magento 2

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

Latest Stable Version

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:

(*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:

Class Description
FilterProcessor Applies Filters & FilterGroups as Where-Statements
SortOrderProcessor Applies 1 or multiple SortOrders as OrderBy-Clauses
LimitProcessor Applies PageSize & CurrentPage as Limit-Offset-Clauses
JoinProcessor Adds Joins to the query based on used Tables/Fields
ChainProcessor Takes multiple processors and applies all
DefaultSearchCriteriaProcessor Applies the default Filter-, SortOrder- & LimitProcessor, Also Accepts Joins

(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:

  1. A FieldExtractor (Renttek\SearchCriteriaProcessor\FieldExtractor\FieldExtractorInterface)
  2. 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:

Class Description
FilterFieldExtractor Extracts fields & tables from Filter & FilterGroups
SortOrderFieldExtractor Extracts fields & tables from SortOrder
ChainFieldExtractor Takes multiple extractors and applies all
DefaultFieldExtractor Apples the default Filter- & Sortorder-Extractors

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

List of provided Joins:

Class Description
LeftJoin Adds an Left-Join to the Select

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

Usage

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

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:

  1. Name of the field in the main-table to join by
  2. Name of the foreign table to join
  3. Name of the field in the foreign-table to join by

Installation

Via composer:

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:

All versions of magento2-search-criteria-processor with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
magento/framework Version >=103.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package renttek/magento2-search-criteria-processor contains the following files

Loading the files please wait ....