Diviner Tech Docs PhabricatorPhurlRemarkupRule

final class PhabricatorPhurlRemarkupRule
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.
protected function getObjectNamePrefix()
protected function loadObjects($ids)
protected function getObjectNamePrefixBeginsWithWordCharacter()
protected function getObjectIDPattern()
protected function shouldMarkupObject($params)
protected function getObjectNameText($object, $handle, $id)
protected function loadHandles($objects)
protected function getObjectHref($object, $handle, $id)
protected function renderObjectRefForAnyMedia($object, $handle, $anchor, $id)
protected function renderObjectRef($object, $handle, $anchor, $id)
protected function renderObjectEmbedForAnyMedia($object, $handle, $options)
protected function renderObjectEmbed($object, $handle, $options)
final protected function renderDefaultObjectEmbed($object, $handle)
protected function renderObjectTagForMail($text, $href, $handle)
protected function renderHovertag($name, $href, $attr)
private function getObjectEmbedPattern()
private function getObjectReferencePattern()
public function extractReferences($text) — Extract matched object references from a block of text.
public function markupObjectEmbed($matches)
public function markupObjectReference($matches)
private function markupObject($params)

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()
Inherited

This method is not documented.

Return

wild

public function apply($text)
Inherited

PhutilRemarkupRule

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

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

protected function getObjectNamePrefix()

This method is not documented.

Return

wild

protected function loadObjects($ids)

This method is not documented.

Parameters

array

$ids

Return

wild

protected function getObjectNamePrefixBeginsWithWordCharacter()
Inherited

This method is not documented.

Return

wild

protected function getObjectIDPattern()
Inherited

This method is not documented.

Return

string

Regex which defines a valid object ID

protected function shouldMarkupObject($params)
Inherited

This method is not documented.

Parameters

array

$params

Return

wild

protected function getObjectNameText($object, $handle, $id)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle
	$id

Return

wild

protected function loadHandles($objects)
Inherited

This method is not documented.

Parameters

array

$objects

Return

array<PhabricatorHandleList>

protected function getObjectHref($object, $handle, $id)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle
	$id

Return

wild

protected function renderObjectRefForAnyMedia($object, $handle, $anchor, $id)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle
	$anchor
	$id

Return

string|PhutilSafeHTML|PHUITagView

protected function renderObjectRef($object, $handle, $anchor, $id)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle
	$anchor
	$id

Return

PhutilSafeHTML|string|array

protected function renderObjectEmbedForAnyMedia($object, $handle, $options)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle
	$options

Return

string|PhutilSafeHTML|PHUITagView

protected function renderObjectEmbed($object, $handle, $options)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle
	$options

Return

PhutilSafeHTML|string|array

final protected function renderDefaultObjectEmbed($object, $handle)
Inherited

This method is not documented.

Parameters

	$object
\PhabricatorObjectHandle	$handle

Return

PhutilSafeHTML|string|array

protected function renderObjectTagForMail($text, $href, $handle)
Inherited

This method is not documented.

Parameters

	$text
	$href
\PhabricatorObjectHandle	$handle

Return

PhutilSafeHTML

protected function renderHovertag($name, $href, $attr)
Inherited

This method is not documented.

Parameters

	$name
	$href
array	$attr

Return

PhutilSafeHTML|string|array

private function getObjectEmbedPattern()
Inherited

This method is not documented.

Return

string

Regex

private function getObjectReferencePattern()
Inherited

This method is not documented.

Return

string

Regex

public function extractReferences($text)
Inherited

PhabricatorObjectRemarkupRule

Extract matched object references from a block of text.

This is intended to make it easy to write unit tests for object remarkup rules. Production code is not normally expected to call this method.

Parameters

string

$text

Text to match rules against.

Return

array<string, RemarkupReference[]>

Map of matches, suitable for writing unit tests against.

public function markupObjectEmbed($matches)
Inherited

This method is not documented.

Parameters

array

$matches

Return

wild

public function markupObjectReference($matches)
Inherited

This method is not documented.

Parameters

array

$matches

Return

wild

private function markupObject($params)
Inherited

This method is not documented.

Parameters

array

$params

Return

wild

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

final class PhabricatorPhurlRemarkupRulePhorge Technical Documentation ()

Tasks

Documentation in the Reference App

Other Methods

Methods

public function setEngine($engine)Inherited

public function getEngine()Inherited

public function getPriority()Inherited

public function apply($text)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

protected function getObjectNamePrefix()

protected function loadObjects($ids)

protected function getObjectNamePrefixBeginsWithWordCharacter()Inherited

protected function getObjectIDPattern()Inherited

protected function shouldMarkupObject($params)Inherited

protected function getObjectNameText($object, $handle, $id)Inherited

protected function loadHandles($objects)Inherited

protected function getObjectHref($object, $handle, $id)Inherited

protected function renderObjectRefForAnyMedia($object, $handle, $anchor, $id)Inherited

protected function renderObjectRef($object, $handle, $anchor, $id)Inherited

protected function renderObjectEmbedForAnyMedia($object, $handle, $options)Inherited

protected function renderObjectEmbed($object, $handle, $options)Inherited

final protected function renderDefaultObjectEmbed($object, $handle)Inherited

protected function renderObjectTagForMail($text, $href, $handle)Inherited

protected function renderHovertag($name, $href, $attr)Inherited

private function getObjectEmbedPattern()Inherited

private function getObjectReferencePattern()Inherited

public function extractReferences($text)Inherited

public function markupObjectEmbed($matches)Inherited

public function markupObjectReference($matches)Inherited

private function markupObject($params)Inherited

final class PhabricatorPhurlRemarkupRule
Phorge Technical Documentation ()

public function setEngine($engine)
Inherited

public function getEngine()
Inherited

public function getPriority()
Inherited

public function apply($text)
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

protected function getObjectNamePrefixBeginsWithWordCharacter()
Inherited

protected function getObjectIDPattern()
Inherited

protected function shouldMarkupObject($params)
Inherited

protected function getObjectNameText($object, $handle, $id)
Inherited

protected function loadHandles($objects)
Inherited

protected function getObjectHref($object, $handle, $id)
Inherited

protected function renderObjectRefForAnyMedia($object, $handle, $anchor, $id)
Inherited

protected function renderObjectRef($object, $handle, $anchor, $id)
Inherited

protected function renderObjectEmbedForAnyMedia($object, $handle, $options)
Inherited

protected function renderObjectEmbed($object, $handle, $options)
Inherited

final protected function renderDefaultObjectEmbed($object, $handle)
Inherited

protected function renderObjectTagForMail($text, $href, $handle)
Inherited

protected function renderHovertag($name, $href, $attr)
Inherited

private function getObjectEmbedPattern()
Inherited

private function getObjectReferencePattern()
Inherited

public function extractReferences($text)
Inherited

public function markupObjectEmbed($matches)
Inherited

public function markupObjectReference($matches)
Inherited

private function markupObject($params)
Inherited