GetList
Описание и параметры
CDBResult CCatalog::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", . . . )Удовлетворяющие фильтру записи возвращаются в результате, а записи, которые не удовлетворяют условиям фильтра, отбрасываются. Допустимыми являются следующие модификаторы:
Пример фильтра: array("SUBSCRIPTION" => "Y")Этот фильтр означает "выбрать все записи, в которых значение в поле SUBSCRIPTION (флаг "Продажа контента") равно Y". Значение по умолчанию - пустой массив array() - означает, что результат отфильтрован не будет. |
arGroupBy | Массив полей, по которым группируются записи
каталога. Массив имеет вид:
array("название_поля1", "название_поля2", . . .)В качестве "название_поляN" может стоять любое поле каталога. Если массив пустой, то метод вернет число записей, удовлетворяющих фильтру. Значение по умолчанию - false - означает, что результат группироваться не будет. |
arNavStartParams | Массив параметров выборки. Может содержать следующие ключи:
|
arSelectFields | Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение
"*", то будут возвращены все доступные поля. Значение по умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса. |
Возвращаемые значения
Возвращает объект класса CDBResult, содержащий коллекцию ассоциативных массивов с ключами:
Ключ | Описание |
---|---|
ID | Код каталога. Совпадает с кодом информационного блока. |
IBLOCK_ID | Код информационного блока. |
IBLOCK_TYPE_ID | Тип информационного блока. |
SUBSCRIPTION | Флаг "Продажа контента". |
NAME | Название информационного блока. |
YANDEX_EXPORT | флаг "экспортировать в Яндекс.Маркет" |
Если в качестве параметра arGroupBy передается пустой массив, то метод вернет число записей, удовлетворяющих фильтру.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024