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

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

Авторизация, поддерживающая однофакторный и двухфакторный формат, по логину(Email или Логин или Телефон) + паролю или только по номеру телефона.

Открытые члены
	getAcceptRequestMethod ()

Открытые члены унаследованные от AbstractMethod
	__construct ()

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

	getProcessFunctionName ($version)

	getAcceptRequestMethod ()

	validateRights ($params, $version)

	validateParams ($params, $version)

	getInfo ($lang=null)

	getSelfMethodName ()

Открытые статические члены
static	makeResponseVerificationSessionData (VerificationSession $verify_session)

static	makeResponseUserData (User $user)

static	makeResponseAuthTokenData (AuthorizationToken $token)

Поля данных
	$remember = true

Поля данных унаследованные от AbstractMethod
const	ALLOW_ALL_METHOD = 'all'

const	BASE_VERSION = 1

const	DEFAULT_LANGUAGE = 'ru'

	$default_version

	$method_params = []

	$version

	$params

Защищенные члены
	process ($client_id, $client_secret, $login=null, $password=null, $phone=null, $grant_type= 'password')

	checkApp ($client_id, $client_secret)

	authByLogin ($login, $password, $client_id)

	authByPhone ($phone, $client_id)

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

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

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

Методы

authByLogin	(	$login,
		$password,
		$client_id
	)

protected

Пытается авторизовать пользователя по логину и паролю. Возвращает объект пользователя или верификационную сессию, если включена друхфакторная авторизация

Аргументы

string	$login
string	$password
string	$client_id

Возвращает: User|VerificationSession

Исключения

ApiException

authByPhone	(	$phone,
		$client_id
	)

protected

Пытается авторизовать пользователя по номеру телефона

Аргументы

string	$phone
string	$client_id

Возвращает: VerificationSession Возвращает верификационную сессию

Исключения

ApiException

checkApp	(	$client_id,
		$client_secret
	)

protected

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

Аргументы

string	$client_id	Уникальный идентификатор приложения, которое запрашивает авторизацию пользователя
string	$client_secret	Секретный ключ приложения, которое запрашивает авторизацию пользователя

Возвращает: Возвращает объект приложения

Исключения

ApiException

getAcceptRequestMethod ( )

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

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

static makeResponseAuthTokenData ( AuthorizationToken $token )

static

Подготавливает секцию информации об авторизационном токене

Аргументы

AuthorizationToken $token Авторизационный токен

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

static makeResponseUserData ( User $user )

static

Подготавливает секцию информации о пользователе для объекта пользователя

Аргументы

User $user Пользователь

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

static makeResponseVerificationSessionData ( VerificationSession $verify_session )

static

Подготавливает секцию верификационной сессии для возврата через API

Аргументы

VerificationSession $verify_session объект верификационной сессии

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

process	(	$client_id,
		$client_secret,
		$login = `null`,
		$password = `null`,
		$phone = `null`,
		$grant_type = `'password'`
	)

protected

Поля

$remember = true

$users_module_config

protected

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

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

Открытые статические члены

Поля данных

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

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

Методы

Поля