PHPXRef 0.7.1 : Phabricator : Detail view of HeraldAdapter.php

Given a @{class:HeraldRule}, this function extracts all the phids that
we'll want to load as handles later.

This function performs a somewhat hacky approach to figuring out what
is and is not a phid - try to get the phid type and if the type is
*not* unknown assume its a valid phid.

Don't try this at home. Use more strongly typed data at home.

Think of the children.

getCustomFieldTemplateObject() X-Ref

Return an object which custom fields can be generated from while editing
rules. Adapters must return an object from this method to enable custom
field rules.

Normally, you'll return an empty version of the adapted object, assuming
it implements @{interface:PhabricatorCustomFieldInterface}:

return new ApplicationObject();

This is normally the only adapter method you need to override to enable
Herald rules to run against custom fields.

return: null|PhabricatorCustomFieldInterface Template object.

getCustomKeyPrefix() X-Ref

Returns the prefix used to namespace Herald fields which are based on
custom fields.

return: string Key prefix.

isHeraldCustomKey($key) X-Ref

Determine if a field key is based on a custom field or a regular internal
field.

param: string Field key.
return: bool True if the field key is based on a custom field.

getHeraldKeyFromCustomKey($key) X-Ref

Convert a custom field key into a Herald field key.

param: string Custom field key.
return: string Herald field key.

getCustomFields() X-Ref

Get custom fields for this adapter, if appliable. This will either return
a field list or `null` if the adapted object does not implement custom
fields or the adapter does not support them.

return: PhabricatorCustomFieldList|null List of fields, or `null`.

getCustomField($herald_field_key) X-Ref

Get a custom field by Herald field key, or `null` if it does not exist
or custom fields are not supported.

param: string Herald field key.
return: PhabricatorCustomField|null Matching field, if it exists.

getCustomFieldNameMap() X-Ref

Get the field map for custom fields.

return: map<string, string> Map of Herald field keys to field names.

getCustomFieldValue($field_key) X-Ref

Get the value for a custom field.

param: string Herald field key.
return: wild Custom field value.

getCustomFieldConditions($field_key) X-Ref

Get the Herald conditions for a custom field.

param: string Herald field key.
return: list<const> List of Herald conditions.

getCustomFieldValueTypeForFieldAndCondition($field_key,$condition) X-Ref

Get the Herald value type for a custom field and condition.

param: string Herald field key.
param: const Herald condition constant.
return: const|null Herald value type constant, or null to use the default.

File Size:	1476 lines (48 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Phabricator

/src/applications/herald/adapter/ -> HeraldAdapter.php (summary)

Defines 50 functions