Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorEditEngineConfigurationEditEngine

final class PhabricatorEditEngineConfigurationEditEngine
Phabricator Technical Documentation (Transactions)

This class is not documented.

Tasks

Managing Fields

No methods for this task.

Display Text

Edit Engine Configuration

No methods for this task.

Managing URIs

Creating and Loading Objects

  • protected function newEditableObject()
  • protected function newObjectQuery()
  • final public function getIsCreate() — Test if this workflow is creating a new object or editing an existing one.
  • protected function newEditableObjectFromConduit($raw_xactions) — Initialize a new object for object creation via Conduit.
  • protected function newEditableObjectForDocumentation() — Initialize a new object for documentation creation.
  • private function setIsCreate($is_create) — Flag this workflow as a create or edit.
  • 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.
  • private function newObjectFromID($id, $capabilities) — Load an object by ID.
  • private function newObjectFromPHID($phid, $capabilities) — Load an object by PHID.
  • private function newObjectFromQuery($query, $capabilities) — Load an object given a configured query.
  • private function validateObject($object) — Verify that an object is appropriate for editing.

Responding to Web Requests

No methods for this task.

Responding to Edit Requests

No methods for this task.

Responding to HTTP Parameter Requests

Responding to Conduit Requests

Other Methods

Methods

final public function setViewer($viewer)
Inherited

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

final public function getViewer()
Inherited

This method is not documented.
Return
wild

final public function setController($controller)
Inherited

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

final public function getController()
Inherited

This method is not documented.
Return
wild

final public function getEngineKey()
Inherited

This method is not documented.
Return
wild

final public function getApplication()
Inherited

This method is not documented.
Return
wild

final public function addContextParameter($key)
Inherited

This method is not documented.
Parameters
$key
Return
wild

public function isEngineConfigurable()
Inherited

This method is not documented.
Return
wild

public function isEngineExtensible()
Inherited

This method is not documented.
Return
wild

public function isDefaultQuickCreateEngine()
Inherited

This method is not documented.
Return
wild

public function getDefaultQuickCreateFormKeys()
Inherited

This method is not documented.
Return
wild

public static function splitFullKey($full_key)
Inherited

This method is not documented.
Parameters
$full_key
Return
wild

public function getQuickCreateOrderVector()
Inherited

This method is not documented.
Return
wild

public function setTargetObject($target_object)
Inherited

PhabricatorEditEngine

Force the engine to edit a particular object.

Parameters
$target_object
Return
wild

public function getTargetObject()
Inherited

This method is not documented.
Return
wild

public function setNavigation($navigation)
Inherited

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

public function getNavigation()
Inherited

This method is not documented.
Return
wild

public function getEngineApplicationClass()

This method is not documented.
Return
wild

protected function buildCustomEditFields($object)

This method is not documented.
Parameters
$object
Return
wild

public function getFieldsForConfig($config)
Inherited

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

final protected function buildEditFields($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function willConfigureFields($object, $fields)
Inherited

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

final public function supportsSubtypes()
Inherited

This method is not documented.
Return
wild

final public function newSubtypeMap()
Inherited

This method is not documented.
Return
wild

public function getEngineName()

This method is not documented.
Return
wild

protected function getObjectCreateTitleText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getFormHeaderText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectEditTitleText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectCreateShortText()

This method is not documented.
Return
wild

protected function getObjectName()

This method is not documented.
Return
wild

protected function getObjectEditShortText($object)

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectCreateButtonText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getObjectEditButtonText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewSeriousHeaderText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewSeriousButtonText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewHeaderText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getCommentViewButtonText($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getPageHeader($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function getSummaryHeader()

PhabricatorEditEngine

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

PhabricatorEditEngineConfigurationEditEngine
This method is not documented.
Return
stringHuman-readable description of the engine.

public function getSummaryText()

PhabricatorEditEngine

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

PhabricatorEditEngineConfigurationEditEngine
This method is not documented.
Return
stringHuman-readable description of the engine.

protected function supportsEditEngineConfiguration()
Inherited

This method is not documented.
Return
wild

final protected function getEditEngineConfiguration()
Inherited

This method is not documented.
Return
wild

public function newConfigurationQuery()
Inherited

This method is not documented.
Return
wild

private function loadEditEngineConfigurationWithQuery($query, $sort_method)
Inherited

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

private function loadEditEngineConfigurationWithIdentifier($identifier)
Inherited

This method is not documented.
Parameters
$identifier
Return
wild

private function loadDefaultConfiguration()
Inherited

This method is not documented.
Return
wild

private function loadDefaultCreateConfiguration()
Inherited

This method is not documented.
Return
wild

public function loadDefaultEditConfiguration($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

final public function getBuiltinEngineConfigurations()
Inherited

This method is not documented.
Return
wild

protected function newBuiltinEngineConfigurations()
Inherited

This method is not documented.
Return
wild

final protected function newConfiguration()
Inherited

This method is not documented.
Return
wild

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

This method is not documented.
Parameters
$object
Return
wild

public function getCreateURI($form_key)
Inherited

This method is not documented.
Parameters
$form_key
Return
wild

public function getEditURI($object, $path)
Inherited

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

public function getEffectiveObjectViewURI($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function getEffectiveObjectEditDoneURI($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function getEffectiveObjectEditCancelURI($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function newEditableObject()

PhabricatorEditEngine

Initialize a new object for creation.

PhabricatorEditEngineConfigurationEditEngine
This method is not documented.
Return
objectNewly initialized object.

protected function newObjectQuery()

PhabricatorEditEngine

Build an empty query for objects.

PhabricatorEditEngineConfigurationEditEngine
This method is not documented.
Return
PhabricatorPolicyAwareQueryQuery.

final public function getIsCreate()
Inherited

PhabricatorEditEngine

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

PhabricatorEditEngine

Initialize a new object for object creation via Conduit.

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

protected function newEditableObjectForDocumentation()
Inherited

PhabricatorEditEngine

Initialize a new object for documentation creation.

Return
objectNewly initialized object.

private function setIsCreate($is_create)
Inherited

PhabricatorEditEngine

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

PhabricatorEditEngine

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

PhabricatorEditEngine

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

PhabricatorEditEngine

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

PhabricatorEditEngine

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

PhabricatorEditEngine

Verify that an object is appropriate for editing.

Parameters
wild$objectLoaded value.
Return
void

final public function buildResponse()
Inherited

This method is not documented.
Return
wild

private function buildCrumbs($object, $final)
Inherited

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

private function buildEditResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function newEditFormHeadContent($state)
Inherited

This method is not documented.
Parameters
PhabricatorEditEnginePageState$state
Return
wild

protected function newEditFormTailContent($state)
Inherited

This method is not documented.
Parameters
PhabricatorEditEnginePageState$state
Return
wild

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

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

private function getEditEngineSubmitKey()
Inherited

This method is not documented.
Return
wild

private function buildEditForm($object, $fields)
Inherited

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

protected function willBuildEditForm($object, $fields)
Inherited

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

private function buildEditFormActionButton($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildEditFormActions($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

public function newNUXButton($text)
Inherited

This method is not documented.
Parameters
$text
Return
wild

final public function addActionToCrumbs($crumbs, $parameters)
Inherited

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

public function newCreateActionSpecifications($parameters)
Inherited

PhabricatorEditEngine

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

This method is not documented.
Parameters
$object
Return
wild

protected function loadDraftVersion($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildParametersResponse($object)
Inherited

PhabricatorEditEngine

Respond to a request for documentation on HTTP parameters.

Parameters
object$objectEditable object.
Return
AphrontResponseResponse object.

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

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

private function buildNoDefaultResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildNoCreateResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildNoManageResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildNoEditResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildNotEditFormRespose($object, $config)
Inherited

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

private function buildDisabledFormResponse($object, $config)
Inherited

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

private function buildLockedObjectResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function buildCommentResponse($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function newDraftEngine($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

final public function buildConduitResponse($request)
Inherited

PhabricatorEditEngine

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

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

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

PhabricatorEditEngine

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

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

public function getConduitEditTypes()
Inherited

This method is not documented.
Return
wild

final public static function getAllEditEngines()
Inherited

This method is not documented.
Return
wild

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

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

public function getIcon()
Inherited

This method is not documented.
Return
wild

private function loadUsableConfigurationsForCreate()
Inherited

This method is not documented.
Return
wild

protected function getValidationExceptionShortMessage($ex, $field)
Inherited

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

This method is not documented.
Return
wild

private function hasCreateCapability()
Inherited

This method is not documented.
Return
wild

public function isCommentAction()
Inherited

This method is not documented.
Return
wild

public function getEditAction()
Inherited

This method is not documented.
Return
wild

protected function newCommentActionGroups()
Inherited

This method is not documented.
Return
wild

protected function newAutomaticCommentTransactions($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function newCommentPreviewContent($object, $xactions)
Inherited

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

public function getSelectedPage()
Inherited

This method is not documented.
Return
wild

private function selectPage($object, $page_key)
Inherited

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

protected function newPages($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

protected function getPages($object)
Inherited

This method is not documented.
Parameters
$object
Return
wild

private function applyPageToFields($object, $fields)
Inherited

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

protected function willApplyTransactions($object, $xactions)
Inherited

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

protected function didApplyTransactions($object, $xactions)
Inherited

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

final public function newBulkEditGroupMap()
Inherited

This method is not documented.
Return
wild

protected function newBulkEditGroups()
Inherited

This method is not documented.
Return
wild

final public function newBulkEditMap()
Inherited

This method is not documented.
Return
wild

final public function newRawBulkTransactions($xactions)
Inherited

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

private function getBulkEditTypesFromFields($fields)
Inherited

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

public function getPHID()
Inherited

This method is not documented.
Return
wild

public function getCapabilities()
Inherited

This method is not documented.
Return
wild

public function getPolicy($capability)
Inherited

This method is not documented.
Parameters
$capability
Return
wild

public function hasAutomaticCapability($capability, $viewer)
Inherited

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

public function setTargetEngine($target_engine)

This method is not documented.
Parameters
PhabricatorEditEngine$target_engine
Return
wild

public function getTargetEngine()

This method is not documented.
Return
wild

private function getURI($path)

This method is not documented.
Parameters
$path
Return
wild