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

Add

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

int
CRubric::Add(
	array arFields
);

Метод добавляет рассылку. При этом если рассылка активна и является автоматической, то в случае соответствующей настроки модуля (метод генерации не cron) добляется агент для генерации выпусков. Метод нестатический.

Параметры

ПараметрОписаниеC версии
arFieldsМассив со значениями полей объекта "Рассылка".

Требования к полям, передаваемым в arFields

  • NAME - не должно быть пустым.
  • LID - не должно быть пустым и должно содержать корректный идентификатор сайта.
  • DAYS_OF_MONTH - может быть пустым или должно содержать корректный список дней месяца вида (DD|DD-DD)[[,(DD|DD-DD)],...].
  • DAYS_OF_WEEK - может быть пустым или должно содержать корректный список дней недели вида DD[[,DD],...].
  • TIMES_OF_DAY - может быть пустым или должно содержать корректный список времен вида HH:MM[[,HH:MM],...].
  • TEMPLATE - может быть пустым или должно содержать корректный идентификатор шаблона.
  • LAST_EXECUTED - может быть пустым или должно содержать корректное значение времени.
  • AUTO - если задано и равно "Y", то должны быть заданы DAYS_OF_MONTH или DAYS_OF_WEEK, а также TIMES_OF_DAY и LAST_EXECUTED. И еще поле FROM_FIELD должно содержать правильный адрес e-mail (см. функцию check_email).

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

В случае успешного добавления возвращается ID рассылки. В противном случает возвращается false, и переменная класса LAST_ERROR содержит сообщение об ошибке.

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

$rubric = new CRubric;
$arFields = Array(
	"ACTIVE" => ($ACTIVE <> "Y"? "N":"Y"),
	"NAME" => $NAME,
	"SORT" => $SORT,
	"DESCRIPTION" => $DESCRIPTION,
	"LID" => $LID
);
$ID = $rubric->Add($arFields);
if($ID == false)
	echo $rubric->LAST_ERROR;


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