Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhutilGoogleAuthAdapter

final class PhutilGoogleAuthAdapter
Phabricator Technical Documentation (Auth)

Authentication adapter for Google OAuth2.

Methods

final public function getAccountIdentifiers()
Inherited

This method is not documented.
Return
wild

protected function newAccountIdentifiers()

This method is not documented.
Return
wild

final protected function newAccountIdentifier($raw_identifier)
Inherited

This method is not documented.
Parameters
$raw_identifier
Return
wild

public function getAccountID()
Inherited

PhutilAuthAdapter

Get a unique identifier associated with the account.

This identifier should be permanent, immutable, and uniquely identify the account. If possible, it should be nonsensitive. For providers that have a GUID or PHID value for accounts, these are the best values to use.

You can implement newAccountIdentifiers() instead if a provider is unable to emit identifiers with all of these properties.

If the adapter was unable to authenticate an identity, it should return null.

Return
string|nullUnique account identifier, or `null` if authentication failed.

public function getAdapterType()

PhutilAuthAdapter

Get a string identifying this adapter, like "ldap". This string should be unique to the adapter class.

PhutilGoogleAuthAdapter
This method is not documented.
Return
stringUnique adapter identifier.

public function getAdapterDomain()

PhutilAuthAdapter

Get a string identifying the domain this adapter is acting on. This allows an adapter (like LDAP) to act against different identity domains without conflating credentials. For providers like Facebook or Google, the adapters just return the relevant domain name.

PhutilGoogleAuthAdapter
This method is not documented.
Return
stringDomain the adapter is associated with.

public function getAdapterKey()
Inherited

PhutilAuthAdapter

Generate a string uniquely identifying this adapter configuration. Within the scope of a given key, all account IDs must uniquely identify exactly one identity.

Return
stringUnique identifier for this adapter configuration.

public function getAccountEmail()

PhutilAuthAdapter

Optionally, return an email address associated with this account.

PhutilGoogleAuthAdapter
This method is not documented.
Return
string|nullAn email address associated with the account, or `null` if data is not available.

public function getAccountName()

PhutilAuthAdapter

Optionally, return a human readable username associated with this account.

PhutilGoogleAuthAdapter
This method is not documented.
Return
string|nullAccount username, or `null` if data isn't available.

public function getAccountURI()

PhutilAuthAdapter

Optionally, return a URI corresponding to a human-viewable profile for this account.

PhutilGoogleAuthAdapter
This method is not documented.
Return
string|nullA profile URI associated with this account, or `null` if the data isn't available.

public function getAccountImageURI()

PhutilAuthAdapter

Optionally, return a profile image URI associated with this account.

PhutilGoogleAuthAdapter
This method is not documented.
Return
string|nullURI for an account profile image, or `null` if one is not available.

public function getAccountRealName()

PhutilAuthAdapter

Optionally, return a real name associated with this account.

PhutilGoogleAuthAdapter
This method is not documented.
Return
string|nullA human real name, or `null` if this data is not available.

protected function getAuthenticateBaseURI()

This method is not documented.
Return
wild

protected function getTokenBaseURI()

This method is not documented.
Return
wild

protected function loadOAuthAccountData()

This method is not documented.
Return
wild

public function getAuthenticateURI()
Inherited

This method is not documented.
Return
wild

public function setState($state)
Inherited

This method is not documented.
Parameters
$state
Return
wild

public function getState()
Inherited

This method is not documented.
Return
wild

public function setCode($code)
Inherited

This method is not documented.
Parameters
$code
Return
wild

public function getCode()
Inherited

This method is not documented.
Return
wild

public function setRedirectURI($redirect_uri)
Inherited

This method is not documented.
Parameters
$redirect_uri
Return
wild

public function getRedirectURI()
Inherited

This method is not documented.
Return
wild
This method is not documented.
Return
wild

public function getExtraTokenParameters()

This method is not documented.
Return
wild

public function getExtraRefreshParameters()
Inherited

This method is not documented.
Return
wild

public function setScope($scope)
Inherited

This method is not documented.
Parameters
$scope
Return
wild

public function getScope()

This method is not documented.
Return
wild

public function setClientSecret($client_secret)
Inherited

This method is not documented.
Parameters
PhutilOpaqueEnvelope$client_secret
Return
wild

public function getClientSecret()
Inherited

This method is not documented.
Return
wild

public function setClientID($client_id)
Inherited

This method is not documented.
Parameters
$client_id
Return
wild

public function getClientID()
Inherited

This method is not documented.
Return
wild

public function getAccessToken()
Inherited

This method is not documented.
Return
wild

public function getAccessTokenExpires()
Inherited

This method is not documented.
Return
wild

public function getRefreshToken()
Inherited

This method is not documented.
Return
wild

protected function getAccessTokenData($key, $default)
Inherited

This method is not documented.
Parameters
$key
$default
Return
wild

public function supportsTokenRefresh()
Inherited

This method is not documented.
Return
wild

public function refreshAccessToken($refresh_token)
Inherited

This method is not documented.
Parameters
$refresh_token
Return
wild

protected function loadRefreshTokenData($refresh_token)
Inherited

This method is not documented.
Parameters
$refresh_token
Return
wild

protected function loadAccessTokenData()
Inherited

This method is not documented.
Return
wild

private function makeTokenRequest($params)
Inherited

This method is not documented.
Parameters
array$params
Return
wild

protected function readAccessTokenResponse($body)
Inherited

This method is not documented.
Parameters
$body
Return
wild

protected function getOAuthAccountData($key, $default)
Inherited

This method is not documented.
Parameters
$key
$default
Return
wild