Properties
Properties existing in the Solar_Markdown_Apidoc class.
Public
None.
Protected
$_Solar_Markdown_Apidoc
(array) Default configuration values.
This sets the plugins and their processing order for the engine.
$_block_class
(array) Array of all block-type plugin class names.
Inherited from Solar_Markdown.
Each plugin reports if it is a span or a block.
$_bs_esc
(array) Escape table for backslashed special Markdown characters.
Inherited from Solar_Markdown.
Format is "\$char" => "\x1B$char\x1B".
Note that the backslash escape table and the normal escape table map to identical escape sequences.
$_char_ldelim
(string) Left-delimiter for encoded Markdown characters.
Inherited from Solar_Markdown.
$_char_rdelim
(string) Right-delimiter for encoded Markdown characters.
Inherited from Solar_Markdown.
$_chars
(array) Special characters that should be encoded by Markdown.
Inherited from Solar_Markdown.
This list will grow as plugins are added; they each report their own list of special characters to be encoded.
$_cleanup_class
(array) Array of all plugin classes that need to clean up the text after processing.
Inherited from Solar_Markdown.
$_config
(array) Collection point for configuration values.
Inherited from Solar_Base.
Note that you do not define config defaults in $_config directly.
<?php
// DO NOT DO THIS
protected $_config = array(
'foo' => 'bar',
'baz' => 'dib',
);Instead, define config defaults in a protected property named for the class, withan underscore prefix.
For exmple, a "Vendor_Class_Name" class would define the default config array in "$_Vendor_Class_Name". This convention lets child classes inherit parent config keys and values.
<?php
// DO THIS INSTEAD
protected $_Vendor_Class_Name = array(
'foo' => 'bar',
'baz' => 'dib',
);$_count
(int) Running count of $this->_html elements so we don't have to count($this->_html) each time we add an HTML token.
Inherited from Solar_Markdown.
$_esc
(array) Escape table for special Markdown characters.
Inherited from Solar_Markdown.
Format is "$char" => "\x1B$char\x1B".
$_html
(array) Array of HTML blocks represented by delimited token numbers.
Inherited from Solar_Markdown.
Format is token => html.
$_link
(array) List of defined link references keyed on the link name.
Inherited from Solar_Markdown.
Format is "link-name" => array('href' => ..., 'title' => ...).
Generally populated via the StripLinkDefs plugin.
$_plugin
(array) Array of all plugin objects.
Inherited from Solar_Markdown.
Format is class name => object instance.
$_prepare_class
(array) Array of all plugin classes that need to prepare the text before processing.
Inherited from Solar_Markdown.
$_span_class
(array) Array of all span-type plugin class names.
Inherited from Solar_Markdown.
Each plugin reports if it is a span or a block.
Private
None.