| [ Index ] |
PHP Cross Reference of Phabricator |
[Source view] [Print] [Project Stats]
Defines a settings panel. Settings panels appear in the Settings application, and behave like lightweight controllers -- generally, they render some sort of form with options in it, and then update preferences when the user submits the form. By extending this class, you can add new settings panels.
| File Size: | 190 lines (5 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| setUser(PhabricatorUser $user) X-Ref |
| No description |
| getUser() X-Ref |
| No description |
| setViewer(PhabricatorUser $viewer) X-Ref |
| No description |
| getViewer() X-Ref |
| No description |
| setOverrideURI($override_uri) X-Ref |
| No description |
| isEnabled() X-Ref |
| 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. |
| buildPanels() X-Ref |
| 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. |
| isEditableByAdministrators() X-Ref |
| Return true if this panel is available to administrators while editing system agent accounts. return: bool True to enable edit by administrators. |
| getPanelURI($path = '') X-Ref |
| Get the URI for this panel. param: string? Optional path to append. return: string Relative URI for the panel. |
| getPanelSortKey() X-Ref |
| Generates a key to sort the list of panels. return: string Sortable key. |
| Generated: Sun Nov 30 09:20:46 2014 | Cross-referenced by PHPXref 0.7.1 |