Methods

Public

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

cleanup()

Cleans up the source text after all parsing occurs.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

getChars()

Get the list of characters this plugin uses for parsing.

isBlock()

Is this a block-level plugin?

isCleanup()

Run this plugin during the "cleanup" phase?

isPrepare()

Run this plugin during the "prepare" phase?

isSpan()

Is this a span-level plugin?

locale()

Looks up class-specific locale strings based on a key.

parse()

Parses the source text and replaces with HTML or tokens.

prepare()

Prepares the source text before any parsing occurs.

reset()

Resets this plugin to its original state (for multiple parsings).

setMarkdown()

Sets the "parent" Markdown object.

Protected

_buildConfig()

Builds and returns the default config for a class, including all configs inherited from its parents.

_encode()

Encodes special Markdown characters to they are not parsed by plugins.

_escape()

Escapes HTML in source text.

_exception()

Convenience method for returning exceptions with localized text.

_getTabWidth()

Returns the number of spaces per tab.

_isHtmlToken()

Is a piece of text a delimited HTML token?

_outdent()

Removes one level of leading tabs or space from a text block.

_postConfig()

A hook that activates after _buildConfig() in the constructor.

_postConstruct()

Post-construction tasks to complete object construction.

_preConfig()

A hook that activates before _buildConfig() in the constructor.

_processBlocks()

Processes the text using block-type plugins.

_processSpans()

Processes the text using span-type plugins.

_toHtmlToken()

Converts a piece of text to a delimited HTML token.

_unHtmlToken()

Converts all delimited HTML tokens back into HTML.

Private

None.