public function setEngine($engine)Inherited
public function setEngine($engine)
Inherited
Parameters
| PhutilRemarkupEngine | $engine |
Return
| wild |
public function getEngine()Inherited
public function getEngine()
Inherited
Return
| wild |
public function getPriority()Inherited
public function getPriority()
Inherited
Return
| wild |
public function apply($text)Inherited
public function apply($text)
Inherited
Parameters
| $text |
Return
| wild |
public function getPostprocessKey()Inherited
public function getPostprocessKey()
Inherited
Return
| wild |
public function didMarkupText()Inherited
public function didMarkupText()
Inherited
Return
| wild |
protected function replaceHTML($pattern, $callback, $text)Inherited
protected function replaceHTML($pattern, $callback, $text)
Inherited
Parameters
| $pattern | ||
| $callback | ||
| $text |
Return
| wild |
private function replaceHTMLCallback($match)Inherited
private function replaceHTMLCallback($match)
Inherited
Parameters
| array | $match |
Return
| wild |
protected function newTag($name, $attrs, $content)Inherited
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. |
| dict<string, | $attrs | wild> Tag attributes. |
| wild | $content | Tag content. |
Return
| PhutilSafeHTML | Tag object. |
protected function assertFlatText($text)Inherited
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
| wild | $text | Ostensibly flat text. |
Return
| string | Flat text. |
protected function isFlatText($text)Inherited
protected function isFlatText($text)
Inherited
PhutilRemarkupRule
Check whether text is flat (contains no replacement tokens) or not.
Parameters
| wild | $text | Ostensibly flat text. |
Return
| bool | True if the text is flat. |
protected function getObjectNamePrefix()
protected function getObjectNamePrefix()
Return
| wild |
protected function loadObjects($ids)
protected function loadObjects($ids)
Parameters
| array | $ids |
Return
| wild |
protected function getObjectNamePrefixBeginsWithWordCharacter()Inherited
protected function getObjectNamePrefixBeginsWithWordCharacter()
Inherited
Return
| wild |
protected function getObjectIDPattern()Inherited
protected function getObjectIDPattern()
Inherited
Return
| wild |
protected function shouldMarkupObject($params)Inherited
protected function shouldMarkupObject($params)
Inherited
Parameters
| array | $params |
Return
| wild |
protected function getObjectNameText($object, $handle, $id)Inherited
protected function getObjectNameText($object, $handle, $id)
Inherited
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle | |
| $id |
Return
| wild |
protected function loadHandles($objects)Inherited
protected function loadHandles($objects)
Inherited
Parameters
| array | $objects |
Return
| wild |
protected function getObjectHref($object, $handle, $id)Inherited
protected function getObjectHref($object, $handle, $id)
Inherited
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle | |
| $id |
Return
| wild |
protected function renderObjectRefForAnyMedia($object, $handle, $anchor, $id)Inherited
protected function renderObjectRefForAnyMedia($object, $handle, $anchor, $id)
Inherited
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle | |
| $anchor | ||
| $id |
Return
| wild |
protected function renderObjectRef($object, $handle, $anchor, $id)Inherited
protected function renderObjectRef($object, $handle, $anchor, $id)
Inherited
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle | |
| $anchor | ||
| $id |
Return
| wild |
protected function renderObjectEmbedForAnyMedia($object, $handle, $options)Inherited
protected function renderObjectEmbedForAnyMedia($object, $handle, $options)
Inherited
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle | |
| $options |
Return
| wild |
protected function renderObjectEmbed($object, $handle, $options)
protected function renderObjectEmbed($object, $handle, $options)
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle | |
| $options |
Return
| wild |
final protected function renderDefaultObjectEmbed($object, $handle)Inherited
final protected function renderDefaultObjectEmbed($object, $handle)
Inherited
Parameters
| $object | ||
| PhabricatorObjectHandle | $handle |
Return
| wild |
protected function renderObjectTagForMail($text, $href, $handle)Inherited
protected function renderObjectTagForMail($text, $href, $handle)
Inherited
Parameters
| $text | ||
| $href | ||
| PhabricatorObjectHandle | $handle |
Return
| wild |
protected function renderHovertag($name, $href, $attr)Inherited
protected function renderHovertag($name, $href, $attr)
Inherited
Parameters
| $name | ||
| $href | ||
| array | $attr |
Return
| wild |
private function getObjectEmbedPattern()Inherited
private function getObjectEmbedPattern()
Inherited
Return
| wild |
private function getObjectReferencePattern()Inherited
private function getObjectReferencePattern()
Inherited
Return
| wild |
public function extractReferences($text)Inherited
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
| wild | Matches, suitable for writing unit tests against. |
public function markupObjectEmbed($matches)Inherited
public function markupObjectEmbed($matches)
Inherited
Parameters
| array | $matches |
Return
| wild |
public function markupObjectReference($matches)Inherited
public function markupObjectReference($matches)
Inherited
Parameters
| array | $matches |
Return
| wild |
private function markupObject($params)Inherited
private function markupObject($params)
Inherited
Parameters
| array | $params |
Return
| wild |
private function getFileOptions($option_string)
private function getFileOptions($option_string)
Parameters
| $option_string |
Return
| wild |
private function renderImageFile($file, $handle, $options)
private function renderImageFile($file, $handle, $options)
Parameters
| PhabricatorFile | $file | |
| PhabricatorObjectHandle | $handle | |
| array | $options |
Return
| wild |
private function renderAudioFile($file, $handle, $options)
private function renderAudioFile($file, $handle, $options)
Parameters
| PhabricatorFile | $file | |
| PhabricatorObjectHandle | $handle | |
| array | $options |
Return
| wild |
private function renderVideoFile($file, $handle, $options)
private function renderVideoFile($file, $handle, $options)
Parameters
| PhabricatorFile | $file | |
| PhabricatorObjectHandle | $handle | |
| array | $options |
Return
| wild |
private function renderMediaFile($tag, $file, $handle, $options)
private function renderMediaFile($tag, $file, $handle, $options)
Parameters
| $tag | ||
| PhabricatorFile | $file | |
| PhabricatorObjectHandle | $handle | |
| array | $options |
Return
| wild |
private function renderFileLink($file, $handle, $options)
private function renderFileLink($file, $handle, $options)
Parameters
| PhabricatorFile | $file | |
| PhabricatorObjectHandle | $handle | |
| array | $options |
Return
| wild |
private function parseDimension($string)
private function parseDimension($string)
Parameters
| $string |
Return
| wild |