Diviner Tech Docs DiffusionSymbolQuery

final class DiffusionSymbolQuery
Phorge Technical Documentation (Diffusion)

Query symbol information (class and function names and location), returning a list of matching PhabricatorRepositorySymbol objects and possibly attached data.

Tasks

Formatting Query Clauses

protected function formatWhereClause($conn, $parts)
protected function formatSelectClause($conn, $parts)
protected function formatJoinClause($conn, $parts)
protected function formatHavingClause($conn, $parts)
private function flattenSubclause($parts)

Configuring the Query

public function setViewer($viewer)
public function getViewer()
public function setContext($context)
public function setName($name)
public function setNamePrefix($name_prefix)
public function withRepositoryPHIDs($repository_phids)
public function setLanguage($language)
public function setType($type)
public function needPaths($need_paths)
public function needRepositories($need_repositories)

Executing the Query

public function execute()

Internals

private function buildOrderClause($conn_r)
protected function buildWhereClause($conn)
private function loadPaths($symbols)
private function loadRepositories($symbols)

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
final public function setOffset($offset)
final public function setLimit($limit)
final public function getOffset()
final public function getLimit()
protected function buildLimitClause($conn)
final public function executeWithOffsetPager($pager)
public function existsSymbolsInRepository($repository_phid)

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	$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 execute()

This method is not documented.

Return

wild

protected function formatWhereClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

protected function formatSelectClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

protected function formatJoinClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

protected function formatHavingClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

private function flattenSubclause($parts)
Inherited

This method is not documented.

Parameters

array

$parts

Return

wild

final public function setOffset($offset)
Inherited

This method is not documented.

Parameters

$offset

Return

wild

final public function setLimit($limit)
Inherited

This method is not documented.

Parameters

$limit

Return

wild

final public function getOffset()
Inherited

This method is not documented.

Return

wild

final public function getLimit()
Inherited

This method is not documented.

Return

wild

protected function buildLimitClause($conn)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection

$conn

Return

wild

final public function executeWithOffsetPager($pager)
Inherited

This method is not documented.

Parameters

PHUIPagerView

$pager

Return

wild

public function setViewer($viewer)

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function getViewer()

This method is not documented.

Return

wild

public function setContext($context)

This method is not documented.

Parameters

$context

Return

wild

public function setName($name)

This method is not documented.

Parameters

$name

Return

wild

public function setNamePrefix($name_prefix)

This method is not documented.

Parameters

$name_prefix

Return

wild

public function withRepositoryPHIDs($repository_phids)

This method is not documented.

Parameters

array

$repository_phids

Return

wild

public function setLanguage($language)

This method is not documented.

Parameters

$language

Return

wild

public function setType($type)

This method is not documented.

Parameters

$type

Return

wild

public function needPaths($need_paths)

This method is not documented.

Parameters

$need_paths

Return

wild

public function needRepositories($need_repositories)

This method is not documented.

Parameters

$need_repositories

Return

wild

public function existsSymbolsInRepository($repository_phid)

This method is not documented.

Parameters

$repository_phid

Return

wild

private function buildOrderClause($conn_r)

This method is not documented.

Parameters

$conn_r

Return

wild

protected function buildWhereClause($conn)

This method is not documented.

Parameters

AphrontDatabaseConnection

$conn

Return

wild

private function loadPaths($symbols)

This method is not documented.

Parameters

array

$symbols

Return

wild

private function loadRepositories($symbols)

This method is not documented.

Parameters

array

$symbols

Return

wild

Defined: src/applications/diffusion/query/DiffusionSymbolQuery.php:12
Extends: PhobjectPhabricatorQueryPhabricatorOffsetPagedQuery

final class DiffusionSymbolQueryPhorge Technical Documentation (Diffusion)

Tasks

Formatting Query Clauses

Configuring the Query

Executing the Query

Internals

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function execute()

protected function formatWhereClause($conn, $parts)Inherited

protected function formatSelectClause($conn, $parts)Inherited

protected function formatJoinClause($conn, $parts)Inherited

protected function formatHavingClause($conn, $parts)Inherited

private function flattenSubclause($parts)Inherited

final public function setOffset($offset)Inherited

final public function setLimit($limit)Inherited

final public function getOffset()Inherited

final public function getLimit()Inherited

protected function buildLimitClause($conn)Inherited

final public function executeWithOffsetPager($pager)Inherited

public function setViewer($viewer)

public function getViewer()

public function setContext($context)

public function setName($name)

public function setNamePrefix($name_prefix)

public function withRepositoryPHIDs($repository_phids)

public function setLanguage($language)

public function setType($type)

public function needPaths($need_paths)

public function needRepositories($need_repositories)

public function existsSymbolsInRepository($repository_phid)

private function buildOrderClause($conn_r)

protected function buildWhereClause($conn)

private function loadPaths($symbols)

private function loadRepositories($symbols)

final class DiffusionSymbolQuery
Phorge Technical Documentation (Diffusion)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

protected function formatWhereClause($conn, $parts)
Inherited

protected function formatSelectClause($conn, $parts)
Inherited

protected function formatJoinClause($conn, $parts)
Inherited

protected function formatHavingClause($conn, $parts)
Inherited

private function flattenSubclause($parts)
Inherited

final public function setOffset($offset)
Inherited

final public function setLimit($limit)
Inherited

final public function getOffset()
Inherited

final public function getLimit()
Inherited

protected function buildLimitClause($conn)
Inherited

final public function executeWithOffsetPager($pager)
Inherited