Версия: 6.x
burger close
Открытые члены | Поля данных | Защищенные члены
Класс Save
Граф наследования:Save:
AbstractAuthorizedMethod AbstractMethod

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

Метод API - сохраняет заказ и/или возвращает рассчитанные стоимости

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

 __construct ()
 
 getRightTitles ()
 
 getOrderDataValidator ()
 
 getOrderItemValidator ()
 
 process ($token, $data, $refresh_mode)
 
- Открытые члены унаследованные от 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 ()
 

Поля данных

const RIGHT_CALCULATE = 1
 
const RIGHT_SAVE = 2
 
- Поля данных унаследованные от 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
 

Защищенные члены

 loadOrder ($data, $refresh_mode)
 
 validateMethodRights (Order $order)
 
 isTokenUserManager ()
 
 isTokenUserCourier ()
 
 prepareDocComment ($text, $lang)
 
 fillData ($data, $order)
 
 addAdminData (Order $order, $response)
 
 getCargosSection ($order)
 
 getShipmentsSection ($order)
 
 getFilesSection ($order)
 
 canFastResponse ()
 
 getDeliveryOrderSection (Order $order)
 
- Защищенные члены унаследованные от 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
 

Конструктор(ы)

__construct ( )

Методы

addAdminData ( Order  $order,
  $response 
)
protected

Добавляет данные, которые могут быть исключительно администраторам

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

Возвращает true, если в админ.панели существуют сообщения для быстрого ответа

Возвращает
bool
fillData (   $data,
  $order 
)
protected

Заполняет заказ данными

Аргументы
array$data
Order$order
Возвращает
void
getCargosSection (   $order)
protected

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

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

Возвращает секцию с информацией о заказах на доставку

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

Возвращает подготовленную секцию files с файлами со всеми правами

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

Возвращает допустимую структуру значений в переменной data, в которой будут содержаться сведения для обновления

Возвращает
ValidateArray
getOrderItemValidator ( )

Возвращает допустимую структуру значений в переменной data, в которой будут содержаться сведения для обновления

Возвращает
ValidateArray
getRightTitles ( )

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

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

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

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

Возвращает true, если текущий пользователь курьер

Возвращает
bool
isTokenUserManager ( )
protected

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

Возвращает
bool
loadOrder (   $data,
  $refresh_mode 
)
protected

Загружает или создает объект заказа

Аргументы
array$data
Возвращает
Order
Исключения
ApiException
prepareDocComment (   $text,
  $lang 
)
protected

Форматирует комментарий, полученный из PHPDoc

Аргументы
string$text- комментарий
Возвращает
string
process (   $token,
  $data,
  $refresh_mode 
)
validateMethodRights ( Order  $order)
protected

Проверяет права текущего пользователя на доступ к заказу

Аргументы
Order$order
Возвращает
void

Поля

const RIGHT_CALCULATE = 1
const RIGHT_SAVE = 2