Diviner Tech Docs PhabricatorSearchField

abstract class PhabricatorSearchField
Phorge Technical Documentation (Search)

This class is not documented.

Tasks

Configuring Fields

public function setKey($key) — Set the primary key for the field, like `projectPHIDs`.
public function getKey() — Get the field's key.
public function getLabel() — Get the field's human-readable label.
public function setViewer($viewer) — Set the acting viewer.
public function getViewer() — Get the acting viewer.
public function setAliases($aliases) — Provide alternate field aliases, usually more human-readable versions of the key.
public function getAliases() — Get aliases for this field.
public function setConduitKey($conduit_key) — Provide an alternate field key for Conduit.
public function getConduitKey() — Get the field key for use in Conduit.
public function setDescription($description) — Set a human-readable description for this field.
public function getDescription() — Get this field's human-readable description.
public function setIsHidden($is_hidden) — Hide this field from the web UI.
public function getIsHidden() — Should this field be hidden from the web UI?

Handling Errors

No methods for this task.

Reading and Writing Field Values

No methods for this task.

Integration with Conduit

final public function getConduitParameterType()

Utility Methods

No methods for this task.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function setLabel($label) — Set a human-readable label for the field.
protected function addError($short, $long)
public function getErrors()
protected function validateControlValue($value)
protected function getShortError()
public function readValueFromRequest($request)
protected function getValueExistsInRequest($request, $key)
abstract protected function getValueFromRequest($request, $key)
public function readValueFromSavedQuery($saved)
protected function didReadValueFromSavedQuery($value)
public function getValue()
protected function getValueForControl()
protected function getDefaultValue()
public function getValueForQuery($value)
protected function newControl()
protected function renderControl()
public function appendToForm($form)
protected function newConduitParameterType()
public function getValueExistsInConduitRequest($constraints)
public function readValueFromConduitRequest($constraints, $strict)
public function getValidConstraintKeys()
final public function setEnableForConduit($enable)
final public function getEnableForConduit()
public function newConduitConstants()

utility

protected function getListFromRequest($request, $key) — Read a list of items from the request, in either array format or string format:

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function setKey($key)

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.

Parameters

string

$key

Unique key which identifies the field.

Return

this

public function getKey()

Get the field's key.

Return

string

Unique key for this field.

public function setLabel($label)

Set a human-readable label for the field.

This should be a short text string, like "Reviewers" or "Colors".

Parameters

string

$label

Short, human-readable field label.

Return

this	task config

public function getLabel()

Get the field's human-readable label.

Return

string

Short, human-readable field label.

public function setViewer($viewer)

Set the acting viewer.

Engines do not need to do this explicitly; it will be done on their behalf by the caller.

Parameters

PhabricatorUser

$viewer

Viewer.

Return

this

public function getViewer()

Get the acting viewer.

Return

PhabricatorUser

Viewer.

public function setAliases($aliases)

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.

Parameters

list<string>

$aliases

List of aliases for this field.

Return

this

public function getAliases()

Get aliases for this field.

Return

list<string>

List of aliases for this field.

public function setConduitKey($conduit_key)

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.

Parameters

string

$conduit_key

Alternate key for Conduit.

Return

this

public function getConduitKey()

Get the field key for use in Conduit.

Return

string

Conduit key for this field.

public function setDescription($description)

Set a human-readable description for this field.

Parameters

string

$description

Human-readable description.

Return

this

public function getDescription()

Get this field's human-readable description.

Return

string|null

Human-readable description.

public function setIsHidden($is_hidden)

Hide this field from the web UI.

Parameters

bool

$is_hidden

True to hide the field from the web UI.

Return

this

public function getIsHidden()

Should this field be hidden from the web UI?

Return

bool	True to hide the field in the web UI.

protected function addError($short, $long)

This method is not documented.

Parameters

	$short
	$long

Return

wild

public function getErrors()

This method is not documented.

Return

wild

protected function validateControlValue($value)

This method is not documented.

Parameters

$value

Return

wild

protected function getShortError()

This method is not documented.

Return

wild

public function readValueFromRequest($request)

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

protected function getValueExistsInRequest($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

abstract protected function getValueFromRequest($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

public function readValueFromSavedQuery($saved)

This method is not documented.

Parameters

PhabricatorSavedQuery

$saved

Return

wild

protected function didReadValueFromSavedQuery($value)

This method is not documented.

Parameters

$value

Return

wild

public function getValue()

This method is not documented.

Return

wild

protected function getValueForControl()

This method is not documented.

Return

wild

protected function getDefaultValue()

This method is not documented.

Return

wild

public function getValueForQuery($value)

This method is not documented.

Parameters

$value

Return

wild

protected function newControl()

This method is not documented.

Return

wild

protected function renderControl()

This method is not documented.

Return

wild

public function appendToForm($form)

This method is not documented.

Parameters

AphrontFormView

$form

Return

wild

final public function getConduitParameterType()

This method is not documented.

Return

wild

protected function newConduitParameterType()

This method is not documented.

Return

wild

public function getValueExistsInConduitRequest($constraints)

This method is not documented.

Parameters

array

$constraints

Return

wild

public function readValueFromConduitRequest($constraints, $strict)

This method is not documented.

Parameters

array	$constraints
	$strict

Return

wild

public function getValidConstraintKeys()

This method is not documented.

Return

wild

final public function setEnableForConduit($enable)

This method is not documented.

Parameters

$enable

Return

wild

final public function getEnableForConduit()

This method is not documented.

Return

wild

public function newConduitConstants()

This method is not documented.

Return

wild

protected function getListFromRequest($request, $key)

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.

Parameters

AphrontRequest	$request	Request to read strings from.
string	$key	Key to read in the request.

Return

list<string>

List of values.

Defined: src/applications/search/field/PhabricatorSearchField.php:10
Extends: Phobject

abstract class PhabricatorSearchFieldPhorge Technical Documentation (Search)

Tasks

Configuring Fields

Handling Errors

Reading and Writing Field Values

Integration with Conduit

Utility Methods

Other Methods

utility

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function setKey($key)

public function getKey()

public function setLabel($label)

public function getLabel()

public function setViewer($viewer)

public function getViewer()

public function setAliases($aliases)

public function getAliases()

public function setConduitKey($conduit_key)

public function getConduitKey()

public function setDescription($description)

public function getDescription()

public function setIsHidden($is_hidden)

public function getIsHidden()

protected function addError($short, $long)

public function getErrors()

protected function validateControlValue($value)

protected function getShortError()

public function readValueFromRequest($request)

protected function getValueExistsInRequest($request, $key)

abstract protected function getValueFromRequest($request, $key)

public function readValueFromSavedQuery($saved)

protected function didReadValueFromSavedQuery($value)

public function getValue()

protected function getValueForControl()

protected function getDefaultValue()

public function getValueForQuery($value)

protected function newControl()

protected function renderControl()

public function appendToForm($form)

final public function getConduitParameterType()

protected function newConduitParameterType()

public function getValueExistsInConduitRequest($constraints)

public function readValueFromConduitRequest($constraints, $strict)

public function getValidConstraintKeys()

final public function setEnableForConduit($enable)

final public function getEnableForConduit()

public function newConduitConstants()

protected function getListFromRequest($request, $key)

abstract class PhabricatorSearchField
Phorge Technical Documentation (Search)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited