Download the PHP package pahanini/yii2-refiner without Composer
On this page you can find all versions of the php package pahanini/yii2-refiner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pahanini/yii2-refiner
More information about pahanini/yii2-refiner
Files in pahanini/yii2-refiner
Package yii2-refiner
Short Description Helps to add additional where params to active query (refine query)
License BSD-3-Clause
Homepage https://github.com/pahanini/yii2-refiner
FAQ
Example:
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 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.
Informations about the package yii2-refiner
Yii2 search refiner (facet search)
Helps to add additional 'where' conditions based on http request to active queries (refine search queries) and also automates calculation of possible values of different filters used to build UI. Can be used in RESTful APIs.
Terms
"Base query" - ActiveQuery (e.g. MySqlQuery, SphinxQuery) to find all possible items before any refiner will
be applied. E.g. SELECT * FROM products WHERE balance > 0
"Refiner" is object which:
- calculates all possible (or independent) values for UI, e.g. list of possible product's categories, maximum and minimum price between products (all callback).
- analyzes http request and add additional where conditions to basic query (refine callback)
- calculates active values of UI. Active values depends on values of other refiners (active callback).
"Refiner Set" - object which contain one or more refiners and base query. Refiner set applies all refiners to query.
Installation
Add
to the require section of your composer.json file.
Usage
Set
Refiner set has two main independent functions:
- getRefinedQuery - returns query modified by refiners
- getRefinerValues - returns all refiners values
Refiner
Each refiner modifies base query according to http query params. To modify query refiner calls refine($query, $params)
callback function. This function must return modified query. Function example:
Note:
- if http param does no exist refine function will not be called
- if $paramSeparator property is set and http param is not an array then http param wll converted to array using $paramSeparator property
- if $paramToArray property is set and http param is not an array then it will converted to array with one element
- if $paramType is set then http param type will be changed using php setType function
Some examples:
