Overview
Replaces class page links in source text with XHTML anchors.
Class page links are in this format ...
[[Class]] [[Class]]es [[Class | display this instead]] [[Class::Page]] [[Class::$property]] [[Class::method()]] [[Class::CONSTANT]]
Package
This class is part of the Solar_Markdown_Apidoc package.
Inheritance:
Solar_Markdown_Apidoc_ClassPage
Configuration Keys
markdown: The "parent" Markdown object.constant: A string template for the xml:id for "Constants" page links.overview: A string template for the xml:id for "Overview" page links.method: A string template for the xml:id for individual method page links.other: A string template for the xml:id for all other types of page links.property: A string template for the xml:id for "Properties" page links.package: A string template for the xml:id for "Package" page links.
Constants
None.
Public Properties
The Solar_Markdown_Apidoc_ClassPage class has no public properties; try the list of all properties.
Public Methods
These are all the public methods in the Solar_Markdown_Apidoc_ClassPage class.
You can also view the list of all public, protected, and private methods.
-
__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 for Class::Page links.
-
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.