Компоненты 2.0::Форум (комплексный компонент)
Данный комплексный компонент позволяет создать полноценный публичный
интерфейс модуля Форум.
Пример вызова
<?$APPLICATION->IncludeComponent("bitrix:forum","",Array(
"TMPLT_SHOW_MENU" => "TOP",
"TMPLT_SHOW_AUTH_FORM" => "LINK",
"TMPLT_SHOW_ADDITIONAL_MARKER" => "(new)",
"TMPLT_SHOW_TOP" => "",
"TMPLT_SHOW_BOTTOM" => "SET_BE_READ",
"WORD_WRAP_CUT" => "23",
"SEF_MODE" => "Y",
"CACHE_TYPE" => "A",
"CACHE_TIME" => "3600",
"SET_TITLE" => "Y",
"PATH_TO_AUTH_FORM" => "/auth/",
"USE_DESC_PAGE_TOPIC" => "Y",
"FORUMS_PER_PAGE" => "15",
"TOPICS_PER_PAGE" => "10",
"MESSAGES_PER_PAGE" => "3",
"FID" => Array("12","1","6","9","7","8"),
"USE_RSS" => "Y",
"DATE_FORMAT" => "d.m.Y",
"DATE_TIME_FORMAT" => "d.m.Y H:i:s",
"SET_NAVIGATION" => "Y",
"PATH_TO_SMILE" => "/bitrix/images/forum/smile/",
"PATH_TO_ICON" => "/bitrix/images/forum/icon/",
"HELP_CONTENT" => "",
"RULES_CONTENT" => "",
"SHOW_FORUMS_LIST" => "N",
"SHOW_FORUM_ANOTHER_SITE" => "N",
"WORD_LENGTH" => "50",
"TIME_INTERVAL_FOR_USER_STAT" => "600",
"SEND_MAIL" => "E",
"SEND_ICQ" => "A",
"SHOW_USER_STATUS" => "N",
"USER_PROPERTY" => Array(),
"RSS_TYPE_RANGE" => Array("RSS1","RSS2","ATOM"),
"RSS_FID_RANGE" => Array("12","1"),
"RSS_CACHE" => "1800",
"RSS_COUNT" => "30",
"RSS_TN_TITLE" => "",
"RSS_TN_DESCRIPTION" => "",
"SEF_FOLDER" => "/Test_comp/forum/",
"SEF_URL_TEMPLATES" => Array(
"index" => "index.php",
"list" => "forum#FID#/",
"read" => "forum#FID#/topic#TID#/message#MID#/",
"help" => "help/",
"rules" => "rules/",
"message_appr" => "message/approve/forum#FID#/topic#TID#/",
"message_move" => "message/move/forum#FID#/topic#TID#/message#MID#/",
"pm_list" => "pm/forlder#FID#/",
"pm_edit" => "pm/folder#FID#/message#MID#/user#UID#/#mode#/",
"pm_read" => "pm/folder#FID#/message#MID#/",
"pm_search" => "pm/search/",
"pm_folder" => "pm/folders/",
"rss" => "rss/#TYPE#/#MODE#/#IID#/",
"search" => "search/",
"subscr_list" => "subscribe/",
"active" => "topic/new/",
"topic_move" => "topic/move/forum#FID#/topic#TID#/",
"topic_new" => "topic/add/forum#FID#/",
"topic_search" => "topic/search/",
"user_list" => "users/",
"profile" => "user/#UID#/edit/",
"profile_view" => "user/#UID#/",
"user_post" => "user/#UID#/post/#mode#/",
"message_send" => "user/#UID#/send/#TYPE#/"
),
"VARIABLE_ALIASES" => Array(
"index" => Array(),
"list" => Array(),
"read" => Array(),
"help" => Array(),
"rules" => Array(),
"message_appr" => Array(),
"message_move" => Array(),
"pm_list" => Array(),
"pm_edit" => Array(),
"pm_read" => Array(),
"pm_search" => Array(),
"pm_folder" => Array(),
"rss" => Array(),
"search" => Array(),
"subscr_list" => Array(),
"active" => Array(),
"topic_move" => Array(),
"topic_new" => Array(),
"topic_search" => Array(),
"user_list" => Array(),
"profile" => Array(),
"profile_view" => Array(),
"user_post" => Array(),
"message_send" => Array(),
)
)
);?>
Описание параметров
Дополнительно
- TMPLT_SHOW_MENU
- Способ отображения меню форума:
- BOTH - сверху и снизу;
- TOP - только сверху;
- BOTTOM - только снизу;
- NONE - не показывать.
- TMPLT_SHOW_AUTH_FORM
- Авторизация может быть показана в виде:
- LINK - ссылок;
- INPUT - полей ввода.
- TMPLT_SHOW_ADDITIONAL_MARKER
- Надпись, которая пишется рядом с темой, в которой есть непрочитанные вами
сообщения.
- TMPLT_SHOW_TOP
-
Надпись сверху списка форумов.
- TMPLT_SHOW_BOTTOM
- Надпись снизу списка форумов (тем).
- WORD_WRAP_CUT
- Действие со словом, длина которого превышает заявленную. Например:
- 0 - разорвать: в слово будут вставлены разделительные символы, но
при просмотре они не отображаются;
- 23 - обрезать: слово будет обрезано до 23 символов.
Основные параметры
- PATH_TO_AUTH_FORM
- Путь к форме авторизации.
- USE_DESC_PAGE_TOPIC
- [Y/N] Отмеченная опция позволяет использовать обратную постраничную
навигацию для списка тем.
- FORUMS_PER_PAGE
- Количество форумов на одной странице.
- TOPICS_PER_PAGE
- Количество тем на одной странице.
- MESSAGES_PER_PAGE
- Количество сообщений на одной странице.
- SEND_MAIL
- Пользователи, которые могут отправлять письмо (e-mail) из
профиля:
- A - никто;
- E - авторизованные пользователи;
- U - все пользователи, для незарегистрированных пользователей
выводить поле CAPTCHA;
- Y - все пользователи.
- SEND_ICQ
- Пользователи, которые могут отправлять сообщение (icq) из
профиля.
- SHOW_USER_STATUS
- [Y/N] При отмеченной опции будет отображаться статус пользователя в списке
пользователей.
Управление адресами страниц
- SEF_MODE
- [Y/N] При установленном флаге включается поддержка ЧПУ и становятся
доступными поля настройки адресов ЧПУ.
- SEF_FOLDER
- Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может
как совпадать с физическим путём, так и не совпадать.
- SEF_URL_TEMPLATES
- Указываются адреса следующих страниц:
- index - страница списка форумов;
- list - страница списка тем форума;
- read - страница чтения темы форума;
- help - страница помощи по форумам;
- rules - страница правил форумов;
- message_appr - страница неодобренных сообщений;
- message_move - страница переноса сообщений;
- pm_list - страница списка персональных сообщений;
- pm_edit - страница создания (редактирования) персональных
сообщений;
- pm_read - страница чтения персонального сообщения;
- pm_search - страница поиска пользователей;
- pm_folder - страница управления папками персональных сообщений;
- rss - страница экспорта данных в RSS;
- search - страница поиска по форумам;
- subscr_list - страница подписки;
- active - страница новых тем форумов;
- topic_move - страница переноса тем в форум;
- topic_new - страница создания новой темы форума;
- topic_search - страница поиска по форуму;
- user_list - страница списка зарегистрированных пользователей
форума;
- profile - страница изменения профиля пользователя;
- profile_view - страница просмотра профиля пользователя;
- user_post - страница сообщений пользователей форума;
- message_send - страница отправки письма.
- VARIABLE_ALIASES
- Имена переменных для управления адресами страниц форума.
Настройки кеширования
- CACHE_TYPE
- Тип кеширования:
- A - Авто: действует при включенном кешировании в течение
заданного времени;
- Y - Кешировать: для кеширования необходимо определить только
время кеширования;
- N - Не кешировать: кеширования нет в любом случае.
- CACHE_TIME
- Время кеширования, указанное в секундах.
Дополнительные настройки
- SET_TITLE
- [Y/N] При отмеченной опции будет установлен заголовок каждой страницы в
соответствии с ее содержимым.
- FID
- Идентификаторы форумов, которые необходимо отобразить в публичном разделе.
Если не выбран ни один форум, то будут показаны все форумы.
- DATE_FORMAT
- Формат показа даты.
- DATE_TIME_FORMAT
- Формат показа даты и времени.
- SET_NAVIGATION
- [Y/N] При отмеченной опции в навигационной цепочке будут отражаться
переходы по страницам форума.
- PATH_TO_SMILE
- Путь относительно корня сайта к папке со смайлами.
- PATH_TO_ICON
- Путь относительно корня сайта к папке с иконками к темам.
- HELP_CONTENT
- Путь к файлу, содержащему "Помощь по форуму" (при пустом поле ввода будет
использовано значение по умолчанию).
- RULES_CONTENT
- Путь к файлу, содержащему "Правила форума" (при пустом поле ввода будет
использовано значение по умолчанию).
- WORD_LENGTH
-
Максимально допустимая длина словообразующих символов, следующих друг за
другом.
Если длина слова превысит указанное число, то символы слова будут
разбавлены разрывами (при просмотре сообщений разрывы не отображаются).
- TIME_INTERVAL_FOR_USER_STAT
- Период времени (в секундах), за который отображается информация о
посетителях на форуме.
- USER_PROPERTY
- Указываются свойства пользователя, которые необходимо дополнительно
отобразить при просмотре его профиля. Если не выбрано ни одно из свойств, то
будут показаны все имеющиеся свойства.
Настройки RSS
- USE_RSS
- [Y/N] При отмеченной опции становится возможным экспорт данных в формате
RSS и появляются дополнительные поля настройки RSS.
- RSS_TYPE_RANGE
- Указываются необходимы форматы экспорта данных форума: RSS 0.92, RSS 2.0 и
Atom 0.3.
- RSS_FID_RANGE
- Указываются идентификаторы тех форумов, на которых разрешить RSS.
- RSS_CACHE
- Время кеширования ленты, указанное в секундах.
- RSS_COUNT
- Количество элементов форума для экспорта.
- RSS_TN_TITLE
- Название ленты (при пустом поле ввода будет использовано значение по
умолчанию).
- RSS_TN_DESCRIPTION
- Описание ленты (при пустом поле ввода будет использовано значение по
умолчанию).
Настройки администратора
- SHOW_FORUMS_LIST
- [Y/N] При отмеченной опции администратору будут показаны только те форумы,
которые указаны в параметре FID.
- SHOW_FORUM_ANOTHER_SITE
- [Y/N] При отмеченной опции администратору будут показаны форумы других
сайтов.