Page MenuHomePhorge

abstract class HeraldAdapter
Phorge Technical Documentation (Herald)

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.

public function getEmailPHIDs()

This method is not documented.
Return
wild

public function getForcedEmailPHIDs()

This method is not documented.
Return
wild

final public function setActingAsPHID($acting_as_phid)

This method is not documented.
Parameters
$acting_as_phid
Return
wild

final public function getActingAsPHID()

This method is not documented.
Return
wild

public function addEmailPHID($phid, $force)

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

public function setViewer($viewer)

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

public function getViewer()

This method is not documented.
Return
wild

public function setContentSource($content_source)

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

public function getContentSource()

This method is not documented.
Return
wild

public function getIsNewObject()

This method is not documented.
Return
wild

public function setIsNewObject($new)

This method is not documented.
Parameters
$new
Return
wild

public function supportsApplicationEmail()

This method is not documented.
Return
wild

public function setApplicationEmail($email)

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

public function getApplicationEmail()

This method is not documented.
Return
wild

public function getPHID()

This method is not documented.
Return
wild

abstract public function getHeraldName()

This method is not documented.
Return
wild

final public function willGetHeraldField($field_key)

This method is not documented.
Parameters
$field_key
Return
wild

public function getHeraldField($field_key)

This method is not documented.
Parameters
$field_key
Return
wild

public function applyHeraldEffects($effects)

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

public function isAvailableToUser($viewer)

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

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>$xactionsList of transactions.
Return
this

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)

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

final public function getQueuedTransactions()

This method is not documented.
Return
wild

final public function newTransaction()

This method is not documented.
Return
wild

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

This method is not documented.
Return
wild

abstract public function getAdapterContentDescription()

This method is not documented.
Return
wild

abstract public function getAdapterApplicationClass()

This method is not documented.
Return
wild

abstract public function getObject()

This method is not documented.
Return
wild

public function getAdapterContentIcon()

This method is not documented.
Return
wild

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|objectTemplate object.

public function supportsRuleType($rule_type)

This method is not documented.
Parameters
$rule_type
Return
wild

public function canTriggerOnObject($object)

This method is not documented.
Parameters
$object
Return
wild

public function isTestAdapterForObject($object)

This method is not documented.
Parameters
$object
Return
wild

public function canCreateTestAdapterForObject($object)

This method is not documented.
Parameters
$object
Return
wild

public function newTestAdapter($viewer, $object)

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

public function getAdapterTestDescription()

This method is not documented.
Return
wild

public function explainValidTriggerObjects()

This method is not documented.
Return
wild

public function getTriggerObjectPHIDs()

This method is not documented.
Return
wild

public function getAdapterSortKey()

This method is not documented.
Return
wild

public function getAdapterSortOrder()

This method is not documented.
Return
wild

private function getFieldImplementationMap()

This method is not documented.
Return
wild

private function getFieldImplementation($key)

This method is not documented.
Parameters
$key
Return
wild

public function getFields()

This method is not documented.
Return
wild

public function getFieldNameMap()

This method is not documented.
Return
wild

public function getFieldGroupKey($field_key)

This method is not documented.
Parameters
$field_key
Return
wild

public function isFieldAvailable($field_key)

This method is not documented.
Parameters
$field_key
Return
wild

public function getConditionNameMap()

This method is not documented.
Return
wild

public function getConditionsForField($field)

This method is not documented.
Parameters
$field
Return
wild

private function requireFieldImplementation($field_key)

This method is not documented.
Parameters
$field_key
Return
wild

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

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

public function willSaveCondition($condition)

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

private function getActionImplementationMap()

This method is not documented.
Return
wild

private function requireActionImplementation($action_key)

This method is not documented.
Parameters
$action_key
Return
wild

private function getActionsForRuleType($rule_type)

This method is not documented.
Parameters
$rule_type
Return
wild

public function getActionImplementation($key)

This method is not documented.
Parameters
$key
Return
wild

public function getActionKeys()

This method is not documented.
Return
wild

public function getActionGroupKey($action_key)

This method is not documented.
Parameters
$action_key
Return
wild

public function isActionAvailable($action_key)

This method is not documented.
Parameters
$action_key
Return
wild

public function getActions($rule_type)

This method is not documented.
Parameters
$rule_type
Return
wild

public function getActionNameMap($rule_type)

This method is not documented.
Parameters
$rule_type
Return
wild

public function willSaveAction($rule, $action)

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

public function getValueTypeForFieldAndCondition($field, $condition)

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

public function getValueTypeForAction($action, $rule_type)

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

private function buildTokenizerFieldValue($datasource)

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

public function getRepetitionOptions()

This method is not documented.
Return
wild

protected function initializeNewAdapter()

This method is not documented.
Return
wild

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

This method is not documented.
Return
wild

public static function getAdapterForContentType($content_type)

This method is not documented.
Parameters
$content_type
Return
wild

public static function getEnabledAdapterMap($viewer)

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

public function getEditorValueForCondition($viewer, $condition)

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

public function getEditorValueForAction($viewer, $action_record)

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

public function renderRuleAsText($rule, $viewer)

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

private function renderConditionAsText($condition, $viewer)

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

private function renderActionAsText($viewer, $action_record)

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

private function renderConditionValueAsText($condition, $viewer)

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

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

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

protected function applyStandardEffect($effect)

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

public function loadEdgePHIDs($type)

This method is not documented.
Parameters
$type
Return
wild

final public function getForbiddenActions()

This method is not documented.
Return
wild

final public function setForbiddenAction($action, $reason)

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

final public function getRequiredFieldStates($field_key)

This method is not documented.
Parameters
$field_key
Return
wild

final public function getRequiredActionStates($action_key)

This method is not documented.
Parameters
$action_key
Return
wild

final public function getForbiddenReason($action)

This method is not documented.
Parameters
$action
Return
wild

final public function addMustEncryptReason($reason)

This method is not documented.
Parameters
$reason
Return
wild

final public function getMustEncryptReasons()

This method is not documented.
Return
wild

public function supportsWebhooks()

This method is not documented.
Return
wild

final public function queueWebhook($webhook_phid, $rule_phid)

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

final public function getWebhookMap()

This method is not documented.
Return
wild