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

CheckFields

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

boolean
CCatalogDiscountCoupon::CheckFields(
	string $ACTION,
	array &$arFields,
	int $ID = 0
);

Метод служит для проверки (и корректировки, если это возможно) параметров, переданных в методы CCatalogDiscountCoupon::Add и CCatalogDiscountCoupon::Update. Нестатический метод.

Параметры вызова

Параметр Описание
ACTION указывает, для какого метода идет проверка. Возможные значения:
arFields Ассоциативный массив параметров купона. Массив передается по ссылке и его значения могут быть изменены методом.
Допустимые ключи:
  • DISCOUNT_ID - код (ID) скидки;
  • ACTIVE - флаг активности купона (Y/N);
  • ONE_TIME - флаг однократного использования купона (Y|N);
  • COUPON - код купона;
  • DATE_APPLY - дата применения купона;
  • DESCRIPTION - комментарий.
ID код (ID) купона (только для CCatalogDiscountCoupon::Update).

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

В случае корректности переданных параметров возвращает true, иначе - false. Если метод вернул false, с помощью $APPLICATION->GetException() можно получить текст ошибок.

Обязательные проверки

  • для CCatalogDiscountCoupon::Add
    • поле DISCOUNT_ID присутствует и содержит код (ID) существующей скидки;
    • если поле ACTIVE не существует или не равно N, ему присваивается значение Y;
    • если поле ONE_TIME не существует или не равно N, ему присваивается значение Y;
    • поле COUPON существует и содержит уникальный код, отсутствующий в списке купонов;
    • если поле DATE_APPLY не существует или не содержит корректную дату, ему присваивается значение false.

  • для CCatalogDiscountCoupon::Update
    • если поле DISCOUNT_ID присутствует, оно должно содержать код (ID) существующей скидки;
    • если поле ACTIVE существует и не равно N, ему присваивается значение Y;
    • если поле ONE_TIME существует и не равно N, ему присваивается значение Y;
    • если поле COUPON существует, оно содержит уникальный код, заданный только для этого купона (с таким ID);
    • если поле DATE_APPLY существует и содержит некорректную дату, ему присваивается значение false.


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