Версия: 6.x
burger close
Открытые члены
Интерфейс InterfaceDeliveryOrder
Граф наследования:InterfaceDeliveryOrder:
Cdek2

Подробное описание

Интерфейс работы с заказами на доставку Используется вместе с трейтом Shop

Открытые члены

 getDeliveryOrderActions (DeliveryOrder $delivery_order)
 
 executeInterfaceDeliveryOrderAction (HttpRequest $http_request, Order $order, string $action)
 
 createDeliveryOrder (Order $order)
 
 deleteDeliveryOrder (DeliveryOrder $delivery_order)
 
 refreshDeliveryOrder (DeliveryOrder $delivery_order)
 
 getDeliveryOrderDataLines (DeliveryOrder $delivery_order)
 
 getDeliveryOrderTrackNumber (DeliveryOrder $delivery_order)
 
 getDeliveryOrderList (Order $order)
 
 getDeliveryOrderAdminDeliveryParamsHtml (Order $order)
 

Методы

createDeliveryOrder ( Order  $order)

Создаёт заказ на доставку

Аргументы
Order$order- объект заказа
Возвращает
DeliveryOrder
Исключения
ShopException

Замещается в Cdek2.

deleteDeliveryOrder ( DeliveryOrder  $delivery_order)

Удаляет заказ на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
void
Исключения
ShopException

Замещается в Cdek2.

executeInterfaceDeliveryOrderAction ( HttpRequest  $http_request,
Order  $order,
string  $action 
)

Исполняет действие интерфейса заказов на доставку При успехе - возвращает инструкции для вывода результата, при неудаче - бросает исключение

Инструкция для вывода результата - это массив ключ=>значение, в котором тип отображения результата указывается в ключе 'view_type' (message|form|html|output) [ 'view_type' => 'message' - показ текстового уведомления 'message' => (string) текст сообщения ]; [ 'view_type' => 'form' - отображение формы 'title' => (string) заголовок формы 'assign' => (array) переменные, которые будут переданы в шаблон 'template' => (string) шаблон тела формы 'bottom_toolbar' => () нижняя панель действий формы ]; [ 'view_type' => 'html' - возврат чистого html 'html' => (string) возвращаемый html ]; [ 'view_type' => 'output' - возврат содержимого без обёртки в ResultStandard (используется для отображения файлов) 'content' => (string) текст сообщения ];

Аргументы
HttpRequest$http_request- объект запроса
Order$order- объект заказа
string$action- идентификатор действия
Возвращает
array
Исключения
ShopException

Замещается в Cdek2.

getDeliveryOrderActions ( DeliveryOrder  $delivery_order)

Возвращает список дополнительных действий, доступных для указанного заказа на доставку Каждое "действие" в списке имеет следующую структуру: [ 'title' => (string) текст на кнопке 'class' => (string) стилизующие css классы (например, 'btn-primary btn-alt') 'action' => (string) идентификатор действия который будет передан в метод executeInterfaceDeliveryOrderAction() 'attributes' => (array) дополнительные html аттрибуты (например, ['target' => '_blank']), 'view_type' => (string) что будет получено в результате успешного выполнения действия, одно из значений: message (сообщение), form (HTML с формой), html (произвольный HTML), output (прямой вывод данных или печатная форма) ]

Аргументы
DeliveryOrder$delivery_order- объект заказка на доставку
Возвращает
array

Замещается в Cdek2.

getDeliveryOrderAdminDeliveryParamsHtml ( Order  $order)

Возвращает HTML для управления заказами на доставку в админке

Аргументы
Order$order- заказ
Возвращает
string
getDeliveryOrderDataLines ( DeliveryOrder  $delivery_order)

Возвращает список данных заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
array

Замещается в Cdek2.

getDeliveryOrderList ( Order  $order)

Возвращает список заказов на доставку

Аргументы
Order$order- заказ
Возвращает
DeliveryOrder[]
getDeliveryOrderTrackNumber ( DeliveryOrder  $delivery_order)

Возвращает трек-номер указанного заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
string|null

Замещается в Cdek2.

refreshDeliveryOrder ( DeliveryOrder  $delivery_order)

Обновляет данные заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
void
Исключения
ShopException

Замещается в Cdek2.