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

Тема (чтение)

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

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

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

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

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

  • Основные параметры
  • Шаблоны ссылок
  • Настройки кеширования
  • Дополнительные настройки
  • Настройки рейтинга
  • Описание параметров

    Поле Параметр Описание
    Основные параметры
    ID форума FID Указывается идентификатор форума, явно или в виде кода. По умолчанию поле содержит ={$_REQUEST["FID"]}.
    ID темы TID Указывается идентификатор темы, явно или в виде кода. По умолчанию поле содержит ={$_REQUEST["TID"]}.
    ID сообщения MID Указывается идентификатор сообщения, явно или в виде кода. По умолчанию поле содержит ={$_REQUEST["MID"]}.
    Могут отправлять письмо (e-mail) из профиля SEND_MAIL Указываются пользователи, которые могут отправлять письмо (e-mail) из профиля:
    • A - никто;
    • E - авторизованные пользователи;
    • U - все пользователи, а для неавторизованных пользователей выводить поле CAPTCHA;
    • Y - все пользователи.
    Шаблоны ссылок
    Страница чтения темы URL_TEMPLATES_READ Указывается адрес страницы чтения темы форума. По умолчанию поле содержит read.php?FID=#FID#&TID=#TID#.
    Страница чтения темы (с ID сообщения) URL_TEMPLATES_MESSAGE Указывается адрес страницы со списком тем форума. По умолчанию поле содержит message.php?FID=#FID#&TID=#TID#&MID=#MID#.
    Страница списка тем URL_TEMPLATES_LIST Указывается адрес страницы со списком тем форума. По умолчанию поле содержит list.php?FID=#FID#. Такая страница может быть создана с помощью компонента Темы (список).
    Страница переноса сообщений URL_TEMPLATES_MESSAGE_MOVE Указывается адрес страницы переноса сообщений форума. По умолчанию поле содержит message_move.php?FID=#FID#&TID=#TID#&MID_ARRAY=#MID_ARRAY#. Такая страница может быть создана с помощью компонента Сообщения (перемещение).
    Страница профиля пользователя URL_TEMPLATES_PROFILE_VIEW Указывается адрес страницы просмотра профиля пользователя. По умолчанию поле содержит profile_view.php?UID=#UID#. Такая страница может быть создана с помощью компонента Пользователь (профиль).
    Страница создания новой темы URL_TEMPLATES_TOPIC_NEW Указывается адрес страницы создания новой темы форума. По умолчанию поле содержит topic_new.php?FID=#FID#. Такая страница может быть создана с помощью компонента Тема (создание).
    Страница подписки URL_TEMPLATES_SUBSCR_LIST Указывается адрес страницы подписки на форум. По умолчанию поле содержит subscr_list.php?FID=#FID#. Такая страница может быть создана с помощью компонента Подписка (список).
    Страница переноса тем URL_TEMPLATES_TOPIC_MOVE Указывается адрес страницы переноса темы форума. По умолчанию поле содержит topic_move.php?FID=#FID#&TID=#TID#. Такая страница может быть создана с помощью компонента Темы (перемещение).
    Страница списка форумов URL_TEMPLATES_INDEX Указывается адрес страницы со списком форумов. По умолчанию поле содержит index.php. Такая страница может быть создана с помощью компонента Форумы (список).
    Страница личных сообщений URL_TEMPLATES_PM_EDIT Указывается адрес страницы со списком форумов. По умолчанию поле содержит pm_edit.php. Такая страница может быть создана с помощью компонента PM (изменение).
    Страница отправки сообщения URL_TEMPLATES_MESSAGE_SEND Указывается адрес страницы отправки сообщения. По умолчанию поле содержит message_send.php?UID=#UID#.
    Страница RSS URL_TEMPLATES_RSS Указывается адрес страницы RSS форума. По умолчанию поле содержит rss.php?TYPE=#TYPE#&MODE=#MODE#&IID=#IID#.
    Страница сообщений пользователя URL_TEMPLATES_USER_POST Указывается адрес страницы сообщений пользователя. По умолчанию поле содержит user_post.php?UID=#UID#&mode=#mode#.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Дополнительные настройки
    Количество сообщений на одной странице MESSAGES_PER_PAGE Указывается количество сообщений, отображаемых на одной странице. Все сообщения будут выведены с помощью постраничной навигации.
    Формат показа даты DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Формат показа даты и времени DATE_TIME_FORMAT Указывается формат показа даты и времени. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Название шаблона для вывода постраничной навигации PAGE_NAVIGATION_TEMPLATE Задается название шаблона для вывода постраничной навигации. Если поле пусто, то используется шаблон по умолчанию.
    Количество страниц в постраничной навигации PAGE_NAVIGATION_WINDOW Задается количество отображаемых в навигации ссылок на страницы. Если количество страниц превышает заданное число, то в навигацию будет добавлено многоточие.
    Разрешать показывать все страницы форума PAGE_NAVIGATION_SHOW_ALL [Y|N] При отмеченной опции будут показаны все страницы форума.
    Длина слова WORD_LENGTH Задается максимально допустимая длина словообразующих символов, следующих друг за другом. Если длина слова превысит указанное число, то символы слова будут разбавлены разрывами (при просмотре сообщений разрывы не отображаются).
    Размер прикрепленного рисунка (px) IMAGE_SIZE Указывается допустимый размер прикрепленного рисунка в пикселах.
    Показывать первое сообщение темы на каждой странице SHOW_FIRST_POST [Y|N] При отмеченной опции на каждой странице просмотра темы будет отображаться первое ее сообщение.
    Показывать навигацию (хлебные крошки) SET_NAVIGATION [Y|N] При отмеченной опции в навигационную цепочку будет добавлен пункт с заголовком страницы.
    Использовать аякс AJAX_TYPE [Y|N] При отмеченной опции для компонента будет включен режим AJAX.
    Устанавливать теги и описание темы в свойства страницы SET_PAGE_PROPERTY [Y|N] Разрешает установку тегов и описания темы, указанных при создании темы в качестве тегов и описания для страницы.
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено название просматриваемой темы.
    Как показывать прикрепленные рисунки (под сообщением) ATTACH_MODE Задается форма отображения прикрепленных рисунков (под сообщением). Доступные формы:
    • Миниатюра При выборе формы Миниатюра станет доступно дополнительное поле:
      Размер миниатюры рисунка (под сообщением, px) ATTACH_SIZE Задается сторона квадрата, в который с сохранением пропорций будет включено изображение. Указывается в пикселях.
    • Название
    Показывать RSS SHOW_RSS [Y|N] При отмеченной опции на странице будет отображаться ссылка на RSS.
    Показывать ссылку «Имя» SHOW_NAME_LINK [Y|N] При отмеченной опции в форме сообщения будет показана ссылка «Имя» для вставки имени пользователя в создаваемое сообщение.
    Не индексировать ссылку на профиль SEO_USER [Y|N] При отмеченной опции поисковые боты не смогут индексировать ссылки на профиль пользователя.
    Показывать опросы SHOW_VOTE [Y|N] При отмеченной опции будет выведен опрос.
    Шаблон для опросов VOTE_TEMPLATE Укажите шаблон для отображения опроса.
    Настройки рейтинга
    Включить рейтингSHOW_RATINGУказывается включать ли вывод рейтинга:
    • - по умолчанию;
    • Y - да;
    • N - нет.




    Примечание:

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

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


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

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

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

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

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх