Page MenuHomePhorge
Diviner Tech Docs PhabricatorDocumentEngine

abstract class PhabricatorDocumentEngine
Phorge Technical Documentation (Files)

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

final public function setViewer($viewer)

This method is not documented.
Parameters
PhabricatorUser$viewer
Return
wild

final public function getViewer()

This method is not documented.
Return
wild

final public function setHighlightedLines($highlighted_lines)

This method is not documented.
Parameters
array$highlighted_lines
Return
wild

final public function getHighlightedLines()

This method is not documented.
Return
wild

final public function canRenderDocument($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

public function canDiffDocuments($uref, $vref)

This method is not documented.
Parameters
PhabricatorDocumentRef$uref
PhabricatorDocumentRef$vref
Return
wild

public function newBlockDiffViews($uref, $ublock, $vref, $vblock)

This method is not documented.
Parameters
PhabricatorDocumentRef$uref
PhabricatorDocumentEngineBlock$ublock
PhabricatorDocumentRef$vref
PhabricatorDocumentEngineBlock$vblock
Return
wild

public function newBlockContentView($ref, $block)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
PhabricatorDocumentEngineBlock$block
Return
wild

public function newEngineBlocks($uref, $vref)

This method is not documented.
Parameters
PhabricatorDocumentRef$uref
PhabricatorDocumentRef$vref
Return
wild

public function canConfigureEncoding($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

public function canConfigureHighlighting($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

public function canBlame($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

final public function setEncodingConfiguration($config)

This method is not documented.
Parameters
$config
Return
wild

final public function getEncodingConfiguration()

This method is not documented.
Return
wild

final public function setHighlightingConfiguration($config)

This method is not documented.
Parameters
$config
Return
wild

final public function getHighlightingConfiguration()

This method is not documented.
Return
wild

final public function setBlameConfiguration($blame_configuration)

This method is not documented.
Parameters
$blame_configuration
Return
wild

final public function getBlameConfiguration()

This method is not documented.
Return
wild

final protected function getBlameEnabled()

This method is not documented.
Return
wild

public function shouldRenderAsync($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

abstract protected function canRenderDocumentType($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

final public function newDocument($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

final public function newDocumentIcon($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

abstract protected function newDocumentContent($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

protected function getDocumentIconIcon($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

protected function getDocumentRenderingText($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

final public function getDocumentEngineKey()

This method is not documented.
Return
wild

final public static function getAllEngines()

This method is not documented.
Return
wild

final public function newSortVector($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

protected function getContentScore($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

abstract public function getViewAsLabel($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

public function getViewAsIconIcon($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

public function getViewAsIconColor($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

final public static function getEnginesForRef($viewer, $ref)

This method is not documented.
Parameters
PhabricatorUser$viewer
PhabricatorDocumentRef$ref
Return
wild

protected function getByteLengthLimit()

This method is not documented.
Return
wild

protected function canRenderCompleteDocument($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

protected function canRenderPartialDocument($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

protected function newMessage($message)

This method is not documented.
Parameters
$message
Return
wild

final public function newLoadingContent($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild

public function shouldSuggestEngine($ref)

This method is not documented.
Parameters
PhabricatorDocumentRef$ref
Return
wild