Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorOAuthAuthProvider

abstract class PhabricatorOAuthAuthProvider
Phabricator Technical Documentation (Auth)

This class is not documented.

Methods

public function attachProviderConfig($config)
Inherited

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

public function hasProviderConfig()
Inherited

This method is not documented.
Return
wild

public function getProviderConfig()
Inherited

This method is not documented.
Return
wild

public function getConfigurationHelp()

This method is not documented.
Return
wild

public function getDefaultProviderConfig()
Inherited

This method is not documented.
Return
wild

public function getNameForCreate()
Inherited

This method is not documented.
Return
wild

public function getDescriptionForCreate()

This method is not documented.
Return
wild

public function getProviderKey()
Inherited

This method is not documented.
Return
wild

public function getProviderType()
Inherited

This method is not documented.
Return
wild

public function getProviderDomain()
Inherited

This method is not documented.
Return
wild

public static function getAllBaseProviders()
Inherited

This method is not documented.
Return
wild

public static function getAllProviders()
Inherited

This method is not documented.
Return
wild

public static function getAllEnabledProviders()
Inherited

This method is not documented.
Return
wild

public static function getEnabledProviderByKey($provider_key)
Inherited

This method is not documented.
Parameters
$provider_key
Return
wild

abstract public function getProviderName()
Inherited

This method is not documented.
Return
wild

public function getAdapter()

This method is not documented.
Return
wild

public function isEnabled()
Inherited

This method is not documented.
Return
wild

public function shouldAllowLogin()
Inherited

This method is not documented.
Return
wild

public function shouldAllowRegistration()
Inherited

This method is not documented.
Return
wild

public function shouldAllowAccountLink()
Inherited

This method is not documented.
Return
wild

public function shouldAllowAccountUnlink()
Inherited

This method is not documented.
Return
wild

public function shouldTrustEmails()
Inherited

This method is not documented.
Return
wild

public function shouldAllowEmailTrustConfiguration()
Inherited

PhabricatorAuthProvider

Should we allow the adapter to be marked as "trusted". This is true for all adapters except those that allow the user to type in emails (see PhabricatorPasswordAuthProvider).

Return
wild

public function buildLoginForm($controller)
Inherited

This method is not documented.
Parameters
PhabricatorAuthStartController$controller
Return
wild

public function buildInviteForm($controller)
Inherited

This method is not documented.
Parameters
PhabricatorAuthStartController$controller
Return
wild

abstract public function processLoginRequest($controller)
Inherited

This method is not documented.
Parameters
PhabricatorAuthLoginController$controller
Return
wild

public function buildLinkForm($controller)
Inherited

This method is not documented.
Parameters
PhabricatorAuthLinkController$controller
Return
wild

public function shouldAllowAccountRefresh()
Inherited

This method is not documented.
Return
wild

public function buildRefreshForm($controller)
Inherited

This method is not documented.
Parameters
PhabricatorAuthLinkController$controller
Return
wild

protected function renderLoginForm($request, $mode)
Inherited

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

public function createProviders()
Inherited

This method is not documented.
Return
wild

protected function willSaveAccount($account)

This method is not documented.
Parameters
PhabricatorExternalAccount$account
Return
wild

public function willRegisterAccount($account)
Inherited

This method is not documented.
Parameters
PhabricatorExternalAccount$account
Return
wild

protected function loadOrCreateAccount($account_id)
Inherited

This method is not documented.
Parameters
$account_id
Return
wild

public function getLoginURI()
Inherited

This method is not documented.
Return
wild

public function getSettingsURI()
Inherited

This method is not documented.
Return
wild

public function getStartURI()
Inherited

This method is not documented.
Return
wild

public function isDefaultRegistrationProvider()
Inherited

This method is not documented.
Return
wild

public function shouldRequireRegistrationPassword()
Inherited

This method is not documented.
Return
wild

public function getDefaultExternalAccount()
Inherited

This method is not documented.
Return
wild

public function getLoginOrder()
Inherited

This method is not documented.
Return
wild

protected function getLoginIcon()
Inherited

This method is not documented.
Return
wild

public function isLoginFormAButton()

This method is not documented.
Return
wild

public function renderConfigPropertyTransactionTitle($xaction)

This method is not documented.
Parameters
PhabricatorAuthProviderConfigTransaction$xaction
Return
wild

public function readFormValuesFromProvider()

This method is not documented.
Return
wild

public function readFormValuesFromRequest($request)

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

public function processEditForm($request, $values)
Inherited

This method is not documented.
Parameters
AphrontRequest$request
array$values
Return
wild

public function extendEditForm($request, $form, $values, $issues)
Inherited

This method is not documented.
Parameters
AphrontRequest$request
AphrontFormView$form
array$values
array$issues
Return
wild

public function willRenderLinkedAccount($viewer, $item, $account)
Inherited

This method is not documented.
Parameters
PhabricatorUser$viewer
PHUIObjectItemView$item
PhabricatorExternalAccount$account
Return
wild

public function hasSetupStep()
Inherited

PhabricatorAuthProvider

Return true to use a two-step configuration (setup, configure) instead of the default single-step configuration. In practice, this means that creating a new provider instance will redirect back to the edit page instead of the provider list.

Return
boolTrue if this provider uses two-step configuration.

protected function renderStandardLoginButton($request, $mode, $attributes)
Inherited

PhabricatorAuthProvider

Render a standard login/register button element.

The $attributes parameter takes these keys:

  • uri: URI the button should take the user to when clicked.
  • method: Optional HTTP method the button should use, defaults to GET.
Parameters
AphrontRequest$requestHTTP request.
string$modeRequest mode string.
map$attributesAdditional parameters, see above.
Return
wildLog in button.

public function renderConfigurationFooter()
Inherited

This method is not documented.
Return
wild

public function getAuthCSRFCode($request)
Inherited

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

protected function verifyAuthCSRFCode($request, $actual)
Inherited

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

public function supportsAutoLogin()
Inherited

This method is not documented.
Return
wild

public function getAutoLoginURI($request)
Inherited

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

protected function getContentSecurityPolicyFormActions()
Inherited

This method is not documented.
Return
wild

abstract protected function newOAuthAdapter()

This method is not documented.
Return
wild

abstract protected function getIDKey()

This method is not documented.
Return
wild

abstract protected function getSecretKey()

This method is not documented.
Return
wild

protected function processOAuthEditForm($request, $values, $id_error, $secret_error)

This method is not documented.
Parameters
AphrontRequest$request
array$values
$id_error
$secret_error
Return
wild

abstract protected function getProviderConfigurationHelp()

This method is not documented.
Return
wild

protected function extendOAuthEditForm($request, $form, $values, $issues, $id_label, $secret_label)

This method is not documented.
Parameters
AphrontRequest$request
AphrontFormView$form
array$values
array$issues
$id_label
$secret_label
Return
wild

abstract protected function synchronizeOAuthAccount($account)

This method is not documented.
Parameters
PhabricatorExternalAccount$account
Return
wild
Defined
src/applications/auth/provider/PhabricatorOAuthAuthProvider.php:3
Extends
PhabricatorAuthProvider