Diviner Phabricator Tech Docs PhabricatorModularTransactionType

abstract class PhabricatorModularTransactionType
Phabricator Technical Documentation (Transactions)

This class is not documented.

Methods

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)

This method is not documented.

Parameters

	$value
array	$xactions

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	$object	Object being edited.
PhabricatorApplicationTransaction	$xaction	Transaction 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

Defined: src/applications/transactions/storage/PhabricatorModularTransactionType.php:3

abstract class PhabricatorModularTransactionTypePhabricator Technical Documentation (Transactions)

Methods

final public function getTransactionTypeConstant()

public function generateOldValue($object)

public function generateNewValue($object, $value)

public function validateTransactions($object, $xactions)

public function applyInternalEffects($object, $value)

public function applyExternalEffects($object, $value)

public function didCommitTransaction($object, $value)

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

public function extractFilePHIDs($object, $value)

public function shouldHide()

public function shouldHideForFeed()

public function shouldHideForMail()

public function shouldHideForNotifications()

public function getIcon()

public function getTitle()

public function getTitleForFeed()

public function getActionName()

public function getActionStrength()

public function getColor()

public function hasChangeDetailView()

public function newChangeDetailView()

public function getMailDiffSectionHeader()

public function newRemarkupChanges()

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

final public function setStorage($xaction)

private function getStorage()

final public function setViewer($viewer)

final protected function getViewer()

final public function getActor()

final public function getActingAsPHID()

final public function setEditor($editor)

final protected function getEditor()

final protected function hasEditor()

final protected function getAuthorPHID()

final protected function getObjectPHID()

final protected function getObject()

final protected function getOldValue()

final protected function getNewValue()

final protected function renderAuthor()

final protected function renderObject()

final protected function renderHandle($phid)

final protected function renderOldHandle()

final protected function renderNewHandle()

final protected function renderOldPolicy()

final protected function renderNewPolicy()

final protected function renderPolicy($phid, $mode)

final protected function renderHandleList($phids)

final protected function renderValue($value)

final protected function renderValueList($values)

final protected function renderOldValue()

final protected function renderNewValue()

final protected function renderDate($epoch)

final protected function renderOldDate()

final protected function renderNewDate()

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

final protected function newRequiredError($message, $xaction)

final protected function newInvalidError($message, $xaction)

final protected function isNewObject()

final protected function isEmptyTextTransaction($value, $xactions)

final protected function isRenderingTargetExternal()

final protected function isTextMode()

final protected function newRemarkupChange()

final protected function isCreateTransaction()

final protected function getPHIDList($old, $new)

public function getMetadataValue($key, $default)

public function loadTransactionTypeConduitData($xactions)

public function getTransactionTypeForConduit($xaction)

public function getFieldValuesForConduit($xaction, $data)

protected function requireApplicationCapability($capability)

public function getRequiredCapabilities($object, $xaction)

public function shouldTryMFA($object, $xaction)

final public function getTitleForTextMail()

final public function getTitleForHTMLMail()

final public function getBodyForTextMail()

final public function getBodyForHTMLMail()

private function getTitleForMailWithRenderingTarget($target)

private function getBodyForMailWithRenderingTarget($target)

protected function getTitleForMail()

abstract class PhabricatorModularTransactionType
Phabricator Technical Documentation (Transactions)