Diviner Tech Docs PhabricatorOffsetPagedQuery

abstract class PhabricatorOffsetPagedQuery
Phorge Technical Documentation ()

A query class which uses offset/limit paging. Provides logic and accessors for offsets and limits.

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)

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.
abstract public function execute()
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)

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.

abstract public function execute()
Inherited

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)

This method is not documented.

Parameters

$offset

Return

wild

final public function setLimit($limit)

This method is not documented.

Parameters

$limit

Return

wild

final public function getOffset()

This method is not documented.

Return

wild

final public function getLimit()

This method is not documented.

Return

wild

protected function buildLimitClause($conn)

This method is not documented.

Parameters

AphrontDatabaseConnection

$conn

Return

wild

final public function executeWithOffsetPager($pager)

This method is not documented.

Parameters

PHUIPagerView

$pager

Return

wild

Defined: src/infrastructure/query/PhabricatorOffsetPagedQuery.php:7
Extends: PhobjectPhabricatorQuery

abstract class PhabricatorOffsetPagedQueryPhorge Technical Documentation ()

Tasks

Formatting Query Clauses

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

abstract public function execute()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)

final public function setLimit($limit)

final public function getOffset()

final public function getLimit()

protected function buildLimitClause($conn)

final public function executeWithOffsetPager($pager)

abstract class PhabricatorOffsetPagedQuery
Phorge Technical Documentation ()

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

abstract public function execute()
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