Page MenuHomePhorge
Diviner Tech Docs PhabricatorQueryOrderItem

final class PhabricatorQueryOrderItem
Phorge Technical Documentation ()

Structural class representing one item in an order vector.

See PhabricatorQueryOrderVector for discussion of order vectors. This represents one item in an order vector, like "id". When combined with the other items in the vector, a complete ordering (like "name, id") is described.

Construct an item using newFromScalar():

$item = PhabricatorQueryOrderItem::newFromScalar('id');

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()
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$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 newFromScalar($scalar)

This method is not documented.
Parameters
$scalar
Return
wild

public function getIsReversed()

This method is not documented.
Return
wild

public function getOrderKey()

This method is not documented.
Return
wild

public function getAsScalar()

This method is not documented.
Return
wild
Defined
src/infrastructure/query/order/PhabricatorQueryOrderItem.php:18
Extends
Phobject
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0