Query::setOrderBy() - Code Metrics - Inspection of "refact query params" - bardex/elastic-query - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — devel ( ccf8ba...513da0 )

by Alexey
created 2017-04-25 17:19 UTC
Query::setOrderBy() A

↳ Parent: Query
Complexity

Conditions	1
Paths	1
Size

Total Lines	6
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	2
<?php

namespace Bardex\Elastic;


class Query implements \JsonSerializable
{
    /**
     * @var \Elasticsearch\Client $client
     */
    protected $elastic;

    /**
     * Параметры запроса
     * @var array
     */
    protected $params=[];

    /**
     * сколько всего в индексе ES строк удовлетворяющих параметрам поиска
     * @var integer $totalResults
     */
    protected $totalResults;

    /**
     * Логгер
     * @var \Psr\Log\LoggerInterface $logger
     */
    protected $logger;


    public function __construct(\Elasticsearch\Client $elastic)
    {
        $this->elastic = $elastic;
        $this->logger = new \Psr\Log\NullLogger;
    }


    public function setLogger(\Psr\Log\LoggerInterface $logger)
    {
        $this->logger = $logger;
        return $this;
    }


    /**
     * Установить имя индекса для поиска
     * @param $index
     * @return $this
     */
    public function setIndex($index)
    {
        $this->params['index'] = (string) $index;
        return $this;
    }


    /**
     * Установить имя типа для поиска
     * @param $type
     * @return $this
     */
    public function setType($type)
    {
        $this->params['type'] = (string) $type;
        return $this;
    }


    /**
     * Выводить перечисленные поля.
     * (не обязательный метод, по-умолчанию, выводятся все)
     * Методы select() и exclude() могут работать совместно.
     * @param array $fields
     * @return $this;

     * @example $q->select(['id', 'title', 'brand.id', 'brand.title']);
     */
    public function select(array $fields)
    {
        $this->params['body']['_source']['includes'] = $fields;
        return $this;
    }


    /**
     * Добавить в результаты вычисляемое поле, на скриптовом языке painless или groovy
     * ```
     * $q->addScriptField('pricefactor', 'return doc["product.price"].value * params.factor', ['factor' => 2]);
     * ```
     * Использование параметров рекомендуется, для увеличения производительности и эффективности компилирования скриптов.
     * @param string $fieldName - имя поля в результатах (если такое поле уже есть в документе, то оно будет заменено)
     * @param string $script - текст скрипта
     * @param array $params - параметры которые нужно передать в скрипт
     * @param string $lang - язык скрипта painless или groovy
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-request-script-fields.html
     * @return self $this
     */
    public function addScriptField($fieldName, $script, array $params = null, $lang = 'painless')
    {
        $item = [
            'script' => [
                'lang'   => $lang,
                'inline' => $script,
            ]
        ];
        if ($params) {
            $item['script']['params'] = $params;
        }
        $this->params['body']['script_fields'][$fieldName] = $item;
        return $this;
    }


    /**
     * Удалить из выборки поля.
     * (не обязательный метод, по-умолчанию, выводятся все)
     * Методы select() и exclude() могут работать совместно.
     * @param array $fields
     * @return $this;

     * @example $q->exclude(['anons', '*.anons']);
     */
    public function exclude(array $fields)
    {
        $this->params['body']['_source']['excludes'] = $fields;
        return $this;
    }


    /**
     * Добавить фильтр в raw формате, если готовые методы фильтрации не подходят.
     * Для удобства используй готовые методы фильтрации: where(), whereIn(), whereBetween(), whereMatch()
     * whereLess() и другие методы where*()
     *
     * @param $type - тип фильтрации (term|terms|match|range)
     * @param $filter - сам фильтр
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-terms-query.html
     * @return $this
     */
    public function addFilter($type, $filter)
    {
        if ( !isset($this->params['body']['query']['bool']['must']) ) {
            $this->params['body']['query']['bool']['must'] = [];
        }

        $this->params['body']['query']['bool']['must'][] = [$type => $filter];

        return $this;
    }


    /**
     * Добавить фильтр ТОЧНОГО совпадения,
     * этот фильтр не влияет на поле релевантности _score.
     *
     * @param $field - поле по которому фильтруем (id, page.categoryId...)
     * @param $value - искомое значение
     * @example $q->where('channel', 1)->where('page.categoryId', 10);
     * @return $this;

     */
    public function where($field, $value)
    {
        $this->addFilter('term', [$field => $value]);
        return $this;
    }


    /**
     * Добавить фильтр совпадения хотя бы одного значения из набора,
     * этот фильтр не влияет на поле релевантности _score.
     *
     * @param $field - поле по которому фильтруем
     * @param $values - массив допустимых значений
     * @example $q->whereIn('channel', [1,2,3])->whereIn('page.categoryId', [10,11]);
     * @return $this;

     */
    public function whereIn($field, array $values)
    {
        // потому что ES не понимает дырки в ключах
        $values = array_values($values);
        $this->addFilter('terms', [$field => $values]);
        return $this;
    }


    /**
     * Добавить фильтр вхождения значение в диапазон (обе границы включительно)
     * Можно искать по диапазону дат
     * этот фильтр не влияет на поле релевантности _score.
     *
     * @param $field - поле, по которому фильтруем
     * @param $min - нижняя граница диапазона (включительно)
     * @param $max - верхняя граница диапазона (включительно)
     * @param $dateFormat - необязательное поле описание формата даты
     * @example $q->whereBetween('created', '01/01/2010','01/01/2011', 'dd/MM/yyyy');
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-range-query.html
     * @return $this;

     */
    public function whereBetween($field, $min, $max, $dateFormat = null)

    {
        $params = ['gte' => $min, 'lte' => $max];
        if ($dateFormat) {
            $params['format'] = $dateFormat;
        }
        $this->addFilter('range',[$field => $params]);
        return $this;
    }


    /**
     * Добавить в фильтр сложное условие с вычислениями, на скриптовом языке painless или groovy
     * ```
     *  $q->whereScript('doc["id"].value == params.id', ['id' => 5169]);
     * ```
     * Использование параметров рекомендуется, для увеличения производительности и эффективности компилирования скриптов
     *
     * @param string $script - строка скрипта
     * @param array $params - параматеры для скрипта
     * @param string $lang - язык painless или groovy
     * @return self $this;
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-script-query.html
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting-painless.html
     */
    public function whereScript($script, array $params = null, $lang = 'painless')
    {
        $item = [
            'script' => [
                'inline' => $script,
                'lang'   => $lang
            ]
        ];
        if ($params) {
            $item['script']['params'] = $params;
        }
        $this->addFilter('script', $item);
        return $this;
    }


    /**
     * добавить фильтр "больше или равно"
     * @param $field
     * @param $value
     * @param null $dateFormat
     * @return $this
     */
    public function whereGreaterOrEqual($field, $value, $dateFormat = null)

    {
        $params = ['gte' => $value];
        if ($dateFormat) {
            $params['format'] = $dateFormat;
        }
        $this->addFilter('range', [$field => $params]);
        return $this;
    }

    /**
     * добавить фильтр "больше чем"
     * @param $field
     * @param $value
     * @param null $dateFormat
     * @return $this
     */
    public function whereGreater($field, $value, $dateFormat = null)

    {
        $params = ['gt' => $value];
        if ($dateFormat) {
            $params['format'] = $dateFormat;
        }
        $this->addFilter('range', [$field => $params]);
        return $this;
    }

    /**
     * добавить фильтр "меньше или равно"
     * @param $field
     * @param $value
     * @param null $dateFormat
     * @return $this
     */
    public function whereLessOrEqual($field, $value, $dateFormat = null)

    {
        $params = ['lte' => $value];
        if ($dateFormat) {
            $params['format'] = $dateFormat;
        }
        $this->addFilter('range', [$field => $params]);
        return $this;
    }

    /**
     * добавить фильтр "меньше чем"
     * @param $field
     * @param $value
     * @param null $dateFormat
     * @return $this
     */
    public function whereLess($field, $value, $dateFormat = null)

    {
        $params = ['lt' => $value];
        if ($dateFormat) {
            $params['format'] = $dateFormat;
        }
        $this->addFilter('range', [$field => $params]);
        return $this;
    }


    /**
     * Добавить фильтр полнотекстового поиска
     * этот фильтр влияет на поле релевантности _score.
     *
     * @param $field - поле по которому фильтруем
     * @param $text - поисковая фраза
     * @example $q->whereMatch('title', 'яблочная слойка')->setOrderBy('_score', 'desc');
     * @return $this;

     */
    public function whereMatch($field, $text)
    {
        if (is_array($field)) {
            $this->addFilter('multi_match', [
                    'query'  => $text,
                    'fields' => $field
                ]);
        }
        else {
            $this->addFilter('match', [$field => $text]);
        }
        return $this;
    }


    /**
     * Добавить поле сортировки.
     * Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше)
     * @param $field - поле сортировки
     * @param string $order - направление сортировки asc|desc
     * @example $q->addOrderBy('_score', 'desc');
     * @return $this
     */
    public function addOrderBy($field, $order = 'asc')
    {
        $field = (string) $field;
        $order = (string) $order;
        if (!isset($this->params['body']['sort'])) {
            $this->params['body']['sort'] = [];
        }
        $this->params['body']['sort'][] = [$field => ['order' => $order]];
        return $this;
    }


    /**
     * Установить поле сортировки.
     * Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше)
     * @param $field - поле сортировки
     * @param string $order - направление сортировки asc|desc
     * @example $q->setOrderBy('_score', 'desc');
     * @return $this
     */
    public function setOrderBy($field, $order = 'asc')
    {
        $this->params['body']['sort'] = [];
        $this->addOrderBy($field, $order);
        return $this;
    }


    /**
     * Установить лимиты выборки
     * @param $limit - сколько строк выбирать
     * @param int $offset - сколько строк пропустить
     * @return $this;

     */
    public function limit($limit, $offset = 0)
    {
        $this->params['size'] = (int) $limit;
        $this->params['from'] = (int) $offset;
        return $this;
    }


    public function fetchRaw()
    {
        $this->totalResults;

        // build query
        $query  = $this->getQuery();

        // send query to elastic
        $start  = microtime(1);

        $result = $this->elastic->search($query);

        // measure time
        $time   = round((microtime(1) - $start) * 1000);

        // total results
        $this->totalResults = $result['hits']['total'];

        // log
        $index = $this->params['index'].'/'.$this->params['type'];
        $context = [
            'type'  => 'elastic',
            'query' => json_encode($query),
            'time'  => $time,
            'index' => $index,
            'found_rows'   => $this->totalResults,
            'fetched_rows' => count($result['hits']['hits'])
        ];

        $this->logger->debug("Elastic query (index: $index, time: $time ms)", $context);

        return $result;
    }


    /**
     * Выполнить запрос к ES и вернуть результаты поиска.
     * Внимание! для экономии памяти результаты не хранятся в этом объекте, а сразу возвращаются.
     * Чтобы получить кол-во строк всего найденных в индексе (без учета лимита), используй метод getTotalResults()
     * @return array - возвращает набор документов
     */
    public function fetchAll()
    {
        $result = $this->fetchRaw();

        $results = [];
        foreach ($result['hits']['hits'] as $hit) {
            $row = $hit['_source'];
            if (isset($hit['fields'])) { // script fields
                foreach ($hit['fields'] as $field => $data) {
                    if (count($data) == 1) {
                        $row[$field] = array_shift($data);
                    }
                    else {
                        $row[$field] = $data;
                    }
                }
            }
            $results[] = $row;
        }

        return $results;
    }


    /**
     * Выполнить запрос к ES и вернуть первый результат.
     * Внимание! для экономии памяти результаты не хранятся в этом объекте, а сразу возвращаются.
     * Чтобы получить кол-во строк всего найденных в индексе (без учета лимита), используй метод getTotalResults()
     * @return array|null возращает первый найденный документ или null.
     */
    public function fetchOne()
    {
        $results = $this->fetchAll();
        if (count($results)) {
            return array_shift($results);
        }
        else {
            return null;
        }
    }


    /**
     * Количество документов всего найденных в индексе, для последнего запроса.
     * @return int
     */
    public function getTotalResults()
    {
        return $this->totalResults;
    }


    /**
     * Собрать запрос
     * @return array
     */
    public function getQuery()
    {
        $params = $this->params;

        if (!isset($params['body']['_source'])) {
            $params['body']['_source'] = true;
        }

        return $params;
    }


    public function jsonSerialize() {
        return $this->getQuery();
    }


    /**
     * Получить JSON-дамп запроса для отладки
     * @return string
     */
    public function getJsonQuery()
    {
        return json_encode($this);
    }
}
1			<?php
2
3			namespace Bardex\Elastic;
4
5
6			class Query implements \JsonSerializable
7			{
8			/**
9			* @var \Elasticsearch\Client $client
10			*/
11			protected $elastic;
12
13			/**
14			* Параметры запроса
15			* @var array
16			*/
17			protected $params=[];
18
19			/**
20			* сколько всего в индексе ES строк удовлетворяющих параметрам поиска
21			* @var integer $totalResults
22			*/
23			protected $totalResults;
24
25			/**
26			* Логгер
27			* @var \Psr\Log\LoggerInterface $logger
28			*/
29			protected $logger;
30
31
32			public function __construct(\Elasticsearch\Client $elastic)
33			{
34			$this->elastic = $elastic;
35			$this->logger = new \Psr\Log\NullLogger;
36			}
37
38
39			public function setLogger(\Psr\Log\LoggerInterface $logger)
40			{
bardex / elastic-query

Push — devel ( ccf8ba...513da0 )

Query::setOrderBy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
