Версия: 5.x
Класс Update
Граф наследования:Update:
AbstractUpdate AbstractAuthorizedMethod AbstractMethod

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

Сохраняет изменения в заказе

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

 getRightTitles ()
 
 getRunRights ()
 
 getUpdateDataScheme ()
 
 getOrmObject ()
 
 updateData ($orm_object, $data)
 
 onCashPayment ($orm_object)
 
- Открытые члены унаследованные от AbstractUpdate
 getRightTitles ()
 
 getUpdateDataScheme ()
 
 getUpdateDataValidator ()
 
 getOrmObject ()
 
 validateData ($data)
 
 updateData ($orm_object, $data)
 
- Открытые члены унаследованные от AbstractAuthorizedMethod
 validateRights ($params, $version)
 
 checkAccessError ($rights)
 
 getRunRights ()
 
 getRightTitles ()
 
 run ($params, $version=null, $lang= 'ru')
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName ($version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

Поля данных

const RIGHT_UPDATE = 1
 
const RIGHT_UPDATE_COURIER = 2
 
- Поля данных унаследованные от AbstractUpdate
const RIGHT_UPDATE = 1
 
 $data_field = 'fields'
 
 $orm_object
 
- Поля данных унаследованные от AbstractAuthorizedMethod
 $token_is_invalid = false
 
- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = array()
 
 $version
 
 $params
 

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

 loadObject ($orm_object, $object_id)
 
 onToucanPayment ($orm_object)
 
 process ($token, $order_id, $data)
 
- Защищенные члены унаследованные от AbstractUpdate
 prepareDocComment ($text, $lang)
 
 loadObject ($orm_object, $object_id)
 
 process ($token, $object_id, $data)
 
- Защищенные члены унаследованные от AbstractMethod
 addMethodHelpUrlToException (\ExternalApi\Model\AbstractException $api_exception)
 
 getParamComment ($comment, $param, $lang)
 
 prepareDocComment ($text, $lang)
 
 getParamType ($comment, $param)
 
 getMethodComment ($comment, $lang)
 
 getMethodReturnComment ($comment, $lang)
 
 getMethodExample ($comment, $lang)
 

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

- Защищенные данные унаследованные от AbstractAuthorizedMethod
 $token_require = true
 
 $token_param_name = 'token'
 
 $token
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

Методы

getOrmObject ( )

Возвращает объект, который необходимо обновить

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

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

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

Возвращает список прав, требуемых для запуска метода API По умолчанию для запуска метода нужны все права, что присутствуют в методе

Возвращает
[код1, код2, ...]
getUpdateDataScheme ( )

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

Возвращает
array
loadObject (   $orm_object,
  $object_id 
)
protected

Загружает объект из БД по ID

Аргументы
\RS\Orm\AbstractObject$orm_object
integer$object_id
Исключения
ExternalApi
Возвращает
void
onCashPayment (   $orm_object)

Вызывается в случае, если администратор или курьер нажимает на кнопку "Оплатить", при выбранном способе оплаты наличными.

Аргументы
\Shop\Model\Orm\Order$orm_object
onToucanPayment (   $orm_object)
protected

Вызывается в случае, если оплата происходит через сервис 2can. Добавляет сведения о транзакции к заказу

Аргументы
\Shop\Model\Orm\Order$orm_object
mixed$data
Возвращает
void
process (   $token,
  $order_id,
  $data 
)
protected
updateData (   $orm_object,
  $data 
)

Обновляет данные

Аргументы
\Shop\Model\Orm\Order$orm_object
array$data

Поля

const RIGHT_UPDATE = 1
const RIGHT_UPDATE_COURIER = 2