Page MenuHomePhorge
Diviner Tech Docs PhabricatorQueryOrderVector

final class PhabricatorQueryOrderVector
Phorge Technical Documentation ()

Structural class representing a column ordering for a query.

Queries often order results on multiple columns. For example, projects might be ordered by "name, id". This class wraps a list of column orderings and makes them easier to manage.

To construct an order vector, use newFromVector():

$vector = PhabricatorQueryOrderVector::newFromVector(array('name', 'id'));

You can iterate over an order vector normally:

foreach ($vector as $item) {
  // ...
}

The items are objects of class PhabricatorQueryOrderItem.

This class is primarily internal to the query infrastructure, and most application code should not need to interact with it directly.

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$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

private function __construct()

This method is not documented.
Return
this//Implicit.//

public static function newFromVector($vector)

This method is not documented.
Parameters
$vector
Return
wild

public function appendVector($vector)

This method is not documented.
Parameters
$vector
Return
wild

public function getAsString()

This method is not documented.
Return
wild

public function containsKey($key)

This method is not documented.
Parameters
$key
Return
wild