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

Update

Описание и параметры

int
CSocNetGroup::Update(
	int ID,
	array arFields,
	bool bAutoSubscribe = true,
	bool bClearCommonTag = true
);

Метод изменяет параметры группы с заданным идентификатором. Метод статический.

Примечание: при работе метода вызываются события OnBeforeSocNetGroupUpdate и OnSocNetGroupUpdate.

Параметры

Параметр Описание С версии
ID Идентификатор группы
arFields Массив параметров группы, которые должны быть изменены. Ключами в массиве являются названия параметров, а значениями - новые значения. Допустимые ключи: SITE_ID - код сайта;
NAME - название группы;
DESCRIPTION - описание группы;
VISIBLE - флаг Y/N - видна ли группа в списке групп;
OPENED - флаг Y/N - открыта ли группа для свободного вступления;
SUBJECT_ID - код темы;
KEYWORDS - ключевые слова;
IMAGE_ID - иконка группы;
INITIATE_PERMS - кто имеет право на приглашение пользователей в группу: SONET_ROLES_OWNER - только владелец группы, SONET_ROLES_MODERATOR - владелец группы и модераторы группы, SONET_ROLES_USER - все члены группы;*
CLOSED - флаг Y/N - является ли группа архивной;
SPAM_PERMS - кто имеет право на отправку сообщений в группу: SONET_ROLES_OWNER - только владелец группы, SONET_ROLES_MODERATOR - владелец группы и модераторы группы, SONET_ROLES_USER - все члены группы.*
ID
bAutoSubscribe Флаг автоподписки на уведомления. Необязательный. По умолчанию равен true. 10.0.0
bClearCommonTag Необязательный. По умолчанию равен true. 12.5.1

* - SONET_ROLES_OWNER, SONET_ROLES_MODERATOR, SONET_ROLES_USER - имена констант.

Метод поддерживает пользовательские поля. Значения пользовательских полей передаются так же, как и штатных полей, например: "UF_TEXT_1"=>"xxx".

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

Метод возвращает код изменяемой группы или false в случае ошибки.

Примеры использования

<?
$arFields = array(
	"NAME" => $_POST["GROUP_NAME"],
	"DESCRIPTION" => $_POST["GROUP_DESCRIPTION"],
);
if (!CSocNetGroup::Update($ID, $arFields))
{
	if ($e = $GLOBALS["APPLICATION"]->GetException())
		$errorMessage .= $e->GetString();
}
?>


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