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

Поиск по каталогу


Описание catalog.search

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

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

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



Параметры

Поле Параметр Описание
Основные параметры
Тип инфо-блока IBLOCK_TYPE Указывается один из созданных в системе типов информационных блоков.
Инфо-блок IBLOCK_ID Для выбранного типа инфоблоков указывается идентификатор информационного блока, по элементам которого будет произведен поиск.
Источник данных
По какому полю сортируем элементы ELEMENT_SORT_FIELD Выбирается свойство элементов, по которому следует произвести сортировку:
  • shows – по количеству просмотров в среднем;
  • sort – по индексу сортировки;
  • timestamp_x – по дате изменения;
  • name – по названию;
  • id – по идентификатору;
  • active_from – по дате активности с;
  • active_to – по дате активности по;
  • SCALED_PRICE_[ID] – по типу цен (вместо [ID] - идентификатор типа цены)
Порядок сортировки элементов ELEMENT_SORT_ORDER Указывается порядок сортировки элементов:
  • по возрастанию;
  • по убыванию;
  • другое.
Поле для второй сортировки элементов ELEMENT_SORT_FIELD2 Выбирается свойство элементов, по которому будет выполняться вторая сортировка:
  • shows – по количеству просмотров в среднем;
  • sort – по индексу сортировки;
  • timestamp_x – по дате изменения;
  • name – по названию;
  • id – по идентификатору;
  • active_from – по дате активности с;
  • active_to – по дате активности по;
  • SCALED_PRICE_[ID] – по типу цен (вместо [ID] - идентификатор типа цены)
Порядок второй сортировки элементов ELEMENT_SORT_ORDER2 Указывается порядок второй сортировки элементов:
  • по возрастанию;
  • по убыванию;
  • другое.
Недоступные товары HIDE_NOT_AVAILABLE Как отображать недоступные товары:
  • Отображать в общем списке
  • Отображать в конце
  • Не отображать
Недоступны товары, для которых количество меньше либо равно нулю, включен количественный учет и не разрешена покупка при отсутствии товара.
Товар с торговыми предложениями считается доступным, если хоть одно предложение доступно.
Доступность товара не означает, что его можно купить. Для покупки должны быть цены тех типов, по которым клиент может покупать.
Недоступные торговые предложения HIDE_NOT_AVAILABLE_OFFERS Указывается способ отображения недоступных для покупки торговых предложений:
  • не отображать;
  • отображать только с возможностью подписки;
  • отображать все.

Не отображать товары, которых нет на складах HIDE_NOT_AVAILABLE [Y|N] При отмеченной опции будут скрыты товары, для которых общее доступное количество меньше либо равно нулю (не остатки по складам), включен количественный учет и не разрешена покупка при отсутствии товара.
Внешний вид
Количество элементов на странице PAGE_ELEMENT_COUNT Максимальное число показываемых на одной странице элементов.
Количество элементов выводимых в одной строке таблицы LINE_ELEMENT_COUNT Указывается число элементов, которые будут показаны в одной строке таблицы результатов поиска.
Свойства PROPERTY_CODE Указываются выводимые свойства товаров.
Поля предложений OFFERS_FIELD_CODE Выбираются поля предложений. Можно добавлять свои. С помощью клавиши Ctrl можно выбрать несколько значений. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Свойства предложений OFFERS_PROPERTY_CODE Указываются свойства предложений. Можно добавлять свои. С помощью клавиши Ctrl можно выбрать несколько значений. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
По какому полю сортируем предложения товара OFFERS_SORT_FIELD Указывается поле, по которому сортируется весь список предложений товара. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Порядок сортировки предложений товара OFFERS_SORT_ORDER Выбирается как сортировать предложения товара: по возрастанию, или по убыванию. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Поле для второй сортировки предложений товара OFFERS_SORT_FIELD2 Указывается поле, по которому выполняется вторая сортировка списка предложений товара. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Порядок второй сортировки предложений товара OFFERS_SORT_ORDER2 Выбирается порядок второй сортировки предложений товара: по возрастанию, или по убыванию. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Максимальное количество предложений для показа OFFERS_LIMIT Указывается максимально допустимое число показываемых торговых предложений (0 - все).
Шаблоны ссылок
URL, ведущий на страницу с содержимым раздела SECTION_URL Указывается адрес страницы содержимого раздела.
URL, ведущий на страницу с содержимым элемента раздела DETAIL_URL Указывается адрес страницы содержимого элемента раздела.
URL, ведущий на страницу с корзиной покупателя BASKET_URL Указывается адрес страницы корзины покупателя.
Название переменной, в которой передается действие ACTION_VARIABLE Указывается имя переменной, в которой передается действие. Значение параметра должно быть уникальным среди всех используемых компонентов на одной странице.
Название переменной, в которой передается код товара для покупки PRODUCT_ID_VARIABLE Указывается имя переменной, в которой передается код товара для покупки.
Название переменной, в которой передается количество товара PRODUCT_QUANTITY_VARIABLE Указывается имя переменной, в которой передается количество товара.
Название переменной, в которой передаются характеристики товара PRODUCT_PROPS_VARIABLE Указывается имя переменной, в которой передаются характеристики товара.
Название переменной, в которой передается код группы SECTION_ID_VARIABLE Указывается имя переменной, в которой передается код группы.
Управление режимом AJAX
Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленной опции по окончании загрузки произойдет прокрутка к началу компонента.
Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера Назад и Вперед.
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Дополнительные настройки
Выводить кнопку сравнения DISPLAY_COMPARE [Y|N] При отмеченной опции под каждым выводимым элементом будет ссылка Сравнить.
Цены
Тип цены PRICE_CODE Указывается тип цены для выводимых элементов. Если не задан ни один из типов, то цена товара и кнопки Купить и В корзину показаны не будут.
Использовать вывод цен с диапазонами USE_PRICE_COUNT [Y|N] При отмеченной опции будут отображаться цены всех типов на товары.
Выводить цены для количества SHOW_PRICE_COUNT Параметр определяет количество единиц товара, для которых выводить стоимость.
Включать НДС в цену PRICE_VAT_INCLUDE [Y|N] При отмеченной опции цены будут показаны с учетом НДС.
Характеристики товара PRODUCT_PROPERTIES Указываются характеристики товара.
Разрешить указание количества товара USE_PRODUCT_QUANTITY [Y|N] При установленной опции будет разрешено указание количества товара.
Показывать цены в одной валюте CONVERT_CURRENCY [Y|N] При установке флажка цены будут выводиться в одной валюте, даже если в каталоге они будут заданы в разных валютах, станет доступным дополнительное поле
Валюта, в которую будут сконвертированы цены CURRENCY_ID Выбор валюты в которой будут отображаться цены. Поле видно при отмеченной опции Показывать цены в одной валюте.
. При выборе этой опции кеш компонента будет автоматически сбрасываться при изменении курсов валют тех товаров, которые показываются компонентом. К примеру, если выбрана конвертация в рубли, а цены в информационном блоке сохранены в евро, то кеш сбросится при изменении курса евро или рубля. Изменения остальных валют на кеш не окажут влияния.
Свойства предложений, добавляемые в корзину OFFERS_CART_PROPERTIES Из списка выбираются свойства, которые можно добавить в корзину. Для выбора нескольких свойств нужно использоать клавишу Ctrl. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Поиск
Искать без учета морфологии (при отсутствии результата поиска) RESTART [Y|N] При отмеченной опции с лучае отсутствия результата поиска будут выведены элементы, имеющие морфологические отклонения от поискового запроса.
Отключить обработку слов как логических операторов NO_WORD_LOGIC [Y|N] При снятой опции слова логических операторов ("И", "ИЛИ" и пр.) будут интерпретироваться только как лингвистическая часть поискового запроса.
Включить автоопределение раскладки клавиатуры USE_LANGUAGE_GUESS [Y|N] При отмеченной опции будет включено автоопределение раскладки клавиатуры.
Искать только в активных по дате документах CHECK_DATES [Y|N] При отмеченной опции поиск будет осуществляться только в активных по дате элементах.
При ранжировании результата учитывать заголовки USE_TITLE_RANK [Y|N] При отмеченной опции элементы сайта, содержащие в заголовке поисковые слова, будут выведены в начале выдачи результатов.
Использовать сортировку результатов по релевантности USE_SEARCH_RESULT_ORDER [Y|N] При отмеченной опции результаты поиска будут выведены в порядке убывания релевантности.
Настройки постраничной навигации
Шаблон постраничной навигации PAGER_TEMPLATE Указывается название шаблона постраничной навигации.
Выводить над списком DISPLAY_TOP_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена вверху страницы поиска.
Выводить под списком DISPLAY_BOTTOM_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена внизу страницы поиска.
Название категорий PAGER_TITLE Указывается название заголовка постраничной навигации.
Выводить всегда PAGER_SHOW_ALWAYS [Y|N] При отмеченной опции навигация будет отображаться всегда, даже если результаты поиска помещаются на одной странице.
Использовать обратную навигацию PAGER_DESC_NUMBERING [Y|N] При отмеченной опции будет использоваться обратная навигация. Для обратной навигации в системе происходит обратный отсчет страниц (последняя страница считается первой). Таким образом, постоянно меняется лишь последняя страница при добавлении нового элемента. Это верно, если новые элементы попадают всегда вверх списка (отсортированы по дате начала активности по убыванию).
Время кеширования страниц для обратной навигации PAGER_DESC_NUMBERING_CACHE_TIME Задается время кеширования страниц в секундах для обратной навигации.
Показывать ссылку "Все" PAGER_SHOW_ALL [Y|N] При отмеченной опции в постраничную навигацию будет добавлена ссылка Все, с помощью которой можно отобразить все элементы каталога..


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

<?$APPLICATION->IncludeComponent (
"bitrix:catalog.search",
	"",
	Array(
		"AJAX_MODE" => "Y",
		"IBLOCK_TYPE" => "catalog_tovar",
		"IBLOCK_ID" => "8",
		"ELEMENT_SORT_FIELD" => "sort",
		"ELEMENT_SORT_ORDER" => "asc",
		"ELEMENT_SORT_FIELD2" => "id",
		"ELEMENT_SORT_ORDER2" => "desc",
		"SECTION_URL" => "",
		"DETAIL_URL" => "",
		"BASKET_URL" => "/personal/basket.php",
		"ACTION_VARIABLE" => "action",
		"PRODUCT_ID_VARIABLE" => "id",
		"PRODUCT_QUANTITY_VARIABLE" => "quantity",
		"PRODUCT_PROPS_VARIABLE" => "prop",
		"SECTION_ID_VARIABLE" => "SECTION_ID",
		"DISPLAY_COMPARE" => "Y",
		"PAGE_ELEMENT_COUNT" => "30",
		"LINE_ELEMENT_COUNT" => "3",
		"PROPERTY_CODE" => array(),
		"OFFERS_FIELD_CODE" => array(),
		"OFFERS_PROPERTY_CODE" => array(),
		"OFFERS_SORT_FIELD" => "sort",
		"OFFERS_SORT_ORDER" => "asc",
		"OFFERS_SORT_FIELD2" => "id",
		"OFFERS_SORT_ORDER2" => "desc",
		"OFFERS_LIMIT" => "5",
		"PRICE_CODE" => array("BASE"),
		"USE_PRICE_COUNT" => "Y",
		"SHOW_PRICE_COUNT" => "1",
		"PRICE_VAT_INCLUDE" => "Y",
		"USE_PRODUCT_QUANTITY" => "Y",
		"CACHE_TYPE" => "A",
		"CACHE_TIME" => "36000000",
		"RESTART" => "Y",
		"NO_WORD_LOGIC" => "Y",
		"USE_LANGUAGE_GUESS" => "Y",
		"CHECK_DATES" => "Y",
		"DISPLAY_TOP_PAGER" => "Y",
		"DISPLAY_BOTTOM_PAGER" => "Y",
		"PAGER_TITLE" => "Товары",
		"PAGER_SHOW_ALWAYS" => "Y",
		"PAGER_TEMPLATE" => "",
		"PAGER_DESC_NUMBERING" => "Y",
		"PAGER_DESC_NUMBERING_CACHE_TIME" => "36000",
		"PAGER_SHOW_ALL" => "Y",
		"HIDE_NOT_AVAILABLE" => "N",
		"CONVERT_CURRENCY" => "Y",
		"CURRENCY_ID" => "RUB",
		"OFFERS_CART_PROPERTIES" => array(),
		"AJAX_OPTION_JUMP" => "Y",
		"AJAX_OPTION_STYLE" => "Y",
		"AJAX_OPTION_HISTORY" => "Y"
	)
);?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх