Page MenuHomeClusterLabs Projects
Diviner Tech Docs PhabricatorHandleList

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

This method is not documented.
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 valid()

This method is not documented.
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