Класс AuthCode

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

Открытые члены
	confirmAction ($code, $signedData)
	loginByOtpAction ($otp, $captchaSid="", $captchaWord="")
	configureActions ()
Открытые члены унаследованные от Controller
	__construct (Request $request=null)
	forward ($controller, string $actionName, array $parameters=null)
	getConfigurationOfActions ()
	getModuleId ()
	isLocatedUnderPsr4 ()
	getActionUri (string $actionName, array $params=[], bool $absolute=false)
	getUnsignedParameters ()
	getCurrentUser ()
	setCurrentUser (CurrentUser $currentUser)
	convertKeysToCamelCase ($data)
	listNameActions ()
	getAutoWiredParameters ()
	getPrimaryAutoWiredParameter ()
	getDefaultAutoWiredParameters ()
	getRequest ()
	getScope ()
	setScope ($scope)
	getSourceParametersList ()
	setSourceParametersList ($sourceParametersList)
	run ($actionName, array $sourceParametersList)
	finalizeResponse (Response $response)
	generateActionMethodName ($action)
	redirectTo ($url)
	getErrors ()
	getErrorByCode ($code)

Открытые атрибуты
const	SIGNATURE_SALT = 'phone_auth_email'
Открытые атрибуты унаследованные от Controller
const	SCOPE_REST = 'rest'
const	SCOPE_AJAX = 'ajax'
const	SCOPE_CLI = 'cli'
const	EVENT_ON_BEFORE_ACTION = 'onBeforeAction'
const	EVENT_ON_AFTER_ACTION = 'onAfterAction'
const	ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'
const	ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'
const	EXCEPTION_UNKNOWN_ACTION = 22002
Открытые атрибуты унаследованные от Controllerable
const	METHOD_ACTION_SUFFIX = 'Action'

Защищенные члены
	checkOtpCaptcha ()
Защищенные члены унаследованные от Controller
	init ()
	getFilePath ()
	processUnsignedParameters ()
	getSaltToUnsign ()
	writeToLogException (\Throwable $e)
	collectDebugInfo ()
	logDebugInfo ()
	prepareParams ()
	processBeforeAction (Action $action)
	shouldDecodePostData (Action $action)
	decodePostData ()
	triggerOnBeforeAction (Action $action)
	processAfterAction (Action $action, $result)
	triggerOnAfterAction (Action $action, $result)
	create ($actionName)
	buildActionInstance ($actionName, array $config)
	existsAction ($actionName)
	getDefaultPreFilters ()
	getDefaultPostFilters ()
	buildFilters (array $config=null)
	appendFilters (array $filters, array $filtersToAppend)
	removeFilters (array $filters, array $filtersToRemove)
	detachFilters (Action $action)
	detachPreFilters (Action $action)
	detachPostFilters (Action $action)
	getActionConfig ($actionName)
	setActionConfig ($actionName, array $config=null)
	runProcessingThrowable (\Throwable $throwable)
	runProcessingException (\Exception $e)
	runProcessingError (\Error $error)
	runProcessingBinderThrowable (BinderArgumentException $e)
	buildErrorFromException (\Exception $e)
	buildErrorFromPhpError (\Error $error)
	runProcessingIfUserNotAuthorized ()
	runProcessingIfInvalidCsrfToken ()
	addError (Error $error)
	addErrors (array $errors)

Дополнительные унаследованные члены
Открытые статические члены унаследованные от Controller
static	className ()
static	getFullEventName ($eventName)
Защищенные данные унаследованные от Controller
	$errorCollection
	$request
Configurator	$configurator

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

См. определение в файле authcode.php строка 15

Методы

checkOtpCaptcha()

checkOtpCaptcha ( )

protected

См. определение в файле authcode.php строка 156

configureActions()

configureActions

(

)

Возвращает

array

Переопределяет метод предка Controller.

См. определение в файле authcode.php строка 174

confirmAction()

confirmAction	(		$code,
			$signedData )

Verifies the code and authorizes the user on success.

Аргументы

string	$code	User input
string	$signedData	Expected to be sent back from sendEmail() result

Возвращает

bool|null

См. определение в файле authcode.php строка 67

loginByOtpAction()

loginByOtpAction	(		$otp,
			$captchaSid = "",
			$captchaWord = "" )

Verifies the code and authorizes the user on success.

Аргументы

string	$otp	OTP code
string	$captchaSid	If needed
string	$captchaWord	If needed

Возвращает

bool|null

См. определение в файле authcode.php строка 136

Данные класса

SIGNATURE_SALT

const SIGNATURE_SALT = 'phone_auth_email'

См. определение в файле authcode.php строка 17