Interface PhabricatorMarkupInterface

Defined	src/infrastructure/markup/PhabricatorMarkupInterface.php:20
Group	Remarkup Extensions

An object which has one or more fields containing markup that can be rendered into a display format. Commonly, the fields contain Remarkup and are rendered into HTML. Implementing this interface allows you to render objects through PhabricatorMarkupEngine and benefit from caching and pipelining infrastructure.

An object may have several "fields" of markup. For example, Differential revisions have a "summary" and a "test plan". In these cases, the $field parameter is used to identify which field is being operated on. For simple objects like comments, you might only have one field (say, "body"). In these cases, the implementation can largely ignore the $field parameter.

Tasks

Markup Interface

public didMarkupText()
public getMarkupFieldKey()
public getMarkupText()
public newMarkupEngine()
public shouldUseMarkupCache()

Methods

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

parameters	string	$field	Field name.
	string	$output	The finalized output of the engine.
	string	$engine	The engine which generated the output.
return	string		Final output.

Callback for final postprocessing of output. Normally, you can return the output unmodified.

public string getMarkupFieldKey($field)

parameters	string	$field	Field name.
return	string		Cache key up to 125 characters.

Get a key to identify this field. This should uniquely identify the block of text to be rendered and be usable as a cache key. If the object has a PHID, using the PHID and the field name is likley reasonable:

"{$phid}:{$field}"

public string getMarkupText($field)

parameters	string	$field	Field name.
return	string		The raw markup contained in the field.

Return the contents of the specified field.

public PhutilRemarkupEngine newMarkupEngine($field)

parameters	string	$field	Field name.
return	PhutilRemarkupEngine		Markup engine to use.

Build the engine the field should use.

public bool shouldUseMarkupCache($field)

parameters	wild	$field
return	bool		True to use the markup cache.

Determine if the engine should try to use the markup cache or not. Generally you should use the cache for durable/permanent content but should not use the cache for temporary/draft content.