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

GetList

CDBResult
    
CSalePaySystem::GetList(
array arOrder = array(("SORT"=>"ASC", "NAME"=>"ASC"),
array arFilter = array(),
array arGroupBy = false,
array arNavStartParams = false,
array arSelectFields = array()
);

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

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

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

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

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

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

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

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

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

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

Ключ Описание
ID Код платежной системы.
NAME Название платежной системы.
ACTIVE Флаг (Y/N) активности системы.
SORT Индекс сортировки.
DESCRIPTION Описание платежной системы.
PSA_ID Код обработчика платежной системы (возвращается, если в метод передается тип плательщика)
PSA_NAME Название обработчика (возвращается, если в метод передается тип плательщика)
PSA_ACTION_FILE Скрипт обработчика (возвращается, если в метод передается тип плательщика)
PSA_RESULT_FILE Скрипт запроса результатов (возвращается, если в метод передается тип плательщика)
PSA_NEW_WINDOW Флаг (Y/N) открывать ли скрипт обработчика в новом окне (возвращается, если в метод передается тип плательщика)
PSA_PERSON_TYPE_ID Код типа плательщика.
PSA_PARAMS Параметры вызова обработчика.
PSA_HAVE_PAYMENT Есть вариант обработчика для работы после оформления заказа.
PSA_HAVE_ACTION Есть вариант обработчика для мгновенного списания денег.
PSA_HAVE_RESULT Есть скрипт запроса результатов.
PSA_HAVE_PREPAY Есть вариант обработчика для работы во время оформления заказа.

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

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

<?
// Выведем все активные платежные системы для текущего сайта, для типа плательщика с кодом 2, работающие с валютой RUR
$db_ptype = CSalePaySystem::GetList($arOrder = Array("SORT"=>"ASC", "PSA_NAME"=>"ASC"), Array("LID"=>SITE_ID, "CURRENCY"=>"RUB", "ACTIVE"=>"Y", "PERSON_TYPE_ID"=>2));
$bFirst = True;
while ($ptype = $db_ptype->Fetch())
{
?><input type="radio" name="PAY_SYSTEM_ID" value="<?echo $ptype["ID"] ?>"<?if ($bFirst) echo " checked";?>><b><?echo $ptype["PSA_NAME"] ?></b><br><?
$bFirst = false;
if (strlen($ptype["DESCRIPTION"])>0)
echo $ptype["DESCRIPTION"]."<br>";
?><hr size="1" width="90%"><?
}
?>


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

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

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

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

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