Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorEditEngine

abstract class PhabricatorEditEngine
Phabricator Technical Documentation (Transactions)

This class is not documented.

Methods

final public function setViewer($viewer)

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

final public function getViewer()

This method is not documented.
Return
wild

final public function setController($controller)

This method is not documented.
Parameters
PhabricatorController$controller
Return
wild

final public function getController()

This method is not documented.
Return
wild

final public function getEngineKey()

This method is not documented.
Return
wild

final public function getApplication()

This method is not documented.
Return
wild

final public function addContextParameter($key)

This method is not documented.
Parameters
$key
Return
wild

public function isEngineConfigurable()

This method is not documented.
Return
wild

public function isEngineExtensible()

This method is not documented.
Return
wild

public function isDefaultQuickCreateEngine()

This method is not documented.
Return
wild

public function getDefaultQuickCreateFormKeys()

This method is not documented.
Return
wild

public static function splitFullKey($full_key)

This method is not documented.
Parameters
$full_key
Return
wild

public function getQuickCreateOrderVector()

This method is not documented.
Return
wild

public function setTargetObject($target_object)

Force the engine to edit a particular object.

Parameters
$target_object
Return
wild

public function getTargetObject()

This method is not documented.
Return
wild

public function setNavigation($navigation)

This method is not documented.
Parameters
AphrontSideNavFilterView$navigation
Return
wild

public function getNavigation()

This method is not documented.
Return
wild

abstract public function getEngineApplicationClass()

This method is not documented.
Return
wild

abstract protected function buildCustomEditFields($object)

This method is not documented.
Parameters
$object
Return
wild

public function getFieldsForConfig($config)

This method is not documented.
Parameters
PhabricatorEditEngineConfiguration$config
Return
wild

final protected function buildEditFields($object)

This method is not documented.
Parameters
$object
Return
wild

protected function willConfigureFields($object, $fields)

This method is not documented.
Parameters
$object
array$fields
Return
wild

final public function supportsSubtypes()

This method is not documented.
Return
wild

final public function newSubtypeMap()

This method is not documented.
Return
wild

abstract public function getEngineName()

This method is not documented.
Return
wild

abstract protected function getObjectCreateTitleText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getFormHeaderText($object)

This method is not documented.
Parameters
$object
Return
wild

abstract protected function getObjectEditTitleText($object)

This method is not documented.
Parameters
$object
Return
wild

abstract protected function getObjectCreateShortText()

This method is not documented.
Return
wild

abstract protected function getObjectName()

This method is not documented.
Return
wild

abstract protected function getObjectEditShortText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectCreateButtonText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectEditButtonText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewSeriousHeaderText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewSeriousButtonText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewHeaderText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewButtonText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getPageHeader($object)

This method is not documented.
Parameters
$object
Return
wild

abstract public function getSummaryHeader()

Return a human-readable header describing what this engine is used to do, like "Configure Maniphest Task Forms".

Return
stringHuman-readable description of the engine.

abstract public function getSummaryText()

Return a human-readable summary of what this engine is used to do.

Return
stringHuman-readable description of the engine.

protected function supportsEditEngineConfiguration()

This method is not documented.
Return
wild

final protected function getEditEngineConfiguration()

This method is not documented.
Return
wild

public function newConfigurationQuery()

This method is not documented.
Return
wild

private function loadEditEngineConfigurationWithQuery($query, $sort_method)

This method is not documented.
Parameters
PhabricatorEditEngineConfigurationQuery$query
$sort_method
Return
wild

private function loadEditEngineConfigurationWithIdentifier($identifier)

This method is not documented.
Parameters
$identifier
Return
wild

private function loadDefaultConfiguration()

This method is not documented.
Return
wild

private function loadDefaultCreateConfiguration()

This method is not documented.
Return
wild

public function loadDefaultEditConfiguration($object)

This method is not documented.
Parameters
$object
Return
wild

final public function getBuiltinEngineConfigurations()

This method is not documented.
Return
wild

protected function newBuiltinEngineConfigurations()

This method is not documented.
Return
wild

final protected function newConfiguration()

This method is not documented.
Return
wild

abstract protected function getObjectViewURI($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectCreateCancelURI($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getEditorURI()

This method is not documented.
Return
wild

protected function getObjectEditCancelURI($object)

This method is not documented.
Parameters
$object
Return
wild

public function getCreateURI($form_key)

This method is not documented.
Parameters
$form_key
Return
wild

public function getEditURI($object, $path)

This method is not documented.
Parameters
$object
$path
Return
wild

public function getEffectiveObjectViewURI($object)

This method is not documented.
Parameters
$object
Return
wild

public function getEffectiveObjectEditDoneURI($object)

This method is not documented.
Parameters
$object
Return
wild

public function getEffectiveObjectEditCancelURI($object)

This method is not documented.
Parameters
$object
Return
wild

abstract protected function newEditableObject()

Initialize a new object for creation.

Return
objectNewly initialized object.

abstract protected function newObjectQuery()

Build an empty query for objects.

Return
PhabricatorPolicyAwareQueryQuery.

final public function getIsCreate()

Test if this workflow is creating a new object or editing an existing one.

Return
boolTrue if a new object is being created.

protected function newEditableObjectFromConduit($raw_xactions)

Initialize a new object for object creation via Conduit.

Parameters
list<wild>$raw_xactionsRaw transactions.
Return
objectNewly initialized object.

protected function newEditableObjectForDocumentation()

Initialize a new object for documentation creation.

Return
objectNewly initialized object.

private function setIsCreate($is_create)

Flag this workflow as a create or edit.

Parameters
bool$is_createTrue if this is a create workflow.
Return
this

private function newObjectFromIdentifier($identifier, $capabilities)

Try to load an object by ID, PHID, or monogram. This is done primarily to make Conduit a little easier to use.

Parameters
wild$identifierID, PHID, or monogram.
list<const>$capabilitiesList of required capability constants, or omit for defaults.
Return
objectCorresponding editable object.

private function newObjectFromID($id, $capabilities)

Load an object by ID.

Parameters
int$idObject ID.
list<const>$capabilitiesList of required capability constants, or omit for defaults.
Return
object|nullObject, or null if no such object exists.

private function newObjectFromPHID($phid, $capabilities)

Load an object by PHID.

Parameters
phid$phidObject PHID.
list<const>$capabilitiesList of required capability constants, or omit for defaults.
Return
object|nullObject, or null if no such object exists.

private function newObjectFromQuery($query, $capabilities)

Load an object given a configured query.

Parameters
PhabricatorPolicyAwareQuery$queryConfigured query.
list<const>$capabilitiesList of required capability constants, or omit for defaults.
Return
object|nullObject, or null if no such object exists.

private function validateObject($object)

Verify that an object is appropriate for editing.

Parameters
wild$objectLoaded value.
Return
void

final public function buildResponse()

This method is not documented.
Return
wild

private function buildCrumbs($object, $final)

This method is not documented.
Parameters
$object
$final
Return
wild

private function buildEditResponse($object)

This method is not documented.
Parameters
$object
Return
wild

protected function newEditResponse($request, $object, $xactions)

This method is not documented.
Parameters
AphrontRequest$request
$object
array$xactions
Return
wild

private function buildEditForm($object, $fields)

This method is not documented.
Parameters
$object
array$fields
Return
wild

protected function willBuildEditForm($object, $fields)

This method is not documented.
Parameters
$object
array$fields
Return
wild

private function buildEditFormActionButton($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildEditFormActions($object)

This method is not documented.
Parameters
$object
Return
wild

public function newNUXButton($text)

This method is not documented.
Parameters
$text
Return
wild

final public function addActionToCrumbs($crumbs, $parameters)

This method is not documented.
Parameters
PHUICrumbsView$crumbs
array$parameters
Return
wild

public function newCreateActionSpecifications($parameters)

Build a raw description of available "Create New Object" UI options so other methods can build menus or buttons.

Parameters
array$parameters
Return
wild

final public function buildEditEngineCommentView($object)

This method is not documented.
Parameters
$object
Return
wild

protected function loadDraftVersion($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildParametersResponse($object)

Respond to a request for documentation on HTTP parameters.

Parameters
object$objectEditable object.
Return
AphrontResponseResponse object.

private function buildError($object, $title, $body)

This method is not documented.
Parameters
$object
$title
$body
Return
wild

private function buildNoDefaultResponse($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildNoCreateResponse($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildNoManageResponse($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildNoEditResponse($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildNotEditFormRespose($object, $config)

This method is not documented.
Parameters
$object
$config
Return
wild

private function buildDisabledFormResponse($object, $config)

This method is not documented.
Parameters
$object
$config
Return
wild

private function buildLockedObjectResponse($object)

This method is not documented.
Parameters
$object
Return
wild

private function buildCommentResponse($object)

This method is not documented.
Parameters
$object
Return
wild

protected function newDraftEngine($object)

This method is not documented.
Parameters
$object
Return
wild

final public function buildConduitResponse($request)

Respond to a Conduit edit request.

This method accepts a list of transactions to apply to an object, and either edits an existing object or creates a new one.

Parameters
ConduitAPIRequest$request
Return
wild

private function getRawConduitTransactions($request)

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

private function getConduitTransactions($request, $xactions, $types, $template)

Generate transactions which can be applied from edit actions in a Conduit request.

Parameters
ConduitAPIRequest$requestThe request.
list<wild>$xactionsRaw conduit transactions.
list<PhabricatorEditType>$typesSupported edit types.
PhabricatorApplicationTransaction$templateTemplate transaction.
Return
list<PhabricatorApplicationTransaction>Generated transactions.

private function getConduitEditTypesFromFields($fields)

This method is not documented.
Parameters
array$fields
Return
map<string, PhabricatorEditType>

public function getConduitEditTypes()

This method is not documented.
Return
wild

final public static function getAllEditEngines()

This method is not documented.
Return
wild

final public static function getByKey($viewer, $key)

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

public function getIcon()

This method is not documented.
Return
wild

private function loadUsableConfigurationsForCreate()

This method is not documented.
Return
wild

protected function getValidationExceptionShortMessage($ex, $field)

This method is not documented.
Parameters
PhabricatorApplicationTransactionValidationException$ex
PhabricatorEditField$field
Return
wild

protected function getCreateNewObjectPolicy()

This method is not documented.
Return
wild

private function requireCreateCapability()

This method is not documented.
Return
wild

private function hasCreateCapability()

This method is not documented.
Return
wild

public function isCommentAction()

This method is not documented.
Return
wild

public function getEditAction()

This method is not documented.
Return
wild

protected function newCommentActionGroups()

This method is not documented.
Return
wild

protected function newAutomaticCommentTransactions($object)

This method is not documented.
Parameters
$object
Return
wild

protected function newCommentPreviewContent($object, $xactions)

This method is not documented.
Parameters
$object
array$xactions
Return
wild

public function getSelectedPage()

This method is not documented.
Return
wild

private function selectPage($object, $page_key)

This method is not documented.
Parameters
$object
$page_key
Return
wild

protected function newPages($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getPages($object)

This method is not documented.
Parameters
$object
Return
wild

private function applyPageToFields($object, $fields)

This method is not documented.
Parameters
$object
array$fields
Return
wild

protected function willApplyTransactions($object, $xactions)

This method is not documented.
Parameters
$object
array$xactions
Return
wild

protected function didApplyTransactions($object, $xactions)

This method is not documented.
Parameters
$object
array$xactions
Return
wild

final public function newBulkEditGroupMap()

This method is not documented.
Return
wild

protected function newBulkEditGroups()

This method is not documented.
Return
wild

final public function newBulkEditMap()

This method is not documented.
Return
wild

final public function newRawBulkTransactions($xactions)

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

private function getBulkEditTypesFromFields($fields)

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

public function getPHID()

This method is not documented.
Return
wild

public function getCapabilities()

This method is not documented.
Return
wild

public function getPolicy($capability)

This method is not documented.
Parameters
$capability
Return
wild

public function hasAutomaticCapability($capability, $viewer)

This method is not documented.
Parameters
$capability
PhabricatorUser$viewer
Return
wild
Defined
src/applications/transactions/editengine/PhabricatorEditEngine.php:15