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

top элементов каталога

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

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

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

Пример вызова компонента catalog.top

Секции настроек компонента:

Описание параметров

Поле Параметр Описание Примечание
Основные параметры
Тип инфоблока IBLOCK_TYPE Указывается один из созданных в системе типов информационных блоков.
Инфоблок IBLOCK_ID Для выбранного типа инфоблоков указывается идентификатор информационного блока, из которого будет выводиться top элементов сгруппированных по разделам.
Источник данных
Имя массива со значениями фильтра для фильтрации элементов FILTER_NAME Задается имя переменной, в которую передается массив параметров из фильтра. Если имя массива не указано, то будет использоваться значение по умолчанию.
Фильтр товаров CUSTOM_FILTER В данном поле настраиваются условия отбора товаров для показа. Выбор каждого условия осуществляется из выпадающего списка, доступного по ссылке Добавить условие. Для выбранного поля/свойства товара задается соответствие некоторому значению. Допускается создание нескольких условий и использование между ними как логики "И", так и логики "ИЛИ".

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

См. примечание в конце страницы.
Данные параметры появляются при настройке компонента на инфоблок с поддержкой SKU.
Порядок сортировки предложений товара OFFERS_SORT_ORDER Выбирается как сортировать предложения товара: по возрастанию, или по убыванию.
Поле для второй сортировки предложений товара OFFERS_SORT_FIELD2 Указывается поле, по которому выполняется вторая сортировка списка предложений товара.

См. примечание в конце страницы.
Порядок второй сортировки предложений товара OFFERS_SORT_ORDER2 Выбирается направление второй сортировки предложений товара: по возрастанию, или по убыванию.
Внешний вид
Свойства PROPERTY_CODE Указываются свойства инфоблока, которые будут отображены при показе элементов в таблице. При выборе пункта (не выбрано)-> и без указания кодов свойств в строках ниже, свойства выведены не будут.

Внимание! При включенной опции Использовать параметры свойств в компонентах и формах эта настройка может быть скрыта. В этом случае показ свойств настраивается только в форме редактирования инфоблока . Подробнее о настройке свойств инфоблока в уроке.

Свойства товаров, отображаемые на мобильных устройствах PROPERTY_CODE_MOBILE Выбираются свойства инфоблока (перечень формируется из выбранных в параметре выше свойств), которые будут отображены в списке товаров при просмотре с мобильных устройств.
Поля предложений OFFERS_FIELD_CODE Выбираются поля предложений. С помощью клавиши Ctrl можно выбрать несколько значений. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
Свойства предложений OFFERS_PROPERTY_CODE Указываются свойства предложений. Можно добавлять свои. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.

Внимание! При включенной опции Использовать параметры свойств в компонентах и формах эта настройка может быть скрыта. В этом случае показ свойств настраивается только в форме редактирования инфоблока . Подробнее о настройке свойств инфоблока в уроке.

Максимальное количество предложений для показа OFFERS_LIMIT Указывается максимальное для вывода на страницу число предложений (0 - все). Параметр доступен, если опция Включить режим совместимости включена.
Показ элементов VIEW_MODE Определяется способ отображения элементов: баннер (BANNER), слайдер (SLIDER) или список (SECTION).
Цветовая тема TEMPLATE_THEME Задается цветовая схема для отображения top'а элементов. По умолчанию используется синяя схема (blue).
Схема отображения PRODUCT_DISPLAY_MODE Задается режим отображения товаров: простой (N) или расширенный (Y). Параметр доступен для инфоблока с торговыми предложениями.
Дополнительная картинка основного товара ADD_PICT_PROP Задается свойство, в котором хранится дополнительная картинка для основного товара.
Свойство меток товара LABEL_PROP Указываются свойство, в котором хранится метка товара (например, новинка).
Свойства меток товара, отображаемые на мобильных устройствах LABEL_PROP_MOBILE Выбираются свойства меток (перечень формируется из выбранных в параметре выше свойств), которые будут отображены в списке товаров при просмотре с мобильных устройств.
Дополнительные картинки предложения OFFER_ADD_PICT_PROP Задается свойство, в котором хранится дополнительная картинка для торгового предложения. Параметр доступен для инфоблока с торговыми предложениями.. Данные настройки доступны, если в параметре Схема отображения выбрано значение расширенный.
Свойства для отбора предложений OFFER_TREE_PROPS Указываются свойства, по значениям которых будут группироваться торговые предложения. Параметр доступен для инфоблока с торговыми предложениями.

Внимание! При включенной опции Использовать параметры свойств в компонентах и формах эта настройка может быть скрыта. В этом случае показ свойств настраивается только в форме редактирования инфоблока . Подробнее о настройке свойств инфоблока в уроке.

Расположение меток товара LABEL_PROP_POSITION Выберите подходящее место для меток на карточке товара.
Показывать процент скидки SHOW_DISCOUNT_PERCENT [Y|N] При отмеченной опции будет отображаться процентное значение скидки, если она задана.
Показывать старую цену SHOW_OLD_PRICE [Y|N] Если задана скидка на товар, то при отмеченной опции будет отображаться старая цена.
Показывать остаток товара SHOW_MAX_QUANTITY Укажите способ отображения остатка товара:
  • не показывать;
  • с отображением реального остатка - в этом случае необходимо настроить параметр Текст для остатка;
  • с подменой остатка текстом - в этом случае необходимо настроить параметры Текст для остатка, Значение, от которого происходит подмена, Текст для значения больше и Текст для значения меньше.
Текст для остатка MESS_SHOW_MAX_QUANTITY Задается текст для отображения информации о наличии товара. Доступность данных параметров компонента определяется настройками параметра Показывать остаток товара.
Значение, от которого происходит подмена RELATIVE_QUANTITY_FACTOR Указывается значение, меньше (больше) которого о количестве товара на складе будет отображаться выражение, что товара мало (много).
Текст для значения больше MESS_RELATIVE_QUANTITY_MANY Задается текст, который будет отображаться при наличии товара в количестве большем, чем значение в параметре Значение, от которого происходит подмена.
Текст для значения меньше MESS_RELATIVE_QUANTITY_FEW Задается текст, который будет отображаться при наличии товара в количестве меньшем, чем значение в параметре Значение, от которого происходит подмена..
Показывать кнопку продолжения покупок во всплывающих окнах SHOW_CLOSE_POPUP [Y|N] При отмеченной опции будет отображаться кнопка Продолжить покупки во всплывающем окне, появляющемся после добавления товара в корзину.
Разрешить оповещения для отсутствующих товаров PRODUCT_SUBSCRIPTION [Y|N] При отмеченной опции клиент будет оповещаться, что интересующий его товар стал доступным для покупки. Данные параметры доступны, если в параметре Показ элементов выбрано значение список.
Расположение процента скидки "DISCOUNT_PERCENT_POSITION Выберите подходящее место для отображения процентной скидки на карточке товара.
Вариант отображения товаров PRODUCT_ROW_VARIANTS В правой части поля выберите подходящий вам вариант отображения одной строки товаров на странице и перетащите его в левую часть. Аналогичным образом настройте остальные строки для формирования таблицы товаров.

Количество товаров на странице ELEMENT_COUNT Отображается информация по количеству товаров на странице в соответствии с выбранным вариантом отображения товаров.
Выделять товары в списке ENLARGE_PRODUCT Выберите способ выделения товаров в списке:
  • по выбранному шаблону (строго) - товар будет выделятся строго по настроенному варианту отображения товаров;
  • по свойству, подгонять по шаблону (в этом случае возможно изменение сортировки элементов) - в списке будет выделяться тот товар, для которого заполнено указанное в параметре Выделять по выбранному свойству свойство.
Примечание: выделение товаров осуществляется в том случае, если для показа списка товаров выбран хотя бы один вариант вида:

Выделять по выбранному свойству ENLARGE_PROP Указывается то свойство товара, при наличии которого товар будет выделен в списке просмотренных (если позволяет вариант отображения товаров, см. поле Вариант отображения товаров). Параметр доступен, если в параметре Выделять товары в списке указано значение по свойству (подгонять по шаблону).
Порядок отображения блоков товара PRODUCT_BLOCKS_ORDER Перетаскивая блоки, определите необходимый вам порядок следования блоков товара.

Показывать слайдер для товаров SHOW_SLIDER [Y|N] При отмеченной опции для товаров будет использоваться слайдер для показа изображений; станет доступным дополнительное окно
Интервал смены слайдов, мс SLIDER_INTERVAL Указывается интервал смены слайдов в миллисекундах. Параметр настраивается, если отмечена опция Показывать слайдер для товаров.
Показывать полосу прогресса SLIDER_PROGRESS [Y|N] При отмеченной опции будет отображаться полоса прогресса до начала показа следующего слайда.
.
Данные параметры доступны, если в параметре Показ элементов выбрано значение баннер или слайдер.
Время показа одного слайда, сек (0 - выключить автоматическую смену слайдов) ROTATE_TIMER Указывается время показа одного слайда (в сек.). Используется для автоматической прокрутки слайдов.
Показывать навигацию по слайдам SHOW_PAGINATION [Y|N] При отмеченной опции будет доступна навигация по слайдам.
Текст кнопки "Купить" MESS_BTN_BUY Задается текст, который должен быть отображен на кнопке "Купить".
Текст кнопки "Добавить в корзину" MESS_BTN_ADD_TO_BASKET Задается текст, который должен быть отображен на кнопке добавления в корзину.
Текст кнопки "Сравнить" MESS_BTN_COMPARE Задается текст, который должен быть отображен на кнопке "Сравнить".
Текст кнопки "Подробнее" MESS_BTN_DETAIL Задается текст, который должен быть отображен на кнопке "Подробнее".
Сообщение об отсутствии товара MESS_NOT_AVAILABLE Указывается текст, который будет отображаться при отсутствии товара и невозможности его купить.
Шаблоны ссылок
URL, ведущий на страницу с содержимым раздела SECTION_URL Указывается путь к странице с детальным содержимым раздела.
URL, ведущий на страницу с содержимым элемента раздела DETAIL_URL Указывается путь к странице с детальным описанием элемента раздела.
Название переменной, в которой передается количество товара PRODUCT_QUANTITY_VARIABLE Задается имя переменной, в которой будет передаваться количество товара.
Управление адресами страниц
Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции включается поддержка ЧПУ и становятся доступными поля настройки ЧПУ.
Правило для обработки SEF_RULE Указывается правило обработки вызова страницы. Для создания правила следует использовать шаблоны, доступные по кнопке [...].
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Учитывать права доступа CACHE_GROUPS [Y|N] При отмеченной опции будут учитываться права доступа при кешировании.
Дополнительные настройки
Кешировать при установленном фильтре CACHE_FILTER [Y|N] При отмеченной опции каждый результат, полученный из фильтра, будет кешироваться.
Включить режим совместимости COMPATIBLE_MODE [Y|N] При отмеченной опции будет включен режим совместимости. Опцию необходимо отмечать при наличии старого кастомизированного шаблона компонента версии ниже 16.6.2 модуля Информационные блоки.
Настройки действий
Название переменной, в которой передается действие ACTION_VARIABLE Задается имя переменной, в которой передается действие: ADD_TO_COMPARE_LIST, ADD2BASKET и т.д. Значение поля по умолчанию action. Значение параметра должно быть уникальным среди всех используемых компонентов на одной странице.
Название переменной, в которой передается код товара для покупки PRODUCT_ID_VARIABLE Задается имя переменной, в которой будет передаваться идентификатор товара.
Цены
Тип цены PRICE_CODE Указывается тип цены для выводимых элементов. Если не задан ни один из типов, то цена товара и кнопки Купить и В корзину показаны не будут.
Использовать вывод цен с диапазонами USE_PRICE_COUNT [Y/N] При отмеченной опции будут отображаться цены всех типов на товары.
Выводить цены для количества SHOW_PRICE_COUNT Параметр определяет количество единиц товара, для которых выводить стоимость.
Включать НДС в цену PRICE_VAT_INCLUDE [Y|N] При отмеченной опции цены будут показаны с учетом НДС.
Показывать цены в одной валюте CONVERT_CURRENCY При установке флажка цены будут выводиться в одной валюте, даже если в каталоге они будут заданы в разных валютах; станет доступным дополнительное окно
Валюта, в которую будут сконвертированы цены CURRENCY_ID Выбор валюты в которой будут отображаться цены.
. При выборе этой опции кеш компонента будет автоматически сбрасываться при изменении курсов валют тех товаров, что показываются компонентом. К примеру, если выбрана конвертация в рубли, а цены в инфоблоке сохранены в евро, то кеш сбросится при изменении курса евро или рубля. Изменения остальных валют на кеш не окажут влияния.
Добавление в корзину
URL, ведущий на страницу с корзиной покупателя BASKET_URL Указывается путь к странице с корзиной покупателя.
Разрешить указание количества товара USE_PRODUCT_QUANTITY [Y|N] При отмеченной опции будет разрешен вывод количества товара.
Добавлять в корзину свойства товаров и предложений ADD_PROPERTIES_TO_BASKET [Y|N] При отмеченной опции становятся доступными настройки выбора свойств товаров и предложений
Название переменной, в которой передаются характеристики товара PRODUCT_PROPS_VARIABLE Задается имя переменной, в которой будет передаваться характеристики товара.
Разрешить добавлять в корзину товары, у которых заполнены не все характеристики PARTIAL_PRODUCT_PROPERTIES [Y|N] При отмеченной опции в корзину будут добавляться и те товары, у которых заполнены не все характеристики. Если же опция не отмечена, то товар будет добавлен в корзину только при условии, что все характеристики, добавляемые в корзину, заполнены. На торговые предложения этот параметр не влияет.
Характеристики товара PRODUCT_PROPERTIES Указываются характеристики товара.
Свойства предложений, добавляемые в корзину OFFERS_CART_PROPERTIES Из списка выбираются свойства, которые можно добавить в корзину. Для выбора нескольких свойств нужно использоать клавишу Ctrl. Данный параметр появляется при настройке компонента на инфоблок с поддержкой SKU.
для передачи их в корзину и заказ.
Показывать кнопку добавления в корзину или покупки ADD_TO_BASKET_ACTION Выберите какая кнопка должна отображаться: кнопка покупки (BUY) или кнопка добавления в корзину (ADD).
Сравнение товаров
Разрешить сравнение товаров DISPLAY_COMPARE [Y|N] Если опция отмечена, то будет отображаться кнопка для сравнения товаров, станет активным дополнительное окно
Путь к странице сравнения COMPARE_PATH Путь к странице с компонентом сравнения товаров. Если значение параметра пустое, будет использована текущая страница.
.
Уникальное имя для списка сравнения COMPARE_NAME Задается имя переменной, в которой передается список сравниваемых элементов. По умолчанию CATALOG_COMPARE_LIST.
Настройки аналитики
Отправлять данные электронной торговли в Google и Яндекс USE_ENHANCED_ECOMMERCE [Y|N] Включение опции. После включения станут доступны ещё два поля
Имя контейнера данных DATA_LAYER_NAME Указываются свойства инфоблока, которые будут отображены в списке просмотренных товаров. При выборе пункта (не выбрано)-> и без указания кодов свойств в строках ниже, свойства выведены не будут.
Свойство брендов BRAND_PROPERTY Из списка выбираются свойства, которые можно добавить в корзину. Для выбора нескольких свойств нужно использовать клавишу Ctrl.
. Требуется дополнительная настройка в Google Analytics Enhanced Ecommerce и/или Яндекс.Метрике.

Примечание: Настройка Яндекс метрикой не сложна, и данные в ней отображаются довольно быстро (полчаса-час). У Google используется Google Tag Manager с плагином электронной коммерции, его нужно настроить и добавить на страницу в шаблоне. После настройки на "той" стороне, нужно настроить компоненты для работы с электронной коммерцией и включить это поле настройки.

Примечание: если указаны поля сортировки, отличные от ID и CATALOG_AVAILABLE, и значения этих полей для торговых предложений разные, то для выбора первого для показа предложения будет выбрано то предложение, которое отсортировано первым.
Если же все значения совпадают, то будет показано то торговое предложение, у которого сортировка участвующих в выборе SKU значений свойств минимальна.



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

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

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

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

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