public function setUser($user)
PhabricatorUser | $user |
wild |
public function getUser()
wild |
public function setViewer($viewer)
PhabricatorUser | $viewer |
wild |
public function getViewer()
wild |
public function setOverrideURI($override_uri)
$override_uri |
wild |
final public function setController($controller)
PhabricatorController | $controller |
wild |
final public function getController()
wild |
final public function setNavigation($navigation)
AphrontSideNavFilterView | $navigation |
wild |
final public function getNavigation()
wild |
public function setPreferences($preferences)
PhabricatorUserPreferences | $preferences |
wild |
public function getPreferences()
wild |
final public static function getAllPanels()
wild |
final public static function getAllDisplayPanels()
wild |
final public function getPanelGroup()
wild |
public function getPanelKey()
Return a unique string used in the URI to identify this panel, like "example".
string | Unique panel identifier (used in URIs). |
abstract public function getPanelName()
Return a human-readable description of the panel's contents, like "Example Settings".
string | Human-readable panel name. |
public function getPanelMenuIcon()
Return an icon for the panel in the menu.
string | Icon identifier. |
abstract public function getPanelGroupKey()
Return a panel group key constant for this panel.
const | Panel group key. |
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 unavailable in this install. By default, all panels are enabled.
bool | True if the panel should be shown. |
public function isUserPanel()
Return true if this panel is available to users while editing their own settings.
bool | True to enable management on behalf of a user. |
public function isManagementPanel()
Return true if this panel is available to administrators while managing bot and mailing list accounts.
bool | True to enable management on behalf of accounts. |
public function isTemplatePanel()
Return true if this panel is available while editing settings templates.
bool | True to allow editing in templates. |
public function isMultiFactorEnrollmentPanel()
Return true if this panel should be available when enrolling in MFA on a new account with MFA requiredd.
bool | True to allow configuration during MFA enrollment. |
abstract public function processRequest($request)
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.
AphrontRequest | $request | Incoming request. |
wild | Response to request, either as an @{class:AphrontResponse} or something which can be composed into a @{class:AphrontView}. |
final public function getPanelURI($path)
Get the URI for this panel.
string? | $path | Optional path to append. |
string | Relative URI for the panel. |
final public function getPanelOrderVector()
Generates a key to sort the list of panels.
string | Sortable key. |
protected function newDialog()
wild |
protected function writeSetting($preferences, $key, $value)
PhabricatorUserPreferences | $preferences | |
$key | ||
$value |
wild |
public function newBox($title, $content, $actions)
$title | ||
$content | ||
$actions |
wild |