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

Add

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

int
CStatEvent::Add(
	int type_id,
	string event3,
	string date,
	string gid,
	mixed money = "",
	string currency = "",
	string chargeback = "N"
)

Добавляет событие по заданному типу и специальному параметру.

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

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

ПараметрОписание
type_idID типа события.
event3Дополнительный параметр event3 события.
dateДата в текущем формате.
gidСпециальный параметр в котором закодированы все необходимые данные для добавления события.
moneyДенежная сумма.
currencyТрехсимвольный идентификатор валюты. Идентификаторы валют задаются в модуле "Валюты".
chargebackФлаг отрицательной суммы. Используется, когда необходимо зафиксировать событие о возврате денег (chargeback). Возможные значения:
  • Y - денежная сумма отрицательная;
  • N - денежная сумма положительная.

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

Функция возвращает ID добавленного события в случае успеха и 0 если событие не было добавлено по каким либо причинам.

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

<?
// добавим событие по типу события #1
// данный тип должен быть заранее создан

// специальный параметр события в незакодированном виде
$gid = "BITRIX_SM.995.82.N0.25.N.ru"; 

// дата должна быть заданы в формате текущего сайта или языка
$date = "23.12.2005 18:15:10";

CStatEvent::Add(1, "", $date, $gid, 99, "USD");
?>
<?
// добавим событие по типу события #2
// данный тип должен быть заранее создан

// специальный параметр события в закодированном виде
$gid = "BITRIX_SM.OTk1LjgyLk4wLjI1Lk4ucnU%3D";

// дата должна быть заданы в формате текущего сайта или языка
$date = "01.06.2005";

CStatEvent::Add(2, "", $date, $gid, "199", "EUR");
?>


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