Версия: 5.x
Класс AbstractGet
Граф наследования:AbstractGet:
AbstractAuthorizedMethod AbstractMethod Get Get Get Get Get Get GetOffersList GetRecommendedList Get Get Get Get

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

Абстрактный класс для загрузки одного объекта

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

 getRightTitles ()
 
 getOrmObject ()
 
 getObjectSectionName ()
 
- Открытые члены унаследованные от 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_LOAD = 1
 
- Поля данных унаследованные от 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
 

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

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

Защищенные данные

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

Методы

getObjectSectionName ( )

Возвращает название секции ответа, в которой должен вернуться объект

Возвращает
string
getOrmObject ( )
abstract

Возвращает какой объект нужно загружать

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

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

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

Загружает объект по ID

Аргументы
string$tokenАвторизационный токен
integer$object_idID объекта
Исключения
ApiException
Возвращает
array Возвращает значения свойств объекта

Поля

$object
protected
const RIGHT_LOAD = 1

Право на загрузку объекта