GetList
Описание и параметры
CDBResult CSaleOrderUserPropsValue::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( "USER_PROPS_ID" => 120 )Этот фильтр означает "выбрать все записи, в которых значение в поле USER_PROPS_ID (код профиля покупателя) равно 120". Значение по умолчанию - пустой массив array() - означает, что результат отфильтрован не будет. Важно! Если результат фильтровать не нужно, то пустой массив фильтра надо передать обязательно. Это требуется из-за наследия старого API.
|
arGroupBy | Массив полей, по которым группируются записи
значений свойств профилей покупателя. Массив имеет вид:
array( "название_поля1", "группирующая_функция2" => "название_поля2", ... )В качестве "название_поляN" может стоять любое поле значений свойств профилей покупателя. В качестве группирующей функции могут стоять:
Значение по умолчанию - false - означает, что результат группироваться не будет. |
arNavStartParams | Массив параметров выборки. Может содержать следующие ключи:
|
arSelectFields | Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение
"*", то будут возвращены все доступные поля. Значение по умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса. |
Возвращаемые значения
Возвращается объект класса CDBResult, содержащий ассоциативные массивы параметров свойств с ключами:
Ключ | Описание |
---|---|
ID | Код свойства профиля покупателя. |
USER_PROPS_ID | Код профиля покупателя. |
ORDER_PROPS_ID | Код свойства заказа. |
USER_VALUE_NAME | Название свойства заказа, сохраненное в профиле покупателя. |
VALUE | Значение свойства заказа, сохраненное в профиле покупателя. |
TYPE | Тип свойства заказа. |
SORT | Индекс сортировки свойства заказа. |
VARIANT_NAME | Название варианта значения свойства заказа со значением из профиля покупателя. |
CODE | Символьный код свойства заказа. |
Если в качестве параметра arGroupBy передается пустой массив, то метод вернет число записей, удовлетворяющих фильтру.
Пример использования
// Выведем все свойства профиля покупателя с кодом $ID $db_propVals = CSaleOrderUserPropsValue::GetList(array("ID" => "ASC"), Array("USER_PROPS_ID"=>$ID)); while ($arPropVals = $db_propVals->Fetch()) { echo $arPropVals["USER_VALUE_NAME"]."=".$arPropVals["VALUE"]."<br>"; }
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.