Метод API, требующий авторизационный токен token с необходимым набором прав для выполнения
Открытые члены | |
validateRights ($params, $version) | |
checkAccessError ($rights) | |
getRunRights () | |
getRightTitles () | |
run ($params, $version=null, $lang= 'ru') | |
getToken () | |
Открытые члены унаследованные от AbstractMethod | |
__construct () | |
run ($params, $version=null, $lang= 'ru') | |
getProcessFunctionName ($version) | |
getAcceptRequestMethod () | |
validateRights ($params, $version) | |
validateParams ($params, $version) | |
getInfo ($lang=null) | |
getSelfMethodName () | |
Поля данных | |
$token_is_invalid = false | |
Поля данных унаследованные от AbstractMethod | |
const | ALLOW_ALL_METHOD = 'all' |
const | BASE_VERSION = 1 |
const | DEFAULT_LANGUAGE = 'ru' |
$default_version | |
$method_params = [] | |
$version | |
$params | |
Защищенные данные | |
$token_require = true | |
$token_param_name = 'token' | |
$token | |
Защищенные данные унаследованные от AbstractMethod | |
$external_api_config | |
Дополнительные унаследованные члены | |
Защищенные члены унаследованные от 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) | |
checkAccessError | ( | $rights | ) |
Проверяет наличие у token'а отдельных необходимых прав
integer | array | $rights | - Одно или несколько прав. Проверка будет происходить с помощью ИЛИ |
|
abstract |
Возвращает комментарии к кодам прав доступа
getRunRights | ( | ) |
Возвращает список прав, требуемых для запуска метода API По умолчанию для запуска метода нужны все права, что присутствуют в методе
getToken | ( | ) |
Возвращает объект авторизационного токена, если он есть
run | ( | $params, | |
$version = null , |
|||
$lang = 'ru' |
|||
) |
Запускает выполнение метода
array | $params | - параметры запроса |
string | $version | - версия АПИ |
string | $lang | - язык ответа |
validateRights | ( | $params, | |
$version | |||
) |
Проверяет права на выполнение данного метода. Метод может быть вызван, если на него есть права у пользователя (чей токен передается) или в настройках модуля ExternalAPI, также приложение, к которому привязан токен должно обладать правами на запрашиваемый метод API
array | $params | - параметры запроса |
string | $version | - версия приложения |
ApiException |
|
protected |
$token_is_invalid = false |
|
protected |
|
protected |
Если указать false, то token можно принимать опционально, чтобы давать в определенных случаях больше прав для вызова данного метода