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

AddByEvents

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

int
CStatEvent::AddByEvents(
	string event1,
	string event2,
	string event3,
	string date,
	string gid,
	mixed money = "",
	string currency = "",
	string chargeback = "N"
)

Добавляет событие по заданным идентификаторам типа события и специальному параметру. Если типа события с идентификаторами event1, event2 не существует, то он будет автоматически создан с указанными идентификаторами.

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

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

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

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

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

<?
// добавим событие по типу softkey/buy
// если такого типа нет, то он автоматически будет создан

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

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

CStatEvent::AddByEvents("softkey", "buy", "", $date, $gid, "899", "USD");
?>
<?
// добавим событие по типу regnow/buy
// если такого типа нет, то он автоматически будет создан

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

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

CStatEvent::AddByEvents("regnow", "buy", "", $date, $gid, "199", "EUR");
?>


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