Diviner Phabricator Tech Docs PhabricatorSearchSettingsPanel

final class PhabricatorSearchSettingsPanel
Phabricator 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".
public function getPanelName()
public function getPanelMenuIcon()
public function getPanelGroupKey()
final public function isEnabled()
public function isUserPanel()
public function isManagementPanel() — Return true if this panel is available to administrators while managing bot and mailing list accounts.
public function isTemplatePanel()
public function isMultiFactorEnrollmentPanel() — Return true if this panel should be available when enrolling in MFA on a new account with MFA requiredd.

Panel Implementation

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

Internals

final public function getPanelOrderVector() — 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)
final public function setController($controller)
final public function getController()
final public function setNavigation($navigation)
final public function getNavigation()
public function setPreferences($preferences)
public function getPreferences()
final public static function getAllPanels()
final public static function getAllDisplayPanels()
final public function getPanelGroup()
protected function newDialog()
protected function writeSetting($preferences, $key, $value)
public function newBox($title, $content, $actions)
final public function newEditEnginePage()
final public function getPanelSettingsKeys()
public function newSettingsPanelEditFormHeadContent($state)
public function newSettingsPanelEditFormTailContent($state)

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

string

Unique panel identifier (used in URIs).

public function getPanelName()

PhabricatorSettingsPanel

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

PhabricatorSearchSettingsPanel

This method is not documented.

Return

string

Human-readable panel name.

public function getPanelMenuIcon()

PhabricatorSettingsPanel

Return an icon for the panel in the menu.

PhabricatorSearchSettingsPanel

This method is not documented.

Return

string

Icon identifier.

public function getPanelGroupKey()

PhabricatorSettingsPanel

Return a panel group key constant for this panel.

PhabricatorSearchSettingsPanel

This method is not documented.

Return

const

Panel group key.

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

Return

bool	True if the panel should be shown.

public function isUserPanel()

PhabricatorSettingsPanel

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

PhabricatorSearchSettingsPanel

This method is not documented.

Return

bool	True 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

bool	True to enable management on behalf of accounts.

public function isTemplatePanel()

PhabricatorSettingsPanel

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

PhabricatorSearchSettingsPanel

This method is not documented.

Return

bool	True 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

bool	True to allow configuration during MFA enrollment.

final public function processRequest($request)
Inherited

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.

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

PhabricatorSettingsPanel

Generates a key to sort the list of panels.

Return

string

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

This method is not documented.

Return

wild

final public function getPanelSettingsKeys()
Inherited

This method is not documented.

Return

wild

public function newSettingsPanelEditFormHeadContent($state)
Inherited

This method is not documented.

Parameters

PhabricatorEditEnginePageState

$state

Return

wild

public function newSettingsPanelEditFormTailContent($state)
Inherited

This method is not documented.

Parameters

PhabricatorEditEnginePageState

$state

Return

wild

Defined: src/applications/settings/panel/PhabricatorSearchSettingsPanel.php:3
Extends: PhabricatorSettingsPanelPhabricatorEditEngineSettingsPanel

final class PhabricatorSearchSettingsPanelPhabricator 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

final public function setController($controller)Inherited

final public function getController()Inherited

final public function setNavigation($navigation)Inherited

final public function getNavigation()Inherited

public function setPreferences($preferences)Inherited

public function getPreferences()Inherited

final public static function getAllPanels()Inherited

final public static function getAllDisplayPanels()Inherited

final public function getPanelGroup()Inherited

public function getPanelKey()Inherited

public function getPanelName()

public function getPanelMenuIcon()

public function getPanelGroupKey()

final public function isEnabled()Inherited

public function isUserPanel()

public function isManagementPanel()Inherited

public function isTemplatePanel()

public function isMultiFactorEnrollmentPanel()Inherited

final public function processRequest($request)Inherited

final public function getPanelURI($path)Inherited

final public function getPanelOrderVector()Inherited

protected function newDialog()Inherited

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

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

final public function newEditEnginePage()Inherited

final public function getPanelSettingsKeys()Inherited

public function newSettingsPanelEditFormHeadContent($state)Inherited

public function newSettingsPanelEditFormTailContent($state)Inherited

final class PhabricatorSearchSettingsPanel
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

final public function setController($controller)
Inherited

final public function getController()
Inherited

final public function setNavigation($navigation)
Inherited

final public function getNavigation()
Inherited

public function setPreferences($preferences)
Inherited

public function getPreferences()
Inherited

final public static function getAllPanels()
Inherited

final public static function getAllDisplayPanels()
Inherited

final public function getPanelGroup()
Inherited

public function getPanelKey()
Inherited

final public function isEnabled()
Inherited

public function isManagementPanel()
Inherited

public function isMultiFactorEnrollmentPanel()
Inherited

final public function processRequest($request)
Inherited

final public function getPanelURI($path)
Inherited

final public function getPanelOrderVector()
Inherited

protected function newDialog()
Inherited

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

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

final public function newEditEnginePage()
Inherited

final public function getPanelSettingsKeys()
Inherited

public function newSettingsPanelEditFormHeadContent($state)
Inherited

public function newSettingsPanelEditFormTailContent($state)
Inherited