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

GetList

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

CDBResult
CCatalogExport::GetList(
	array arOrder = array("ID"=>"ASC"),
	array arFilter = array(),
	bool bCount = false
);

Возвращает список профилей экспорта по фильтру arFilter, отсортированый в соответствии с arOrder. Нестатический метод.

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

Параметр Описание
arOrder Массив, в соответствии с которым сортируются результирующие записи. Массив имеет вид:
array(
	"название_поля1" => "направление_сортировки1",
	"название_поля2" => "направление_сортировки2",
	. . .
)
В качестве "название_поляN" могут использоваться:
  • NAME - название профиля экспорта;
  • FILE_NAME - имя файла профиля со скриптом, осуществляющего экспорт;
  • DEFAULT_PROFILE - Y|N] флаг использования профиля по умолчанию;
  • IN_MENU - [Y|N] флаг отображения профиля в административном меню;
  • LAST_USE - дата и время последнего выполнения профиля в формате базы;
  • IN_AGENT -[Y|N] флаг наличия агента, осуществляющего автоматическое выполнение профиля экспорта;
  • IN_CRON - [Y|N] флаг привязки профиля к утилите cron для автоматической периодической выгрузки;
  • NEED_EDIT - [Y|N] флаг означает неполную настройку профиля (до тех пор, пока профиль не будет отредактирован, он выполняться не будет).
Попытка сортировки по остальным полям профиля приведет к сортировке по ID.

В качестве "направление_сортировкиX" могут быть значения "ASC" (по возрастанию) и "DESC" (по убыванию).

Если массив сортировки имеет несколько элементов, то результирующий набор сортируется последовательно по каждому элементу (т.е. сначала сортируется по первому элементу, потом результат сортируется по второму и т.д.).
arFilter Массив, в соответствии с которым фильтруются записи профилей экспорта. Массив имеет вид:
array(
	"[модификатор]название_поля1" => "значение1",
	"[модификатор]название_поля2" => "значение2",
	. . .
)
Удовлетворяющие фильтру записи возвращаются в результате, а записи, которые не удовлетворяют условиям фильтра, отбрасываются.

Допустимым является следующий модификатор:
  • ! - отрицание;
В качестве "название_поляX" может стоять любое поле профиля экспорта, кроме SETUP_VARS, TIMESTAMP_X и DATE_CREATE.
bCount Если параметр равен true, то возвращается только количество профилей, которое соответствует установленному фильтру. Необязательный. По умолчанию равен false.

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

Возвращается объект класса CDBResult, содержащий коллекцию ассоциативных массивов с ключами:

  • ID - код записи;
  • FILE_NAME - имя файла профиля со скриптом, осуществляющего экспорт;
  • NAME - название профиля экспорта;
  • IN_MENU - [Y|N] флаг отображения профиля в административном меню;
  • IN_AGENT -[Y|N] флаг наличия агента, осуществляющего автоматическое выполнение профиля экспорта;
  • IN_CRON - [Y|N] флаг привязки профиля к утилите cron для автоматической периодической выгрузки;
  • SETUP_VARS - параметры настройки профиля в виде url-строки;
  • DEFAULT_PROFILE - [Y|N] флаг использования профиля по умолчанию;
  • LAST_USE - дата и время последнего выполнения профиля в формате базы;
  • NEED_EDIT - [Y|N] флаг означает неполную настройку профиля (до тех пор, пока профиль не будет отредактирован, он выполняться не будет);
  • LAST_USE_FORMAT - дата и время последнего использования профиля в формате сайта;
  • CREATED_BY - ID пользователя, создавшего профиль;
  • MODIFIED_BY - ID пользователя, изменившего профиль;
  • TIMESTAMP_X - дата и время последнего изменения профиля в формате сайта;
  • DATE_CREATE - дата и время создания профиля в формате сайта.


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