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.

Get the class name for the application this editor is a part of.

Uninstalling the application will disable the editor.

Get a description of the objects this editor edits, like "Differential Revisions".

When the editor tries to apply transactions that have no effect, should it raise an exception (default) or drop them and continue?

Generally, you will set this flag for edits coming from "Edit" interfaces, and leave it cleared for edits coming from "Comment" interfaces, so the user will get a useful error if they try to submit a comment that does nothing (e.g., empty comment with a status change that has already been performed by another user).

When the editor tries to apply transactions which don't populate all of an object's required fields, should it raise an exception (default) or drop them and continue?

For example, if a user adds a new required custom field (like "Severity") to a task, all existing tasks won't have it populated. When users manually edit existing tasks, it's usually desirable to have them provide a severity. However, other operations (like batch editing just the owner of a task) will fail by default.

By setting this flag for edit operations which apply to specific fields (like the priority, batch, and merge editors in Maniphest), these operations can continue to function even if an object is outdated.

Not strictly necessary, but reply handlers ideally set this value to make email threading work better.

PhabricatorTransactions provides many built-in transactions which should not require much - if any - code in specific applications.

This method is a hook for the exceedingly-rare cases where you may need to do additional work for built-in transactions. Developers should extend this method, making sure to return the parent implementation regardless of handling any transactions.

See also applyBuiltinExternalTransaction().

See :applyBuiltinInternalTransaction().

Fill in a transaction's common values, like author and content source.

Optionally expand transactions which imply other effects. For example, resigning from a revision in Differential implies removing yourself as a reviewer.

Attempt to combine similar transactions into a smaller number of total transactions. For example, two transactions which edit the title of an object can be merged into a single edit.

Hook for validating transactions. This callback will be invoked for each available transaction type, even if an edit does not apply any transactions of that type. This allows you to raise exceptions when required fields are missing, by detecting that the object has no field value and there is no transaction which sets one.

Check for a missing text field.

A text field is missing if the object has no value and there are no transactions which set a value, or if the transactions remove the value. This method is intended to make implementing validateTransaction() more convenient:

$missing = $this->validateIsEmptyTextField(
  $object->getName(),
  $xactions);

This will return true if the net effect of the object and transactions is an empty field.

When a user interacts with an object, we might want to add them to CC.

Extract the PHIDs of any files which these transactions attach.

Load any object state which is required to publish transactions.

This hook is invoked in the main process before we compute data related to publishing transactions (like email "To" and "CC" lists), and again in the worker before publishing occurs.

Convert the editor state to a serializable dictionary which can be passed to a worker.

This data will be loaded with loadWorkerState() in the worker.

Hook; return custom properties which need to be passed to workers.

Hook; return storage encoding for custom properties which need to be passed to workers.

This primarily allows binary data to be passed to workers and survive JSON encoding.

Load editor state using a dictionary emitted by getWorkerState().

This method is used to load state when running worker operations.

Hook; set custom properties on the editor from data emitted by getCustomWorkerState().

Get a list of object properties which should be automatically sent to workers in the state data.

These properties will be automatically stored and loaded by the editor in the worker.

Apply encodings prior to storage.

See getCustomWorkerStateEncoding().

Undo storage encoding applied when storing state.

See getCustomWorkerStateEncoding().

Remove conflicts from a list of projects.

Objects aren't allowed to be tagged with multiple milestones in the same group, nor projects such that one tag is the ancestor of any other tag. If the list of PHIDs include mutually exclusive projects, remove the conflicting projects.

When the view policy for an object is changed, scramble the secret keys for attached files to invalidate existing URIs.

Check if a policy is strong enough to justify scrambling. Objects which are set to very open policies don't need to scramble their files, and files with very open policies don't need to be scrambled when associated objects change.