Page MenuHomePhorge
Diviner Tech Docs HarbormasterBuildTransactionType

abstract class HarbormasterBuildTransactionType
Phorge Technical Documentation (Harbormaster)

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()
Inherited

This method is not documented.
Return
wild

public function generateOldValue($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function generateNewValue($object, $value)
Inherited

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

public function validateTransactions($object, $xactions)
Inherited

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

public function applyInternalEffects($object, $value)
Inherited

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

public function applyExternalEffects($object, $value)
Inherited

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

public function didCommitTransaction($object, $value)
Inherited

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

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

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

public function extractFilePHIDs($object, $value)
Inherited

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

public function shouldHide()
Inherited

This method is not documented.
Return
wild

public function shouldHideForFeed()
Inherited

This method is not documented.
Return
wild

public function shouldHideForMail()
Inherited

This method is not documented.
Return
wild

public function shouldHideForNotifications()
Inherited

This method is not documented.
Return
wild

public function getIcon()
Inherited

This method is not documented.
Return
wild

public function getTitle()
Inherited

This method is not documented.
Return
wild

public function getTitleForFeed()
Inherited

This method is not documented.
Return
wild

public function getActionName()
Inherited

This method is not documented.
Return
wild

public function getActionStrength()
Inherited

This method is not documented.
Return
wild

public function getColor()
Inherited

This method is not documented.
Return
wild

public function hasChangeDetailView()
Inherited

This method is not documented.
Return
wild

public function newChangeDetailView()
Inherited

This method is not documented.
Return
wild

public function getMailDiffSectionHeader()
Inherited

This method is not documented.
Return
wild

public function newRemarkupChanges()
Inherited

This method is not documented.
Return
wild

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

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

final public function setStorage($xaction)
Inherited

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

private function getStorage()
Inherited

This method is not documented.
Return
wild

final public function setViewer($viewer)
Inherited

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

final protected function getViewer()
Inherited

This method is not documented.
Return
wild

final public function getActor()
Inherited

This method is not documented.
Return
wild

final public function getActingAsPHID()
Inherited

This method is not documented.
Return
wild

final public function setEditor($editor)
Inherited

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

final protected function getEditor()
Inherited

This method is not documented.
Return
wild

final protected function hasEditor()
Inherited

This method is not documented.
Return
wild

final protected function getAuthorPHID()
Inherited

This method is not documented.
Return
wild

final protected function getObjectPHID()
Inherited

This method is not documented.
Return
wild

final protected function getObject()
Inherited

This method is not documented.
Return
wild

final protected function getOldValue()
Inherited

This method is not documented.
Return
wild

final protected function getNewValue()
Inherited

This method is not documented.
Return
wild

final protected function renderAuthor()
Inherited

This method is not documented.
Return
wild

final protected function renderObject()
Inherited

This method is not documented.
Return
wild

final protected function renderHandle($phid)
Inherited

This method is not documented.
Parameters
$phid
Return
wild

final protected function renderOldHandle()
Inherited

This method is not documented.
Return
wild

final protected function renderNewHandle()
Inherited

This method is not documented.
Return
wild

final protected function renderOldPolicy()
Inherited

This method is not documented.
Return
wild

final protected function renderNewPolicy()
Inherited

This method is not documented.
Return
wild

final protected function renderPolicy($phid, $mode)
Inherited

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

final protected function renderHandleList($phids)
Inherited

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

final protected function renderValue($value)
Inherited

This method is not documented.
Parameters
$value
Return
wild

final protected function renderValueList($values)
Inherited

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

final protected function renderOldValue()
Inherited

This method is not documented.
Return
wild

final protected function renderNewValue()
Inherited

This method is not documented.
Return
wild

final protected function renderDate($epoch)
Inherited

This method is not documented.
Parameters
$epoch
Return
wild

final protected function renderOldDate()
Inherited

This method is not documented.
Return
wild

final protected function renderNewDate()
Inherited

This method is not documented.
Return
wild

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

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

final protected function newRequiredError($message, $xaction)
Inherited

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

final protected function newInvalidError($message, $xaction)
Inherited

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

final protected function isNewObject()
Inherited

This method is not documented.
Return
wild

final protected function isEmptyTextTransaction($value, $xactions)
Inherited

PhabricatorModularTransactionType

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()
Inherited

PhabricatorModularTransactionType

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()
Inherited

This method is not documented.
Return
wild

final protected function newRemarkupChange()
Inherited

This method is not documented.
Return
wild

final protected function isCreateTransaction()
Inherited

This method is not documented.
Return
wild

final protected function getPHIDList($old, $new)
Inherited

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

public function getMetadataValue($key, $default)
Inherited

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

public function loadTransactionTypeConduitData($xactions)
Inherited

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

public function getTransactionTypeForConduit($xaction)
Inherited

This method is not documented.
Parameters
$xaction
Return
wild

public function getFieldValuesForConduit($xaction, $data)
Inherited

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

protected function requireApplicationCapability($capability)
Inherited

This method is not documented.
Parameters
$capability
Return
wild

public function getRequiredCapabilities($object, $xaction)
Inherited

PhabricatorModularTransactionType

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)
Inherited

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

final public function getTitleForTextMail()
Inherited

This method is not documented.
Return
wild

final public function getTitleForHTMLMail()
Inherited

This method is not documented.
Return
wild

final public function getBodyForTextMail()
Inherited

This method is not documented.
Return
wild

final public function getBodyForHTMLMail()
Inherited

This method is not documented.
Return
wild

private function getTitleForMailWithRenderingTarget($target)
Inherited

This method is not documented.
Parameters
$target
Return
wild

private function getBodyForMailWithRenderingTarget($target)
Inherited

This method is not documented.
Parameters
$target
Return
wild

protected function getTitleForMail()
Inherited

This method is not documented.
Return
wild

protected function getBodyForMail()
Inherited

This method is not documented.
Return
wild
Defined
src/applications/harbormaster/xaction/build/HarbormasterBuildTransactionType.php:3
Extends
PhobjectPhabricatorModularTransactionType
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