OnBeforeGroupUpdate

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

bool
EventHandler(
	int ID,
	array &arFields
);

Событие вызывается в методе CGroup::Update до изменения полей группы, и может быть использовано для отмены изменения или переопределения некоторых полей.

Параметры метода

Параметр arFields данного обработчика является ссылкой на исходные переменные. Поэтому если изменить значение параметра внутри обработчика, это приведет к смене значения исходной переменной, поступившей на вход функции-обработчика.

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

Для отмены изменения и прекращении выполнения метода CGroup::Update необходимо в функции-обработчике создать исключение методом $APPLICATION->ThrowException() и вернуть false.

Смотрите также

• CGroup
• События

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

<?
AddEventHandler("main", "OnBeforeGroupUpdate", "MyOnBeforeGroupUpdate");
public static function MyOnBeforeGroupUpdate($ID, &$arFields)
{
	if($ID == 1)
		$arFields["DESCRIPTION"] = "Главная группа админов.";
}
?>