public function __get($name)Inherited
public function __get($name)
Inherited
Parameters
| $name |
Return
| wild |
public function __set($name, $value)Inherited
public function __set($name, $value)
Inherited
Parameters
| $name | ||
| $value |
Return
| wild |
public function current()Inherited
public function current()
Inherited
Return
| wild |
public function key()Inherited
public function key()
Inherited
Return
| wild |
public function next()Inherited
public function next()
Inherited
Return
| wild |
public function rewind()Inherited
public function rewind()
Inherited
Return
| wild |
public function valid()Inherited
public function valid()
Inherited
Return
| wild |
private function throwOnAttemptedIteration()Inherited
private function throwOnAttemptedIteration()
Inherited
Return
| wild |
public function getPhobjectClassConstant($key, $byte_limit)Inherited
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 getHosts()
public function getHosts()
Return
| wild |
public function setService($service)
public function setService($service)
Parameters
| PhabricatorSearchService | $service |
Return
| wild |
public function getService()
public function getService()
Return
| PhabricatorSearchService |
abstract public function getHostType()
abstract public function getHostType()
Implementations must return a prototype host instance which is cloned by the PhabricatorSearchService infrastructure to configure each engine.
Return
| PhabricatorSearchHost |
abstract public function getEngineIdentifier()
abstract public function getEngineIdentifier()
Return a unique, nonempty string which identifies this storage engine.
Return
| string | Unique string for this engine, max length 32. |
abstract public function reindexAbstractDocument($document)
abstract public function reindexAbstractDocument($document)
Update the index for an abstract document.
Parameters
| PhabricatorSearchAbstractDocument | $document | Document to update. |
Return
| void |
abstract public function executeSearch($query)
abstract public function executeSearch($query)
Execute a search query.
Parameters
| PhabricatorSavedQuery | $query | A query to execute. |
Return
| list | A list of matching PHIDs. |
abstract public function indexExists()
abstract public function indexExists()
Does the search index exist?
Return
| bool |
abstract public function getIndexStats()
abstract public function getIndexStats()
Implementations should override this method to return a dictionary of stats which are suitable for display in the admin UI.
Return
| wild |
public function indexIsSane()
public function indexIsSane()
Is the index in a usable state?
Return
| bool |
public function initIndex()
public function initIndex()
Do any sort of setup for the search index.
Return
| void |
public function getFulltextTokens()
public function getFulltextTokens()
Return
| wild |