Документация для разработчиков
Темная тема
Недоступно в редакциях: Старт

Список новостей для почты


Описание news.list.mail

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

В визуальном редакторе компонент расположен по пути: Контент > Статьи и новости > Список новостей для почты.

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



Параметры

Поле Параметр Описание
Основные параметры
Тип информационного блока (используется только для проверки) IBLOCK_TYPE Указывается один из созданных в системе типов информационного блока.
Код информационного блока IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока, новости из которого будут выводиться.
Количество новостей на странице NEWS_COUNT Указывается количество новостей, отображаемых на одной странице.
Не отправлять выпуск, если недостаточно указанного количества новых элементов PREVENT_SEND_IF_NO_NEWS [Y|N] При отмеченной опции будут выбираться элементы, созданные с момента последней отправки периодического выпуска. Причем, если количество элементов меньше указанного в настройке NEWS_COUNT (Количество новостей на странице), то выпуск не будет отправлен. При выборе данной опции станет доступно дополнительное поле. Дополнительное поле:
Код периодического выпуска рассылки SENDER_CHAIN_ID Указывается код периодического выпуска Email-маркетинга, у которого будет браться дата последней отправки для поиска новых элементов с этой даты. Обычно значение этой настройки остается по умолчанию.
Источник данных
Поле для первой сортировки новостей SORT_BY1 Поле для первой сортировки новостей:
  • ID – по идентификатору;
  • NAME – по заголовку;
  • ACTIVE_FORM – по дате начала активности;
  • SORT – по индексу сортировки;
  • TIMESTAMP_X – по дате последнего изменения.
Выбрав пункт (другое)->, можно сформировать свой вариант поля для первой сортировки новостей.
Направление для первой сортировки новостей SORT_ORDER1 Задается направление для первой сортировки новостей:
  • ASCПо возрастанию;
  • DESCПо убыванию.
Поле для второй сортировки новостей SORT_BY2 Поле для второй сортировки новостей:
  • ID – по идентификатору;
  • NAME – по заголовку;
  • ACTIVE_FORM – по дате начала активности;
  • SORT – по индексу сортировки;
  • TIMESTAMP_X – по дате последнего изменения.
Выбрав пункт (другое)->, можно сформировать свой вариант поля для второй сортировки новостей.
Направление для второй сортировки новостей SORT_ORDER2 Задается направление для второй сортировки новостей:
  • ASCПо возрастанию;
  • DESCПо убыванию.
Фильтр FILTER_NAME Указывается имя переменной, в которой передается массив параметров из фильтра. Служит для определения выходящих из фильтра элементов. Если поле оставлено пустым, то используется значение по умолчанию.
Поля FIELD_CODE Указываются поля, которые будут отображены на странице. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
Свойства PROPERTY_CODE Указываются свойства, которые будут отображены на странице. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
Показывать только активные на данный момент элементы CHECK_DATES [Y|N] При отмеченной опции будут показаны только активные на данный момент элементы.
Шаблоны ссылок
URL страницы детального просмотра (по умолчанию - из настроек инфоблока) DETAIL_URL Задается адрес, ведущий на страницу с детальной информацией элемента раздела (по умолчанию - из настроек инфоблока).
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Кешировать при установленном фильтре CACHE_FILTER [Y|N] При отмеченной опции каждый результат, полученный из фильтра, будет кешироваться.
Дополнительные настройки
Максимальная длина анонса для вывода (только для типа текст) PREVIEW_TRUNCATE_LEN Указывается максимальная длина анонса для вывода (только для типа текст). При превышении параметра остаток текста будет отсечен.
Формат показа даты ACTIVE_DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
Скрывать ссылку, если нет детального описания HIDE_LINK_WHEN_NO_DETAIL [Y|N] При отмеченной опции ссылки будут скрыты, если нет детальной информации или у пользователя нет прав на ее просмотр.
ID раздела PARENT_SECTION Указывается числовой код раздела инфоблока, из которого будут выбраны новости. Поле может быть оставлено пустым, если указан Код раздела.
Код раздела PARENT_SECTION_CODE Указывается символьный код раздела инфоблока, из которого будут выбраны новости. Поле может быть оставлено пустым, если указан ID раздела.
Показывать элементы подразделов разделаINCLUDE_SUBSECTIONS[Y|N] При отмеченной опции будут отображены элементы подразделов раздела.
Выводить дату элемента DISPLAY_DATE [Y|N] При отмеченной опции будут выведены даты элементов.
Выводить название элемента DISPLAY_NAME [Y|N] При отмеченной опции для каждого элемента будет выведено его название.
Выводить изображение для анонса DISPLAY_PICTURE [Y|N] При отмеченной опции будут выведены изображения для элемента, если они заданы.
Выводить текст анонса DISPLAY_PREVIEW_TEXT [Y|N] При отмеченной опции будет выведен текст анонса для элементов, если он определен.


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

<?$APPLICATION->IncludeComponent(
	"bitrix:news.list.mail",
	"",
	Array(
		"IBLOCK_TYPE" => "news",
		"IBLOCK_ID" => "3",
		"NEWS_COUNT" => "20",
		"PREVENT_SEND_IF_NO_NEWS" => "Y",
		"SENDER_CHAIN_ID" => "{#SENDER_CHAIN_ID#}",
		"SORT_BY1" => "ACTIVE_FROM",
		"SORT_ORDER1" => "DESC",
		"SORT_BY2" => "SORT",
		"SORT_ORDER2" => "ASC",
		"FILTER_NAME" => "",
		"FIELD_CODE" => array("",""),
		"PROPERTY_CODE" => array("",""),
		"CHECK_DATES" => "Y",
		"DETAIL_URL" => "/news/detail.php?ELEMENT_ID=#ELEMENT_ID#",
		"CACHE_TYPE" => "A",
		"CACHE_TIME" => "36000000",
		"CACHE_FILTER" => "N",
		"PREVIEW_TRUNCATE_LEN" => "",
		"ACTIVE_DATE_FORMAT" => "d.m.Y",
		"HIDE_LINK_WHEN_NO_DETAIL" => "Y",
		"PARENT_SECTION" => "",
		"PARENT_SECTION_CODE" => "",
		"INCLUDE_SUBSECTIONS" => "Y",
		"DISPLAY_DATE" => "Y",
		"DISPLAY_NAME" => "Y",
		"DISPLAY_PICTURE" => "Y",
		"DISPLAY_PREVIEW_TEXT" => "Y"
	)
);?>


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

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

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

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

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