Page MenuHomePhabricator

final class DivinerAtomQuery
Phabricator Technical Documentation (Diviner)

This class is not documented.

Methods

public function withIDs($ids)

This method is not documented.
Parameters
array$ids
Return
wild

public function withPHIDs($phids)

This method is not documented.
Parameters
array$phids
Return
wild

public function withBookPHIDs($phids)

This method is not documented.
Parameters
array$phids
Return
wild

public function withTypes($types)

This method is not documented.
Parameters
array$types
Return
wild

public function withNames($names)

This method is not documented.
Parameters
array$names
Return
wild

public function withContexts($contexts)

This method is not documented.
Parameters
array$contexts
Return
wild

public function withIndexes($indexes)

This method is not documented.
Parameters
array$indexes
Return
wild

public function withNodeHashes($hashes)

This method is not documented.
Parameters
array$hashes
Return
wild

public function withTitles($titles)

This method is not documented.
Parameters
$titles
Return
wild

public function withNameContains($text)

This method is not documented.
Parameters
$text
Return
wild

public function needAtoms($need)

This method is not documented.
Parameters
$need
Return
wild

public function needChildren($need)

This method is not documented.
Parameters
$need
Return
wild

public function withGhosts($ghosts)

Include or exclude "ghosts", which are symbols which used to exist but do not exist currently (for example, a function which existed in an older version of the codebase but was deleted).

These symbols had PHIDs assigned to them, and may have other sorts of metadata that we don't want to lose (like comments or flags), so we don't delete them outright. They might also come back in the future: the change which deleted the symbol might be reverted, or the documentation might have been generated incorrectly by accident. In these cases, we can restore the original data.

Parameters
bool$ghosts
Return
this

public function needExtends($need)

This method is not documented.
Parameters
$need
Return
wild

public function withIsDocumentable($documentable)

This method is not documented.
Parameters
$documentable
Return
wild

public function withRepositoryPHIDs($repository_phids)

This method is not documented.
Parameters
array$repository_phids
Return
wild

public function needRepositories($need_repositories)

This method is not documented.
Parameters
$need_repositories
Return
wild

protected function loadPage()

This method is not documented.
Return
wild

protected function willFilterPage($atoms)

This method is not documented.
Parameters
array$atoms
Return
wild

protected function buildWhereClause($conn)

This method is not documented.
Parameters
AphrontDatabaseConnection$conn
Return
wild

private function getAllChildHashes($symbols, $recurse_up)

Walk a list of atoms and collect all the node hashes of the atoms' children. When recursing, also walk up the tree and collect children of atoms they extend.

Parameters
list<DivinerLiveSymbol>$symbolsList of symbols to collect child hashes of.
bool$recurse_upTrue to collect children of extended atoms, as well.
Return
map<string, string>Hashes of atoms' children.

private function attachAllChildren($symbols, $children, $recurse_up)

Attach child atoms to existing atoms. In recursive mode, also attach child atoms to atoms that these atoms extend.

Parameters
list<DivinerLiveSymbol>$symbolsList of symbols to attach children to.
map<string,$childrenDivinerLiveSymbol> Map of symbols, keyed by node hash.
bool$recurse_upTrue to attach children to extended atoms, as well.
Return
void

public function getQueryApplicationClass()

This method is not documented.
Return
wild