Получить условия для выборки Options::getFilterLogic
Модуль: main — подключать отдельно не нужно
Метод Options::getFilterLogic превращает значения фильтра в условия для выборки. Метод вызывает getFilter и переводит значения по типам полей. Например, число «больше 10» станет условием >WEIGHT, период дат — условиями >= и <=.
Сигнатура метода в классе Bitrix\Main\UI\Filter\Options:
public function getFilterLogic($sourceFields = [])
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| sourceFields | array |
Задает описание полей фильтра — тот же массив, что параметр FILTER компонента. По умолчанию — пустой массив |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
Метод возвращает массив условий в формате фильтра getList. Если фильтр не применен, метод возвращает пустой массив.
Особенности
- Метод строит условия по описанию полей из
sourceFields. Если там есть поле типаdateилиnumber, метод построит условия для всех полей этого типа в значениях, даже тех, которых нет вsourceFields. - Метод не переносит строку поиска
FIND. - Ключ
strictв описании поля метод не учитывает.
Примеры
Пример. Код получает условие для числового поля:
<?php
use Bitrix\Main\UI\Filter\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$fields = [['id' => 'WEIGHT', 'type' => 'number']];
$options = new Options('units_filter', [
'heavy' => ['name' => 'Heavy', 'default' => true, 'fields' => ['WEIGHT_numsel' => 'more', 'WEIGHT_from' => '10', 'WEIGHT_to' => '']],
]);
echo json_encode($options->getFilterLogic($fields));
Код выведет {">WEIGHT":"10"}.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая