Документация для разработчиков
Темная тема

GetList

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

CDBResult
CSaleDeliveryHandler::GetList(
array arSort = array("SORT" => "ASC"),
 array arFilter = array()
);

Метод возвращает список обработчиков автоматизированных служб доставки, для которых установлены настройки в БД. Метод статический.

Примечание: метод устарел и не рекомендуется к использованию. Вместо него следует использовать методы класса \Bitrix\Sale\Delivery\Services\Base.

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

Параметр Описание
arSort Массив, в соответствии с которым сортируются результирующие записи. Массив имеет вид:
array("параметр_сортировки" => "направление_сортировки" [, ...])

В качестве параметра сортировки может выступать одно из следующих значений:

  • SORT - параметр "сортировка";
  • NAME - наименования службы доставки;
  • SID - строковой идентификатор службы доставки;
  • HANDLER - путь к обработчику службы доставки;
  • ACTIVE - флаг активности службы доставки.

В качестве "направление_сортировки" могут быть значения "ASC" (по возрастанию) и "DESC" (по убыванию).

Значение по умолчанию - массив array("SORT" => "ASC") - означает, что результат будет отсортирован по возрастанию.
arFilter Массив, в соответствии с которым фильтруются записи службы доставки.
Массив имеет вид:
array("фильтруемое_поле"=>"значения_фильтра" [, ...])
"фильтруемое_поле" может принимать значения:
  • ACTIVE - фильтр по активности (Y|N); передача значения "ACTIVE"=>"ALL" выводит все элементы без учета их состояния;
    по умолчанию выводятся только активные элементы;
  • SITE_ID - по сайту; ; передача значения "SITE_ID"=>"ALL" выводит настройки для всех сайтов;
    по умолчанию получаются настройки службы доставки только для текущего сайта;
  • SID - по строковому идентификатору обработчика;
  • HANDLER - фильтр по части пути к файлу обработчика.
  • COMPABILITY - проверка совместимости обработчика с параметрами заказа;
    значение должно быть массивом данных по заказу следующей структуры:
    • WEIGHT - суммарный вес заказа;
    • PRICE - суммарная стоимость заказа;
    • LOCATION_FROM - ID местоположения магазина (устанавливается в настройках модуля);
    • LOCATION_TO - ID местоположения, указанному при оформлении заказа.
Значение по умолчанию - пустой массив array() - означает, что результат отфильтрован не будет.

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

Возвращается объект класса CDBResult, содержащий записи следующей структуры:

Ключ Описание
SID Строковой идентификатор обработчика доставки.
NAME Наименование службы доставки.
DESCRIPTION Описание службы доставки.
DESCRIPTION_INNER "Внутреннее" описание функционала обработчика службы доставки.
LID Идентификатор сайта, для которого установлены настройки.
ACTIVE Флаг активности службы доставки.
SORT Значение параметра сортировки для данной службы доставки.
BASE_CURRENCY Идентификатор валюты, в которой работает обработчик службы доставки.
TAX_RATE Значение наценки, автоматически добавляемой к стоимости доставки (%).
HANDLER Путь к файлу обработчика доставки.
DBSETSETTINGS callback к методу обработчика, обеспечивающему сохранение массива настроек в БД.
DBGETSETTINGS callback к методу обработчика, обеспечивающему получение массива настроек из БД.
GETCONFIG callback к методу обработчика, возвращающему список настроек обработчика.
COMPATIBILITY callback к методу обработчика, осуществляющему проверку применимости обработчика к заказу.
CALCULATE callback к методу обработчика, осуществляющему расчёт стоимости доставки.
PROFILES Массив профилей обработки доставки. Представляет собой ассоциативный массив вида:
Array
(
	"строковый_идентификатор_профиля" => Array
		(
			"TITLE" => "название_профиля",
			"DESCRIPTION" => "описание_профиля",
			"RESTRICTIONS_WEIGHT" => Array
				(
					/* ограничения обработчика по весу */
				),

			"RESTRICTIONS_SUM" => Array
				(
					/* ограничения обработчика по стоимости */
				),

			"ACTIVE" => "флаг_активности_профиля",
		),
/* ................... */
)
CONFIG Массив настроек обработчика доставки со значениями. Подробнее см. Руководство по созданию автоматизированных обработчиков доставки.
PROFILE_USE_DEFAULT Значение флага "используются параметры профилей по умолчанию" (Y|N).

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


CModule::IncludeModule('sale');

$dbResult = CSaleDeliveryHandler::GetList(
  array(
    'SORT' => 'ASC', 
    'NAME' => 'ASC'
  ), 
  array(
    'ACTIVE' => 'Y'
  )
);
echo '<ul>';
while ($arResult = $dbResult->GetNext())
{
  echo '<li>('.$arResult['SID'].') <b>'.$arResult['NAME'].'</b><br />'; 
  echo '<small>'.$arResult['DESCRIPTION'].'</small></li>';
}
echo '</ul>';


© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх