getList

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

false|string|CCatalogMeasureResult
CCatalogMeasure::getList(
	array arOrder = [],
	array arFilter = [],
	bool|array arGroupBy = false,
	bool|array arNavStartParams = false,
	array arSelectFields = []
);

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

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

Параметр	Описание
arOrder	Массив, по которому сортируются записи. Формат: [ "название_поля" => "направление_сортировки" ] В качестве направления сортировки можно указать: ASC — по возрастанию, DESC (по убыванию). Если массив содержит несколько элементов, результат сортируется последовательно по каждому полю. Значение по умолчанию — пустой массив [] — означает, что результат отсортирован не будет.
arFilter	Массив, по которому фильтруются записи. Формат: [ "[модификатор][оператор]название_поля" => "значение" ] Записи, которые не соответствуют условиям фильтра, не попадут в результат. Допустимые модификаторы фильтра: ! — отрицание, + — значения null, 0 и пустая строка также удовлетворяют условиям фильтра. Допустимые операторы фильтра: >= — значение поля больше или равно переданной величине, > — значение поля строго больше переданной величины, <= — значение поля меньше или равно переданной величине, < — значение поля строго меньше переданной величине, @ — поле соответствует одному из переданных значений, оператор можно использовать для целочисленных и вещественных данных при передаче массива значений, ~ — значение поля проверяется на соответствие переданному шаблону, % — значение поля проверяется на соответствие переданной строке в соответствии с языком запросов. Значение по умолчанию — пустой массив [] — означает, что результат отфильтрован не будет.
arGroupBy	Массив полей, по которым группируются записи: [ "название_поля1", "название_поля2" ] Если передан пустой массив, метод возвращает количество записей, удовлетворяющих фильтру. Значение по умолчанию — false — означает, что результат группироваться не будет.
arNavStartParams	Массив параметров выборки. Может содержать ключ "nTopCount", который ограничивает количество возвращаемых записей, или параметры постраничной навигации. Значение по умолчанию — false — означает, что параметров выборки нет.
arSelectFields	Массив полей записей, которые вернет метод. Можно указать только необходимые поля. Если в массиве присутствует значение "", будут возвращены все доступные поля. Значение по умолчанию — пустой массив [] — означает, что будут выбраны поля ID, CODE, MEASURE_TITLE, SYMBOL_RUS, SYMBOL_INTL, SYMBOL_LETTER_INTL, IS_DEFAULT*.

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

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

Ключ	Описание
ID	Идентификатор записи единицы измерения.
CODE	Код единицы измерения.
MEASURE_TITLE	Название единицы измерения.
SYMBOL_RUS	Условное обозначение единицы измерения на русском языке.
SYMBOL_INTL	Международное условное обозначение единицы измерения.
SYMBOL_LETTER_INTL	Международное буквенное обозначение единицы измерения.
IS_DEFAULT	Признак единицы измерения по умолчанию. Возможные значения: Y или N.

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

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

<?php
$measureList = CCatalogMeasure::getList(
	["MEASURE_TITLE" => "ASC"],
	["IS_DEFAULT" => "Y"],
	false,
	["nTopCount" => 1],
	["ID", "CODE", "MEASURE_TITLE", "SYMBOL_INTL", "IS_DEFAULT"]
);

if ($measureList instanceof CCatalogMeasureResult)
{
	while ($measure = $measureList->Fetch())
	{
		echo $measure["MEASURE_TITLE"]." (".$measure["SYMBOL_INTL"].")<br>";
	}
}