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

Комментарии


Описание forum.comments

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

В визуальном редакторе компонент находится в Компоненты > Общение > Комментарии.

Компонент относится к модулю Форум.



Параметры

Поле Параметр Описание
Основные параметры
Тип сущности ENTITY_TYPE Двухсимвольный идентификатор типа комментируемой сущности. Пишется латиницей. Например, для задач тип сущности – TK.
Числовой ID сущности ENTITY_ID Числовой идентификатор комментируемой сущности. Для задачи с ID, равной 348, это значение - 348.
Буквенно-числовой ID сущности (XML ID) ENTITY_XML_ID Бувенно-числовой ID комментируемой сущности, а именно XML ID. Используются символы [A-Z0-9_]. Для задачи 348, это значение - TASKS_348.
ID форума для комментариев FORUM_ID Указывается форум, в котором будут храниться комментарии.
Права доступа PERMISSION Внешние права, которые переопределяют права пользователя на форуме: A < E < I < Q < U < Y (A - нет доступа, E - чтение, I - ответ, Q - модерирование, U - редактирование, Y - полный доступ).
Показывать пользовательские поля сообщения USER_FIELDS Указываются пользовательские поля сообщения.
Шаблоны ссылок
Страница пользователя URL_TEMPLATES_PROFILE_VIEW Указывается адрес страницы просмотра профиля пользователя. Такая страница может быть создана с помощью компонента Пользователь (профиль).
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Дополнительные настройки
Количество сообщений на одной странице MESSAGES_PER_PAGE Указывается количество сообщений, отображаемых на одной странице. Все сообщения будут выведены с помощью постраничной навигации.
Название шаблона для вывода постраничной навигации PAGE_NAVIGATION_TEMPLATE Задается название шаблона для вывода постраничной навигации. Если поле пусто, то используется шаблон по умолчанию.
Формат показа даты и времени DATE_TIME_FORMAT Указывается формат показа даты и времени. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
Формат имени NAME_TEMPLATE Указывается шаблон для отображения ФИО пользователя. По умолчанию - значение Формат сайта (т.е используются значение Формат имени, указанное в закладке Параметры страницы Редактирование сайта). Указав пункт другое->, можно задать свой шаблон. Допустимы шаблоны: #NAME# - имя, #LAST_NAME# - фамилия, #SECOND_NAME# - отчество, #NAME_SHORT#, #LAST_NAME_SHORT#, #SECOND_NAME_SHORT# - сокращенные до одной буквы имя, фамилия и отчество.
Размер рисунков в тексте сообщения (px) IMAGE_SIZE Задается сторона квадрата, в который с сохранением пропорций будет включено изображение. Указывается в пикселях.
Дополнительный размер рисунков в тексте сообщения (px) (используется для html-сжатия) IMAGE_HTML_SIZE Задается дополнительный размер изображения, используемый при html-сжатии. Указывается в пикселях.
По умолчанию показывать невизуальный режим редактора EDITOR_CODE_DEFAULT [Y|N] При отмеченной опции при создании или редактировании сообщения будет включен режим показа BB-кодов. (Пример: [B]сообщение[/B] вместо сообщение).
Подписывать автора элемента на новые комментарии SUBSCRIBE_AUTHOR_ELEMENT [Y|N] При отмеченной опции автор элемента будет подписан на новые комментарии.
Включить рейтинг SHOW_RATING [Y|N] Указывается включать ли вывод рейтинга.
Сворачивать форму добавления отзыва SHOW_MINIMIZED [Y|N] При отмеченной опции форма ввода отзыва будет свернута.
Использовать CAPTCHA USE_CAPTCHA [Y|N] При отмеченной опции будет выводиться изображение и поле ввода CAPTCHA в форме добавления отзыва в публичной части.
Выводить сообщения в прямом порядке PREORDER [Y|N] При отмеченной опции сообщения будут отсортированы по возрастанию.
Обновлять статистику просмотра форума SET_LAST_VISIT [Y|N] При отмеченной опции будет обновляться статистика просмотра форума.
Настройки редактора
Позволить HTML-код ALLOW_HTML [Y|N] При выборе данной опции в сообщения можно будет вставить код html .
Позволить ссылки ALLOW_ANCHOR [Y|N] При выборе данной опции в сообщения можно будет вставить ссылки.
Позволить теги B, U, I, S ALLOW_BIU [Y|N] При выборе данной опции в сообщениях можно будет использовать теги B, U, I, S.
Позволить изображения ALLOW_IMG [Y|N] Разрешить использование изображений в тексте сообщения. Изображения располагаются на сторонних сайтах и подключаются на форуме (<img src=...>).
Позволить видео ALLOW_VIDEO [Y|N] При выборе данной опции к сообщениям можно будет прикреплять видео.
Позволить списки ALLOW_LIST [Y|N] При выборе данной опции в сообщениях можно использовать списки.
Позволить цитирование ALLOW_QUOTE [Y|N] Возможность цитировать сообщение другого пользователя (<quote>).
Позволить коды ALLOW_CODE [Y|N] Возможность использования кодов в сообщении (<code>).
Позволить таблицы ALLOW_TABLE [Y|N] Разрешить использование таблиц (<table>).
Позволить шрифты ALLOW_FONT [Y|N] Возможность изменения цвета текста и шрифт (<font color=...>).
Позволить смайлы ALLOW_SMILES [Y|N] Возможность использования смайлов в сообщении.
Заменять символ перевода каретки на <br> ALLOW_NL2BR [Y|N] Замена символа перевода каретки на <br> (доступно только при отмеченной опции HTML-код).
Позволить выравнивание ALLOW_ALIGN [Y|N] Разрешить использование выравнивания текста.
Позволить упоминание пользователя ALLOW_MENTION [Y|N] Разрешить упоминание пользователя в комментариях.

С версии 23.300.0 модуля Форум в шаблоне компонента .default дополнились системные параметры:

  • $arParams['MAIN_POST_FORM_BUTTONS'] – дополнительные кнопки для компонента main.post.form в виде массива. Cписок возможных кнопок – Copilot, UploadFile, MentionUser, Quote, SearchTag.
  • $arParams['LHE']['copilotParams'] – параметры копилота {{moduleId, contextId, category, invitationLineMode, contextParameters, isMentionUnavailable}}.
  • $arParams['LHE']['isCopilotEnabled'] – доступен ли копилот.
  • $arParams['LHE']['isCopilotImageEnabledBySettings'] – доступна ли генерация изображений (в зависимости от настроек).
  • $arParams['LHE']['isCopilotTextEnabledBySettings'] – доступна ли генерация текстов (в зависимости от настроек).


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

<?$APPLICATION->IncludeComponent("bitrix:forum.topic.reviews","",Array(
		"ALLOW_ALIGN" => "Y",
		"ALLOW_ANCHOR" => "Y",
		"ALLOW_BIU" => "Y",
		"ALLOW_CODE" => "Y",
		"ALLOW_FONT" => "Y",
		"ALLOW_HTML" => "Y",
		"ALLOW_IMG" => "Y",
		"ALLOW_LIST" => "Y",
		"ALLOW_MENTION" => "Y",
		"ALLOW_NL2BR" => "Y",
		"ALLOW_QUOTE" => "Y",
		"ALLOW_SMILES" => "Y",
		"ALLOW_TABLE" => "Y",
		"ALLOW_VIDEO" => "Y",
		"CACHE_TIME" => "0",
		"CACHE_TYPE" => "A",
		"DATE_TIME_FORMAT" => "d.m.Y H:i:s",
		"EDITOR_CODE_DEFAULT" => "Y",
		"ENTITY_ID" => "348",
		"ENTITY_TYPE" => "TK",
		"ENTITY_XML_ID" => "TASKS_348",
		"FORUM_ID" => "1",
		"IMAGE_HTML_SIZE" => "0",
		"IMAGE_SIZE" => "600",
		"MESSAGES_PER_PAGE" => "10",
		"NAME_TEMPLATE" => "",
		"PAGE_NAVIGATION_TEMPLATE" => "",
		"PERMISSION" => "Y",
		"PREORDER" => "Y",
		"SET_LAST_VISIT" => "N",
		"SHOW_MINIMIZED" => "Y",
		"SHOW_RATING" => "Y",
		"SUBSCRIBE_AUTHOR_ELEMENT" => "Y",
		"URL_TEMPLATES_PROFILE_VIEW" => "profile_view.php?UID=#UID#",
		"USER_FIELDS" => array("UF_FORUM_MES_URL_PRV","UF_TASK_COMMENT_TYPE"),
		"USE_CAPTCHA" => "Y"
	)
);?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024