Page MenuHomeClusterLabs Projects
Diviner Tech Docs PhabricatorEditEngineSettingsPanel

abstract class PhabricatorEditEngineSettingsPanel
Phorge Technical Documentation (Settings)

This class is not documented.

Tasks

Panel Configuration

  • public function getPanelKey() — Return a unique string used in the URI to identify this panel, like "example".
  • abstract public function getPanelName() — Return a human-readable description of the panel's contents, like "Example Settings".
  • public function getPanelMenuIcon() — Return an icon for the panel in the menu.
  • abstract public function getPanelGroupKey() — Return a panel group key constant for this panel.
  • final public function isEnabled()
  • public function isUserPanel() — Return true if this panel is available to users while editing their own settings.
  • public function isManagementPanel() — Return true if this panel is available to administrators while managing bot and mailing list accounts.
  • public function isTemplatePanel() — Return true if this panel is available while editing settings templates.
  • public function isMultiFactorEnrollmentPanel() — Return true if this panel should be available when enrolling in MFA on a new account with MFA requiredd.

Panel Implementation

Internals

Other Methods

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

final public function setController($controller)
Inherited

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

final public function getController()
Inherited

This method is not documented.
Return
wild

final public function setNavigation($navigation)
Inherited

This method is not documented.
Parameters
AphrontSideNavFilterView$navigation
Return
wild

final public function getNavigation()
Inherited

This method is not documented.
Return
wild

public function setPreferences($preferences)
Inherited

This method is not documented.
Parameters
PhabricatorUserPreferences$preferences
Return
wild

public function getPreferences()
Inherited

This method is not documented.
Return
wild

final public static function getAllPanels()
Inherited

This method is not documented.
Return
wild

final public static function getAllDisplayPanels()
Inherited

This method is not documented.
Return
wild

final public function getPanelGroup()
Inherited

This method is not documented.
Return
wild

public function getPanelKey()
Inherited

PhabricatorSettingsPanel

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

Return
stringUnique panel identifier (used in URIs).

abstract public function getPanelName()
Inherited

PhabricatorSettingsPanel

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

Return
stringHuman-readable panel name.

public function getPanelMenuIcon()
Inherited

PhabricatorSettingsPanel

Return an icon for the panel in the menu.

Return
stringIcon identifier.

abstract public function getPanelGroupKey()
Inherited

PhabricatorSettingsPanel

Return a panel group key constant for this panel.

Return
constPanel group key.

final public function isEnabled()

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 unavailable in this install. By default, all panels are enabled.

PhabricatorEditEngineSettingsPanel
This method is not documented.
Return
boolTrue if the panel should be shown.

public function isUserPanel()
Inherited

PhabricatorSettingsPanel

Return true if this panel is available to users while editing their own settings.

Return
boolTrue to enable management on behalf of a user.

public function isManagementPanel()
Inherited

PhabricatorSettingsPanel

Return true if this panel is available to administrators while managing bot and mailing list accounts.

Return
boolTrue to enable management on behalf of accounts.

public function isTemplatePanel()
Inherited

PhabricatorSettingsPanel

Return true if this panel is available while editing settings templates.

Return
boolTrue to allow editing in templates.

public function isMultiFactorEnrollmentPanel()
Inherited

PhabricatorSettingsPanel

Return true if this panel should be available when enrolling in MFA on a new account with MFA requiredd.

Return
boolTrue to allow configuration during MFA enrollment.

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

PhabricatorEditEngineSettingsPanel
This method is not documented.
Parameters
AphrontRequest$requestIncoming request.
Return
wildResponse 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?$pathOptional path to append.
Return
stringRelative URI for the panel.

final public function getPanelOrderVector()
Inherited

PhabricatorSettingsPanel

Generates a key to sort the list of panels.

Return
stringSortable key.

protected function newDialog()
Inherited

This method is not documented.
Return
wild

protected function writeSetting($preferences, $key, $value)
Inherited

This method is not documented.
Parameters
PhabricatorUserPreferences$preferences
$key
$value
Return
wild

public function newBox($title, $content, $actions)
Inherited

This method is not documented.
Parameters
$title
$content
$actions
Return
wild

final public function newEditEnginePage()

This method is not documented.
Return
wild

final public function getPanelSettingsKeys()

This method is not documented.
Return
wild

public function newSettingsPanelEditFormHeadContent($state)

This method is not documented.
Parameters
PhabricatorEditEnginePageState$state
Return
wild

public function newSettingsPanelEditFormTailContent($state)

This method is not documented.
Parameters
PhabricatorEditEnginePageState$state
Return
wild
Defined
src/applications/settings/panel/PhabricatorEditEngineSettingsPanel.php:3
Extends
PhabricatorSettingsPanel