HumHub Documentation (unofficial)

RichTextToMarkdownConverter extends BaseRichTextConverter
in package

Application

This parser can be used to convert HumHub richtext to plain markdown by removing special richtext markdown syntax.

Note: The output of this converter will not be encoded, so do not directly embed the output to a HTML view without encoding. When using this as export format, the frontend responsible for rendering the markdown needs to make sure to purify the result and ideally deactivate direct html parsing e.g.: require('markdown-it')({html:false, ...})

Constants

EVENT_AFTER_PARSE = 'afterParse'
EVENT_BEFORE_PARSE = 'beforeParse'
MAX_CACHE_ENTRIES = 200: Maximum entries in the cache
OPTION_CACHE_KEY = 'cacheKey': Cache key can be used to cache parser results
OPTION_EXCLUDE = 'exclude': Option key for excluding blocks or extensions.
OPTION_IMAGE_AS_LINK = 'imageAsLink': Option key used for rendering images as links.
OPTION_IMAGE_AS_URL = 'imageAsText': Option key used for rendering images as url links.
OPTION_LINK_AS_TEXT = 'linkAsText': Option key used for rendering links as plain text.
OPTION_LINK_TARGET = 'linkTarget': Option key for overwriting default link target _blank.
OPTION_PREV_LINK_TARGET = 'prevLinkTarget': Option key for preventing link target attribute.
BOLD_WRAPPER = '**': Wrapper mark for bold markdown text
EMPHASIZE_WRAPPER = '_': Wrapper mark for emphasized markdown text
IMAGE_SUFFIX = '!': Suffix used for markdown images
INLINE_CODE_WRAPPER = '`': Wrapper mark for inline code markdown
STRIKE_WRAPPER = '~~': Wrapper mark for strikethrough markdown text

Properties

$cache : array<string|int, mixed>
$enableNewlines : bool
$format : string
$html5 : mixed
$keepListStartNumber : bool
$maximumNestingLevel : int
$options : array<string|int, mixed>
$context : array<string|int, mixed>
$escapeBackslashBreak : bool
$escapeCharacters : array<string|int, mixed>
$extensions : array<string|int, RichTextExtension>
$identifyQuote : bool
$identifyTable : bool
$inlineHtmlElements : array<string|int, mixed>
$linkExtensions : array<string|int, RichTextLinkExtension>
$references : array<string|int, mixed>
$selfClosingHtmlElements : array<string|int, mixed>
$_blockTypes : mixed
$_depth : mixed
$_inlineMarkers : array<string|int, mixed>

Methods

__construct() : mixed: BaseRichTextParser constructor.
addExtension() : mixed: Can be used to add additional richtext extensions
buildCacheKeyForContent() : string: Builds a cache key for a given content. When using this function with specific parser options a $prefix should be provided in order to not interfere with other parser results.
buildCacheKeyForRecord() : string: Builds a cache key for a given record. When using this function with specific parser options a $prefix should be provided in order to not interfere with other parser results.
flushCache() : mixed: This function can be used to flush existing parser result caches of this converter class
getOption() : mixed
parse() : string: Parses the given text considering the full language.
parseParagraph() : string: Parses a paragraph without block elements (block elements are ignored).
process() : string: Converts markdown into HTML.
blockTypes() : array<string|int, mixed>
br2nl() : string: Helper function to translate br tags to new lines
cleanup() : mixed: This method will be called after `parse()` and `parseParagraph()`.
composeTable() : string: This method composes a table from parsed body and head HTML.
consumeCode() : mixed: Consume lines for a code block element
consumeFencedCode() : mixed: Consume lines for a fenced code block
consumeHeadline() : mixed: Consume lines for a headline
consumeHr() : mixed: Consume a horizontal rule
consumeHtml() : mixed: Consume lines for an HTML block
consumeOl() : mixed
consumeParagraph() : array<string|int, mixed>: Consume lines for a paragraph
consumeQuote() : mixed: Consume lines for a blockquote element
consumeReference() : mixed: Consume link references
consumeTable() : mixed: Consume lines for a table
consumeUl() : mixed: Consume lines for an unordered list
detectLineType() : mixed
identifyCode() : mixed: identify a line as the beginning of a code block.
identifyFencedCode() : mixed: identify a line as the beginning of a fenced code block.
identifyHeadline() : mixed: identify a line as a headline
identifyHr() : mixed: identify a line as a horizontal rule.
identifyHtml() : mixed: identify a line as the beginning of a HTML block.
identifyOl() : mixed: identify a line as the beginning of an ordered list.
identifyQuote() : false: Deactivates quote parsing in caste [[identifyQuote]] flag is false (default).
identifyReference() : mixed
identifyTable() : bool: Deactivates table parsing in caste [[identifyTable]] flag is false (default).
identifyUl() : mixed: identify a line as the beginning of an unordered list.
inlineMarkers() : array<string|int, mixed>: Returns a map of inline markers to the corresponding parser methods.
lookupReference() : mixed
onAfterParse() : mixed|string: This function is called after the parser starts parsing the given `$text`.
onBeforeParse() : mixed|string: This function is called right before the parser starts parsing the given `$text`.
parseBlock() : array<string|int, mixed>: Parses the block at current line by identifying the block type and parsing the content
parseBlocks() : mixed
parseEmphStrong() : mixed: Parses emphasized and strong elements.
parseEntity() : mixed: html entity mark parser is disabled by removing marker in php doc
parseEscape() : mixed: Parses escaped special characters.
parseGt() : mixed: `>` mark parser is disabled by removing marker in php doc
parseImage() : mixed: Parses an image indicated by `![`.
parseInline() : mixed
parseInlineCode() : mixed: Parses an inline code span `` ` ``.
parseInlineHtml() : mixed: Parses inline HTML.
parseLink() : mixed: Parses a link indicated by `[`.
parseLinkOrImage() : array<string|int, mixed>|bool: Extends parent regex patter in order to support extension metadata as image size ![Scaled Image](http://localhost/static/img/logo.png =150x)
parseLt() : mixed: `<` mark parser is disabled by removing marker in php doc
parseStrike() : mixed: Parses the strikethrough feature.
parseTd() : mixed: Deactivated by removing marker
parseUrl() : mixed: Parses urls and adds auto linking feature.
prepare() : mixed: This method will be called before `parse()` and `parseParagraph()`.
prepareMarkers() : mixed: Prepare markers that are used in the text to parse
renderAbsy() : mixed
renderAutoUrl() : string
renderCode() : string
renderEmail() : string: Returns a plain markdown representation of an email
renderEmph() : string
renderHeadline() : string
renderHr() : string
renderHtml() : string
renderImage() : mixed
renderInlineCode() : string
renderInlineHtml() : string
renderLink() : string: Renders the given link block to plain text <text>(<url>).
renderLinkExtension() : string
renderLinkOrImage() : mixed
renderList() : string: Returns a plain text representation of a list block
renderParagraph() : string: Returns a plain text representation of a text paragraph
renderPlainImage() : string
renderPlainLink() : string
renderQuote() : string
renderStrike() : string
renderStrong() : string
renderTable() : mixed: render a table block
renderText() : string: This function renders plain text sections in the markdown text.
renderUrl() : string
replaceEscape() : string: Remove backslash from escaped characters
consumeList() : mixed
generateHtmlAttributes() : string: Return html attributes string from [attrName => attrValue] list
getExcludes() : mixed

EVENT_AFTER_PARSE


    public
        mixed
    EVENT_AFTER_PARSE
    = 'afterParse'

EVENT_BEFORE_PARSE


    public
        mixed
    EVENT_BEFORE_PARSE
    = 'beforeParse'

MAX_CACHE_ENTRIES

Maximum entries in the cache


    public
        mixed
    MAX_CACHE_ENTRIES
    = 200

OPTION_CACHE_KEY

Cache key can be used to cache parser results


    public
        mixed
    OPTION_CACHE_KEY
    = 'cacheKey'