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

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

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

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

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

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

- Защищенные члены унаследованные от AbstractGet
 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)
 
- Защищенные данные унаследованные от AbstractGet
 $object
 
- Защищенные данные унаследованные от AbstractAuthorizedMethod
 $token_require = true
 
 $token_param_name = 'token'
 
 $token
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

Методы

getOrmObject ( )

Возвращает ORM объект, который следует загружать

getRightTitles ( )

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

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

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

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

Поля

const RIGHT_COURIER = 2