Methods

All methods in the Solar_Markdown_Apidoc class.

Public

__construct()

Constructor.

__destruct()

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

cleanup()

Runs the processed text through each plugin's cleanup() method.

dump()

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

encode()

Encodes special Markdown characters so they are not recognized when parsing.

escape()

Escapes HTML in source text.

getLink()

Returns the href and title of a named link reference.

getLinks()

Returns an array of all defined link references.

getPlugin()

Returns an internal Markdown plugin object for direct manipulation and inspection.

getTabWidth()

Returns the number of spaces per tab.

isHtmlToken()

Is a piece of text a delimited HTML token?

locale()

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

prepare()

Prepares the text for processing by running the prepare() method of each plugin, in order, on the source text.

processBlocks()

Runs the source text through all block-type plugins.

processSpans()

Runs the source text through all span-type plugins.

render()

Returns a final rendering of the processed text.

reset()

Resets Markdown and all its plugins for a new transformation.

setLink()

Sets the value of a named link reference.

toHtmlToken()

Saves a pieces of text as HTML and returns a delimited token.

transform()

One-step transformation of source text using plugins.

unEncode()

Un-encodes special Markdown characters.

unHtmlToken()

Replaces all HTML tokens in source text with saved HTML.

Protected

_buildConfig()

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

_encode()

Support method for encode().

_exception()

Convenience method for returning exceptions with localized text.

_explodeTags()

Explodes source text into tags and text

_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.

Private

None.



Local