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

GetList

CDBResult
CCatalogVat::GetList(
  array arOrder = array('CSORT' => 'ASC'),
  array arFilter = array(),
  array arFields = array()
);

Метод возвращает результат выборки записей из таблицы ставок НДС в соответствии со своими параметрами. Нестатический метод.

Примечание: начиная с версии модуля 12.5.6, метод считается устаревшим. Вместо него рекомендуется использовать CCatalogVat::GetListEx.

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

ПараметрОписание
arOrder Массив, в соответствии с которым сортируются результирующие записи. Массив имеет вид:
array(
"название_поля1" => "направление_сортировки1",
"название_поля2" => "направление_сортировки2",
. . .
)
В качестве "название_поляN" может стоять любое поле, кроме TIMESTAMP_X. В качестве "направление_сортировкиX" могут быть значения "ASC" (по возрастанию) и "DESC" (по убыванию).

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

Допустимыми являются следующие операторы:
  • >= - значение поля больше или равно передаваемой в фильтр величины;
  • > - значение поля строго больше передаваемой в фильтр величины;
  • <= - значение поля меньше или равно передаваемой в фильтр величины;
  • < - значение поля строго меньше передаваемой в фильтр величины;
  • @ - оператор может использоваться для целочисленных и вещественных данных при передаче набора значений (массива). В этом случае при генерации sql-запроса будет использован sql-оператор IN, дающий компактную форму записи;
  • ~ - значение поля проверяется на соответствие передаваемому в фильтр шаблону;
  • % - значение поля проверяется на соответствие передаваемой в фильтр строке в соответствии с языком запросов.
В качестве "название_поляX" может стоять любое из следующих полей: ID, ACTIVE, NAME или RATE.

Значение по умолчанию - пустой массив array() - означает, что результат отфильтрован не будет.
arFields Массив полей записей, которые будут возвращены методом.

Возможные поля выборки: ID, TIMESTAMP_X, ACTIVE, C_SORT, NAME и RATE.

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

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



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

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

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

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

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