Документация для разработчиков
Недоступно в редакциях: Старт

Форум (комплексный компонент)

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

В компоненте используется неотключаемая обратная навигация. Поэтому число списка тем может не совпадать с числом установленным в поле Количество тем на одной странице.

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

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

Внимание! Компонент поддерживает два режима настройки: простой и расширенный. Расширенный предоставляет более обширные средства настройки.

Пример вызова компонента forum

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

Простой режим Расширенный режим
  • Настройки шаблона
  • Настройки шаблона
  • Настройки поиска
  • Настройки поиска
  • Основные параметры
  • Основные параметры
  • Управление адресами страниц
  • Управление адресами страниц
  • Настройки кеширования
  • Настройки кеширования
  • Дополнительные настройки
  • Дополнительные настройки
  • Настройки администратора
  • Настройки RSS
  • Настройки RSS
  • Настройки опросов
  • Настройки опросов
  • Настройки рейтинга
  • Настройки рейтинга
  • Описание параметров

    Простой режим

    Поле Параметр Описание
    Настройки шаблона
    Темы THEME Выбор темы оформления шаблона.
    Показывать теги SHOW_TAGS [Y|N] При отмеченной опции будут отображаться теги форума.
    Показывать форму авторизации SHOW_AUTH_FORM [Y|N] Если опция отмечена, то отображаются ссылки "Войти" для неавторизованного пользователя и "Выйти" - для авторизованного.
    Дополнительный маркер для новых сообщений TMPLT_SHOW_ADDITIONAL_MARKER Задается текст надписи, отображаемый рядом с темой, в которой есть непрочитанные вами сообщения.
    Настройки поиска
    Искать без учета морфологии (при отсутствии результата поиска) RESTART [Y|N] Если опция отмечена, то будет отключен морфологический поиск (морфологический поиск предполагает поиск по полному совпадению слова с запросом).
    Отключить обработку слов как логических операторов NO_WORD_LOGIC [Y|N] При отмеченной опции слова (и, или, не) не будут использоваться как логические операторы.
    Основные параметры
    Использовать простой режим настройки USE_LIGHT_VIEW [Y|N] При отмеченной опции используется простой режим настройки компонента, а в противном случае - расширенный.
    Показывать только выбранные форумы FID Указываются форумы, которые должны быть показаны.
    Максимальное количество файлов, прикрепленных к одному сообщению FILES_COUNT Задается количество файлов, которое может быть прикреплено к сообщению. Данный параметр работает только в том случае, если в настройках соответствующего форума разрешено прикреплять файлы к сообщениям.
    Управление адресами страниц
    Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

    Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры
    Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
    Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
    • index - страница списка форумов;
    • list - страница списка тем форума;
    • read - страница чтения темы форума;
    • message - страница чтения сообщения;
    • 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 - страница отправки письма.
    : SEF_FOLDER, SEF_URL_TEMPLATES.
    Если режим поддержки ЧПУ выключен, то необходимо настроить параметр VARIABLE_ALIASES
    Имена переменныхVARIABLE_ALIASES Имена переменных для управления страницами.

    При выключенном режиме ЧПУ необходимо указать имена следующих переменных:
    • FID - идентификатор форума;
    • TID - идентификатор темы;
    • MID - идентификатор сообщения;
    • UID - идентификатор пользователя.
    .
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Время кеширования списка пользователей на форуме (сек.) CACHE_TIME_USER_STAT Время кеширования списка пользователей, указанное в секундах.
    Время кеширования статистики (сек.) CACHE_TIME_FOR_FORUM_STAT Время кеширования статистики форума, указанное в секундах.
    Дополнительные настройки
    Количество форумов на одной странице FORUMS_PER_PAGE Указывается количество форумов, отображаемых на одной странице.
    Количество тем на одной странице TOPICS_PER_PAGE Указывается количество тем, отображаемых на одной странице.
    Количество сообщений на одной странице MESSAGES_PER_PAGE Указывается количество сообщений, отображаемых на одной странице.
    Размер рисунков в сообщении IMAGE_SIZE Задается сторона квадрата, в который с сохранением пропорций будет включено изображение. Указывается в пикселях.
    Как показывать прикрепленные рисунки (под сообщением) ATTACH_MODE Задается форма отображения прикрепленных рисунков (под сообщением). Доступные формы:
    • Миниатюра При выборе формы Миниатюра станет доступно дополнительное поле:
      Размер миниатюры рисунка (под сообщением, px) ATTACH_SIZE Задается сторона квадрата, в который с сохранением пропорций будет включено изображение. Указывается в пикселях.
    • Название
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено Форумы.
    Настройки RSS
    Разрешить RSSUSE_RSS [Y|N] При отмеченной опции становится возможным экспорт данных в формате RSS.
    Количество элементов для экспортаRSS_COUNT Указывается количество элементов для экспорта в RSS-ленту.
    Настройки опросов
    Разрешить опросыSHOW_VOTE[Y|N] При отмеченной опции будет выведен опрос. Создание опроса доступно только при создании новой темы на форуме. При выборе данной опции станут доступны дополнительные поля.
    Группа опросовVOTE_CHANNEL_IDУказывается группа опросов, в которой будет создан опрос.
    Группы пользователей, которые могут создавать опрос VOTE_GROUP_ID Задаются группы пользователей, которым разрешено создавать опросы на форуме.
    Шаблон для голосований VOTE_TEMPLATE Указывается шаблон для отображения опроса.
    Не голосовать дважды VOTE_UNIQUE Указывается варианты запрета на повторное голосование в опросе:
    • 1 - в одной сессии;
    • 2 - с одним cookie;
    • 4 - с одного IP;
    • 8 - с одним ID пользователя.
    Не голосовать дважды с одного IP в течение VOTE_UNIQUE_IP_DELAY Указывается период, в течение которого запрещается голосовать дважды с одного IP:
    • VOTE_UNIQUE_IP_DELAY_INPUT - указывается число;
    • VOTE_UNIQUE_IP_DELAY_SELECT - указывается:
      • S - секунд;
      • M - минут;
      • H - часов;
      • D - дней.
    Настройки рейтинга
    Включить рейтингSHOW_RATINGУказывается включать ли вывод рейтинга:
    • - по умолчанию;
    • Y - да;
    • N - нет.




    Примечание:

    С версии 17.5.4 добавлена поддержка рейтингов с реакциями.

    РейтингRATING_IDУказывается какой будет использоваться рейтинг.
    Вид кнопок рейтингаRATING_TYPEУказывается тип кнопки рейтинга:
    • - по умолчанию;
    • like - Мне нравится (текстовый);
    • like_graphic - Мне нравится (графический);
    • standart_text - Нравится / Не нравится (текстовый);
    • standart - Нравится / Не нравится (графический).

    Расширенный режим

    Поле Параметр Описание
    Настройки шаблона
    Темы THEME Выбирается одна из восьми доступных тем оформления шаблона.
    Показывать теги SHOW_TAGS [Y|N] При отмеченной опции будут отображаться теги форума.
    Как показывать имя пользователя (seo) SEO_USER Выбор формы показа имени пользователя:
    • Скрытой от поисковых ботов ссылкой
    • Ссылкой
    • Текстом
    Использовать внешний сервис для перевода названия темы (seo) SEO_USE_AN_EXTERNAL_SERVICE [Y|N] При отмеченной опции название темы будет переведено автоматически внешним сервером.
    Показывать список пользователей SHOW_FORUM_USERS [Y|N] При отмеченной опции в меню форума будет показываться ссылка Пользователи, ведущая на страницу со списком пользователей системы.
    Показывать ссылку "Подписка" в верхнем меню SHOW_SUBSCRIBE_LINK [Y|N] При отмеченной опции отображается ссылка "Подписка", ведущая на страницу управления подпиской на темы и сообщения.
    Показывать форму авторизации SHOW_AUTH_FORM [Y|N] Если опция отмечена, то отображаются ссылки "Войти" для неавторизованного пользователя и "Выйти" - для авторизованного.
    Показывать навигационную цепочку SHOW_NAVIGATION[Y|N] При отмеченной опции в навигационную цепочку включается название форума.
    Показывать легенду SHOW_LEGEND [Y|N] Отображается легенда на страницах просмотра форума и списков форумов для иконок "новых сообщений" и статусов тем.
    Показывать блоки статистики SHOW_STATISTIC_BLOCK [Y|N] При отмеченной опции в нижней части форума будут выводиться блоки:
    • STATISTIC - количество сообщений и тем;
    • BIRTHDAY - дни рождения пользователей;
    • USERS_ONLINE - пользователи онлайн.
    Показывать форумы для быстрого доступа SHOW_FORUMS [Y|N] При установленной опции появится окно с выпадающим списком форумов сайта для быстрого перехода между форумами.
    Всегда показывать первое сообщение темы (при отключенной опции будет использоваться значение из настроек форума) SHOW_FIRST_POST [Y|N] При перемещении по страницам темы всегда будет отображаться первое сообщение темы над сообщениями страницы.
    Показывать колонку "Автор" в списке тем SHOW_AUTHOR_COLUMN [Y|N] Отображается колонка с именем автора темы. Имя автора темы под названием темы исчезает.
    Дополнительный маркер для новых сообщений TMPLT_SHOW_ADDITIONAL_MARKER Задается текст надписи, отображаемый рядом с темой, в которой есть непрочитанные вами сообщения.
    Название шаблона для вывода постраничной навигации PAGE_NAVIGATION_TEMPLATE Указывается шаблон, используемый для постраничной навигации. Разработчик может сам создать собственный шаблон и разместить его в папке www\bitrix\templates\.default\components\bitrix\system.pagenavigation\forum\.
    Количество страниц в постраничной навигации PAGE_NAVIGATION_WINDOW Задается количество отображаемых в навигации ссылок на страницы. Если количество страниц превышает заданное число, то в навигацию будет добавлено многоточие.
    Использовать AJAX в диалогах AJAX_POST [Y|N] При отмеченной опции будет использоваться технология AJAX при добавлении, скрытии/показе и удалении сообщений на форуме.
    Длина фразы (если "0", то фраза не обрезается) WORD_WRAP_CUT Параметр предназначен для текста сообщения и только на индексной странице форума. Указывается действие со словом, длина которого превышает заявленную.
    • Разорвать (0) - в фразу будут вставлены разделительные символы, но при просмотре они не отобразятся;
    • Обрезать (23) - фраза будет обрезана до 23 символов.
    • другое - действие аналогичное команде Обрезать. При выборе этого значения в ставшем активном поле можно ввести число знаков, после которых произойдет обрезание фразы.
    Длина слова WORD_LENGTH Задается максимально допустимая длина символов, следующих друг за другом. Если длина слова превысит указанное число, то символы слова будут разбавлены разрывами (при просмотре сообщений разрывы не отображаются).
    Настройки поиска
    Искать без учета морфологии (при отсутствии результата поиска) RESTART [Y|N] Если опция отмечена, то будет отключен морфологический поиск (морфологический поиск предполагает поиск по полному совпадению слова с запросом).
    Отключить обработку слов как логических операторов NO_WORD_LOGIC [Y|N] При отмеченной опции слова (и, или, не) не будут использоваться как логические операторы.
    Основные параметры
    Использовать простой режим настройки USE_LIGHT_VIEW [Y|N] При отмеченной опции используется простой режим настройки компонента, а в противном случае - расширенный.
    Показывать только выбранные форумы FID Указываются форумы, которые должны быть показаны.
    Показывать пользовательские поля в профиле USER_PROPERTY Указываются дополнительные пользовательские свойства, которые будут отображены в профиле пользователя форума.
    Показывать пользовательские поля сообщения USER_FIELDS Указываются пользовательские поля сообщения.
    Путь к файлу, содержащему "Помощь по форуму" (при пустом поле ввода будет использовано значение по умолчанию) HELP_CONTENT Указывается путь к файлу, содержащему помощь по форуму (при пустом поле ввода будет использовано значение по умолчанию).
    Путь к файлу, содержащему "Правила форума" (при пустом поле ввода будет использовано значение по умолчанию) RULES_CONTENT Указывается путь к файлу, содержащему правила форума (при пустом поле ввода будет использовано значение по умолчанию).
    Управление адресами страниц
    Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

    Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры
    Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
    Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
    • index - страница списка форумов;
    • list - страница списка тем форума;
    • read - страница чтения темы форума;
    • message - страница чтения сообщения;
    • 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 - страница отправки письма.
    : SEF_FOLDER, SEF_URL_TEMPLATES.
    Если режим поддержки ЧПУ выключен, то необходимо настроить параметр VARIABLE_ALIASES
    Имена переменныхVARIABLE_ALIASES Имена переменных для управления страницами.

    При выключенном режиме ЧПУ необходимо указать имена следующих переменных:
    • FID - идентификатор форума;
    • TID - идентификатор темы;
    • MID - идентификатор сообщения;
    • UID - идентификатор пользователя.
    Проверять корректность шаблонов пути CHECK_CORRECT_PATH_TEMPLATES [Y|N] При отмеченной опции выполняется проверка корректности путей, указанных в параметрах. При обнаружении ошибок происходит автоматическая замена используемого шаблон на шаблон по умолчанию.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Время кеширования списка пользователей на форуме (сек.) CACHE_TIME_USER_STAT Время кеширования списка пользователей, указанное в секундах.
    Время кеширования статистики (сек.) CACHE_TIME_FOR_FORUM_STAT Время кеширования кеширования статистики форума, указанное в секундах.
    Время кеширования RSS-ленты (сек.) RSS_CACHE Время кеширования ленты RSS, указанное в секундах.
    Дополнительные настройки
    Количество форумов на одной странице FORUMS_PER_PAGE Указывается количество форумов, отображаемых на одной странице.
    Количество тем на одной странице TOPICS_PER_PAGE Указывается количество тем, отображаемых на одной странице.
    Количество сообщений на одной странице MESSAGES_PER_PAGE Указывается количество сообщений, отображаемых на одной странице.
    Путь к форме авторизации PATH_TO_AUTH_FORM Задается путь к форме авторизации. Если не задан, то будет использовано значение по умолчанию (/auth.php).
    Период для отображения статистики (сек.) TIME_INTERVAL_FOR_USER_STAT Указывается период времени в секундах, за который показывается статистика форума.
    Формат показа даты DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Формат показа даты и времени DATE_TIME_FORMAT Указывается формат показа даты и времени. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Размер рисунков в сообщении (px) IMAGE_SIZE Задается сторона квадрата, в который с сохранением пропорций будет включено изображение. Указывается в пикселях.
    Как показывать прикрепленные рисунки (под сообщением) ATTACH_MODE Задается форма отображения прикрепленных рисунков (под сообщением). Доступные формы:
    • Миниатюра При выборе формы Миниатюра станет доступно дополнительное поле:
      Размер миниатюры рисунка (под сообщением, px) ATTACH_SIZE Задается сторона квадрата, в который с сохранением пропорций будет включено изображение. Указывается в пикселях.
    • Название
    По умолчанию показывать невизуальный режим редактора EDITOR_CODE_DEFAULT [Y|N] При отмеченной опции при создании или редактировании сообщения будет включен режим показа BB-кодов. (Пример: [B]сообщение[/B] вместо сообщение).
    Могут отправлять письмо (e-mail) из профиля SEND_MAIL Указываются пользователи, которые могут отправлять письмо (e-mail) из профиля:
    • A - никто;
    • E - авторизованные пользователи;
    • U - все пользователи, а для неавторизованных пользователей выводить поле CAPTCHA;
    • Y - все пользователи.
    Показывать навигацию (хлебные крошки) SET_NAVIGATION [Y|N] При отмеченной опции в навигационной цепочке будет отражен переход на страницу списка тем форума.
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено Форумы.
    Устанавливать мета-тег 'Description' из первого сообщения темы SET_DESCRIPTION [Y|N] При отмеченной опции в коде страницы будет дописываться мета-тег 'Description' с содержанием первого сообщения темы.
    Устанавливать теги и описание темы в свойства страницы SET_PAGE_PROPERTY [Y|N] При отмеченной опции теги и описание темы будут установлена в качестве свойств страницы.
    Показывать список пользователей SHOW_FORUM_USERS [Y|N] При отмеченной опции в меню форума будет показываться ссылка Пользователи, ведущая на страницу со списком пользователей системы.
    Настройки администратора
    Показывать администратору форумы других сайтов SHOW_FORUM_ANOTHER_SITE [Y|N] При отмеченной опции администратору будут показаны форумы других сайтов системы.
    Настройки RSS
    Разрешить RSS USE_RSS [Y|N] При отмеченной опции становится возможным экспорт данных в формате RSS и появляются дополнительные поля настройки RSS.
    Использовать спецификации RSS_TYPE_RANGE Указываются форматы экспорта данных форума, которые необходимо отобразить:
    • RSS 0.92 (RSS1)
    • RSS 2.0 (RSS2)
    • Atom 0.3 (ATOM)
    Количество элементов для экспорта RSS_COUNT Указывается количество элементов для экспорта.
    Название ленты (при пустом поле ввода будет использовано значение по умолчанию) RSS_TN_TITLE Задается название ленты RSS (при пустом поле ввода будет использовано значение по умолчанию).
    Описание ленты (при пустом поле ввода будет использовано значение по умолчанию) RSS_TN_DESCRIPTION Задается описание ленты RSS (при пустом поле ввода будет использовано значение по умолчанию).
    Настройки опросов
    Разрешить опросыSHOW_VOTE[Y|N] При отмеченной опции будет выведен опрос. Создание опроса доступно только при создании новой темы на форуме. При выборе данной опции станут доступны дополнительные поля.
    Группа опросовVOTE_CHANNEL_IDУказывается группа опросов, в которой будет создан опрос.
    Группы пользователей, которые могут создавать опрос VOTE_GROUP_ID Задаются группы пользователей, которым разрешено создавать опросы на форуме.
    Количество вопросов VOTE_COUNT_QUESTIONS Указывается максимально возможное количество вопросов в опросе.
    Количество ответов VOTE_COUNT_ANSWERS Задается максимально возможное количество вариантов ответов на вопрос в опросе.
    Шаблон для голосований VOTE_TEMPLATE Указывается шаблон для отображения опроса.
    Не голосовать дважды VOTE_UNIQUE Указывается варианты запрета на повторное голосование в опросе:
    • 1 - в одной сессии;
    • 2 - с одним cookie;
    • 4 - с одного IP;
    • 8 - с одним ID пользователя.
    Не голосовать дважды с одного IP в течение VOTE_UNIQUE_IP_DELAY Указывается период, в течение которого запрещается голосовать дважды с одного IP:
    • VOTE_UNIQUE_IP_DELAY_INPUT - указывается число;
    • VOTE_UNIQUE_IP_DELAY_SELECT - указывается:
      • S - секунд;
      • M - минут;
      • H - часов;
      • D - дней.
    Настройки рейтинга
    Включить рейтингSHOW_RATINGУказывается включать ли вывод рейтинга:
    • - по умолчанию;
    • Y - да;
    • N - нет.




    Примечание:

    С версии 17.5.4 добавлена поддержка рейтингов с реакциями.

    РейтингRATING_IDУказывается какой будет использоваться рейтинг.
    Вид кнопок рейтингаRATING_TYPEУказывается тип кнопки рейтинга:
    • - по умолчанию;
    • like - Мне нравится (текстовый);
    • like_graphic - Мне нравится (графический);
    • standart_text - Нравится / Не нравится (текстовый);
    • standart - Нравится / Не нравится (графический).

    Примечание: Если в группе Управление адресами страниц в полях Страница чтения темы форума (read) и Страница чтения сообщения (message), а также в Шаблоне пути к сообщению на сайте, изменить переменную символьного идентификатора темы #TID# (#TOPIC_ID#) на #TITLE_SEO#, то при изменении названия темы форума в адресной строке браузера будет отображаться уже новый вариант ссылки, при этом этот адрес будет индексироваться.



    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх