getList

\Bitrix\Main\DB\Result public static
\Bitrix\Sale\Archive\Manager::getList(
	array $parameters = array()
);

Возвращает список архивных заказов по параметрам ORM-запроса. Статический метод.

Параметры

Параметр	Описание
`$parameters`	Параметры выборки. По умолчанию метод возвращает все скалярные поля архивных заказов без фильтра, сортировки и ограничения количества записей

Ключи массива $parameters

Ключ	Описание
`select`	Массив полей, которые нужно вернуть. Псевдоним поля указывают в ключе массива [ "ARCHIVE_ID" => "ID", "ORDER_ID", "DATE_ARCHIVED" ] Если ключ не передан, метод выбирает все скалярные поля архивного заказа
`filter`	Массив условий отбора или объект `\Bitrix\Main\ORM\Query\Filter\ConditionTree` [ "[оператор]FIELD_NAME" => "значение" ] Доступные операторы: без оператора или `=` — равно, `!` или `!=` — не равно, `>`, `<`, `>=`, `<=` — сравнение значений, `><` — значение входит в диапазон, `!><` — значение не входит в диапазон, `%` — строка содержит подстроку, `!%` — строка не содержит подстроку, `@` — значение входит в переданный массив, `!@` — значение не входит в переданный массив. Условия можно объединять во вложенные группы. Ключ `LOGIC` задает связь `AND`, `OR` или `NOT`. Пустой фильтр не ограничивает выборку.
`group`	Массив полей для группировки результата [ "USER_ID", "CURRENCY" ] Если ключ не передан или массив пуст, метод не группирует записи
`order`	Массив полей и направлений сортировки [ "DATE_ARCHIVED" => "DESC", "ID" => "ASC" ] Направления сортировки: `ASC` — по возрастанию, `DESC` — по убыванию. Метод применяет поля последовательно в порядке элементов массива. Если ключ не передан, результат не имеет заданной сортировки.
`limit`	Максимальное количество записей в результате. Если ключ не передан, количество записей не ограничено
`offset`	Количество записей, которые нужно пропустить от начала выборки. Если ключ не передан, метод начинает выборку с первой записи
`count_total`	Значение `true` включает подсчет общего количества записей без учета `limit` и `offset`. Количество возвращает метод `getCount()` объекта результата. По умолчанию подсчет отключен
`runtime`	Массив полей, которые ORM создает на время запроса. В ключе указывают имя поля, в значении — описание поля или объект поля
`data_doubling`	Логическое значение, которое включает или отключает обработку дублирования данных при фильтрации по связям
`private_fields`	Логическое значение, которое разрешает или запрещает использовать приватные поля ORM-объекта
`cache`	Настройки кеширования запроса. [ "ttl" => 3600, "cache_joins" => true ] Ключ `ttl` задает время хранения результата в секундах. Ключ `cache_joins` разрешает кешировать запросы с объединениями таблиц. По умолчанию время хранения равно нулю, а кеширование объединений отключено

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

Метод возвращает объект \Bitrix\Main\ORM\Query\Result, наследник \Bitrix\Main\DB\Result. Метод fetch() последовательно возвращает архивные заказы в виде ассоциативных массивов. После окончания выборки fetch() возвращает false.

Если параметр select не передан, каждая запись содержит перечисленные ниже поля архивного заказа.

Ключ	Описание
`ID`	Целое число. Идентификатор записи архивного заказа
`LID`	Строка. Идентификатор сайта заказа
`ORDER_ID`	Целое число. Идентификатор исходного заказа
`ACCOUNT_NUMBER`	Строка. Номер заказа
`USER_ID`	Строка. Идентификатор пользователя, которому принадлежит заказ
`PERSON_TYPE_ID`	Строка. Идентификатор типа плательщика заказа
`STATUS_ID`	Строка. Идентификатор статуса заказа
`PAYED`	Строка `Y` или `N`. Признак оплаты заказа
`DEDUCTED`	Строка `Y` или `N`. Признак отгрузки заказа
`CANCELED`	Строка `Y` или `N`. Признак отмены заказа
`PRICE`	Число. Стоимость заказа
`SUM_PAID`	Число. Оплаченная сумма
`CURRENCY`	Строка. Код валюты заказа
`VERSION`	Целое число. Версия формата архивной записи
`XML_ID`	Целое число. Внешний идентификатор заказа
`ID_1C`	Целое число. Идентификатор заказа в 1С
`DATE_ARCHIVED`	Объект `\Bitrix\Main\Type\DateTime`. Дата архивации заказа
`DATE_INSERT`	Объект `\Bitrix\Main\Type\DateTime`. Дата создания заказа
`RESPONSIBLE_ID`	Целое число. Идентификатор ответственного за заказ
`COMPANY_ID`	Целое число. Идентификатор компании заказа
`ORDER_DATA`	Строка. Сериализованные данные заказа

Исключения

\Bitrix\Main\ArgumentException — передан неизвестный ключ параметров, недопустимое направление сортировки или некорректное описание поля,
\Bitrix\Main\ObjectPropertyException — ORM не может получить свойство объекта,
\Bitrix\Main\SystemException — ORM не может построить или выполнить запрос.

Пример

<?php
use Bitrix\Main\ArgumentException;
use Bitrix\Main\Loader;
use Bitrix\Main\ObjectPropertyException;
use Bitrix\Main\SystemException;
use Bitrix\Sale\Archive\Manager;

if (!Loader::includeModule('sale'))
{
	echo 'Модуль sale не установлен';
	return;
}

// Идентификатор пользователя, архивные заказы которого нужно получить
$userId = 1;

try
{
	$archivedOrders = Manager::getList([
		'select' => [
			'ID',
			'ORDER_ID',
			'ACCOUNT_NUMBER',
			'DATE_ARCHIVED',
		],
		'filter' => [
			'=USER_ID' => $userId,
		],
		'order' => [
			'DATE_ARCHIVED' => 'DESC',
		],
		'limit' => 10,
	]);

	while ($archivedOrder = $archivedOrders->fetch())
	{
		print_r($archivedOrder);
	}
}
catch (ArgumentException | ObjectPropertyException | SystemException $exception)
{
	echo $exception->getMessage();
}

Пользовательские комментарии

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх