public function getEmailPHIDs()
public function getEmailPHIDs()
Return
| wild |
public function getForcedEmailPHIDs()
public function getForcedEmailPHIDs()
Return
| wild |
final public function setActingAsPHID($acting_as_phid)
final public function setActingAsPHID($acting_as_phid)
Parameters
| $acting_as_phid |
Return
| wild |
final public function getActingAsPHID()
final public function getActingAsPHID()
Return
| wild |
public function addEmailPHID($phid, $force)
public function addEmailPHID($phid, $force)
Parameters
| $phid | ||
| $force |
Return
| wild |
public function setViewer($viewer)
public function setViewer($viewer)
Parameters
| PhabricatorUser | $viewer |
Return
| wild |
public function getViewer()
public function getViewer()
Return
| wild |
public function setContentSource($content_source)
public function setContentSource($content_source)
Parameters
| PhabricatorContentSource | $content_source |
Return
| wild |
public function getContentSource()
public function getContentSource()
Return
| wild |
public function getIsNewObject()
public function getIsNewObject()
Return
| wild |
public function setIsNewObject($new)
public function setIsNewObject($new)
Parameters
| $new |
Return
| wild |
public function supportsApplicationEmail()
public function supportsApplicationEmail()
Return
| wild |
public function setApplicationEmail($email)
public function setApplicationEmail($email)
Parameters
| PhabricatorMetaMTAApplicationEmail |
Return
| wild |
public function getApplicationEmail()
public function getApplicationEmail()
Return
| wild |
public function getPHID()
public function getPHID()
Return
| wild |
abstract public function getHeraldName()
abstract public function getHeraldName()
Return
| wild |
final public function willGetHeraldField($field_key)
final public function willGetHeraldField($field_key)
Parameters
| $field_key |
Return
| wild |
public function getHeraldField($field_key)
public function getHeraldField($field_key)
Parameters
| $field_key |
Return
| wild |
public function applyHeraldEffects($effects)
public function applyHeraldEffects($effects)
Parameters
| array | $effects |
Return
| wild |
public function isAvailableToUser($viewer)
public function isAvailableToUser($viewer)
Parameters
| PhabricatorUser | $viewer |
Return
| wild |
final public function setAppliedTransactions($xactions)
final public function setAppliedTransactions($xactions)
Set the list of transactions which just took effect.
These transactions are set by PhabricatorApplicationEditor automatically, before it invokes Herald.
Parameters
| list<PhabricatorApplicationTransaction> | $xactions | List of transactions. |
Return
| this |
final public function getAppliedTransactions()
final public function getAppliedTransactions()
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)
final public function queueTransaction($transaction)
Parameters
| PhabricatorApplicationTransaction | $transaction |
Return
| wild |
final public function getQueuedTransactions()
final public function getQueuedTransactions()
Return
| wild |
final public function newTransaction()
final public function newTransaction()
Return
| wild |
public function getAdapterContentType()
public function getAdapterContentType()
NOTE: You generally should not override this; it exists to support legacy
adapters which had hard-coded content types.
Return
| wild |
abstract public function getAdapterContentName()
abstract public function getAdapterContentName()
Return
| wild |
abstract public function getAdapterContentDescription()
abstract public function getAdapterContentDescription()
Return
| wild |
abstract public function getAdapterApplicationClass()
abstract public function getAdapterApplicationClass()
Return
| wild |
abstract public function getObject()
abstract public function getObject()
Return
| wild |
public function getAdapterContentIcon()
public function getAdapterContentIcon()
Return
| wild |
protected function newObject()
protected function newObject()
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|object | Template object. |
public function supportsRuleType($rule_type)
public function supportsRuleType($rule_type)
Parameters
| $rule_type |
Return
| wild |
public function canTriggerOnObject($object)
public function canTriggerOnObject($object)
Parameters
| $object |
Return
| wild |
public function isTestAdapterForObject($object)
public function isTestAdapterForObject($object)
Parameters
| $object |
Return
| wild |
public function canCreateTestAdapterForObject($object)
public function canCreateTestAdapterForObject($object)
Parameters
| $object |
Return
| wild |
public function newTestAdapter($viewer, $object)
public function newTestAdapter($viewer, $object)
Parameters
| PhabricatorUser | $viewer | |
| $object |
Return
| wild |
public function getAdapterTestDescription()
public function getAdapterTestDescription()
Return
| wild |
public function explainValidTriggerObjects()
public function explainValidTriggerObjects()
Return
| wild |
public function getTriggerObjectPHIDs()
public function getTriggerObjectPHIDs()
Return
| wild |
public function getAdapterSortKey()
public function getAdapterSortKey()
Return
| wild |
public function getAdapterSortOrder()
public function getAdapterSortOrder()
Return
| wild |
private function getFieldImplementationMap()
private function getFieldImplementationMap()
Return
| wild |
private function getFieldImplementation($key)
private function getFieldImplementation($key)
Parameters
| $key |
Return
| wild |
public function getFields()
public function getFields()
Return
| wild |
public function getFieldNameMap()
public function getFieldNameMap()
Return
| wild |
public function getFieldGroupKey($field_key)
public function getFieldGroupKey($field_key)
Parameters
| $field_key |
Return
| wild |
public function isFieldAvailable($field_key)
public function isFieldAvailable($field_key)
Parameters
| $field_key |
Return
| wild |
public function getConditionNameMap()
public function getConditionNameMap()
Return
| wild |
public function getConditionsForField($field)
public function getConditionsForField($field)
Parameters
| $field |
Return
| wild |
private function requireFieldImplementation($field_key)
private function requireFieldImplementation($field_key)
Parameters
| $field_key |
Return
| wild |
public function doesConditionMatch($engine, $rule, $condition, $field_value)
public function doesConditionMatch($engine, $rule, $condition, $field_value)
Parameters
| HeraldEngine | $engine | |
| HeraldRule | $rule | |
| HeraldCondition | $condition | |
| $field_value |
Return
| wild |
public function willSaveCondition($condition)
public function willSaveCondition($condition)
Parameters
| HeraldCondition | $condition |
Return
| wild |
private function getActionImplementationMap()
private function getActionImplementationMap()
Return
| wild |
private function requireActionImplementation($action_key)
private function requireActionImplementation($action_key)
Parameters
| $action_key |
Return
| wild |
private function getActionsForRuleType($rule_type)
private function getActionsForRuleType($rule_type)
Parameters
| $rule_type |
Return
| wild |
public function getActionImplementation($key)
public function getActionImplementation($key)
Parameters
| $key |
Return
| wild |
public function getActionKeys()
public function getActionKeys()
Return
| wild |
public function getActionGroupKey($action_key)
public function getActionGroupKey($action_key)
Parameters
| $action_key |
Return
| wild |
public function isActionAvailable($action_key)
public function isActionAvailable($action_key)
Parameters
| $action_key |
Return
| wild |
public function getActions($rule_type)
public function getActions($rule_type)
Parameters
| $rule_type |
Return
| wild |
public function getActionNameMap($rule_type)
public function getActionNameMap($rule_type)
Parameters
| $rule_type |
Return
| wild |
public function willSaveAction($rule, $action)
public function willSaveAction($rule, $action)
Parameters
| HeraldRule | $rule | |
| HeraldActionRecord | $action |
Return
| wild |
public function getValueTypeForFieldAndCondition($field, $condition)
public function getValueTypeForFieldAndCondition($field, $condition)
Parameters
| $field | ||
| $condition |
Return
| wild |
public function getValueTypeForAction($action, $rule_type)
public function getValueTypeForAction($action, $rule_type)
Parameters
| $action | ||
| $rule_type |
Return
| wild |
private function buildTokenizerFieldValue($datasource)
private function buildTokenizerFieldValue($datasource)
Parameters
| PhabricatorTypeaheadDatasource | $datasource |
Return
| wild |
public function getRepetitionOptions()
public function getRepetitionOptions()
Return
| wild |
protected function initializeNewAdapter()
protected function initializeNewAdapter()
Return
| wild |
public function isSingleEventAdapter()
public function isSingleEventAdapter()
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()
public static function getAllAdapters()
Return
| wild |
public static function getAdapterForContentType($content_type)
public static function getAdapterForContentType($content_type)
Parameters
| $content_type |
Return
| wild |
public static function getEnabledAdapterMap($viewer)
public static function getEnabledAdapterMap($viewer)
Parameters
| PhabricatorUser | $viewer |
Return
| wild |
public function getEditorValueForCondition($viewer, $condition)
public function getEditorValueForCondition($viewer, $condition)
Parameters
| PhabricatorUser | $viewer | |
| HeraldCondition | $condition |
Return
| wild |
public function getEditorValueForAction($viewer, $action_record)
public function getEditorValueForAction($viewer, $action_record)
Parameters
| PhabricatorUser | $viewer | |
| HeraldActionRecord | $action_record |
Return
| wild |
public function renderRuleAsText($rule, $viewer)
public function renderRuleAsText($rule, $viewer)
Parameters
| HeraldRule | $rule | |
| PhabricatorUser | $viewer |
Return
| wild |
private function renderConditionAsText($condition, $viewer)
private function renderConditionAsText($condition, $viewer)
Parameters
| HeraldCondition | $condition | |
| PhabricatorUser | $viewer |
Return
| wild |
private function renderActionAsText($viewer, $action_record)
private function renderActionAsText($viewer, $action_record)
Parameters
| PhabricatorUser | $viewer | |
| HeraldActionRecord | $action_record |
Return
| wild |
private function renderConditionValueAsText($condition, $viewer)
private function renderConditionValueAsText($condition, $viewer)
Parameters
| HeraldCondition | $condition | |
| PhabricatorUser | $viewer |
Return
| wild |
public function renderFieldTranscriptValue($viewer, $field_type, $field_value)
public function renderFieldTranscriptValue($viewer, $field_type, $field_value)
Parameters
| PhabricatorUser | $viewer | |
| $field_type | ||
| $field_value |
Return
| wild |
protected function applyStandardEffect($effect)
protected function applyStandardEffect($effect)
Parameters
| HeraldEffect | $effect |
Return
| wild |
public function loadEdgePHIDs($type)
public function loadEdgePHIDs($type)
Parameters
| $type |
Return
| wild |
final public function getForbiddenActions()
final public function getForbiddenActions()
Return
| wild |
final public function setForbiddenAction($action, $reason)
final public function setForbiddenAction($action, $reason)
Parameters
| $action | ||
| $reason |
Return
| wild |
final public function getRequiredFieldStates($field_key)
final public function getRequiredFieldStates($field_key)
Parameters
| $field_key |
Return
| wild |
final public function getRequiredActionStates($action_key)
final public function getRequiredActionStates($action_key)
Parameters
| $action_key |
Return
| wild |
final public function getForbiddenReason($action)
final public function getForbiddenReason($action)
Parameters
| $action |
Return
| wild |
final public function addMustEncryptReason($reason)
final public function addMustEncryptReason($reason)
Parameters
| $reason |
Return
| wild |
final public function getMustEncryptReasons()
final public function getMustEncryptReasons()
Return
| wild |
public function supportsWebhooks()
public function supportsWebhooks()
Return
| wild |
final public function queueWebhook($webhook_phid, $rule_phid)
final public function queueWebhook($webhook_phid, $rule_phid)
Parameters
| $webhook_phid | ||
| $rule_phid |
Return
| wild |
final public function getWebhookMap()
final public function getWebhookMap()
Return
| wild |