Версия: 6.x
burger close
Класс Protocol
Граф наследования:Protocol:
AbstractMethod

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

Возвращает протокол, по которому следует работать с API.

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

 getAcceptRequestMethod ()
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName ($version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

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

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

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

- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = []
 
 $version
 
 $params
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

Методы

getAcceptRequestMethod ( )

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

Возвращает
array
process ( )
protected