Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhutilEmptyAuthAdapter

final class PhutilEmptyAuthAdapter
Phabricator Technical Documentation (Auth)

Empty authentication adapter with no logic.

This adapter can be used when you need an adapter for some technical reason but it doesn't make sense to put logic inside it.

Methods

final public function getAccountIdentifiers()
Inherited

This method is not documented.
Return
wild

protected function newAccountIdentifiers()
Inherited

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()

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.

PhutilEmptyAuthAdapter
This method is not documented.
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.

PhutilEmptyAuthAdapter
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.

PhutilEmptyAuthAdapter
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()
Inherited

PhutilAuthAdapter

Optionally, return an email address associated with this account.

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

public function getAccountName()
Inherited

PhutilAuthAdapter

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

Return
string|nullAccount username, or `null` if data isn't available.

public function getAccountURI()
Inherited

PhutilAuthAdapter

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

Return
string|nullA profile URI associated with this account, or `null` if the data isn't available.

public function getAccountImageURI()
Inherited

PhutilAuthAdapter

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

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

public function getAccountRealName()
Inherited

PhutilAuthAdapter

Optionally, return a real name associated with this account.

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

public function setAdapterDomain($adapter_domain)

This method is not documented.
Parameters
$adapter_domain
Return
wild

public function setAdapterType($adapter_type)

This method is not documented.
Parameters
$adapter_type
Return
wild

public function setAccountID($account_id)

This method is not documented.
Parameters
$account_id
Return
wild