PHPXRef 0.7.1 : Phabricator : Detail view of PhabricatorMarkupInterface.php

(no description)

File Size:	85 lines (2 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

PhabricatorMarkupInterface:: (5 methods):
  getMarkupFieldKey()
  newMarkupEngine()
  getMarkupText()
  didMarkupText()
  shouldUseMarkupCache()

Interface: PhabricatorMarkupInterface - X-Ref

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 @{class: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.

getMarkupFieldKey($field) X-Ref

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 likely reasonable:

"{$phid}:{$field}"

param: string Field name.
return: string Cache key up to 125 characters.

newMarkupEngine($field) X-Ref

Build the engine the field should use.

param: string Field name.
return: PhutilRemarkupEngine Markup engine to use.

getMarkupText($field) X-Ref

Return the contents of the specified field.

param: string Field name.
return: string The raw markup contained in the field.

didMarkupText($field,$output,PhutilMarkupEngine $engine) X-Ref

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

param: string Field name.
param: string The finalized output of the engine.
param: string The engine which generated the output.
return: string Final output.

shouldUseMarkupCache($field) X-Ref

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.

return: bool True to use the markup cache.

PHP Cross Reference of Phabricator

/src/infrastructure/markup/ -> PhabricatorMarkupInterface.php (summary)

Defines 1 class