Constructing Engines
Constructing Engines
- public static function getAllEngines() — Load all available application search engines.
- public static function getEngineByClassName($class_name) — Get an engine by class name, if it exists.
Applications
Applications
No methods for this task.
Builtin Queries
Builtin Queries
- public function getBuiltinQueries()
- public function getBuiltinQuery($query_key)
- protected function getBuiltinQueryNames()
- public function isBuiltinQuery($query_key)
- public function buildSavedQueryFromBuiltin($query_key)
Query URIs
Query URIs
- public function getQueryResultsPageURI($query_key) — Return an application URI corresponding to the results page of a query. Normally, this is something like `/application/query/QUERYKEY/`.
- public function getQueryManagementURI() — Return an application URI for query management. This is used when, e.g., a query deletion operation is cancelled.
- abstract protected function getURI($path) — Return the URI to a path within the application. Used to construct default URIs for management and results.
Date Filters
Date Filters
- protected function parseDateTime($date_time)
- protected function buildDateRange($form, $saved_query, $start_key, $start_name, $end_key, $end_name)
Result Ordering
Result Ordering
No methods for this task.
Reading Utilities
Reading Utilities
- protected function readUsersFromRequest($request, $key, $allow_types) — Read a list of user PHIDs from a request in a flexible way. This method supports either of these forms:
- protected function readSubscribersFromRequest($request, $key) — Read a list of subscribers from a request in a flexible way.
- protected function readPHIDsFromRequest($request, $key, $allow_types) — Read a list of generic PHIDs from a request in a flexible way. Like @{method:readUsersFromRequest}, this method supports either array or comma-delimited forms. Objects can be specified either by PHID or by object name.
Paging and Executing Queries
Paging and Executing Queries
No methods for this task.
Rendering Results
Rendering Results
No methods for this task.
Other Methods
Other Methods
- public function setController($controller)
- public function getController()
- public function buildResponse()
- public function newResultObject()
- public function newQuery()
- public function setViewer($viewer)
- protected function requireViewer()
- public function setContext($context)
- public function isPanelContext()
- public function setNavigationItems($navigation_items)
- public function getNavigationItems()
- public function canUseInPanelContext()
- public function saveQuery($query)
- public function buildSavedQueryFromRequest($request) — Create a saved query object from the request.
- public function buildQueryFromSavedQuery($original) — Executes the saved query.
- protected function willUseSavedQuery($saved) — Hook for subclasses to adjust saved queries prior to use.
- protected function buildQueryFromParameters($parameters)
- public function buildSearchForm($form, $saved) — Builds the search form using the request.
- protected function buildSearchFields()
- protected function shouldShowOrderField()
- private function adjustFieldsForDisplay($field_map)
- protected function buildCustomSearchFields()
- protected function getDefaultFieldOrder() — Define the default display order for fields by returning a list of field keys.
- protected function getHiddenFields() — Return a list of field keys which should be hidden from the viewer.
- public function getErrors()
- public function addError($error)
- public function getQueryBaseURI()
- public function getExportURI($query_key)
- public function getCustomizeURI($query_key, $object_phid, $context_phid)
- abstract public function getResultTypeDescription() — Return a human readable description of the type of objects this query searches for.
- public function newSavedQuery()
- public function addNavigationItems($menu)
- public function loadAllNamedQueries()
- public function loadEnabledNamedQueries()
- public function getDefaultQueryKey()
- protected function setQueryProjects($query, $saved)
- protected function getApplicationURI($path)
- protected function getApplication()
- abstract public function getApplicationClassName()
- protected function readListFromRequest($request, $key) — Read a list of items from the request, in either array format or string format:
- protected function readBoolFromRequest($request, $key)
- protected function getBoolFromQuery($query, $key)
- protected function newResultBuckets()
- public function getResultBucket($saved)
- public function getPageSize($saved)
- public function shouldUseOffsetPaging()
- public function newPagerForSavedQuery($saved)
- public function executeQuery($query, $pager)
- protected function didExecuteQuery($query)
- public function setRequest($request)
- public function getRequest()
- public function renderResults($objects, $query)
- protected function getRequiredHandlePHIDsForResultList($objects, $query)
- abstract protected function renderResultList($objects, $query, $handles)
- public function getSearchFieldsForConduit()
- public function buildConduitResponse($request, $method)
- public function getAllConduitFieldSpecifications()
- private function getEngineExtensions()
- private function getConduitFieldExtensions()
- private function setQueryOrderForConduit($query, $request)
- private function setPagerLimitForConduit($pager, $request)
- private function setPagerOffsetsForConduit($pager, $request)
- protected function getObjectWireFieldsForConduit($object, $field_extensions, $extension_data)
- public function getConduitSearchAttachments()
- final public function renderNewUserView()
- protected function getNewUserHeader()
- protected function getNewUserBody()
- public function newUseResultsActions($saved)
- public function canExport()
- final public function newExportFieldList()
- final public function newExport($objects)
- protected function newExportFields()
- protected function newExportData($objects)
- private function newExportExtensions()