Page MenuHomePhorge
Diviner Tech Docs PhabricatorAuthFactor

abstract class PhabricatorAuthFactor
Phorge Technical Documentation (Auth)

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

abstract public function getFactorName()

This method is not documented.
Return
wild

abstract public function getFactorShortName()

This method is not documented.
Return
wild

abstract public function getFactorKey()

This method is not documented.
Return
wild

abstract public function getFactorCreateHelp()

This method is not documented.
Return
wild

abstract public function getFactorDescription()

This method is not documented.
Return
wild

abstract public function processAddFactorForm($provider, $form, $request, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
AphrontFormView$form
AphrontRequest$request
PhabricatorUser$user
Return
wild

abstract public function renderValidateFactorForm($config, $form, $viewer, $validation_result)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
AphrontFormView$form
PhabricatorUser$viewer
PhabricatorAuthFactorResult$validation_result
Return
wild

public function getParameterName($config, $name)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
$name
Return
wild

public static function getAllFactors()

This method is not documented.
Return
wild

protected function newConfigForUser($user)

This method is not documented.
Parameters
PhabricatorUser$user
Return
wild

protected function newResult()

This method is not documented.
Return
wild

public function newIconView()

This method is not documented.
Return
wild

public function canCreateNewProvider()

This method is not documented.
Return
wild

public function getProviderCreateDescription()

This method is not documented.
Return
wild

public function canCreateNewConfiguration($provider, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
PhabricatorUser$user
Return
wild

public function getConfigurationCreateDescription($provider, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
PhabricatorUser$user
Return
wild

public function getConfigurationListDetails($config, $provider, $viewer)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorAuthFactorProvider$provider
PhabricatorUser$viewer
Return
wild

public function newEditEngineFields($engine, $provider)

This method is not documented.
Parameters
PhabricatorEditEngine$engine
PhabricatorAuthFactorProvider$provider
Return
wild

public function newChallengeStatusView($config, $provider, $viewer, $challenge)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorAuthFactorProvider$provider
PhabricatorUser$viewer
PhabricatorAuthChallenge$challenge
Return
wild

public function isContactNumberFactor()

Is this a factor which depends on the user's contact number?

If a user has a "contact number" factor configured, they can not modify or switch their primary contact number.

Return
boolTrue if this factor should lock contact numbers.

abstract public function getEnrollDescription($provider, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
PhabricatorUser$user
Return
wild

public function getEnrollButtonText($provider, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
PhabricatorUser$user
Return
wild

public function getFactorOrder()

This method is not documented.
Return
wild

final public function newSortVector()

This method is not documented.
Return
wild

protected function newChallenge($config, $viewer)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
Return
wild

abstract public function getRequestHasChallengeResponse($config, $response)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
AphrontRequest$response
Return
wild

final public function getNewIssuedChallenges($config, $viewer, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
array$challenges
Return
wild

abstract protected function newIssuedChallenges($config, $viewer, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
array$challenges
Return
wild

final public function getResultFromIssuedChallenges($config, $viewer, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
array$challenges
Return
wild

final public function getResultForPrompt($config, $viewer, $request, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
AphrontRequest$request
array$challenges
Return
wild

protected function newResultForPrompt($config, $viewer, $request, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
AphrontRequest$request
array$challenges
Return
wild

abstract protected function newResultFromIssuedChallenges($config, $viewer, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
array$challenges
Return
wild

final public function getResultFromChallengeResponse($config, $viewer, $request, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
AphrontRequest$request
array$challenges
Return
wild

abstract protected function newResultFromChallengeResponse($config, $viewer, $request, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
AphrontRequest$request
array$challenges
Return
wild

final protected function newAutomaticControl($result)

This method is not documented.
Parameters
PhabricatorAuthFactorResult$result
Return
wild

private function newWaitControl($result)

This method is not documented.
Parameters
PhabricatorAuthFactorResult$result
Return
wild

private function newAnsweredControl($result)

This method is not documented.
Parameters
PhabricatorAuthFactorResult$result
Return
wild

private function newErrorControl($result)

This method is not documented.
Parameters
PhabricatorAuthFactorResult$result
Return
wild

private function newContinueControl($result)

This method is not documented.
Parameters
PhabricatorAuthFactorResult$result
Return
wild

final protected function loadMFASyncToken($provider, $request, $form, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
AphrontRequest$request
AphrontFormView$form
PhabricatorUser$user
Return
wild

protected function newMFASyncTokenProperties($provider, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
PhabricatorUser$user
Return
wild

private function getMFASyncTokenFormKey()

This method is not documented.
Return
wild

private function getMFASyncTokenTTL()

This method is not documented.
Return
wild

final protected function getChallengeForCurrentContext($config, $viewer, $challenges)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
PhabricatorUser$viewer
array$challenges
Return
wild

final protected function newQRCode($uri)

This method is not documented.
Parameters
$uri
Return
wild

final protected function getInstallDisplayName()

This method is not documented.
Return
wild

final protected function getChallengeResponseParameterName($config)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
Return
wild

final protected function getChallengeResponseFromRequest($config, $request)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
AphrontRequest$request
Return
wild

final protected function hasCSRF($config)

This method is not documented.
Parameters
PhabricatorAuthFactorConfig$config
Return
wild

final protected function loadConfigurationsForProvider($provider, $user)

This method is not documented.
Parameters
PhabricatorAuthFactorProvider$provider
PhabricatorUser$user
Return
wild

final protected function isAuthResult($object)

This method is not documented.
Parameters
$object
Return
wild
Defined
src/applications/auth/factor/PhabricatorAuthFactor.php:3
Extends
Phobject
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0