Page MenuHomePhorge
Diviner Tech Docs PhabricatorModularTransactionType

abstract class PhabricatorModularTransactionType
Phorge Technical Documentation (Transactions)

This class is not documented.

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.

final public function getTransactionTypeConstant()

This method is not documented.
Return
wild

public function generateOldValue($object)

This method is not documented.
Parameters
$object
Return
wild

public function generateNewValue($object, $value)

This method is not documented.
Parameters
$object
$value
Return
wild

public function validateTransactions($object, $xactions)

This method is not documented.
Parameters
$object
array$xactions
Return
wild

public function applyInternalEffects($object, $value)

This method is not documented.
Parameters
$object
$value
Return
wild

public function applyExternalEffects($object, $value)

This method is not documented.
Parameters
$object
$value
Return
wild

public function didCommitTransaction($object, $value)

This method is not documented.
Parameters
$object
$value
Return
wild

public function getTransactionHasEffect($object, $old, $new)

This method is not documented.
Parameters
$object
$old
$new
Return
wild

public function extractFilePHIDs($object, $value)

This method is not documented.
Parameters
$object
$value
Return
wild

public function shouldHide()

This method is not documented.
Return
wild

public function shouldHideForFeed()

This method is not documented.
Return
wild

public function shouldHideForMail()

This method is not documented.
Return
wild

public function shouldHideForNotifications()

This method is not documented.
Return
wild

public function getIcon()

This method is not documented.
Return
wild

public function getTitle()

This method is not documented.
Return
wild

public function getTitleForFeed()

This method is not documented.
Return
wild

public function getActionName()

This method is not documented.
Return
wild

public function getActionStrength()

This method is not documented.
Return
wild

public function getColor()

This method is not documented.
Return
wild

public function hasChangeDetailView()

This method is not documented.
Return
wild

public function newChangeDetailView()

This method is not documented.
Return
wild

public function getMailDiffSectionHeader()

This method is not documented.
Return
wild

public function newRemarkupChanges()

This method is not documented.
Return
wild

public function mergeTransactions($object, $u, $v)

This method is not documented.
Parameters
$object
PhabricatorApplicationTransaction$u
PhabricatorApplicationTransaction$v
Return
wild

final public function setStorage($xaction)

This method is not documented.
Parameters
PhabricatorApplicationTransaction$xaction
Return
wild

private function getStorage()

This method is not documented.
Return
wild

final public function setViewer($viewer)

This method is not documented.
Parameters
PhabricatorUser$viewer
Return
wild

final protected function getViewer()

This method is not documented.
Return
wild

final public function getActor()

This method is not documented.
Return
wild

final public function getActingAsPHID()

This method is not documented.
Return
wild

final public function setEditor($editor)

This method is not documented.
Parameters
PhabricatorApplicationTransactionEditor$editor
Return
wild

final protected function getEditor()

This method is not documented.
Return
wild

final protected function hasEditor()

This method is not documented.
Return
wild

final protected function getAuthorPHID()

This method is not documented.
Return
wild

final protected function getObjectPHID()

This method is not documented.
Return
wild

final protected function getObject()

This method is not documented.
Return
wild

final protected function getOldValue()

This method is not documented.
Return
wild

final protected function getNewValue()

This method is not documented.
Return
wild

final protected function renderAuthor()

This method is not documented.
Return
wild

final protected function renderObject()

This method is not documented.
Return
wild

final protected function renderHandle($phid)

This method is not documented.
Parameters
$phid
Return
wild

final protected function renderOldHandle()

This method is not documented.
Return
wild

final protected function renderNewHandle()

This method is not documented.
Return
wild

final protected function renderOldPolicy()

This method is not documented.
Return
wild

final protected function renderNewPolicy()

This method is not documented.
Return
wild

final protected function renderPolicy($phid, $mode)

This method is not documented.
Parameters
$phid
$mode
Return
wild

final protected function renderHandleList($phids)

This method is not documented.
Parameters
array$phids
Return
wild

final protected function renderValue($value)

This method is not documented.
Parameters
$value
Return
wild

final protected function renderValueList($values)

This method is not documented.
Parameters
array$values
Return
wild

final protected function renderOldValue()

This method is not documented.
Return
wild

final protected function renderNewValue()

This method is not documented.
Return
wild

final protected function renderDate($epoch)

This method is not documented.
Parameters
$epoch
Return
wild

final protected function renderOldDate()

This method is not documented.
Return
wild

final protected function renderNewDate()

This method is not documented.
Return
wild

final protected function newError($title, $message, $xaction)

This method is not documented.
Parameters
$title
$message
$xaction
Return
wild

final protected function newRequiredError($message, $xaction)

This method is not documented.
Parameters
$message
$xaction
Return
wild

final protected function newInvalidError($message, $xaction)

This method is not documented.
Parameters
$message
$xaction
Return
wild

final protected function isNewObject()

This method is not documented.
Return
wild

final protected function isEmptyTextTransaction($value, $xactions)

Check whenever a new transaction's value is considered an "empty text"

Parameters
mixed$valueA string, null, an integer...
array$xactionsTransactions
Return
wild

final protected function isRenderingTargetExternal()

When rendering to external targets (Email/Asana/etc), we need to include more information that users can't obtain later.

Return
wild

final protected function isTextMode()

This method is not documented.
Return
wild

final protected function newRemarkupChange()

This method is not documented.
Return
wild

final protected function isCreateTransaction()

This method is not documented.
Return
wild

final protected function getPHIDList($old, $new)

This method is not documented.
Parameters
array$old
array$new
Return
wild

public function getMetadataValue($key, $default)

This method is not documented.
Parameters
$key
$default
Return
wild

public function loadTransactionTypeConduitData($xactions)

This method is not documented.
Parameters
array$xactions
Return
wild

public function getTransactionTypeForConduit($xaction)

This method is not documented.
Parameters
$xaction
Return
wild

public function getFieldValuesForConduit($xaction, $data)

This method is not documented.
Parameters
$xaction
$data
Return
wild

protected function requireApplicationCapability($capability)

This method is not documented.
Parameters
$capability
Return
wild

public function getRequiredCapabilities($object, $xaction)

Get a list of capabilities the actor must have on the object to apply a transaction to it.

Usually, you should use this to reduce capability requirements when a transaction (like leaving a Conpherence thread) can be applied without having edit permission on the object. You can override this method to remove the CAN_EDIT requirement, or to replace it with a different requirement.

If you are increasing capability requirements and need to add an additional capability or policy requirement above and beyond CAN_EDIT, it is usually better implemented as a validation check.

Parameters
object$objectObject being edited.
PhabricatorApplicationTransaction$xactionTransaction being applied.
Return
null|const|list<const>A capability constant (or list of capability constants) which the actor must have on the object. You can return `null` as a shorthand for "no capabilities are required".

public function shouldTryMFA($object, $xaction)

This method is not documented.
Parameters
$object
PhabricatorApplicationTransaction$xaction
Return
wild

final public function getTitleForTextMail()

This method is not documented.
Return
wild

final public function getTitleForHTMLMail()

This method is not documented.
Return
wild

final public function getBodyForTextMail()

This method is not documented.
Return
wild

final public function getBodyForHTMLMail()

This method is not documented.
Return
wild

private function getTitleForMailWithRenderingTarget($target)

This method is not documented.
Parameters
$target
Return
wild

private function getBodyForMailWithRenderingTarget($target)

This method is not documented.
Parameters
$target
Return
wild

protected function getTitleForMail()

This method is not documented.
Return
wild

protected function getBodyForMail()

This method is not documented.
Return
wild