public function setController($controller)Inherited
PhabricatorController | $controller |
wild |
public function getController()Inherited
wild |
public function buildResponse()Inherited
wild |
public function newResultObject()Inherited
wild |
public function newQuery()
wild |
public function setViewer($viewer)Inherited
PhabricatorUser | $viewer |
wild |
protected function requireViewer()Inherited
wild |
public function setContext($context)Inherited
$context |
wild |
public function isPanelContext()Inherited
wild |
public function setNavigationItems($navigation_items)Inherited
array | $navigation_items |
wild |
public function getNavigationItems()Inherited
wild |
public function canUseInPanelContext()
wild |
public function saveQuery($query)Inherited
PhabricatorSavedQuery | $query |
wild |
public function buildSavedQueryFromRequest($request)Inherited
Create a saved query object from the request.
AphrontRequest | $request | The search request. |
PhabricatorSavedQuery |
public function buildQueryFromSavedQuery($original)Inherited
Executes the saved query.
PhabricatorSavedQuery | $original | The saved query to operate on. |
PhabricatorQuery | The result of the query. |
protected function willUseSavedQuery($saved)Inherited
Hook for subclasses to adjust saved queries prior to use.
If an application changes how queries are saved, it can implement this hook to keep old queries working the way users expect, by reading, adjusting, and overwriting parameters.
PhabricatorSavedQuery | $saved | Saved query which will be executed. |
void |
protected function buildQueryFromParameters($map)
array | $parameters |
wild |
public function buildSearchForm($form, $saved)Inherited
Builds the search form using the request.
AphrontFormView | $form | Form to populate. |
PhabricatorSavedQuery | $saved | The query from which to build the form. |
void |
protected function buildSearchFields()Inherited
wild |
protected function shouldShowOrderField()Inherited
wild |
private function adjustFieldsForDisplay($field_map)Inherited
array | $field_map |
wild |
protected function buildCustomSearchFields()
wild |
protected function getDefaultFieldOrder()Inherited
Define the default display order for fields by returning a list of field keys.
You can use the special key ... to mean "all unspecified fields go here". This lets you easily put important fields at the top of the form, standard fields in the middle of the form, and less important fields at the bottom.
For example, you might return a list like this:
return array( 'authorPHIDs', 'reviewerPHIDs', '...', 'createdAfter', 'createdBefore', );
Any unspecified fields (including custom fields and fields added automatically by infrastructure) will be put in the middle.
list<string> | Default ordering for field keys. |
protected function getHiddenFields()Inherited
Return a list of field keys which should be hidden from the viewer.
list<string> | Fields to hide. |
public function getErrors()Inherited
wild |
public function addError($error)Inherited
$error |
wild |
public function getQueryResultsPageURI($query_key)Inherited
Return an application URI corresponding to the results page of a query. Normally, this is something like /application/query/QUERYKEY/.
string | $query_key | The query key to build a URI for. |
string | URI where the query can be executed. |
public function getQueryManagementURI()Inherited
Return an application URI for query management. This is used when, e.g., a query deletion operation is cancelled.
string | URI where queries can be managed. |
public function getQueryBaseURI()Inherited
wild |
public function getExportURI($query_key)Inherited
$query_key |
wild |
public function getCustomizeURI($query_key, $object_phid, $context_phid)Inherited
$query_key | ||
$object_phid | ||
$context_phid |
wild |
protected function getURI($path)
Return the URI to a path within the application. Used to construct default URIs for management and results.
$path |
string | URI to path. |
public function getResultTypeDescription()
Return a human readable description of the type of objects this query searches for.
For example, "Tasks" or "Commits".
string | Human-readable description of what this engine is used to find. |
public function newSavedQuery()Inherited
wild |
public function addNavigationItems($menu)Inherited
PHUIListView | $menu |
wild |
public function loadAllNamedQueries()Inherited
wild |
public function loadEnabledNamedQueries()Inherited
wild |
public function getDefaultQueryKey()Inherited
wild |
protected function setQueryProjects($query, $saved)Inherited
PhabricatorCursorPagedPolicyAwareQuery | $query | |
PhabricatorSavedQuery | $saved |
wild |
protected function getApplicationURI($path)Inherited
$path |
wild |
protected function getApplication()Inherited
wild |
public function getApplicationClassName()
wild |
public static function getAllEngines()Inherited
Load all available application search engines.
list<PhabricatorApplicationSearchEngine> | All available engines. |
public static function getEngineByClassName($class_name)Inherited
Get an engine by class name, if it exists.
$class_name |
PhabricatorApplicationSearchEngine|null | Engine, or null if it does not exist. |
public function getBuiltinQueries()Inherited
wild |
public function getBuiltinQuery($query_key)Inherited
$query_key |
wild |
protected function getBuiltinQueryNames()
wild |
public function isBuiltinQuery($query_key)Inherited
$query_key |
wild |
public function buildSavedQueryFromBuiltin($query_key)
$query_key |
wild |
protected function readUsersFromRequest($request, $key, $allow_types)Inherited
Read a list of user PHIDs from a request in a flexible way. This method supports either of these forms:
users[]=alincoln&users[]=htaft users=alincoln,htaft
Additionally, users can be specified either by PHID or by name.
The main goal of this flexibility is to allow external programs to generate links to pages (like "alincoln's open revisions") without needing to make API calls.
AphrontRequest | $request | Request to read user PHIDs from. |
string | $key | Key to read in the request. |
list<const> | $allow_types | Other permitted PHID types. |
list<phid> | List of user PHIDs and selector functions. |
protected function readSubscribersFromRequest($request, $key)Inherited
Read a list of subscribers from a request in a flexible way.
AphrontRequest | $request | Request to read PHIDs from. |
string | $key | Key to read in the request. |
list<phid> | List of object PHIDs. |
protected function readPHIDsFromRequest($request, $key, $allow_types)Inherited
Read a list of generic PHIDs from a request in a flexible way. Like readUsersFromRequest(), this method supports either array or comma-delimited forms. Objects can be specified either by PHID or by object name.
AphrontRequest | $request | Request to read PHIDs from. |
string | $key | Key to read in the request. |
list<const> | $allow_types | Optional, list of permitted PHID types. |
list<phid> | List of object PHIDs. |
protected function readListFromRequest($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. |
protected function readBoolFromRequest($request, $key)Inherited
AphrontRequest | $request | |
$key |
wild |
protected function getBoolFromQuery($query, $key)Inherited
PhabricatorSavedQuery | $query | |
$key |
wild |
protected function parseDateTime($date_time)Inherited
$date_time |
wild |
protected function buildDateRange($form, $saved_query, $start_key, $start_name, $end_key, $end_name)Inherited
AphrontFormView | $form | |
PhabricatorSavedQuery | $saved_query | |
$start_key | ||
$start_name | ||
$end_key | ||
$end_name |
wild |
protected function newResultBuckets()Inherited
wild |
public function getResultBucket($saved)Inherited
PhabricatorSavedQuery | $saved |
wild |
public function getPageSize($saved)Inherited
PhabricatorSavedQuery | $saved |
wild |
public function shouldUseOffsetPaging()Inherited
wild |
public function newPagerForSavedQuery($saved)Inherited
PhabricatorSavedQuery | $saved |
wild |
public function executeQuery($query, $pager)Inherited
PhabricatorPolicyAwareQuery | $query | |
AphrontView | $pager |
wild |
protected function didExecuteQuery($query)Inherited
PhabricatorPolicyAwareQuery | $query |
wild |
public function setRequest($request)Inherited
AphrontRequest | $request |
wild |
public function getRequest()Inherited
wild |
public function renderResults($objects, $query)Inherited
array | $objects | |
PhabricatorSavedQuery | $query |
wild |
protected function getRequiredHandlePHIDsForResultList($objects, $query)Inherited
array | $objects | |
PhabricatorSavedQuery | $query |
wild |
protected function renderResultList($versions, $query, $handles)
array | $objects | |
PhabricatorSavedQuery | $query | |
array | $handles |
wild |
public function getSearchFieldsForConduit()Inherited
wild |
public function buildConduitResponse($request, $method)Inherited
ConduitAPIRequest | $request | |
ConduitAPIMethod | $method |
wild |
public function getAllConduitFieldSpecifications()Inherited
wild |
private function getEngineExtensions()Inherited
wild |
private function getConduitFieldExtensions()Inherited
wild |
private function setQueryOrderForConduit($query, $request)Inherited
$query | ||
ConduitAPIRequest | $request |
wild |
private function setPagerLimitForConduit($pager, $request)Inherited
$pager | ||
ConduitAPIRequest | $request |
wild |
private function setPagerOffsetsForConduit($pager, $request)Inherited
$pager | ||
ConduitAPIRequest | $request |
wild |
protected function getObjectWireFieldsForConduit($object, $field_extensions, $extension_data)Inherited
$object | ||
array | $field_extensions | |
array | $extension_data |
wild |
public function getConduitSearchAttachments()Inherited
wild |
final public function renderNewUserView()Inherited
wild |
protected function getNewUserHeader()Inherited
wild |
protected function getNewUserBody()Inherited
wild |
public function newUseResultsActions($saved)Inherited
PhabricatorSavedQuery | $saved |
wild |
public function canExport()Inherited
wild |
final public function newExportFieldList()Inherited
wild |
final public function newExport($objects)Inherited
array | $objects |
wild |
protected function newExportFields()Inherited
wild |
protected function newExportData($objects)Inherited
array | $objects |
wild |
private function newExportExtensions()Inherited
wild |