Базовый класс для всех публичных методов API. Данный класс можно использовать в качестве базового, если метод API не требует авторизационный token.
Открытые члены | |
__construct () | |
run ($params, $version=null, $lang= 'ru') | |
getProcessFunctionName ($version) | |
getAcceptRequestMethod () | |
validateRights ($params, $version) | |
validateParams ($params, $version) | |
getInfo ($lang=null) | |
getSelfMethodName () | |
Поля данных | |
const | ALLOW_ALL_METHOD = 'all' |
const | BASE_VERSION = 1 |
const | DEFAULT_LANGUAGE = 'ru' |
$default_version | |
$method_params = [] | |
$version | |
$params | |
Защищенные члены | |
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) | |
Защищенные данные | |
$external_api_config | |
__construct | ( | ) |
|
protected |
Добавляет в сведения, отображаемые клиенту ссылку на документацию к текущему методу
\ExternalApi\Model\AbstractException | $api_exception |
getAcceptRequestMethod | ( | ) |
Возвращает какими методами могут быть переданы параметры для данного метода API
getInfo | ( | $lang = null | ) |
Возвращает информацию об имеющихся методах и их параметрах
mixed | $version |
|
protected |
Возвращает описание метода API, исходя из PHPDoc описания
string | $comment | полный PHPDoc комментарий к функции process... |
|
protected |
Возвращает пример вызова метода API
string | $comment | полный PHPDoc комментарий к функции process... |
|
protected |
Возвращает комментарий к результату метода API
string | $comment | полный PHPDoc комментарий к функции process... |
|
protected |
Возвращает комментарий к параметру API в формате HTML. Данный комментарий должен быть подписан
string | $comment | - полный PHPDoc комментарий к функции process... |
\ReflectionParameter | $param_name | - параметр функции process... |
|
protected |
Возвращает ожидаемый тип параметра API, исходя из комментария PHPDoc
string | $comment | - полный PHPDoc комментарий к функции process... |
\ReflectionParameter | $param_name | - параметр функции process... |
getProcessFunctionName | ( | $version | ) |
Возвращает имя метода(функции) соответствующего указанной версии, если таковой метод существует (processVerX), иначе возвращает имя метода предыдущей версии или имя функции по умолчанию (process)
string | $version | версия |
\ExternalApi\Model\Exception | - в случае если метод process не определен |
getSelfMethodName | ( | ) |
Возвращает идентификатор текущего метода API вместе с группой
|
protected |
Форматирует комментарий, полученный из PHPDoc
string | $text | - комментарий |
run | ( | $params, | |
$version = null , |
|||
$lang = 'ru' |
|||
) |
Запускает выполнение метода
array | $params | - параметры запроса |
string | $version | - версия АПИ |
string | $lang | - язык ответа |
validateParams | ( | $params, | |
$version | |||
) |
Проверяем, все ли обязательные параметры присутствуют. Если да, то возвращает массив параметров для вызова call_user_func_array
array | $params | |
array | $version |
\ExternalApi\Model\Exception |
validateRights | ( | $params, | |
$version | |||
) |
Проверяет права на выполнение данного метода
mixed | $version |
$default_version |
|
protected |
$method_params = [] |
$params |
$version |
const ALLOW_ALL_METHOD = 'all' |
const BASE_VERSION = 1 |
const DEFAULT_LANGUAGE = 'ru' |