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

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

Абстрактный класс для API обновления объектов

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

 getRightTitles ()
 
 getUpdateDataScheme ()
 
 getUpdateDataValidator ()
 
 getOrmObject ()
 
 validateData ($data)
 
 updateData ($orm_object, $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_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 = []
 
 $version
 
 $lang
 
 $params
 
 $context_virtual_app
 

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

 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)
 
 getMethodFullComment ($comment, $lang)
 
 getMethodReturnComment ($comment, $lang)
 
 getMethodExample ($comment, $lang)
 

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

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

Методы

getOrmObject ( )
abstract

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

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

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

Возвращает
[ КОД => КОММЕНТАРИЙ, КОД => КОММЕНТАРИЙ, ... ]
getUpdateDataScheme ( )
abstract
getUpdateDataValidator ( )
loadObject (   $orm_object,
  $object_id 
)
protected

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

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

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

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

put your comment there...

Аргументы
mixed$token
mixed$object_id
mixed$data
updateData (   $orm_object,
  $data 
)

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

Аргументы
\RS\Orm\AbstractObject$orm_object- объект обновления
array$data- данные для обновления
Возвращает
void
validateData (   $data)

Валидирует значения для обновления

Аргументы
array$data
Возвращает
Возвращает true,

Поля

$data_field = 'fields'
$orm_object
const RIGHT_UPDATE = 1