Diviner

Phabricator » ManiphestAuxiliaryFieldSpecification (Class)

Class ManiphestAuxiliaryFieldSpecification

Defined	src/applications/maniphest/auxiliaryfield/ManiphestAuxiliaryFieldSpecification.php:6
Group	Maniphest (Task Tracking)

Tasks

Unspecified

public didMarkupText()
public getAuxiliaryKey()
public getCaption()
public getHandle()
public getLabel()
public getMarkupEngine()
public getMarkupFieldKey()
public getMarkupFields()
public getMarkupText()
public getRequiredHandlePHIDs()
public getTask()
public getType()
public getUser()
public getValue()
public isRequired()
public newMarkupEngine()
public renderControl()
public renderForDetailView()
public renderTransactionDescription()
public renderTransactionEmailVerb()
public setAuxiliaryKey()
public setCaption()
public setHandles()
public setLabel()
public setMarkupEngine()
public setTask()
public setType()
public setUser()
public setValue()
public shouldCopyWhenCreatingSimilarTask()
public shouldUseMarkupCache()
public validate()

Methods

public didMarkupText($field, $output, PhutilMarkupEngine $engine)

parameters	wild	$field
	wild	$output
	PhutilMarkupEngine	$engine
return	wild

This method is not documented.

public getAuxiliaryKey()

return

wild

This method is not documented.

public getCaption()

return

wild

This method is not documented.

public getHandle($phid)

parameters	wild	$phid
return	wild

This method is not documented.

public getLabel()

return

wild

This method is not documented.

public getMarkupEngine()

return

wild

This method is not documented.

public getMarkupFieldKey($field)

parameters	wild	$field
return	wild

This method is not documented.

public getMarkupFields()

return

wild

This method is not documented.

public getMarkupText($field)

parameters	wild	$field
return	wild

This method is not documented.

public getRequiredHandlePHIDs()

return

wild

This method is not documented.

public getTask()

return

wild

This method is not documented.

public getType()

return

wild

This method is not documented.

public getUser()

return

wild

This method is not documented.

public getValue()

return

wild

This method is not documented.

public isRequired()

return

wild

This method is not documented.

public newMarkupEngine($field)

parameters	wild	$field
return	wild

This method is not documented.

public renderControl()

return

wild

This method is not documented.

public renderForDetailView()

return

wild

This method is not documented.

public string|null renderTransactionDescription(ManiphestTransaction $transaction, $target)

parameters	ManiphestTransaction	$transaction	The transaction which needs description.
	const	$target	Constant describing the rendering target (e.g., html or text).
return	string\|null		Description of the transaction.

Render a short description of the transaction, to appear above comments in the Maniphest transaction log. The string will be rendered after the acting user's name. Examples are:

added a comment
added alincoln to CC
claimed this task
created this task
closed this task out of spite

You should return a similar string, describing the transaction.

Note the $target parameter -- Maniphest needs to render transaction descriptions for different targets, like web and email. This method will be called with a ManiphestAuxiliaryFieldSpecification::RENDER_TARGET_* constant describing the intended target.

public string|null renderTransactionEmailVerb(ManiphestTransaction $transaction)

parameters	ManiphestTransaction	$transaction	The transaction which needs description.
return	string\|null		A short description of the transaction.

Render a verb to appear in email titles when a transaction involving this field occurs. Specifically, Maniphest emails are formatted like this:

[Maniphest] [Verb Here] TNNN: Task title here
             ^^^^^^^^^

You should optionally return a title-case verb or short phrase like "Created", "Retitled", "Closed", "Resolved", "Commented On", "Lowered Priority", etc., which describes the transaction.

public setAuxiliaryKey($val)

parameters	wild	$val
return	wild

This method is not documented.

public setCaption($val)

parameters	wild	$val
return	wild

This method is not documented.

public setHandles(array $handles)

parameters	array	$handles
return	wild

This method is not documented.

public setLabel($val)

parameters	wild	$val
return	wild

This method is not documented.

public setMarkupEngine(PhabricatorMarkupEngine $engine)

parameters	PhabricatorMarkupEngine	$engine
return	wild

This method is not documented.

public setTask(ManiphestTask $task)

parameters	ManiphestTask	$task
return	wild

This method is not documented.

public setType($val)

parameters	wild	$val
return	wild

This method is not documented.

public setUser(PhabricatorUser $user)

parameters	PhabricatorUser	$user
return	wild

This method is not documented.

public setValue($val)

parameters	wild	$val
return	wild

This method is not documented.

public bool shouldCopyWhenCreatingSimilarTask()

return

bool

True to copy the default value from the template task when creating a new similar task.

When the user creates a task, the UI prompts them to "Create another similar task". This copies some fields (e.g., Owner and CCs) but not other fields (e.g., description). If this custom field should also be copied, return true from this method.

public shouldUseMarkupCache($field)

parameters	wild	$field
return	wild

This method is not documented.

public validate()

return

wild

This method is not documented.