Page MenuHomePhorge
Diviner Tech Docs PhutilRemarkupBlockRule

abstract class PhutilRemarkupBlockRule
Phorge Technical Documentation (Remarkup)

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.

public function getPriority()

Determine the order in which blocks execute. Blocks with smaller priority numbers execute sooner than blocks with larger priority numbers. The default priority for blocks is 500.

Priorities are used to disambiguate syntax which can match multiple patterns. For example, - Lorem ipsum... may be a code block or a list.

Return
intPriority at which this block should execute.

final public function getPriorityVector()

This method is not documented.
Return
wild

abstract public function markupText($text, $children)

This method is not documented.
Parameters
$text
$children
Return
wild

abstract public function getMatchingLineCount($lines, $cursor)

This will get an array of unparsed lines and return the number of lines from the first array value that it can parse.

Parameters
array$lines$lines
int$cursor$cursor
Return
int

protected function didMarkupText()

This method is not documented.
Return
wild

public function willMarkupChildBlocks()

This method is not documented.
Return
wild

public function didMarkupChildBlocks()

This method is not documented.
Return
wild

final public function setEngine($engine)

This method is not documented.
Parameters
PhutilRemarkupEngine$engine
Return
wild

final protected function getEngine()

This method is not documented.
Return
wild

public function setMarkupRules($rules)

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

private function updateRules()

This method is not documented.
Return
wild

final public function getMarkupRules()

This method is not documented.
Return
wild

final public function postprocess()

This method is not documented.
Return
wild

final protected function applyRules($text)

This method is not documented.
Parameters
$text
Return
wild

public function supportsChildBlocks()

This method is not documented.
Return
wild

public function extractChildText($text)

This method is not documented.
Parameters
$text
Return
wild

protected function renderRemarkupTable($out_rows)

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