Download the PHP package greensight/laravel-elastic-query-specification without Composer

On this page you can find all versions of the php package greensight/laravel-elastic-query-specification. 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 greensight/laravel-elastic-query-specification

Informations about the package laravel-elastic-query-specification

Laravel Elastic Query Specification

Deprecated, use https://github.com/ensi-platform/laravel-elastic-query-specification instead

Extension for greensight/laravel-elastic-query to describe queries in a declarative way.

Installation

  1. Install greensight/laravel-elastic-query https://github.com/greensight/laravel-elastic-query#installation
  2. composer require greensight/laravel-elastic-query-specification

Usage // TODO translate to english

Все виды декларативных запросов строятся на основе спецификации. В ней содержатся определения доступных фильтров, сортировок и агрегатов.

Примеры запросов для данной спецификации.

Метод nested добавляет спецификации для вложенных документов. Имена фильтров, агрегатов и сортировок из них экспортируются в глобальную область видимости без добавления каких-либо префиксов. Если для фильтров допустимо иметь одинаковые имена, то для прочих компонентов нет.

В спецификациях для вложенных документов могут использоваться только поля этих документов.

Допустимо добавлять несколько спецификаций для одного и того же поля типа nested.

Ограничения where* позволяют устанавливать дополнительные программные условия отбора, которые не могут быть изменены клиентом. Ограничения, заданные в корневой спецификации, применяются всегда. Ограничения во вложенных спецификациях идут только как дополнения к добавляемым в запрос фильтрам, агрегатам или сортировкам. Например, если во вложенной спецификации нет ни одного активного фильтра, то в раздел фильтров запроса к Elasticsearch ограничения из этой спецификации не попадут.

Метод allowedFilters определяет доступные для клиента фильтры. Каждый фильтр обязательно содержит уникальное в пределах спецификации имя. В то же время, в корневой и вложенной спецификациях или в разных вложенных спецификациях, имена могут повторяться. Все фильтры с одинаковыми именами будут заполнены одним значением из параметров запроса.

Кроме имени самого фильтра можно отдельно задать имя поля в индексе, для которого он применяется, и значение по умолчанию.

Виды фильтров

Доступные клиенту сортировки добавляются методом allowedSorts. Направление сортировки задается в ее имени. Знак + или отсутствие знака соответствует порядку по возрастанию, - - порядку по убыванию. По умолчанию используется сортировка по возрастанию с выбором минимального, в случае нескольких значений в поле.

Для сортировки из вложенной спецификации учитываются все ограничения и активные фильтры из этой же спецификации.

Агрегаты объявляются методом allowedAggregates. Клиент в параметрах запроса указывает список имен агрегатов, результаты которых он ожидает в ответе.

Виды агрегатов

Агрегаты из вложенных спецификаций добавляются в запрос к Elasticsearch со всеми ограничениями и активными фильтрами.

Поиск документов

Расчет сводных показателей

Contributing

Please see CONTRIBUTING for details.

Testing

  1. composer install
  2. npm i
  3. Start Elasticsearch in your preferred way.
  4. Copy phpunit.xml.dist to phpunit.xml and set correct env variables there
  5. composer test

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-elastic-query-specification with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
elasticsearch/elasticsearch Version ^7.13
greensight/laravel-elastic-query Version ^0.2.0
illuminate/contracts Version ^8.37
illuminate/support Version ^8.0
spatie/laravel-package-tools Version ^1.4.3
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 greensight/laravel-elastic-query-specification contains the following files

Loading the files please wait ....