abstract public function getName()
abstract public function getName()
Return
| wild |
abstract public function getDescription()
abstract public function getDescription()
Return
| wild |
abstract public function getGroup()
abstract public function getGroup()
Return
| wild |
abstract public function getOptions()
abstract public function getOptions()
Return
| array<PhabricatorConfigOption> |
public function getIcon()
public function getIcon()
Return
| wild |
public function getApplicationClassName()
public function getApplicationClassName()
Get corresponding application class for configuration options. Child classes returning a classname should also have getGroup() return 'apps'.
Return
| class-string|null | Application class name, or null if the config options are not related to a specific application. |
public function validateOption($option, $value)
public function validateOption($option, $value)
Parameters
| \PhabricatorConfigOption | $option | |
| $value |
Return
| wild |
protected function didValidateOption($option, $value)
protected function didValidateOption($option, $value)
Parameters
| \PhabricatorConfigOption | $option | |
| $value |
Return
| wild |
public function renderContextualDescription($option, $request)
public function renderContextualDescription($option, $request)
Hook to render additional hints based on, e.g., the viewing user, request, or other context. For example, this is used to show workspace IDs when configuring asana.workspace-id.
Parameters
| PhabricatorConfigOption | $option | Option being rendered. |
| AphrontRequest | $request | Active request. |
Return
| PhutilSafeHTMLProducerInterface|array|null | Additional contextual description information. |
public function getKey()
public function getKey()
Return
| wild |
final protected function newOption($key, $type, $default)
final protected function newOption($key, $type, $default)
Parameters
| $key | ||
| $type | ||
| $default |
Return
| wild |
final public static function loadAll($external_only)
final public static function loadAll($external_only)
Parameters
| $external_only |
Return
| wild |
final public static function loadAllOptions($external_only)
final public static function loadAllOptions($external_only)
Parameters
| $external_only |
Return
| wild |
final protected function deformat($string)
final protected function deformat($string)
Deformat a HEREDOC for use in remarkup by converting line breaks to spaces.
Parameters
| $string |
Return
| wild |