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

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

Класс метода API для выполнения действий с заказом на доставку

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

 getRightTitles ()
 
 process ($token, $delivery_order_id, $action)
 
- Открытые члены унаследованные от 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 signParams ($params)
 

Поля данных

const RIGHT_RUN_ACTION = 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
 

Методы

getRightTitles ( )

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

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

Выполняет действие с заказом на доставку

Поддерживается выполнение действий расчетного класса, не требующих ввода дополнительных параметров, т.е. действия с view_type = message или output

Аргументы
string$tokenАвторизационный токен
integer$delivery_order_idID Заказа на доставку
string$actionТип действия. Может принимать одно из следующих значений:
  • refresh - обновить данные о заказе на доставку на сайте без изменений на стороне доставке
  • change - обновить данные о заказе на доставку на стороне сервиса доставки
  • delete - удалить заказ на доставку Также параметр может принимать одно из значений, которые определяет расчетный класс доставки. Список таких действий будет возвращет в методе deliveryOrder.get в поле actions.action
  • ... другие
Возвращает
array
static signParams (   $params)
static

Возвращает подпись URL-адреса для выполнения действий с заказом на доставку

Аргументы
array$params
Возвращает
string

Поля

const RIGHT_RUN_ACTION = 1