Документация для разработчиков
Темная тема

Фильтр по элементам


Описание catalog.filter

Компонент выводит форму фильтра для фильтрации элементов информационых блоков. Компонент стандартный и входит в дистрибутив модуля.

В визуальном редакторе компонент расположен по пути Контент > Каталог > Фильтр по элементам.

Компонент относится к модулю Информационные блоки.



Параметры

ПолеПараметрОписание
Источник данных
Тип инфо-блокаIBLOCK_TYPEУказывается один из созданных в системе типов информационных блоков.
Инфо-блокIBLOCK_IDДля выбранного типа инфоблоков указывается идентификатор информационного блока, элементы которого будут отфильтрованы.
Имя выходящего массива для фильтрацииFILTER_NAMEЗадается имя переменной, в которую передается массив параметров из фильтра. Если имя массива не указано, то будет использоваться значение по умолчанию.
ПоляFIELD_CODEУказываются дополнительные поля элементов инфоблока, по которым будет возможна фильтрация. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
При выборе пункта (не выбрано)-> и без указания полей в строках (т.е. если задан пустой массив), будут выведены поля по умолчанию.
СвойстваPROPERTY_CODEУказываются свойства инфоблока, которые будут отображены при показе в качестве полей фильтра. При выборе пункта (не выбрано)-> и без указания кодов свойств в строках, свойства выведены не будут.

Значения свойств типа "Список" отображаются в фильтре в соответствии с настройками, заданными в форме редактирования самого свойства (поле "Внешний вид").
Поля предложенийOFFERS_FIELD_CODEВыбираются поля предложений. С помощью клавиши Ctrl можно выбрать несколько значений. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Свойства предложенийOFFERS_PROPERTY_CODEУказываются свойства предложений. Можно добавлять свои. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Внешний вид
Высота списков множественного выбораLIST_HEIGHTУказывается высота множественных списков выбора, отображаемых в фильтре.
Ширина однострочных текстовых полей вводаTEXT_WIDTHУказывается ширина текстового поля ввода в форме фильтра.
Ширина полей ввода для числовых интерваловNUMBER_WIDTHУказывается ширина полей ввода для числовых интервалов в форме фильтра.
Настройки кеширования
Тип кешированияCACHE_TYPEТип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.)CACHE_TIMEВремя кеширования, указанное в секундах.
Учитывать права доступаCACHE_GROUPS[Y|N] При отмеченной опции будут учитываться права доступа при кешировании.
Дополнительные настройки
Сохранять установки фильтра в сессии пользователяSAVE_IN_SESSION[Y|N] При отмеченной опции установки фильтра будут сохраняться в сессии пользователя.
Имя массива с переменными для построения ссылок в постраничной навигацииPAGER_PARAMS_NAMEЗадается имя переменной, в которой передается массив с переменными для построения ссылок компонентом постраничной навигации.
Цены
Тип ценыPRICE_CODEУказывается тип цены для выводимых элементов. Если не задан ни один из типов, то цена товара и кнопки Купить и В корзину показаны не будут.


Пример вызова

<?$APPLICATION->IncludeComponent (
"bitrix:catalog.filter",
	"",
	Array(
		"IBLOCK_TYPE" => "news",
		"IBLOCK_ID" => "2",
		"FILTER_NAME" => "arrFilter",
		"FIELD_CODE" => array(),
		"PROPERTY_CODE" => array(),
		"OFFERS_FIELD_CODE" => array(),
		"OFFERS_PROPERTY_CODE" => array(),
		"PRICE_CODE" => array(),
		"CACHE_TYPE" => "A",
		"CACHE_TIME" => "36000000",
		"CACHE_GROUPS" => "Y",
		"LIST_HEIGHT" => "5",
		"TEXT_WIDTH" => "20",
		"NUMBER_WIDTH" => "5",
		"SAVE_IN_SESSION" => "N",
		"PAGER_PARAMS_NAME" => "arrPager"
	),
false
);?>


© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх