Diviner Tech Docs PhabricatorEditField

abstract class PhabricatorEditField
Phorge Technical Documentation (Transactions)

This class is not documented.

Methods

public function setKey($key)

This method is not documented.

Parameters

$key

Return

wild

public function getKey()

This method is not documented.

Return

wild

public function setLabel($label)

This method is not documented.

Parameters

$label

Return

wild

public function getLabel()

This method is not documented.

Return

wild

public function setBulkEditLabel($bulk_edit_label)

This method is not documented.

Parameters

$bulk_edit_label

Return

wild

public function getBulkEditLabel()

This method is not documented.

Return

wild

public function setBulkEditGroupKey($key)

This method is not documented.

Parameters

$key

Return

wild

public function getBulkEditGroupKey()

This method is not documented.

Return

wild

public function setViewer($viewer)

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function getViewer()

This method is not documented.

Return

wild

public function setAliases($aliases)

This method is not documented.

Parameters

array

$aliases

Return

wild

public function getAliases()

This method is not documented.

Return

wild

public function setObject($object)

This method is not documented.

Parameters

$object

Return

wild

public function getObject()

This method is not documented.

Return

wild

public function setIsLocked($is_locked)

This method is not documented.

Parameters

$is_locked

Return

wild

public function getIsLocked()

This method is not documented.

Return

wild

public function setIsPreview($preview)

This method is not documented.

Parameters

$preview

Return

wild

public function getIsPreview()

This method is not documented.

Return

wild

public function setIsReorderable($is_reorderable)

This method is not documented.

Parameters

$is_reorderable

Return

wild

public function getIsReorderable()

This method is not documented.

Return

wild

public function setIsFormField($is_form_field)

This method is not documented.

Parameters

$is_form_field

Return

wild

public function getIsFormField()

This method is not documented.

Return

wild

public function setDescription($description)

This method is not documented.

Parameters

$description

Return

wild

public function getDescription()

This method is not documented.

Return

wild

public function setConduitDescription($conduit_description)

This method is not documented.

Parameters

$conduit_description

Return

wild

public function getConduitDescription()

This method is not documented.

Return

wild

public function setConduitDocumentation($conduit_documentation)

Set the Conduit documentation in raw Remarkup.

Parameters

string|null

$conduit_documentation

Return

self

public function getConduitDocumentation()

Get the Conduit documentation in raw Remarkup.

Return

string|null

public function setConduitTypeDescription($conduit_type_description)

This method is not documented.

Parameters

$conduit_type_description

Return

wild

public function getConduitTypeDescription()

This method is not documented.

Return

wild

public function setIsEditDefaults($is_edit_defaults)

This method is not documented.

Parameters

$is_edit_defaults

Return

wild

public function getIsEditDefaults()

This method is not documented.

Return

wild

public function setIsDefaultable($is_defaultable)

This method is not documented.

Parameters

$is_defaultable

Return

wild

public function getIsDefaultable()

This method is not documented.

Return

wild

public function setIsLockable($is_lockable)

This method is not documented.

Parameters

$is_lockable

Return

wild

public function getIsLockable()

This method is not documented.

Return

wild

public function setIsHidden($is_hidden)

This method is not documented.

Parameters

$is_hidden

Return

wild

public function getIsHidden()

This method is not documented.

Return

wild

public function setIsCopyable($is_copyable)

This method is not documented.

Parameters

$is_copyable

Return

wild

public function getIsCopyable()

This method is not documented.

Return

wild

public function setIsSubmittedForm($is_submitted)

This method is not documented.

Parameters

$is_submitted

Return

wild

public function getIsSubmittedForm()

This method is not documented.

Return

wild

public function setIsRequired($is_required)

This method is not documented.

Parameters

$is_required

Return

wild

public function getIsRequired()

This method is not documented.

Return

wild

public function setControlError($control_error)

This method is not documented.

Parameters

$control_error

Return

wild

public function getControlError()

This method is not documented.

Return

wild

public function setCommentActionLabel($label)

This method is not documented.

Parameters

$label

Return

wild

public function getCommentActionLabel()

This method is not documented.

Return

wild

public function setCommentActionGroupKey($key)

This method is not documented.

Parameters

$key

Return

wild

public function getCommentActionGroupKey()

This method is not documented.

Return

wild

public function setCommentActionOrder($order)

This method is not documented.

Parameters

$order

Return

wild

public function getCommentActionOrder()

This method is not documented.

Return

wild

public function setCommentActionValue($comment_action_value)

This method is not documented.

Parameters

$comment_action_value

Return

wild

public function getCommentActionValue()

This method is not documented.

Return

wild

public function setPreviewPanel($preview_panel)

This method is not documented.

Parameters

PHUIRemarkupPreviewPanel

$preview_panel

Return

wild

public function getPreviewPanel()

This method is not documented.

Return

wild

public function setControlInstructions($control_instructions)

This method is not documented.

Parameters

$control_instructions

Return

wild

public function getControlInstructions()

This method is not documented.

Return

wild

public function setCanApplyWithoutEditCapability($can_apply)

This method is not documented.

Parameters

$can_apply

Return

wild

public function getCanApplyWithoutEditCapability()

This method is not documented.

Return

wild

protected function newControl()

This method is not documented.

Return

wild

protected function buildControl()

This method is not documented.

Return

wild

public function getControlID()

This method is not documented.

Return

wild

protected function renderControl()

This method is not documented.

Return

wild

public function appendToForm($form)

This method is not documented.

Parameters

AphrontFormView

$form

Return

wild

protected function getValueForControl()

This method is not documented.

Return

wild

public function getValueForDefaults()

This method is not documented.

Return

wild

protected function getValue()

This method is not documented.

Return

wild

public function setValue($value)

This method is not documented.

Parameters

$value

Return

wild

public function setMetadataValue($key, $value)

This method is not documented.

Parameters

	$key
	$value

Return

wild

public function getMetadata()

This method is not documented.

Return

wild

public function getValueForTransaction()

This method is not documented.

Return

wild

public function getTransactionType()

This method is not documented.

Return

wild

public function setTransactionType($type)

This method is not documented.

Parameters

$type

Return

wild

public function readValueFromRequest($request)

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

public function readValueFromComment($value)

This method is not documented.

Parameters

$value

Return

wild

protected function getValueFromComment($value)

This method is not documented.

Parameters

$value

Return

wild

public function getAllReadValueFromRequestKeys()

This method is not documented.

Return

wild

public function readDefaultValueFromConfiguration($value)

This method is not documented.

Parameters

$value

Return

wild

protected function getDefaultValueFromConfiguration($value)

This method is not documented.

Parameters

$value

Return

wild

protected function getValueFromObject($object)

This method is not documented.

Parameters

$object

Return

wild

protected function getValueExistsInRequest($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

protected function getValueFromRequest($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

public function readValueFromField($other)

This method is not documented.

Parameters

PhabricatorEditField

$other

Return

wild

protected function getValueFromField($other)

This method is not documented.

Parameters

PhabricatorEditField

$other

Return

wild

protected function getInitialValueFromSubmit($request, $key)

Read and return the value the object had when the user first loaded the form.

This is the initial value from the user's point of view when they started the edit process, and used primarily to prevent race conditions for fields like "Projects" and "Subscribers" that use tokenizers and support edge transactions.

Most fields do not need to store these values or deal with initial value handling.

Parameters

AphrontRequest	$request	Request to read from.
string	$key	Key to read.

Return

wild	Value read from request.

public function getInitialValue()

This method is not documented.

Return

wild

public function setInitialValue($initial_value)

This method is not documented.

Parameters

$initial_value

Return

wild

public function readValueFromSubmit($request)

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

protected function getValueExistsInSubmit($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

protected function getValueFromSubmit($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

protected function getHTTPParameterValueExists($request, $key)

This method is not documented.

Parameters

AphrontRequest	$request
	$key

Return

wild

protected function getHTTPParameterValue($request, $key)

This method is not documented.

Parameters

	$request
	$key

Return

wild

protected function getDefaultValue()

This method is not documented.

Return

wild

final public function getHTTPParameterType()

This method is not documented.

Return

wild

protected function newHTTPParameterType()

This method is not documented.

Return

wild

protected function getBulkParameterType()

This method is not documented.

Return

wild

protected function newBulkParameterType()

This method is not documented.

Return

wild

public function getConduitParameterType()

This method is not documented.

Return

wild

abstract protected function newConduitParameterType()

This method is not documented.

Return

wild

public function setEditTypeKey($edit_type_key)

This method is not documented.

Parameters

$edit_type_key

Return

wild

public function getEditTypeKey()

This method is not documented.

Return

wild

protected function newEditType()

This method is not documented.

Return

wild

protected function getEditType()

This method is not documented.

Return

wild

final public function getConduitEditTypes()

This method is not documented.

Return

wild

final public function getConduitEditType($key)

This method is not documented.

Parameters

$key

Return

wild

protected function newConduitEditTypes()

This method is not documented.

Return

wild

final public function getBulkEditTypes()

This method is not documented.

Return

wild

final public function getBulkEditType($key)

This method is not documented.

Parameters

$key

Return

wild

protected function newBulkEditTypes()

This method is not documented.

Return

wild

public function getCommentAction()

This method is not documented.

Return

wild

protected function newCommentAction()

This method is not documented.

Return

wild

protected function getValueForCommentAction($value)

This method is not documented.

Parameters

$value

Return

wild

public function shouldGenerateTransactionsFromSubmit()

This method is not documented.

Return

wild

public function shouldReadValueFromRequest()

This method is not documented.

Return

wild

public function shouldReadValueFromSubmit()

This method is not documented.

Return

wild

public function shouldGenerateTransactionsFromComment()

This method is not documented.

Return

wild

public function generateTransactions($template, $spec)

This method is not documented.

Parameters

PhabricatorApplicationTransaction	$template
array	$spec

Return

wild

Defined: src/applications/transactions/editfield/PhabricatorEditField.php:3

abstract class PhabricatorEditFieldPhorge Technical Documentation (Transactions)

Methods

public function setKey($key)

public function getKey()

public function setLabel($label)

public function getLabel()

public function setBulkEditLabel($bulk_edit_label)

public function getBulkEditLabel()

public function setBulkEditGroupKey($key)

public function getBulkEditGroupKey()

public function setViewer($viewer)

public function getViewer()

public function setAliases($aliases)

public function getAliases()

public function setObject($object)

public function getObject()

public function setIsLocked($is_locked)

public function getIsLocked()

public function setIsPreview($preview)

public function getIsPreview()

public function setIsReorderable($is_reorderable)

public function getIsReorderable()

public function setIsFormField($is_form_field)

public function getIsFormField()

public function setDescription($description)

public function getDescription()

public function setConduitDescription($conduit_description)

public function getConduitDescription()

public function setConduitDocumentation($conduit_documentation)

public function getConduitDocumentation()

public function setConduitTypeDescription($conduit_type_description)

public function getConduitTypeDescription()

public function setIsEditDefaults($is_edit_defaults)

public function getIsEditDefaults()

public function setIsDefaultable($is_defaultable)

public function getIsDefaultable()

public function setIsLockable($is_lockable)

public function getIsLockable()

public function setIsHidden($is_hidden)

public function getIsHidden()

public function setIsCopyable($is_copyable)

public function getIsCopyable()

public function setIsSubmittedForm($is_submitted)

public function getIsSubmittedForm()

public function setIsRequired($is_required)

public function getIsRequired()

public function setControlError($control_error)

public function getControlError()

public function setCommentActionLabel($label)

public function getCommentActionLabel()

public function setCommentActionGroupKey($key)

public function getCommentActionGroupKey()

public function setCommentActionOrder($order)

public function getCommentActionOrder()

public function setCommentActionValue($comment_action_value)

public function getCommentActionValue()

public function setPreviewPanel($preview_panel)

public function getPreviewPanel()

public function setControlInstructions($control_instructions)

public function getControlInstructions()

public function setCanApplyWithoutEditCapability($can_apply)

public function getCanApplyWithoutEditCapability()

protected function newControl()

protected function buildControl()

public function getControlID()

protected function renderControl()

public function appendToForm($form)

protected function getValueForControl()

public function getValueForDefaults()

protected function getValue()

public function setValue($value)

public function setMetadataValue($key, $value)

public function getMetadata()

public function getValueForTransaction()

public function getTransactionType()

public function setTransactionType($type)

public function readValueFromRequest($request)

public function readValueFromComment($value)

protected function getValueFromComment($value)

public function getAllReadValueFromRequestKeys()

abstract class PhabricatorEditField
Phorge Technical Documentation (Transactions)