Page MenuHomePhorge
Diviner Tech Docs PhabricatorFerretFulltextStorageEngine

final class PhabricatorFerretFulltextStorageEngine
Phorge Technical Documentation (Search)

This class is not documented.

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$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function getHosts()
Inherited

This method is not documented.
Return
wild

public function setService($service)
Inherited

This method is not documented.
Parameters
PhabricatorSearchService$service
Return
wild

public function getService()
Inherited

This method is not documented.
Return
PhabricatorSearchService

public function getHostType()

PhabricatorFulltextStorageEngine

Implementations must return a prototype host instance which is cloned by the PhabricatorSearchService infrastructure to configure each engine.

PhabricatorFerretFulltextStorageEngine
This method is not documented.
Return
PhabricatorSearchHost

public function getEngineIdentifier()

PhabricatorFulltextStorageEngine

Return a unique, nonempty string which identifies this storage engine.

PhabricatorFerretFulltextStorageEngine
This method is not documented.
Return
stringUnique string for this engine, max length 32.

public function reindexAbstractDocument($doc)

PhabricatorFulltextStorageEngine

Update the index for an abstract document.

PhabricatorFerretFulltextStorageEngine
This method is not documented.
Parameters
PhabricatorSearchAbstractDocument$documentDocument to update.
Return
void

public function executeSearch($query)

PhabricatorFulltextStorageEngine

Execute a search query.

PhabricatorFerretFulltextStorageEngine
This method is not documented.
Parameters
PhabricatorSavedQuery$queryA query to execute.
Return
listA list of matching PHIDs.

public function indexExists()

PhabricatorFulltextStorageEngine

Does the search index exist?

PhabricatorFerretFulltextStorageEngine
This method is not documented.
Return
bool

public function getIndexStats()

PhabricatorFulltextStorageEngine

Implementations should override this method to return a dictionary of stats which are suitable for display in the admin UI.

PhabricatorFerretFulltextStorageEngine
This method is not documented.
Return
wild

public function indexIsSane()
Inherited

PhabricatorFulltextStorageEngine

Is the index in a usable state?

Return
bool

public function initIndex()
Inherited

PhabricatorFulltextStorageEngine

Do any sort of setup for the search index.

Return
void

public function getFulltextTokens()

This method is not documented.
Return
wild