Diviner libphutil Tech Docs PhutilBufferedIterator

abstract class PhutilBufferedIterator
libphutil Technical Documentation (Core Utilities)

Simple iterator that loads results page-by-page and handles buffering. In particular, this maps well to iterators that load database results page by page and allows you to implement an iterator over a large result set without needing to hold the entire set in memory.

For an example implementation, see PhutilExampleBufferedIterator.

Tasks

Methods to Implement

abstract protected function didRewind() — Called when @{method:rewind} is invoked. You should reset any internal cursor your implementation holds.
abstract protected function loadPage() — Called when the iterator needs a page of results. You should load the next result page and update your internal cursor to point past it.

Configuration

final public function getPageSize() — Get the configured page size.
final public function setPageSize($size) — Configure the page size. Note that implementations may ignore this.

Iterator Implementation

final public function current()
public function key() — By default, the iterator assigns a "natural" key (0, 1, 2, ...) to each result. This method is intentionally nonfinal so you can substitute a different behavior by overriding it if you prefer.
final public function next()
final public function rewind()
final public function valid()

Other Methods

public function __get($name)
public function __set($name, $value)
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.

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

final public function current()

This method is not documented.

Return

wild

public function key()

By default, the iterator assigns a "natural" key (0, 1, 2, ...) to each result. This method is intentionally nonfinal so you can substitute a different behavior by overriding it if you prefer.

Return

scalar

Key for the current result (as per @{method:current}).

final public function next()

This method is not documented.

Return

wild

final public function rewind()

This method is not documented.

Return

wild

final public function valid()

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 protected function didRewind()

Called when rewind() is invoked. You should reset any internal cursor your implementation holds.

Return

void

abstract protected function loadPage()

Called when the iterator needs a page of results. You should load the next result page and update your internal cursor to point past it.

If possible, you should use getPageSize() to choose a page size.

Return

list<wild>

List of results.

final public function getPageSize()

Get the configured page size.

Return

int	Page size.

final public function setPageSize($size)

Configure the page size. Note that implementations may ignore this.

Parameters

int

$size

Page size.

Return

this

Defined: src/utils/PhutilBufferedIterator.php:15
Extends: Phobject

abstract class PhutilBufferedIteratorlibphutil Technical Documentation (Core Utilities)

Tasks

Methods to Implement

Configuration

Iterator Implementation

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

final public function current()

public function key()

final public function next()

final public function rewind()

final public function valid()

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

abstract protected function didRewind()

abstract protected function loadPage()

final public function getPageSize()

final public function setPageSize($size)

abstract class PhutilBufferedIterator
libphutil Technical Documentation (Core Utilities)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited