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

Список новостей

Одностраничный компонент выводит список новостей из одного информационного блока (в качестве результата возвращает ID показанных элементов). Настройки позволяют кастомизировать вывод полей элементов в списке, управлять постраничной навигацией, выбирать формат даты, управлять настройками кеширования и т.д. Компонент стандартный и входит в дистрибутив модуля.

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

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

Пример вызова компонента news.list

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

  • Основные параметры
  • Источник данных
  • Шаблоны ссылок
  • Управление режимом AJAX
  • Настройки кеширования
  • Дополнительные настройки
  • Настройки постраничной навигации
  • Настройки 404 ошибки
  • Описание параметров

    Поле Параметр Описание
    Основные параметры
    Тип информационного блока (используется только для проверки) IBLOCK_TYPE Указывается один из созданных в системе типов информационного блока.
    Код информационного блока IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока, новости из которого будут выводиться.
    Количество новостей на странице NEWS_COUNT Указывается количество новостей, отображаемых на одной странице.
    Источник данных
    Поле для первой сортировки новостей SORT_BY1 Поле для первой сортировки новостей:
    • ID – по идентификатору;
    • NAME – по заголовку;
    • ACTIVE_FROM – по дате начала активности;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения.
    Выбрав пункт (другое)->, можно сформировать свой вариант поля для первой сортировки новостей.
    Направление для первой сортировки новостей SORT_ORDER1 Задается направление для первой сортировки новостей:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    Поле для второй сортировки новостей SORT_BY2 Поле для второй сортировки новостей:
    • ID – по идентификатору;
    • NAME – по заголовку;
    • ACTIVE_FROM – по дате начала активности;
    • 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 Задается адрес, ведущий на страницу с детальной информацией элемента раздела (по умолчанию - из настроек инфоблока).
    Управление режимом 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-переходы, то при включенной опции можно использовать кнопки браузера "Назад" и "Вперед".
    Дополнительные настройки
    Максимальная длина анонса для вывода (только для типа текст) PREVIEW_TRUNCATE_LEN Указывается максимальная длина анонса для вывода (только для типа текст). При превышении параметра остаток текста будет отсечен.
    Формат показа даты ACTIVE_DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено имя текущего раздела.
    Устанавливать заголовок окна браузераSET_BROWSER_TITLE[Y|N] При отмеченной опции будет установлен заголовок окна браузера по заданному SEO-шаблону META TITLE (см. закладку "SEO" в инфоблоке).
    Устанавливать ключевые слова страницыSET_META_KEYWORDS[Y|N] При отмеченной опции будут установлены ключевые слова страницы по заданному SEO-шаблону META KEYWORDS (см. закладку "SEO" в инфоблоке).
    Устанавливать описание страницыSET_META_DESCRIPTION[Y|N] При отмеченной опции будет установлено описание страницы по заданному SEO-шаблону META DESCRIPTION (см. закладку "SEO" в инфоблоке).
    Устанавливать в заголовках ответа время модификации страницыSET_LAST_MODIFIED[Y|N] При отмеченной опции http-ответ сервера будет содержать время последнего изменения страницы (заголовок Last-Modified).
    Включать инфоблок в цепочку навигации INCLUDE_IBLOCK_INTO_CHAIN [Y|N] При отмеченной опции в цепочку навигации будет добавлено имя инфоблока.
    Включать раздел в цепочку навигации ADD_SECTIONS_CHAIN [Y|N] При отмеченной опции при переходе по разделам ифоблока в цепочку навигации будут добавлены названия разделов.
    Скрывать ссылку, если нет детального описания 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] При отмеченной опции будет выведен текст анонса для элементов, если он определен.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Кэшировать при установленном фильтре CACHE_FILTER [Y|N] При отмеченной опции каждый результат, полученный из фильтра, будет кешироваться.
    Учитывать права доступа CACHE_GROUPS [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] При отмеченной опции в постраничную навигацию будет добавлена ссылка Все, с помощью которой можно отобразить все новости. По умолчанию выключено.
    Включить обработку ссылокPAGER_BASE_LINK_ENABLE[Y|N] При отмеченной опции доступна обработка ссылок для постраничной навигации. Становятся активными дополнительные поля. Дополнительные поля:
    Url для построения ссылок (по умолчанию - автоматически)PAGER_BASE_LINKЗадается адрес для построения ссылок. Если в параметре ничего не указывать, то адрес будет построен автоматически.
    Имя массива с переменными для построения ссылок в постраничной навигацииPAGER_PARAMS_NAMEЗадается имя переменной, в которой передается массив с переменными для построения ссылок компонентом постраничной навигации.
    Настройки 404 ошибки
    Устанавливать статус 404SET_STATUS_404[Y|N] Опция служит для включения обработки ошибки 404 в компоненте.
    Показ специальной страницыSHOW_404[Y|N] При отмеченной опции будет показана специальная страница Станет активным поле:
    Страница для показа (по умолчанию /404.php)FILE_404Задается адрес страницы, которая будет отображаться при возникновении ошибки 404.
    в случае возникновения ошибки 404, в противном случае - будет отображено специальное сообщение. Станет активным поле:
    Сообщение для показа (по умолчанию из компонента)MESSAGE_404Задается сообщение, которое будет показано в случае возникновения ошибки 404. Если ничего не указывать, то будет использоваться стандартное сообщение из компонента.


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

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

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

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

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    8
    Алексей Попович
    Может быть кому-то будет полезным.

    Была поставлена задача:
    Цитата
    Вывести список новостей, отсортированных по одному из свойств ИБ ("DUTYDATE"). При этом, нужно выводить на 2-х разных страницах элементы со значением данного поля больше-равно текущей даты и меньше текущей даты... Вывод новостей настроен через компонент "bitrix:news.list".

    :idea: Решение:

    1) Задаем свойство ИБ DUTYDATE

    2) На странице вывода компонента для задания фильтрации элементов с DUTYDATE >= текущей задаем глобальный массив:
    Код
    $GLOBALS['filter_ex'] = array('>=PROPERTY_DUTYDATE' => date('Y-m-d h:i:s'));


    :!: Главное не забывать, что свойство должно писаться именно в виде: PROPERTY_DUTYDATE, а не просто DUTY_DATE!!! Лично у меня только из-за этого на решение задачи ушло ооочень много времени....

    3)Указываем сортировку по полю DUTYDATE:
    Код
    "SORT_BY1" => "PROPERTY_DUTYDATE",
    "SORT_ORDER1" => "ASC",


    Опять же не забываем про ключевое слово "PROPERTY".
    Добавить это поле можно не только в режиме php, но и просто указав в параметрах компонента Поле для первой сортировки новостей: Другое, а в поле под ним указываем наше свойство PROPERTY_DUTYDATE.

    4) Указываем переменную фильтрации:
    Код
    "FILTER_NAME" => "filter_ex",

    указывается просто имя переменной. Без Globals, без доллара....
    Данное поле можно точно также указать и в параметрах компонента: для этого в поле Фильтр: без всяких кавычек, долларов и т.п., указываем нашу переменную-массив: filter_ex.

    Для того чтобы выводить все элементы меньше текущей даты массив фильтра будет иметь вид:
    Код
    $GLOBALS['filter_ex'] = array('<PROPERTY_DUTYDATE' => date('Y-m-d h:i:s'));
    3
    Сергей Куняев
    Из за ошибки в логике компонента следует аккуратно обращаться с PARENT_SECTION_CODE. Если указать несуществующий код секции, то будет выведен список всех элементов инфоблока.

    Виновник ошибки:
    Код
          $arParams["PARENT_SECTION"] = CIBlockFindTools::GetSectionID(
             $arParams["PARENT_SECTION"],
             $arParams["PARENT_SECTION_CODE"],
             array(
                "GLOBAL_ACTIVE" => "Y",
                "IBLOCK_ID" => $arResult["ID"],
             )
          );
    
          if([B]$arParams["PARENT_SECTION"]>0[/B])
          {
             $arFilter["SECTION_ID"] = $arParams["PARENT_SECTION"];
             if($arParams["INCLUDE_SUBSECTIONS"])
                $arFilter["INCLUDE_SUBSECTIONS"] = "Y";
    
             $arResult["SECTION"]= array("PATH" => array());
             $rsPath = GetIBlockSectionPath($arResult["ID"], $arParams["PARENT_SECTION"]);
             $rsPath->SetUrlTemplates("", $arParams["SECTION_URL"]);
             while($arPath=$rsPath->GetNext())
             {
                $arResult["SECTION"]["PATH"][] = $arPath;
             }
          }
          else
          {
             $arResult["SECTION"]= false;
          }
       
    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх