GetList

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

CDBResult CExtra::GetList(
	array $arOrder = array(),
	array $arFilter = array(),
	mixed $arGroupBy = false,
	mixed $arNavStartParams = false,
	array $arSelectFields = array()
);

Метод возвращает список наценок в соответствии с фильтром и условиями сортировки. Метод статический.

Примечание: в таком виде метод работает с версии 11.0.0. До этой версии использовалась устаревшая форма вызова метода (см. ниже).

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

Параметр	Описание
arOrder	Массив вида array(by1=>order1[, by2=>order2 [, ..]]), где by - поле для сортировки, может принимать значения: ID - код (ID) наценки NAME - название наценки PERCENTAGE - величина наценки поле order - направление сортировки, может принимать значения: asc - по возрастанию desc - по убыванию Необязательный. По умолчанию данные не сортируются.
arFilter	Массив параметров, по которым строится фильтр выборки. Имеет вид: array( "[модификатор1][оператор1]название_поля1" => "значение1", "[модификатор2][оператор2]название_поля2" => "значение2", . . . ) Удовлетворяющие фильтру записи возвращаются в результате, а записи, которые не удовлетворяют условиям фильтра, отбрасываются. Допустимыми являются следующие модификаторы: ! - отрицание; + - значения null, 0 и пустая строка так же удовлетворяют условиям фильтра. Допустимыми являются следующие операторы: >= - значение поля больше или равно передаваемой в фильтр величины; > - значение поля строго больше передаваемой в фильтр величины; <= - значение поля меньше или равно передаваемой в фильтр величины; < - значение поля строго меньше передаваемой в фильтр величины; @ - оператор может использоваться для целочисленных и вещественных данных при передаче набора значений (массива). В этом случае при генерации sql-запроса будет использован sql-оператор IN, дающий компактную форму записи; ~ - значение поля проверяется на соответствие передаваемому в фильтр шаблону; % - значение поля проверяется на соответствие передаваемой в фильтр строке в соответствии с языком запросов. "название поля" может принимать значения: ID - код (ID) наценки (число) NAME - название наценки (строка) PERCENTAGE - величина наценки (число) Значения фильтра - одиночное значение или массив значений. Необязательное. По умолчанию наценки не фильтруются.
arGroupBy	Массив полей для группировки наценок. Имеет вид: array("название_поля1", "название_поля2", . . .) В качестве "название_поляN" может стоять любое поле каталога. Если массив пустой, то метод вернет число записей, удовлетворяющих фильтру. Значение по умолчанию - false - означает, что результат группироваться не будет.
arNavStartParams	Массив параметров выборки. Может содержать следующие ключи: "nTopCount" - количество возвращаемых методом записей будет ограничено сверху значением этого ключа; любой ключ, принимаемый методом CDBResult::NavQuery в качестве третьего параметра. Необязательный. По умолчанию false - наценки не ограничиваются.
arSelectedFields	Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля. Необязательный. По умолчанию выводятся все поля.

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

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

Ключ	Описание
ID	Код наценки.
NAME	Название наценки.
PERCENTAGE	Величина наценки.

Примечания

Сохранен старый способ вызова:

CDBResult CExtra::GetList(
	string by, 
	string order
);

где by - поле сортировки, а order - направление.