Описание news.calendar
Одностраничный компонент, который служит для формирования и вывода календаря новостей или событий. Настройки позволяют настраивать внешний вид календаря, указывать его тип, управлять шаблоном, кешированием и т.д. Компонент содержит два шаблона: .default и compact. Компонент стандартный и входит в дистрибутив модуля.
В визуальном редакторе компонент расположен по пути: Контент > Статьи и новости > Календарь.
Компонент относится к модулю Информационные блоки.
Параметры
| Поле |
Параметр |
Описание |
| Основные параметры |
|---|
| Тип информационного блока (используется только для проверки) | IBLOCK_TYPE | Указывается один из созданных в системе типов информационного блока. |
| Код информационного блока | IBLOCK_ID | Для выбранного типа инфоблока указывается идентификатор информационного блока, новости из которого будут выводиться. |
| Имя переменной для месяца | MONTH_VAR_NAME | Задается имя переменной, в которой передается номер месяца. |
| Имя переменной для года | YEAR_VAR_NAME | Задается имя переменной, в которой передается номер года. |
| Начало недели | WEEK_START | Указывается день начала отсчета недели. |
| Внешний вид |
|---|
| Показывать переход по годам | SHOW_YEAR | [Y|N] При отмеченной опции будет выведена ссылка на предыдущий год. |
| Показывать время новостей | SHOW_TIME | [Y|N] При отмеченной опции рядом с названием элемента будет выведено время начала активности, если оно определено для элемента. |
| Длина заголовка (0 - не ограничивать) | TITLE_LEN | Указывается длина заголовка новостей, выводимых в календаре (0 - не ограничивать). |
| Показывать текущий месяц и год | SHOW_CURRENT_DATE | [Y|N] При отмеченной опции будут выведены текущий месяц и год над календарем в правом углу. |
| Показывать выпадающий список месяцев | SHOW_MONTH_LIST | [Y|N] При отмеченной опции будет показан выпадающий список месяцев. В противном случае только ссылки на предыдущий и следующий месяцы. |
| Количество новостей в день (0 - не ограничивать) | NEWS_COUNT | Указывается количество новостей, отображаемых в одной ячейки календаря за один день (0 - не ограничивать). Если число отлично от нуля, то будут выбраны элементы с меньшим временем начала активности. Если время не определено, то элементы будут выбраны по индексу сортировки. |
| Шаблоны ссылок |
|---|
| 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-переходы, то при включенной опции можно использовать кнопки браузера "Назад" и "Вперед". |
| Настройки кеширования |
|---|
| Тип кеширования |
CACHE_TYPE |
Тип кеширования:
- A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
- Y - Кешировать: для кеширования необходимо определить время кеширования;
- N - Не кешировать: кеширования нет в любом случае.
|
| Время кеширования (сек.) | CACHE_TIME | Время кеширования, указанное в секундах. |
| Дополнительные настройки |
|---|
| Поле даты | DATE_FIELD | Указывается поле, по которому будет происходить сортировка новостей (событий) по датам:
- DATE_ACTIVE_FROM - Дата активности с;
- DATE_ACTIVE_TO - Дата активности по;
- TIMESTAMP_X - Время последнего изменения;
- DATE_CREATE - Дата создания.
|
| Тип календаря | TYPE | Указывается тип календаря:
- Новостной (NEWS) - освещает наступившие новости (события) (события текущего месяца будут выведены, даже если дата события еще не наступила);
- Событийный (EVENTS) - освещает новости (события) ненаступившей даты.
|
| Устанавливать заголовок страницы | SET_TITLE | [Y|N] При отмеченной опции в качестве заголовка страницы будет выведен текущий месяц и год. |
Пример вызова
<?$APPLICATION->IncludeComponent("bitrix:news.calendar","",Array(
"AJAX_MODE" => "N",
"IBLOCK_TYPE" => "news",
"IBLOCK_ID" => "3",
"MONTH_VAR_NAME" => "month",
"YEAR_VAR_NAME" => "year",
"WEEK_START" => "1",
"DATE_FIELD" => "DATE_ACTIVE_FROM",
"TYPE" => "EVENTS",
"SHOW_YEAR" => "Y",
"SHOW_TIME" => "Y",
"TITLE_LEN" => "0",
"SET_TITLE" => "Y",
"SHOW_CURRENT_DATE" => "Y",
"SHOW_MONTH_LIST" => "Y",
"NEWS_COUNT" => "0",
"DETAIL_URL" => "",
"CACHE_TYPE" => "A",
"CACHE_TIME" => "3600",
"AJAX_OPTION_JUMP" => "N",
"AJAX_OPTION_STYLE" => "Y",
"AJAX_OPTION_HISTORY" => "N",
"AJAX_OPTION_ADDITIONAL" => ""
)
);?>