Managing Fields
Managing Fields
No methods for this task.
Display Text
Display Text
- public function getEngineName()
- protected function getObjectCreateTitleText($object)
- protected function getFormHeaderText($object)
- protected function getObjectEditTitleText($object)
- protected function getObjectCreateShortText()
- protected function getObjectName()
- protected function getObjectEditShortText($object)
- protected function getObjectCreateButtonText($object)
- protected function getObjectEditButtonText($object)
- protected function getCommentViewSeriousHeaderText($object)
- protected function getCommentViewSeriousButtonText($object)
- protected function getCommentViewHeaderText($object)
- protected function getCommentViewButtonText($object)
- protected function getPageHeader($object)
- public function getCommentFieldPlaceholderText($object) — Set default placeholder plain text in the comment textarea of the engine. To be overwritten by conditions defined in the child EditEngine class.
- public function getSummaryHeader()
- public function getSummaryText()
Edit Engine Configuration
Edit Engine Configuration
No methods for this task.
Managing URIs
Managing URIs
- protected function getObjectViewURI($object)
- protected function getObjectCreateCancelURI($object)
- protected function getEditorURI()
- protected function getObjectEditCancelURI($object)
- public function getCreateURI($form_key)
- public function getEditURI($object, $path)
Creating and Loading Objects
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
Responding to Web Requests
No methods for this task.
Responding to Edit Requests
Responding to Edit Requests
No methods for this task.
Responding to HTTP Parameter Requests
Responding to HTTP Parameter Requests
- private function buildParametersResponse($object) — Respond to a request for documentation on HTTP parameters.
Responding to Conduit Requests
Responding to Conduit Requests
- final public function buildConduitResponse($request) — Respond to a Conduit edit request.
- private function getConduitTransactions($request, $xactions, $types, $template) — Generate transactions which can be applied from edit actions in a Conduit request.
- private function getConduitEditTypesFromFields($fields)
Other Methods
Other Methods
- final public function setViewer($viewer)
- final public function getViewer()
- final public function setController($controller)
- final public function getController()
- final public function getEngineKey()
- final public function getApplication()
- final public function addContextParameter($key)
- public function isEngineConfigurable()
- public function isEngineExtensible()
- public function isDefaultQuickCreateEngine()
- public function getDefaultQuickCreateFormKeys()
- public static function splitFullKey($full_key)
- public function getQuickCreateOrderVector()
- public function setTargetObject($target_object) — Force the engine to edit a particular object.
- public function getTargetObject()
- public function setNavigation($navigation)
- public function getNavigation()
- public function getEngineApplicationClass()
- protected function buildCustomEditFields($object)
- public function getFieldsForConfig($config)
- final protected function buildEditFields($object)
- protected function willConfigureFields($object, $fields)
- final public function supportsSubtypes()
- final public function newSubtypeMap()
- protected function supportsEditEngineConfiguration()
- final protected function getEditEngineConfiguration()
- public function newConfigurationQuery()
- private function loadEditEngineConfigurationWithQuery($query, $sort_method)
- private function loadEditEngineConfigurationWithIdentifier($identifier)
- private function loadDefaultConfiguration()
- private function loadDefaultCreateConfiguration()
- public function loadDefaultEditConfiguration($object)
- final public function getBuiltinEngineConfigurations()
- protected function newBuiltinEngineConfigurations()
- final protected function newConfiguration()
- public function getEffectiveObjectViewURI($object)
- public function getEffectiveObjectEditDoneURI($object)
- public function getEffectiveObjectEditCancelURI($object)
- final public function buildResponse()
- private function buildCrumbs($object, $final)
- private function buildEditResponse($object)
- protected function newEditFormHeadContent($state)
- protected function newEditFormTailContent($state)
- protected function newEditResponse($request, $object, $xactions)
- private function getEditEngineSubmitKey()
- private function buildEditForm($object, $fields)
- protected function willBuildEditForm($object, $fields)
- private function buildEditFormActionButton($object)
- private function buildEditFormActions($object)
- public function newNUXButton($text)
- final public function addActionToCrumbs($crumbs, $parameters)
- public function newCreateActionSpecifications($parameters) — Build a raw description of available "Create New Object" UI options so other methods can build menus or buttons.
- final public function buildEditEngineCommentView($object)
- protected function loadDraftVersion($object)
- private function buildError($object, $title, $body)
- private function buildNoDefaultResponse($object)
- private function buildNoCreateResponse($object)
- private function buildNoManageResponse($object)
- private function buildNoEditResponse($object)
- private function buildNotEditFormRespose($object, $config)
- private function buildDisabledFormResponse($object, $config)
- private function buildLockedObjectResponse($object)
- private function buildCommentResponse($object)
- protected function newDraftEngine($object)
- private function getRawConduitTransactions($request)
- public function getConduitEditTypes()
- final public static function getAllEditEngines()
- final public static function getByKey($viewer, $key)
- public function getIcon()
- private function loadUsableConfigurationsForCreate()
- protected function getValidationExceptionShortMessage($ex, $field)
- protected function getCreateNewObjectPolicy()
- private function requireCreateCapability()
- private function hasCreateCapability()
- public function isCommentAction()
- public function getEditAction()
- protected function newCommentActionGroups()
- protected function newAutomaticCommentTransactions($object)
- protected function newCommentPreviewContent($object, $xactions)
- public function getSelectedPage()
- private function selectPage($object, $page_key)
- protected function newPages($object)
- protected function getPages($object)
- private function applyPageToFields($object, $fields)
- protected function willApplyTransactions($object, $xactions)
- protected function didApplyTransactions($object, $xactions)
- final public function newBulkEditGroupMap()
- protected function newBulkEditGroups()
- final public function newBulkEditMap()
- final public function newRawBulkTransactions($xactions)
- private function getBulkEditTypesFromFields($fields)
- public function getPHID()
- public function getCapabilities()
- public function getPolicy($capability)
- public function hasAutomaticCapability($capability, $viewer)