Diviner Tech Docs PhabricatorPhurlLinkRemarkupRule

final class PhabricatorPhurlLinkRemarkupRule
Phorge Technical Documentation ()

This class is not documented.

Tasks

Documentation in the Reference App

public function getRemarkupDocumentationObject()

Other Methods

public function setEngine($engine)
public function getEngine()
public function getPriority()
public function apply($text)
public function getPostprocessKey()
public function didMarkupText()
protected function replaceHTML($pattern, $callback, $text)
private function replaceHTMLCallback($match)
protected function newTag($name, $attrs, $content) — Safely generate a tag.
protected function assertFlatText($text) — Assert that a text token is flat (it contains no replacement tokens).
protected function isFlatText($text) — Check whether text is flat (contains no replacement tokens) or not.
protected function getRemarkupLinkClass($is_internal) — Get the CSS class="" attribute for a Remarkup link. It's just "remarkup-link" for all cases, plus the possibility for designers to style external links differently.
public function markupLink($matches)

Methods

public function setEngine($engine)
Inherited

This method is not documented.

Parameters

\PhutilRemarkupEngine

$engine

Return

wild

public function getEngine()
Inherited

This method is not documented.

Return

wild

public function getPriority()

This method is not documented.

Return

wild

public function apply($text)

PhutilRemarkupRule

Check input whether to apply RemarkupRule. If true, apply formatting.

PhabricatorPhurlLinkRemarkupRule

This method is not documented.

Parameters

string|PhutilSafeHTML

$text

String to check and potentially format.

Return

string|PhutilSafeHTML

Unchanged input if no match, or input after matching the formatting rule and applying the formatting.

public function getPostprocessKey()
Inherited

This method is not documented.

Return

wild

public function didMarkupText()
Inherited

This method is not documented.

Return

wild

protected function replaceHTML($pattern, $callback, $text)
Inherited

This method is not documented.

Parameters

	$pattern
	$callback
	$text

Return

wild

private function replaceHTMLCallback($match)
Inherited

This method is not documented.

Parameters

array

$match

Return

wild

protected function newTag($name, $attrs, $content)
Inherited

PhutilRemarkupRule

Safely generate a tag.

In Remarkup contexts, it's not safe to use arbitrary text in tag attributes: even though it will be escaped, it may contain replacement tokens which are then replaced with markup.

This method acts as phutil_tag(), but checks attributes before using them.

Parameters

string	$name	Tag name.
array<string, mixed>	$attrs	Dictionary of tag attributes.
mixed	$content	(optional) Tag content.

Return

PhutilSafeHTML

Tag object.

protected function assertFlatText($text)
Inherited

PhutilRemarkupRule

Assert that a text token is flat (it contains no replacement tokens).

Because tokens can be replaced with markup, it is dangerous to use arbitrary input text in tag attributes. Normally, rule precedence should prevent this. Asserting that text is flat before using it as an attribute provides an extra layer of security.

Normally, you can call newTag() rather than calling this method directly. newTag() will check attributes for you.

Parameters

mixed

$text

Ostensibly flat text.

Return

string

Flat text.

protected function isFlatText($text)
Inherited

PhutilRemarkupRule

Check whether text is flat (contains no replacement tokens) or not.

Parameters

mixed

$text

Ostensibly flat text.

Return

bool	True if the text is flat.

protected function getRemarkupLinkClass($is_internal)
Inherited

PhutilRemarkupRule

Get the CSS class="" attribute for a Remarkup link. It's just "remarkup-link" for all cases, plus the possibility for designers to style external links differently.

Parameters

boolean

$is_internal

Whenever the link was internal or not.

Return

string

public function getRemarkupDocumentationObject()
Inherited

This method is not documented.

Return

PhorgeRemarkupDocumentation|null

public function markupLink($matches)

This method is not documented.

Parameters

array

$matches

Return

wild

Defined: src/applications/phurl/remarkup/PhabricatorPhurlLinkRemarkupRule.php:3
Extends: PhutilRemarkupRule
Implements: PhorgeRemarkupDocumentationProducer ◀ PhutilRemarkupRule

final class PhabricatorPhurlLinkRemarkupRulePhorge Technical Documentation ()

Tasks

Documentation in the Reference App

Other Methods

Methods

public function setEngine($engine)Inherited

public function getEngine()Inherited

public function getPriority()

public function apply($text)

public function getPostprocessKey()Inherited

public function didMarkupText()Inherited

protected function replaceHTML($pattern, $callback, $text)Inherited

private function replaceHTMLCallback($match)Inherited

protected function newTag($name, $attrs, $content)Inherited

protected function assertFlatText($text)Inherited

protected function isFlatText($text)Inherited

protected function getRemarkupLinkClass($is_internal)Inherited

public function getRemarkupDocumentationObject()Inherited

public function markupLink($matches)

final class PhabricatorPhurlLinkRemarkupRule
Phorge Technical Documentation ()

public function setEngine($engine)
Inherited

public function getEngine()
Inherited

public function getPostprocessKey()
Inherited

public function didMarkupText()
Inherited

protected function replaceHTML($pattern, $callback, $text)
Inherited

private function replaceHTMLCallback($match)
Inherited

protected function newTag($name, $attrs, $content)
Inherited

protected function assertFlatText($text)
Inherited

protected function isFlatText($text)
Inherited

protected function getRemarkupLinkClass($is_internal)
Inherited

public function getRemarkupDocumentationObject()
Inherited