GetList

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

CDBResult
CSaleRecurring::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( "USER_ID" => 150 ) Этот фильтр означает "выбрать все записи, в которых значение в поле USER_ID (код пользователя) равно 150". Значение по умолчанию - пустой массив array() - означает, что результат отфильтрован не будет.
arGroupBy	Массив полей, по которым группируются записи информации о продлении подписки. Массив имеет вид: array( "название_поля1", "группирующая_функция2" => "название_поля2", . . . ) В качестве "название_поляN" может стоять любое поле информации о продлении подписки. В качестве группирующей функции могут стоять: COUNT - подсчет количества; AVG - вычисление среднего значения; MIN - вычисление минимального значения; MAX - вычисление максимального значения; SUM - вычисление суммы. Если массив пустой, то метод вернет число записей, удовлетворяющих фильтру. Значение по умолчанию - false - означает, что результат группироваться не будет.
arNavStartParams	Массив параметров выборки. Может содержать следующие ключи: "nTopCount" - количество возвращаемых методом записей будет ограничено сверху значением этого ключа; любой ключ, принимаемый методом CDBResult::NavQuery в качестве третьего параметра. Значение по умолчанию - false - означает, что параметров выборки нет.
arSelectFields	Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля. Значение по умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса.

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

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

ID - код записи;
USER_ID - код пользователя;
MODULE - модуль, товар которого продлевается;
PRODUCT_ID - код продлеваемого товара;
PRODUCT_NAME - название продлеваемого товара;
PRODUCT_URL - ссылка на продлеваемый товар;
RECUR_SCHEME_TYPE - тип периода оплаты;
RECUR_SCHEME_LENGTH - длина периода оплаты;
WITHOUT_ORDER - флаг "Без оформления заказа";
ORDER_ID - код базового заказа для продления;
CANCELED - флаг отмены продления;
DESCRIPTION - описание;
CALLBACK_FUNC - функция обратного вызова для обновления параметров продления;
REMAINING_ATTEMPTS - количество оставшихся попыток осуществления продления;
SUCCESS_PAYMENT - успешное осуществление продления;
CANCELED_REASON - причина отмены;
DATE_CANCELED - дата отмены;
PRIOR_DATE - дата последнего продления;
NEXT_DATE - дата очередного продления;
TIMESTAMP_X - дата последнего изменения записи;
USER_LOGIN - логин пользователя;
USER_ACTIVE - флаг активности пользователя;
USER_NAME - имя пользователя;
USER_LAST_NAME - фамилия пользователя;
USER_EMAIL - E-Mail пользователя.

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