Page MenuHomePhorge
Diviner Tech Docs PhutilRemarkupDefaultBlockRule

final class PhutilRemarkupDefaultBlockRule
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()

PhutilRemarkupBlockRule

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.

PhutilRemarkupDefaultBlockRule
This method is not documented.
Return
intPriority at which this block should execute.

final public function getPriorityVector()
Inherited

This method is not documented.
Return
wild

public function markupText($text, $children)

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

public function getMatchingLineCount($lines, $cursor)

PhutilRemarkupBlockRule

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

PhutilRemarkupDefaultBlockRule
This method is not documented.
Parameters
array$lines$lines
int$cursor$cursor
Return
int

protected function didMarkupText()
Inherited

This method is not documented.
Return
wild

public function willMarkupChildBlocks()
Inherited

This method is not documented.
Return
wild

public function didMarkupChildBlocks()
Inherited

This method is not documented.
Return
wild

final public function setEngine($engine)
Inherited

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

final protected function getEngine()
Inherited

This method is not documented.
Return
wild

public function setMarkupRules($rules)
Inherited

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

private function updateRules()
Inherited

This method is not documented.
Return
wild

final public function getMarkupRules()
Inherited

This method is not documented.
Return
wild

final public function postprocess()
Inherited

This method is not documented.
Return
wild

final protected function applyRules($text)
Inherited

This method is not documented.
Parameters
$text
Return
wild

public function supportsChildBlocks()
Inherited

This method is not documented.
Return
wild

public function extractChildText($text)
Inherited

This method is not documented.
Parameters
$text
Return
wild

protected function renderRemarkupTable($out_rows)
Inherited

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