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

ForumAddMessage

int
ForumAddMessage(

 string MESSAGE_TYPE,
 int FID,
 int TID,
 int MID,
 array arFieldsG,
 &string strErrorMessage,
 &string strOKMessage [,
 int iFileSize]
);

Добавляет или изменяет сообщение (и возможно тему) форума. В переменную, передаваемую в параметре strErrorMessage дописывает ошибки, которые произошли при работе функции. В переменную, передаваемую в параметре strOKMessage дописывает сообщения об успехах, которые произошли при работе функции.

Примечание. Функция использует внутреннюю транзакцию. Если у вас используется MySQL и InnoDB, и ранее была открыта транзакция, то ее необходимо закрыть до ее подключения.

Параметры функции

ПараметрОписание
MESSAGE_TYPE Тип работы функции. Может принимать следующие значения: NEW - создание новой темы и добавление в нее сообщения, EDIT - изменение сообщения (и темы, если на это есть права), REPLY - новое сообщение в существующую тему.
FID Код форума, в который добавляется новая тема. Актуален для типа работы NEW, в остальных случаях восстанавливается из кода темы.
TID Код темы, в которую добавляется сообщение. Актуален для типа работы REPLY, в остальных случаях восстанавливается из кода сообщения. Для добавления новой темы должен быть равен 0.
MID Код сообщения, которое необходимо изменить. Актуален для типа работы EDIT. В остальных случаях должен быть равен 0.
arFieldsG Массив параметров сообщения и темы. Должен содержать следующие ключи
POST_MESSAGE - тело сообщения,
TITLE - заголовок темы (если NEW или EDIT и разрешено изменение темы),
AUTHOR_NAME - имя автора сообщения,
DESCRIPTION - описание темы (если NEW или EDIT и разрешено изменение темы),
ICON_ID - иконка темы (если NEW или EDIT и разрешено изменение темы),
USE_SMILES - разрешено заменять смайлики на их графические изображения,
ATTACH_IMG - присоединенный файл - массив со структурой элементов массива $_FILES
strErrorMessage Переменная, в которую функция дописывает сообщения об ошибках, которые произошли при ее работе.
strOKMessage Переменная, в которую функция дописывает сообщения об успехах, которые произошли при ее работе.
iFileSize Максимальный размер загружаемых файлов в байтах. Не обязательный параметр, по умолчанию равен 50000 (байт).
captcha_word Слово с капчи.
captcha_sid Сессия капчи.
captcha_code Введенное пользователем слово.

Возвращаемое значение

Возвращает ID сообщения, если функция отработала без ошибок. В противном случае возвращает False.

Следует помнить, что внутри функции используется глобальная переменная $USER. То есть, сообщение запишется в базу от текущего авторизованного пользователя.



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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Валерий Кондаков
Волшебная функция. Практически полностью унифицирует работу по добавлению и модификации сообщений. Однако, имеет ряд недостатков.
Следует помнить, что внутри функции используется глобальная переменная $USER. То есть, сообщение пойдет в базу от лица текущего авторизованного пользователя.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх