Применить значения как временный фильтр Options::setupDefaultFilter

Модуль: main — подключать отдельно не нужно

Метод Options::setupDefaultFilter применяет значения как временный фильтр. Метод записывает значения в пресет tmp_filter, делает его текущим и сохраняет настройки методом save. Метод нужен, например, чтобы открыть страницу списка сразу с отбором по ссылке из другого раздела.

Сигнатура метода в классе Bitrix\Main\UI\Filter\Options:

public function setupDefaultFilter(array $fields, array $rows)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
fields* array Задает значения полей — массив ключ => значение
rows* array Задает коды полей, которые покажет фильтр

Возвращаемое значение

Метод ничего не возвращает.

Примеры

Пример. Код применяет отбор по названию и читает фильтр:

<?php
use Bitrix\Main\UI\Filter\Options;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$options = new Options('units_filter');
$options->setupDefaultFilter(['NAME' => 'kg'], ['NAME']);

$filter = $options->getFilter([['id' => 'NAME']]);

echo $filter['PRESET_ID'] . ' ' . $filter['NAME'];
$options->destroy();

Код выведет tmp_filter kg.

Смотрите также