Граф наследования:AbstractMethod:

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

Базовый класс для всех публичных методов API. Данный класс можно использовать в качестве базового, если метод API не требует авторизационный token.

Открытые члены
	__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	ALLOW_ALL_METHOD = 'all'

const	BASE_VERSION = 1

const	DEFAULT_LANGUAGE = 'ru'

	$default_version

	$method_params = []

	$version

	$lang

	$params

	$context_virtual_app

Защищенные члены
	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)

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

Конструктор(ы)

__construct ( )

Методы

addMethodHelpUrlToException ( \ExternalApi\Model\AbstractException $api_exception )

protected

Добавляет в сведения, отображаемые клиенту ссылку на документацию к текущему методу

Аргументы

\ExternalApi\Model\AbstractException $api_exception

Возвращает

getAcceptRequestMethod ( )

Возвращает какими методами могут быть переданы параметры для данного метода API

Возвращает: array

getContextVirtualApp ( )

Возвращает объект виртуального приложения или null, если метод запущен в стандартном контексте

Возвращает: VirtualApp|null

getInfo ( $lang = null )

Возвращает информацию об имеющихся методах и их параметрах

Аргументы

mixed $version

Возвращает: [ "1.0": [ [ "name" => '', "type" => '', "default_value" => '', "comment" => '' ] ]

getMethodComment	(	$comment,
		$lang
	)

protected

Возвращает короткое описание метода API, исходя из PHPDoc описания. Коротким считается описание до знаков "---"

Аргументы

string	$comment	полный PHPDoc комментарий к функции process...
string	$lang	Идентификатор языка

Возвращает: string | null

getMethodExample	(	$comment,
		$lang
	)

protected

Возвращает пример вызова метода API

Аргументы

string $comment полный PHPDoc комментарий к функции process...

Возвращает: string

getMethodFullComment	(	$comment,
		$lang
	)

protected

Возвращает полное описание метода API, исходя из PHPDoc описания

Аргументы

string	$comment	полный PHPDoc комментарий к функции process...
string	$lang	Идентификатор языка

Возвращает: string|null

getMethodReturnComment	(	$comment,
		$lang
	)

protected

Возвращает комментарий к результату метода API

Аргументы

string $comment полный PHPDoc комментарий к функции process...

Возвращает: string

getParamComment	(	$comment,
		$param,
		$lang
	)

protected

Возвращает комментарий к параметру API в формате HTML. Данный комментарий должен быть подписан

Аргументы

string	$comment	- полный PHPDoc комментарий к функции process...
\ReflectionParameter	$param_name	- параметр функции process...

Возвращает: string | null

getParamType	(	$comment,
		$param
	)

protected

Возвращает ожидаемый тип параметра API, исходя из комментария PHPDoc

Аргументы

string	$comment	- полный PHPDoc комментарий к функции process...
\ReflectionParameter	$param_name	- параметр функции process...

Возвращает: string | null

getProcessFunctionName ( & $version )

Возвращает имя метода(функции) соответствующего указанной версии, если таковой метод существует (processVerX), иначе возвращает имя метода предыдущей версии или имя функции по умолчанию (process)

Аргументы

string $version версия. Корректируется после выполнения метода

Возвращает: string - имя метода

Исключения

\ExternalApi\Model\Exception - в случае если метод process не определен

getSelfMethodName ( )

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

Возвращает: string

prepareDocComment	(	$text,
		$lang
	)

protected

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

Аргументы

string $text - комментарий

Возвращает: string

run	(	$params,
		$version = `null`,
		$lang = `'ru'`
	)

Запускает выполнение метода

Аргументы

array	$params	- параметры запроса
string	$version	- версия АПИ
string	$lang	- язык ответа

Возвращает: mixed

setContextVirtualApp ( VirtualApp|null $virtual_app )

Устанавливает виртуальное приложение, в контексте которого происходит запуск метода

Аргументы

VirtualApp | null $virtual_app

Возвращает: void

validateParams	(	$params,
		$version
	)

Проверяем, все ли обязательные параметры присутствуют. Если да, то возвращает массив параметров для вызова call_user_func_array

Аргументы

array	$params
string	$version

Возвращает: array

Исключения

\ExternalApi\Model\Exception

validateRights	(	$params,
		$version
	)

Проверяет права на выполнение данного метода

Аргументы

mixed $version

Поля

$context_virtual_app

$default_version

$external_api_config

protected

$lang

$method_params = []

$params

$version

const ALLOW_ALL_METHOD = 'all'

const BASE_VERSION = 1

const DEFAULT_LANGUAGE = 'ru'

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

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

Поля данных

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

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

Конструктор(ы)

Методы

Поля