public function setKey($key)Inherited
Set the primary key for the field, like projectPHIDs.
You can set human-readable aliases with setAliases().
The key should be a short, unique (within a search engine) string which does not contain any special characters.
string | $key | Unique key which identifies the field. |
this |
public function getKey()Inherited
Get the field's key.
string | Unique key for this field. |
public function setLabel($label)Inherited
Set a human-readable label for the field.
This should be a short text string, like "Reviewers" or "Colors".
string | $label | Short, human-readable field label. |
this | task config |
public function getLabel()
Get the field's human-readable label.
string | Short, human-readable field label. |
public function setViewer($viewer)Inherited
Set the acting viewer.
Engines do not need to do this explicitly; it will be done on their behalf by the caller.
PhabricatorUser | $viewer | Viewer. |
this |
public function getViewer()Inherited
Get the acting viewer.
PhabricatorUser | Viewer. |
public function setAliases($aliases)Inherited
Provide alternate field aliases, usually more human-readable versions of the key.
These aliases can be used when building GET requests, so you can provide an alias like authors to let users write &authors=alincoln instead of &authorPHIDs=alincoln. This is a little easier to use.
list<string> | $aliases | List of aliases for this field. |
this |
public function getAliases()Inherited
Get aliases for this field.
list<string> | List of aliases for this field. |
public function setConduitKey($conduit_key)Inherited
Provide an alternate field key for Conduit.
This can allow you to choose a more usable key for API endpoints. If no key is provided, the main key is used.
string | $conduit_key | Alternate key for Conduit. |
this |
public function getConduitKey()
Get the field key for use in Conduit.
string | Conduit key for this field. |
public function setDescription($description)Inherited
Set a human-readable description for this field.
string | $description | Human-readable description. |
this |
public function getDescription()
Get this field's human-readable description.
string|null | Human-readable description. |
public function setIsHidden($is_hidden)Inherited
Hide this field from the web UI.
bool | $is_hidden | True to hide the field from the web UI. |
this |
public function getIsHidden()Inherited
Should this field be hidden from the web UI?
bool | True to hide the field in the web UI. |
protected function addError($short, $long)Inherited
$short | ||
$long |
wild |
public function getErrors()Inherited
wild |
protected function validateControlValue($value)Inherited
$value |
wild |
protected function getShortError()Inherited
wild |
public function readValueFromRequest($request)Inherited
AphrontRequest | $request |
wild |
protected function getValueExistsInRequest($request, $key)
AphrontRequest | $request | |
$key |
wild |
protected function getValueFromRequest($request, $key)
AphrontRequest | $request | |
$key |
wild |
public function readValueFromSavedQuery($saved)Inherited
PhabricatorSavedQuery | $saved |
wild |
protected function didReadValueFromSavedQuery($value)Inherited
$value |
wild |
public function getValue()Inherited
wild |
protected function getValueForControl()Inherited
wild |
protected function getDefaultValue()
wild |
public function getValueForQuery($value)Inherited
$value |
wild |
protected function newControl()Inherited
wild |
protected function renderControl()Inherited
wild |
public function appendToForm($form)
AphrontFormView | $form |
wild |
final public function getConduitParameterType()Inherited
wild |
protected function newConduitParameterType()
wild |
public function getValueExistsInConduitRequest($constraints)Inherited
array | $constraints |
wild |
public function readValueFromConduitRequest($constraints, $strict)Inherited
array | $constraints | |
$strict |
wild |
public function getValidConstraintKeys()Inherited
wild |
final public function setEnableForConduit($enable)Inherited
$enable |
wild |
final public function getEnableForConduit()Inherited
wild |
public function newConduitConstants()Inherited
wild |
protected function getListFromRequest($request, $key)Inherited
Read a list of items from the request, in either array format or string format:
list[]=item1&list[]=item2 list=item1,item2
This provides flexibility when constructing URIs, especially from external sources.
AphrontRequest | $request | Request to read strings from. |
string | $key | Key to read in the request. |
list<string> | List of values. |
public function setSearchEngine($engine)
PhabricatorApplicationSearchEngine | $engine |
wild |
public function getSearchEngine()
wild |
public function setCustomField($field)
PhabricatorCustomField | $field |
wild |
public function getCustomField()
wild |