Одностраничный компонент, выводящий список новостей из одного информационного блока. Настройки позволяют кастомизировать вывод полей элементов в списке, управлять постраничной навигацией, выбирать формат даты, управлять настройками кеширования и т.д.
Пример вызова
<?$APPLICATION->IncludeComponent(
"bitrix:news.list",
"",
Array(
"DISPLAY_DATE" => "Y",
"DISPLAY_NAME" => "Y",
"DISPLAY_PICTURE" => "Y",
"DISPLAY_PREVIEW_TEXT" => "Y",
"IBLOCK_TYPE" => "news",
"IBLOCK_ID" => "33",
"NEWS_COUNT" => "10",
"SORT_BY1" => "ACTIVE_FROM",
"SORT_ORDER1" => "DESC",
"SORT_BY2" => "SORT",
"SORT_ORDER2" => "ASC",
"FILTER_NAME" => "",
"FIELD_CODE" => Array("",""),
"PROPERTY_CODE" => Array("",""),
"DETAIL_URL" => "news_detail.php?ID=#ELEMENT_ID#",
"PREVIEW_TRUNCATE_LEN" => "",
"ACTIVE_DATE_FORMAT" => "j F Y",
"DISPLAY_PANEL" => "N",
"SET_TITLE" => "Y",
"INCLUDE_IBLOCK_INTO_CHAIN" => "Y",
"ADD_SECTIONS_CHAIN" => "Y",
"HIDE_LINK_WHEN_NO_DETAIL" => "N",
"PARENT_SECTION" => "",
"CACHE_TYPE" => "A",
"CACHE_TIME" => "3600",
"CACHE_FILTER" => "N",
"DISPLAY_TOP_PAGER" => "N",
"DISPLAY_BOTTOM_PAGER" => "Y",
"PAGER_TITLE" => "Новости",
"PAGER_SHOW_ALWAYS" => "Y",
"PAGER_TEMPLATE" => "",
"PAGER_DESC_NUMBERING" => "N",
"PAGER_DESC_NUMBERING_CACHE_TIME" => "36000"
)
);?>
Описание параметров
Дополнительно
- DISPLAY_DATE
- [Y|N] Вывод даты элементов.
- DISPLAY_NAME
- [Y|N] Вывод название элемента.
- DISPLAY_PICTURE
- [Y|N] Вывод изображения для анонса, если они заданы.
- DISPLAY_PREVIEW_TEXT
- [Y|N] Вывод текст анонса для элементов, если он определен для элемента.
Основные параметры
- IBLOCK_TYPE
- Тип информационного блока (используется только для проверки).
- IBLOCK_ID
- Код информационного блока.
- NEWS_COUNT
- Количество новостей на странице.
Источник данных
- SORT_BY1
- Поле для первой сортировки новостей:
- ID – по ID;
- sort – по индексу сортировки;
- timestamp_x – по дате изменения;
- name – по заголовку;
- active_from – по дате начала активности.
- SORT_ORDER1
- Направление для первой сортировки новостей:
- asc – по возрастанию;
- desc – по убыванию.
- SORT_BY2
- Поле для второй сортировки новостей.
- ID – по ID;
- sort – по индексу сортировки;
- timestamp_x – по дате изменения;
- name – по заголовку;
- active_from – по дате начала активности.
- SORT_ORDER2
- Направление для второй сортировки новостей.
- asc – по возрастанию;
- desc – по убыванию.
- FILTER_NAME
- Имя переменной, в которой передается массив параметров из фильтра. Служит для определения выходящих из фильтра элементов. Если поле оставлено пустым, то используется значение по умолчанию.
- FIELD_CODE
- Выбор полей элементов инфоблока для фильтрации. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
- PROPERTY_CODE
- Выбор свойств элементов инфоблока для фильтрации. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив.
Шаблоны ссылок
- DETAIL_URL
- URL страницы детального просмотра (по умолчанию - из настроек инфоблока). В поле указывается шаблон ссылки на страницу детального просмотра. Например, news_detail.php?ID=#ELEMENT_ID#
Настройки кеширования
- CACHE_TYPE
- Тип кеширования:
- А - Авто. Действует при включенном автокешировании на странице Настройки кэширования (Настройки > Настройки продукта > Автокеширование) и при установленном времени кеширования в поле CACHE_TIME.
- Y - Кешировать. Должно быть установлено время кеширования (CACHE_TIME). Настройки автокеширования не влияют на данный тип кеширования.
- N - Не кешировать. При выборе этого типа кеширование не происходит.
- CACHE_TIME
- Время кеширования в секундах.
- CACHE_FILTER
- [Y|N] Кешировать при установленном фильтре. При установленной опции каждый результат, полученный из фильтра будет кешироваться. Имеет смысл отмечать, если многие пользователи используют одну и ту же выборку из фильтра.
Дополнительные настройки
- PREVIEW_TRUNCATE_LEN
- Максимальная длина анонса для вывода (только для типа текст). При превышении параметра остаток текста будет отсечен.
- ACTIVE_DATE_FORMAT
- Формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое) >, вы можете сформировать свой вариант на основании php-функции date.
Предустановленные варианты формата даты:
| Код | Формат даты |
| d-m-Y | 22-02-2007 |
| m-d-Y | 02-22-2007 |
| Y-m-d | 2007-02-22 |
| d.m.Y | 22.02.2007 |
| m.d.Y | 02.22.2007 |
| j M Y | 22 Фев 2007 |
| M j, Y | Фев 22, 2007 |
| j F Y | 22 Февраль 2007 |
| F j, Y | Февраль 22, 2007 |
| d.m.y g:i A | 22.02.07 7:30 AM |
| d.m.y G:i | 22.02.07 7:30 |
| d.m.Y H:i | 22.02.2007 07:30 |
- DISPLAY_PANEL
- Добавить в Административную панель кнопки для данного компонента в режиме редактирования сайта. Так же добавляет кнопки в область редактирования данного компонента.
- SET_TITLE
- При установленной опции в качестве заголовка страницы будет выбрано имя текущего инфоблока.
- INCLUDE_IBLOCK_INTO_CHAIN
- Включать инфоблок в цепочку навигации.
- ADD_SECTIONS_CHAIN
- Включать раздел в цепочку навигации.
- HIDE_LINK_WHEN_NO_DETAIL
- Опция позволяет скрыть ссылку, если нет детальной информации или у пользователя нет прав на ее просмотр.
- PARENT_SECTION
- ID раздела. В данном поле можно указать ID "родительского" раздела, чтобы ограничить выборку элементов по нему. Параметр используется редко.
Настройки постраничной навигации детального просмотра
- DISPLAY_TOP_PAGER
- При отмеченной опции навигация по страницам будет выведена вверху страницы, над списком.
- DISPLAY_BOTTOM_PAGER
- При отмеченной опции навигация по страницам будет выведена внизу страницы, под списком.
- PAGER_TITLE
- Название категорий, по которым происходит перемещение при детальном просмотре (например, страница, глава и др.)
- PAGER_SHOW_ALWAYS
- Если данный флаг не отмечен, а все элементы помещаются на одной странице, то постраничная навигация не будет выводиться. Если отмечен, то всегда будет выводиться.
- PAGER_TEMPLATE
- В поле указывается имя шаблона постраничной навигации. Если поле пусто, то выбирается шаблон по умолчанию (.default). Также в системе задан шаблон orange.
- PAGER_DESC_NUMBERING
- Использование обратную навигацию при которой происходит обратный отсчет страниц (последняя страница считается первой). При добавлении нового элемента постоянно меняется лишь последняя страница, что позволяет закэшировать остальные на длительный срок
- PAGER_DESC_NUMBERING_CACHE_TIME
- Время кэширования страниц для обратной навигации.