Page MenuHomeClusterLabs Projects
Diviner Tech Docs HeraldPreCommitRefAdapter

final class HeraldPreCommitRefAdapter
Phorge Technical Documentation (Diffusion)

This class is not documented.

Methods

public function getEmailPHIDs()
Inherited

This method is not documented.
Return
wild

public function getForcedEmailPHIDs()
Inherited

This method is not documented.
Return
wild

final public function setActingAsPHID($acting_as_phid)
Inherited

This method is not documented.
Parameters
$acting_as_phid
Return
wild

final public function getActingAsPHID()
Inherited

This method is not documented.
Return
wild

public function addEmailPHID($phid, $force)
Inherited

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

public function setViewer($viewer)
Inherited

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

public function getViewer()
Inherited

This method is not documented.
Return
wild

public function setContentSource($content_source)
Inherited

This method is not documented.
Parameters
PhabricatorContentSource$content_source
Return
wild

public function getContentSource()
Inherited

This method is not documented.
Return
wild

public function getIsNewObject()
Inherited

This method is not documented.
Return
wild

public function setIsNewObject($new)
Inherited

This method is not documented.
Parameters
$new
Return
wild

public function supportsApplicationEmail()
Inherited

This method is not documented.
Return
wild

public function setApplicationEmail($email)
Inherited

This method is not documented.
Parameters
PhabricatorMetaMTAApplicationEmail$email
Return
wild

public function getApplicationEmail()
Inherited

This method is not documented.
Return
wild

public function getPHID()
Inherited

This method is not documented.
Return
wild

public function getHeraldName()

This method is not documented.
Return
wild

final public function willGetHeraldField($field_key)
Inherited

This method is not documented.
Parameters
$field_key
Return
wild

public function getHeraldField($field_key)
Inherited

This method is not documented.
Parameters
$field_key
Return
wild

public function applyHeraldEffects($effects)
Inherited

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

public function isAvailableToUser($viewer)
Inherited

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

final public function setAppliedTransactions($xactions)
Inherited

HeraldAdapter

Set the list of transactions which just took effect.

These transactions are set by PhabricatorApplicationEditor automatically, before it invokes Herald.

Parameters
list<PhabricatorApplicationTransaction>$xactionsList of transactions.
Return
this

final public function getAppliedTransactions()
Inherited

HeraldAdapter

Get a list of transactions which just took effect.

When an object is edited normally, transactions are applied and then Herald executes. You can call this method to examine the transactions if you want to react to them.

Return
list<PhabricatorApplicationTransaction>List of transactions.

final public function queueTransaction($transaction)
Inherited

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

final public function getQueuedTransactions()
Inherited

This method is not documented.
Return
wild

final public function newTransaction()
Inherited

This method is not documented.
Return
wild

public function getAdapterContentType()
Inherited

HeraldAdapter
NOTE: You generally should not override this; it exists to support legacy adapters which had hard-coded content types.
Return
wild

public function getAdapterContentName()

This method is not documented.
Return
wild

public function getAdapterContentDescription()

This method is not documented.
Return
wild

public function getAdapterApplicationClass()
Inherited

This method is not documented.
Return
wild

public function getObject()
Inherited

This method is not documented.
Return
wild

public function getAdapterContentIcon()
Inherited

This method is not documented.
Return
wild

protected function newObject()
Inherited

HeraldAdapter

Return a new characteristic object for this adapter.

The adapter will use this object to test for interfaces, generate transactions, and interact with custom fields.

Adapters must return an object from this method to enable custom field rules and various implicit actions.

Normally, you'll return an empty version of the adapted object:

return new ApplicationObject();
Return
null|objectTemplate object.

public function supportsRuleType($rule_type)
Inherited

This method is not documented.
Parameters
$rule_type
Return
wild

public function canTriggerOnObject($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function isTestAdapterForObject($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function canCreateTestAdapterForObject($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function newTestAdapter($viewer, $object)
Inherited

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

public function getAdapterTestDescription()
Inherited

This method is not documented.
Return
wild

public function explainValidTriggerObjects()
Inherited

This method is not documented.
Return
wild

public function getTriggerObjectPHIDs()
Inherited

This method is not documented.
Return
wild

public function getAdapterSortKey()
Inherited

This method is not documented.
Return
wild

public function getAdapterSortOrder()

This method is not documented.
Return
wild

private function getFieldImplementationMap()
Inherited

This method is not documented.
Return
wild

private function getFieldImplementation($key)
Inherited

This method is not documented.
Parameters
$key
Return
wild

public function getFields()
Inherited

This method is not documented.
Return
wild

public function getFieldNameMap()
Inherited

This method is not documented.
Return
wild

public function getFieldGroupKey($field_key)
Inherited

This method is not documented.
Parameters
$field_key
Return
wild

public function isFieldAvailable($field_key)
Inherited

This method is not documented.
Parameters
$field_key
Return
wild

public function getConditionNameMap()
Inherited

This method is not documented.
Return
wild

public function getConditionsForField($field)
Inherited

This method is not documented.
Parameters
$field
Return
wild

private function requireFieldImplementation($field_key)
Inherited

This method is not documented.
Parameters
$field_key
Return
wild

public function doesConditionMatch($engine, $rule, $condition, $field_value)
Inherited

This method is not documented.
Parameters
HeraldEngine$engine
HeraldRule$rule
HeraldCondition$condition
$field_value
Return
wild

public function willSaveCondition($condition)
Inherited

This method is not documented.
Parameters
HeraldCondition$condition
Return
wild

private function getActionImplementationMap()
Inherited

This method is not documented.
Return
wild

private function requireActionImplementation($action_key)
Inherited

This method is not documented.
Parameters
$action_key
Return
wild

private function getActionsForRuleType($rule_type)
Inherited

This method is not documented.
Parameters
$rule_type
Return
wild

public function getActionImplementation($key)
Inherited

This method is not documented.
Parameters
$key
Return
wild

public function getActionKeys()
Inherited

This method is not documented.
Return
wild

public function getActionGroupKey($action_key)
Inherited

This method is not documented.
Parameters
$action_key
Return
wild

public function isActionAvailable($action_key)
Inherited

This method is not documented.
Parameters
$action_key
Return
wild

public function getActions($rule_type)
Inherited

This method is not documented.
Parameters
$rule_type
Return
wild

public function getActionNameMap($rule_type)
Inherited

This method is not documented.
Parameters
$rule_type
Return
wild

public function willSaveAction($rule, $action)
Inherited

This method is not documented.
Parameters
HeraldRule$rule
HeraldActionRecord$action
Return
wild

public function getValueTypeForFieldAndCondition($field, $condition)
Inherited

This method is not documented.
Parameters
$field
$condition
Return
wild

public function getValueTypeForAction($action, $rule_type)
Inherited

This method is not documented.
Parameters
$action
$rule_type
Return
wild

private function buildTokenizerFieldValue($datasource)
Inherited

This method is not documented.
Parameters
PhabricatorTypeaheadDatasource$datasource
Return
wild

public function getRepetitionOptions()
Inherited

This method is not documented.
Return
wild

protected function initializeNewAdapter()
Inherited

This method is not documented.
Return
wild

public function isSingleEventAdapter()
Inherited

HeraldAdapter

Does this adapter's event fire only once?

Single use adapters (like pre-commit and diff adapters) only fire once, so fields like "Is new object" don't make sense to apply to their content.

Return
bool

public static function getAllAdapters()
Inherited

This method is not documented.
Return
wild

public static function getAdapterForContentType($content_type)
Inherited

This method is not documented.
Parameters
$content_type
Return
wild

public static function getEnabledAdapterMap($viewer)
Inherited

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

public function getEditorValueForCondition($viewer, $condition)
Inherited

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

public function getEditorValueForAction($viewer, $action_record)
Inherited

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

public function renderRuleAsText($rule, $viewer)
Inherited

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

private function renderConditionAsText($condition, $viewer)
Inherited

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

private function renderActionAsText($viewer, $action_record)
Inherited

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

private function renderConditionValueAsText($condition, $viewer)
Inherited

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

public function renderFieldTranscriptValue($viewer, $field_type, $field_value)
Inherited

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

protected function applyStandardEffect($effect)
Inherited

This method is not documented.
Parameters
HeraldEffect$effect
Return
wild

public function loadEdgePHIDs($type)
Inherited

This method is not documented.
Parameters
$type
Return
wild

final public function getForbiddenActions()
Inherited

This method is not documented.
Return
wild

final public function setForbiddenAction($action, $reason)
Inherited

This method is not documented.
Parameters
$action
$reason
Return
wild

final public function getRequiredFieldStates($field_key)
Inherited

This method is not documented.
Parameters
$field_key
Return
wild

final public function getRequiredActionStates($action_key)
Inherited

This method is not documented.
Parameters
$action_key
Return
wild

final public function getForbiddenReason($action)
Inherited

This method is not documented.
Parameters
$action
Return
wild

final public function addMustEncryptReason($reason)
Inherited

This method is not documented.
Parameters
$reason
Return
wild

final public function getMustEncryptReasons()
Inherited

This method is not documented.
Return
wild

public function supportsWebhooks()
Inherited

This method is not documented.
Return
wild

final public function queueWebhook($webhook_phid, $rule_phid)
Inherited

This method is not documented.
Parameters
$webhook_phid
$rule_phid
Return
wild

final public function getWebhookMap()
Inherited

This method is not documented.
Return
wild

public function isPreCommitRefAdapter()

This method is not documented.
Return
wild

public function setPushLog($log)
Inherited

This method is not documented.
Parameters
PhabricatorRepositoryPushLog$log
Return
wild

public function setHookEngine($engine)
Inherited

This method is not documented.
Parameters
DiffusionCommitHookEngine$engine
Return
wild

public function getHookEngine()
Inherited

This method is not documented.
Return
wild
Defined
src/applications/diffusion/herald/HeraldPreCommitRefAdapter.php:3
Extends
HeraldAdapterHeraldPreCommitAdapter