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

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

Сохраняет сведения о распределении заказа по грузовым местам

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

 getRightTitles ()
 
 getCargoDataValidator ()
 
 getCargoItemsDataValidator ()
 
 prepareCargosData ($raw_data)
 
 process ($token, $order_id, $data)
 
- Открытые члены унаследованные от 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_SAVE = 'save'
 
- Поля данных унаследованные от 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
 

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

 prepareDocComment ($text, $lang)
 
- Защищенные члены унаследованные от 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
 

Методы

getCargoDataValidator ( )

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

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

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

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

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

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

Трансформирует входящий массив данных в формат, необходимый для метода saveCargos

Аргументы
array$raw_data
Возвращает
array
prepareDocComment (   $text,
  $lang 
)
protected

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

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

Поля

const RIGHT_SAVE = 'save'