final class PhabricatorHandleList
Phorge Technical Documentation (PHIDs)

A list of object handles.

This is a convenience class which behaves like an array but makes working with handles more convenient, improves their caching and batching semantics, and provides some utility behavior.

Load a handle list by calling loadHandles() on a $viewer:

$handles = $viewer->loadHandles($phids);

This creates a handle list object, which behaves like an array of handles. However, it benefits from the viewer's internal handle cache and performs just-in-time bulk loading.

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

This method is not documented.

Return

wild

public function key()

This method is not documented.

Return

wild

public function next()

This method is not documented.

Return

wild

public function rewind()

This method is not documented.

Return

wild

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.

public function setHandlePool($pool)

This method is not documented.

Parameters

PhabricatorHandlePool

$pool

Return

wild

public function setPHIDs($phids)

This method is not documented.

Parameters

array

$phids

Return

wild

private function loadHandles()

This method is not documented.

Return

wild

private function getHandle($phid)

This method is not documented.

Parameters

$phid

Return

wild

public function getHandleIfExists($phid, $default)

Get a handle from this list if it exists.

This has similar semantics to idx().

Parameters

	$phid
	$default

Return

wild

public function newSublist($phids)

Create a new list with a subset of the PHIDs in this list.

Parameters

array

$phids

Return

wild

public function renderList()

Return a PHUIHandleListView which can render the handles in this list.

Return

wild

public function newListView()

This method is not documented.

Return

wild

public function renderHandle($phid)

Return a PHUIHandleView which can render a specific handle.

Parameters

$phid

Return

wild

public function offsetExists($offset)

This method is not documented.

Parameters

$offset

Return

wild

public function offsetGet($offset)

This method is not documented.

Parameters

$offset

Return

wild

public function offsetSet($offset, $value)

This method is not documented.

Parameters

	$offset
	$value

Return

wild

public function offsetUnset($offset)

This method is not documented.

Parameters

$offset

Return

wild

private function raiseImmutableException()

This method is not documented.

Return

wild

public function count()

This method is not documented.

Return

wild

Defined: src/applications/phid/handle/pool/PhabricatorHandleList.php:18
Extends: Phobject

final class PhabricatorHandleListPhorge Technical Documentation (PHIDs)

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()

public function key()

public function next()

public function rewind()

public function valid()

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function setHandlePool($pool)

public function setPHIDs($phids)

private function loadHandles()

private function getHandle($phid)

public function getHandleIfExists($phid, $default)

public function newSublist($phids)

public function renderList()

public function newListView()

public function renderHandle($phid)

public function offsetExists($offset)

public function offsetGet($offset)

public function offsetSet($offset, $value)

public function offsetUnset($offset)

private function raiseImmutableException()

public function count()

final class PhabricatorHandleList
Phorge Technical Documentation (PHIDs)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited