Diviner Phabricator Tech Docs PhabricatorEmailAddressesSettingsPanel

final class PhabricatorEmailAddressesSettingsPanel
Phabricator Technical Documentation (Settings)

This class is not documented.

Tasks

Panel Configuration

public function getPanelKey()
public function getPanelName()
public function getPanelGroup()
public function isEnabled() — Return false to prevent this panel from being displayed or used. You can do, e.g., configuration checks here, to determine if the feature your panel controls is unavailble in this install. By default, all panels are enabled.
public function buildPanels() — You can use this callback to generate multiple similar panels which all share the same implementation. For example, OAuth providers each have a separate panel, but the implementation for each panel is the same.
public function isEditableByAdministrators()

Panel Implementation

public function processRequest($request)
final public function getPanelURI($path) — Get the URI for this panel.

Internals

final public function getPanelSortKey() — Generates a key to sort the list of panels.

Other Methods

public function setUser($user)
public function getUser()
public function setViewer($viewer)
public function getViewer()
public function setOverrideURI($override_uri)
private function returnNewAddressResponse($request, $uri, $new)
private function returnDeleteAddressResponse($request, $uri, $email_id)
private function returnVerifyAddressResponse($request, $uri, $email_id)
private function returnPrimaryAddressResponse($request, $uri, $email_id)

Methods

public function setUser($user)
Inherited

This method is not documented.

Parameters

PhabricatorUser

$user

Return

wild

public function getUser()
Inherited

This method is not documented.

Return

wild

public function setViewer($viewer)
Inherited

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function getViewer()
Inherited

This method is not documented.

Return

wild

public function setOverrideURI($override_uri)
Inherited

This method is not documented.

Parameters

$override_uri

Return

wild

public function getPanelKey()

PhabricatorSettingsPanel

Return a unique string used in the URI to identify this panel, like "example".

PhabricatorEmailAddressesSettingsPanel

This method is not documented.

Return

string

Unique panel identifier (used in URIs).

public function getPanelName()

PhabricatorSettingsPanel

Return a human-readable description of the panel's contents, like "Example Settings".

PhabricatorEmailAddressesSettingsPanel

This method is not documented.

Return

string

Human-readable panel name.

public function getPanelGroup()

PhabricatorSettingsPanel

Return a human-readable group name for this panel. For instance, if you had several related panels like "Volume Settings" and "Microphone Settings", you might put them in a group called "Audio".

When displayed, panels are grouped with other panels that have the same group name.

PhabricatorEmailAddressesSettingsPanel

This method is not documented.

Return

string

Human-readable panel group name.

public function isEnabled()
Inherited

PhabricatorSettingsPanel

Return false to prevent this panel from being displayed or used. You can do, e.g., configuration checks here, to determine if the feature your panel controls is unavailble in this install. By default, all panels are enabled.

Return

bool	True if the panel should be shown.

public function buildPanels()
Inherited

PhabricatorSettingsPanel

You can use this callback to generate multiple similar panels which all share the same implementation. For example, OAuth providers each have a separate panel, but the implementation for each panel is the same.

To generate multiple panels, build them here and return a list. By default, the current panel ($this) is returned alone. For most panels, this is the right implementation.

Return

list<PhabricatorSettingsPanel>

Zero or more panels.

public function isEditableByAdministrators()

PhabricatorSettingsPanel

Return true if this panel is available to administrators while editing system agent accounts.

PhabricatorEmailAddressesSettingsPanel

This method is not documented.

Return

bool	True to enable edit by administrators.

public function processRequest($request)

PhabricatorSettingsPanel

Process a user request for this settings panel. Implement this method like a lightweight controller. If you return an AphrontResponse, the response will be used in whole. If you return anything else, it will be treated as a view and composed into a normal settings page.

Generally, render your settings panel by returning a form, then return a redirect when the user saves settings.

PhabricatorEmailAddressesSettingsPanel

This method is not documented.

Parameters

AphrontRequest

$request

Incoming request.

Return

wild	Response to request, either as an @{class:AphrontResponse} or something which can be composed into a @{class:AphrontView}.

final public function getPanelURI($path)
Inherited

PhabricatorSettingsPanel

Get the URI for this panel.

Parameters

string?

$path

Optional path to append.

Return

string

Relative URI for the panel.

final public function getPanelSortKey()
Inherited

PhabricatorSettingsPanel

Generates a key to sort the list of panels.

Return

string

Sortable key.

private function returnNewAddressResponse($request, $uri, $new)

This method is not documented.

Parameters

AphrontRequest	$request
PhutilURI	$uri
	$new

Return

wild

private function returnDeleteAddressResponse($request, $uri, $email_id)

This method is not documented.

Parameters

AphrontRequest	$request
PhutilURI	$uri
	$email_id

Return

wild

private function returnVerifyAddressResponse($request, $uri, $email_id)

This method is not documented.

Parameters

AphrontRequest	$request
PhutilURI	$uri
	$email_id

Return

wild

private function returnPrimaryAddressResponse($request, $uri, $email_id)

This method is not documented.

Parameters

AphrontRequest	$request
PhutilURI	$uri
	$email_id

Return

wild

Defined: src/applications/settings/panel/PhabricatorEmailAddressesSettingsPanel.php:3
Extends: PhabricatorSettingsPanel

final class PhabricatorEmailAddressesSettingsPanelPhabricator Technical Documentation (Settings)

Tasks

Panel Configuration

Panel Implementation

Internals

Other Methods

Methods

public function setUser($user)Inherited

public function getUser()Inherited

public function setViewer($viewer)Inherited

public function getViewer()Inherited

public function setOverrideURI($override_uri)Inherited

public function getPanelKey()

public function getPanelName()

public function getPanelGroup()

public function isEnabled()Inherited

public function buildPanels()Inherited

public function isEditableByAdministrators()

public function processRequest($request)

final public function getPanelURI($path)Inherited

final public function getPanelSortKey()Inherited

private function returnNewAddressResponse($request, $uri, $new)

private function returnDeleteAddressResponse($request, $uri, $email_id)

private function returnVerifyAddressResponse($request, $uri, $email_id)

private function returnPrimaryAddressResponse($request, $uri, $email_id)

final class PhabricatorEmailAddressesSettingsPanel
Phabricator Technical Documentation (Settings)

public function setUser($user)
Inherited

public function getUser()
Inherited

public function setViewer($viewer)
Inherited

public function getViewer()
Inherited

public function setOverrideURI($override_uri)
Inherited

public function isEnabled()
Inherited

public function buildPanels()
Inherited

final public function getPanelURI($path)
Inherited

final public function getPanelSortKey()
Inherited