Версия: 6.x
burger close
Класс Get
Граф наследования:Get:
AbstractAuthorizedMethod AbstractMethod

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

Класс метода API для получения информации по одному заказу на доставку

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

 getRightTitles ()
 
 process ($token, $delivery_order_id)
 
- Открытые члены унаследованные от AbstractAuthorizedMethod
 validateRights ($params, $version)
 
 checkAccessError ($rights)
 
 hasRights ($rights)
 
 getRunRights ()
 
 getRightTitles ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getToken ()
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 setContextVirtualApp (VirtualApp|null $virtual_app)
 
 getContextVirtualApp ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName (&$version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

Открытые статические члены

static getDeliveryOrderData (DeliveryOrder $delivery_order, InterfaceDeliveryOrder $delivery_type_object, $detail_mode=true)
 
static getDeliveryTypeByOrder (Order $order)
 
static getDeliveryTypeByDeliveryOrderId ($delivery_order_id)
 

Поля данных

const RIGHT_LOAD = 1
 
- Поля данных унаследованные от AbstractAuthorizedMethod
 $token_is_invalid = false
 
- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = []
 
 $version
 
 $lang
 
 $params
 
 $context_virtual_app
 

Дополнительные унаследованные члены

- Защищенные члены унаследованные от AbstractMethod
 addMethodHelpUrlToException (\ExternalApi\Model\AbstractException $api_exception)
 
 getParamComment ($comment, $param, $lang)
 
 prepareDocComment ($text, $lang)
 
 getParamType ($comment, $param)
 
 getMethodComment ($comment, $lang)
 
 getMethodFullComment ($comment, $lang)
 
 getMethodReturnComment ($comment, $lang)
 
 getMethodExample ($comment, $lang)
 
- Защищенные данные унаследованные от AbstractAuthorizedMethod
 $token_require = true
 
 $token_param_name = 'token'
 
 $token
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

Методы

static getDeliveryOrderData ( DeliveryOrder  $delivery_order,
InterfaceDeliveryOrder  $delivery_type_object,
  $detail_mode = true 
)
static

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

Аргументы
DeliveryOrder$delivery_order
TraitInterfaceDeliveryOrder$delivery_type_object
bool$detail_modeЕсли true, то возвращает более подробную информацию о возможных действиях с заказом
Возвращает
array
static getDeliveryTypeByDeliveryOrderId (   $delivery_order_id)
static

Возвращает тип доставки, поддерживающий оформление заказов

Аргументы
Order$order
Возвращает
array
static getDeliveryTypeByOrder ( Order  $order)
static

Возвращает тип доставки, поддерживающий оформление заказов

Аргументы
Order$order
Возвращает
AbstractType|InterfaceDeliveryOrder|TraitInterfaceDeliveryOrder
getRightTitles ( )

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

Возвращает
[ КОД => КОММЕНТАРИЙ, КОД => КОММЕНТАРИЙ, ... ]
process (   $token,
  $delivery_order_id 
)

Поля

const RIGHT_LOAD = 1