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

Add

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

mixed
CCatalogImport::Add(
	array arFields
);

Метод добавляет новый профиль импорта. Нестатический метод.

Примечание: в данном методе отключена возможность заносить значения в обход CheckFields, кроме одного исключения:
"=LAST_USE" => $DB->GetNowFunction()

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

Параметр Описание
arFields Доступные поля:
  • CREATED_BY - ID создавшего профиль. Если значение данного поля не передается, то оно будет взято из параметра CUser при наличии $USER и авторизованности. В противном случае значение данного поля будет выставлено в NULL;
  • MODIFIED_BY - ID изменившего профиль. Если значение данного поля не передается, то оно будет взято из параметра CUser при наличии $USER и авторизованности. В противном случае значение данного поля будет выставлено в NULL;
  • TIMESTAMP_X - время последнего изменения профиля в формате сайта. Значение данного поля невозможно задать вручную;
  • DATE_CREATE - дата создания профиля в формате сайта. Значение данного поля невозможно задать вручную;
  • FILE_NAME - имя файла профиля со скриптом, осуществляющего импорт;
  • NAME - название профиля импорта;
  • IN_MENU - [Y|N] флаг отображения профиля в административном меню;
  • DEFAULT_PROFILE - [Y|N] признак использования профиля по умолчанию;
  • IN_AGENT - [Y|N] флаг наличия агента, осуществляющего автоматическое выполнение профиля импорта;
  • IN_CRON - [Y|N] флаг привязки профиля к утилите cron для автоматической периодической выгрузки (только для Unix-систем);
  • SETUP_VARS - параметры настройки профиля в виде url-строки;
  • NEED_EDIT - [Y|N] флаг означает неполную настройку профиля (до тех пор, пока профиль не будет отредактирован, он выполняться не будет).

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

Метод возвращает код вставленной записи или false в случае ошибки.

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

Добавление предустановленного профиля csv-импорта, требующего настройки:

$arFields = array(  
	"FILE_NAME" => "csv_new",   
	"NAME" => "Мой импорт", 
	"NEED_EDIT" => "Y", 
	"SETUP_VARS"    => false
);  
CCatalogImport::Add($arFields);

Добавление профиля с указанием времени последнего использования (время может быть только текущим) и занесением в левое меню:

$arFields = array(  
	"FILE_NAME" => "csv_new", 
	"NAME" => "Мой второй импорт", 
	"=LAST_USE" => $DB->GetNowFunction,  
        	"IN_MENU" => "Y",
	"SETUP_VARS" => "IBLOCK_ID=15&FILE_DATE=export.csv" //  набор параметров довольно условный
); 
CCatalogImport::Add($arFields);

Добавление профиля с явным указанием создавшего профиль:

$arFields = array(  
	"FILE_NAME" => "csv_new", 
	"NAME" => "Мой второй импорт", 
	"=LAST_USE" => $DB->GetNowFunction,  
		"IN_MENU" => "Y",
	"SETUP_VARS" => "IBLOCK_ID=15&FILE_DATE=export.csv", //  набор параметров довольно условный 
	"CREATED_BY" => 15, // пользователь с ID = 15 
	"MODIFIED_BY" => 15 // должен совпадать с CREATED_BY
); 
CCatalogImport::Add($arFields);


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх