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

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

Регистрация пользователя (клиентом самостоятельно)

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

 __construct ()
 
 getAcceptRequestMethod ()
 
- Открытые члены унаследованные от AbstractMethod
 __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 ()
 

Поля данных

 $use_post_keys = ['is_company', 'company', 'company_inn', 'fio', 'phone', 'e_mail', 'changepass', 'openpass', 'openpass_confirm', 'captcha', 'data']
 
 $user
 
- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = []
 
 $version
 
 $lang
 
 $params
 
 $context_virtual_app
 

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

 prepareDocComment ($text, $lang)
 
 process ($client_id, $client_secret, $user)
 
 checkApp ($client_id, $client_secret)
 
- Защищенные члены унаследованные от AbstractMethod
 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)
 

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

- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

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

__construct ( )

Методы

checkApp (   $client_id,
  $client_secret 
)
protected

Проверяет корректность параметров client_id и client_secret.

Аргументы
string$client_idУникальный идентификатор приложения, которое запрашивает авторизацию пользователя
string$client_secretСекретный ключ приложения, которое запрашивает авторизацию пользователя
Возвращает
Возвращает объект приложения
Исключения
ApiException
getAcceptRequestMethod ( )

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

Возвращает
array
prepareDocComment (   $text,
  $lang 
)
protected

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

Аргументы
string$text- комментарий
Возвращает
string
process (   $client_id,
  $client_secret,
  $user 
)
protected

Поля

$use_post_keys = ['is_company', 'company', 'company_inn', 'fio', 'phone', 'e_mail', 'changepass', 'openpass', 'openpass_confirm', 'captcha', 'data']

Поля, которые следует ожидать из POST

$user