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

GetList

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

CDBResult
CSalePaySystemAction::GetList(
 array arOrder = array(),
 array arFilter = array(),
 array arGroupBy = false,
 array arNavStartParams = false,
 array arSelectFields = array()
);

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

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

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

Если массив сортировки имеет несколько элементов, то результирующий набор сортируется последовательно по каждому элементу (т.е. сначала сортируется по первому элементу, потом результат сортируется по второму и т.д.). 

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

Допустимыми являются следующие модификаторы:
  • ! - отрицание;
  • + - значения null, 0 и пустая строка так же удовлетворяют условиям фильтра.
Допустимыми являются следующие операторы:
  • >= - значение поля больше или равно передаваемой в фильтр величины;
  • > - значение поля строго больше передаваемой в фильтр величины;
  • <= - значение поля меньше или равно передаваемой в фильтр величины;
  • < - значение поля строго меньше передаваемой в фильтр величины;
  • @ - значение поля находится в передаваемом в фильтр разделенном запятой списке значений;
  • ~ - значение поля проверяется на соответствие передаваемому в фильтр шаблону;
  • % - значение поля проверяется на соответствие передаваемой в фильтр строке в соответствии с языком запросов.
В качестве "название_поляX" может стоять любое поле заказов.

Пример фильтра:
array("!PERSON_TYPE_ID" => 5)
Этот фильтр означает "выбрать все записи, в которых значение в поле PERSON_TYPE_ID (код типа плательщика) не равно 5".

Значение по умолчанию - пустой массив array() - означает, что результат отфильтрован не будет.
arGroupBy Массив полей, по которым группируются записи обработчиков платежных систем. Массив имеет вид:
array("название_поля1",
      "группирующая_функция2" => "название_поля2", ...)
В качестве "название_поляN" может стоять любое поле обработчиков платежных систем. В качестве группирующей функции могут стоять:
  • COUNT - подсчет количества;
  • AVG - вычисление среднего значения;
  • MIN - вычисление минимального значения;
  • MAX - вычисление максимального значения;
  • SUM - вычисление суммы.
Этот фильтр означает "выбрать все записи, в которых значение в поле LID (сайт системы) не равно en".

Значение по умолчанию - false - означает, что результат группироваться не будет.
arNavStartParams Массив параметров выборки. Может содержать следующие ключи:
  • "nTopCount" - количество возвращаемых методом записей будет ограничено сверху значением этого ключа;
  • любой ключ, принимаемый методом CDBResult::NavQuery в качестве третьего параметра.
Значение по умолчанию - false - означает, что параметров выборки нет.
arSelectFields Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

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

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

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

Ключ Описание
ID Код обработчика платежной системы.
PAY_SYSTEM_ID Код платежной системы.
PERSON_TYPE_ID Код типа плательщика.
NAME Название платежной системы.
ACTION_FILE Скрипт платежной системы.
RESULT_FILE Скрипт получения результатов.
NEW_WINDOW Флаг (Y/N) открывать ли скрипт платежной системы в новом окне.
PARAMS Параметры вызова обработчика.
HAVE_PAYMENT Есть вариант обработчика для работы после оформления заказа.
HAVE_ACTION Есть вариант обработчика для мгновенного списания денег.
HAVE_RESULT Есть скрипт запроса результатов.
HAVE_PREPAY Есть вариант обработчика для работы во время оформления заказа.
PS_LID Сайт платежной системы.
PS_CURRENCY Валюта платежной системы.
PS_NAME Название платежной системы.
PS_ACTIVE Активность платежной системы.
PS_SORT Индекс сортировки платежной системы.
PS_DESCRIPTION Описание платежной системы.
PT_LID Сайт типа плательщика.
PT_NAME Название типа плательщика.
PT_SORT Индекс сортировки типа плательщика.

Если в качестве параметра arGroupBy передается пустой массив, то метод вернет число записей, удовлетворяющих фильтру.



© «Битрикс», 2001-2022, «1С-Битрикс», 2022
Наверх