Page MenuHomeMTRNord's Forge
Diviner Tech Docs PhabricatorEdgeType

abstract class PhabricatorEdgeType
Phorge Technical Documentation (Edges)

Defines an edge type.

Edges are typed, directed connections between two objects. They are used to represent most simple relationships, like when a user is subscribed to an object or an object is a member of a project.

Tasks

Loading Types

Other Methods

  • final public function getEdgeConstant()
  • public function getConduitKey()
  • public function getConduitName()
  • public function getConduitDescription()
  • public function getInverseEdgeConstant()
  • public function shouldPreventCycles()
  • public function shouldWriteInverseTransactions()
  • public function getTransactionPreviewString($actor)
  • public function getTransactionAddString($actor, $add_count, $add_edges) — Returns a string representing how adding this instances of this edge should be rendered in history of an object.
  • public function getTransactionRemoveString($actor, $rem_count, $rem_edges) — Returns a string representing how adding removing instances of this edge should be rendered in history of an object.
  • public function getTransactionEditString($actor, $total_count, $add_count, $add_edges, $rem_count, $rem_edges) — Returns a string representing how adding and removing instances of this edge should be rendered in history of an object.
  • public function getFeedAddString($actor, $object, $add_count, $add_edges) — Returns a string representing how adding instances of this edge should be rendered in the feed.
  • public function getFeedRemoveString($actor, $object, $rem_count, $rem_edges) — Returns a string representing how removing instances of this edge should be rendered in the feed.
  • public function getFeedEditString($actor, $object, $total_count, $add_count, $add_edges, $rem_count, $rem_edges) — Returns a string representing how adding and removing instances of this edge should be rendered in the feed.

Methods

final public function getEdgeConstant()

This method is not documented.
Return
wild

public function getConduitKey()

This method is not documented.
Return
wild

public function getConduitName()

This method is not documented.
Return
wild

public function getConduitDescription()

This method is not documented.
Return
wild

public function getInverseEdgeConstant()

This method is not documented.
Return
wild

public function shouldPreventCycles()

This method is not documented.
Return
wild

public function shouldWriteInverseTransactions()

This method is not documented.
Return
wild

public function getTransactionPreviewString($actor)

This method is not documented.
Parameters
$actor
Return
wild

public function getTransactionAddString($actor, $add_count, $add_edges)

Returns a string representing how adding this instances of this edge should be rendered in history of an object.

Note that the parameters to this function (and overriding functions in subclasses) are special-cased by the i18n string extractor; the add_count parameter is treated as a number if passed to pht (even though the extractor can't generally parse numbers passed as method arguments)

Parameters
$actor
$add_count
$add_edges
Return
wild

public function getTransactionRemoveString($actor, $rem_count, $rem_edges)

Returns a string representing how adding removing instances of this edge should be rendered in history of an object.

Note that the parameters to this function (and overriding functions in subclasses) are special-cased by the i18n string extractor; the rem_count parameter is treated as a number if passed to pht (even though the extractor can't generally parse numbers passed as method arguments)

Parameters
$actor
$rem_count
$rem_edges
Return
wild

public function getTransactionEditString($actor, $total_count, $add_count, $add_edges, $rem_count, $rem_edges)

Returns a string representing how adding and removing instances of this edge should be rendered in history of an object.

Note that the parameters to this function (and overriding functions in subclasses) are special-cased by the i18n string extractor; the *_count parameters are treated as a numbers if passed to pht (even though the extractor can't generally parse numbers passed as method arguments)

Parameters
$actor
$total_count
$add_count
$add_edges
$rem_count
$rem_edges
Return
wild

public function getFeedAddString($actor, $object, $add_count, $add_edges)

Returns a string representing how adding instances of this edge should be rendered in the feed.

Note that the parameters to this function (and overriding functions in subclasses) are special-cased by the i18n string extractor; the add_count parameter is treated as a number if passed to pht (even though the extractor can't generally parse numbers passed as method arguments)

Parameters
$actor
$object
$add_count
$add_edges
Return
wild

public function getFeedRemoveString($actor, $object, $rem_count, $rem_edges)

Returns a string representing how removing instances of this edge should be rendered in the feed.

Note that the parameters to this function (and overriding functions in subclasses) are special-cased by the i18n string extractor; the rem_count parameter is treated as a number if passed to pht (even though the extractor can't generally parse numbers passed as method arguments)

Parameters
$actor
$object
$rem_count
$rem_edges
Return
wild

public function getFeedEditString($actor, $object, $total_count, $add_count, $add_edges, $rem_count, $rem_edges)

Returns a string representing how adding and removing instances of this edge should be rendered in the feed.

Note that the parameters to this function (and overriding functions in subclasses) are special-cased by the i18n string extractor; the *_count parameters are treated as numbers if passed to pht (even though the extractor can't generally parse numbers passed as method arguments)

Parameters
$actor
$object
$total_count
$add_count
$add_edges
$rem_count
$rem_edges
Return
wild

public static function getAllTypes()

This method is not documented.
Return
wild

public static function getByConstant($const)

This method is not documented.
Parameters
$const
Return
wild
Defined
src/infrastructure/edges/type/PhabricatorEdgeType.php:12