Previous Page
Constants

Solar_Markdown_Wiki_MethodSynopsis
Properties

Next Page
Methods

Properties

Public

None.

Protected

$_Solar_Markdown_Plugin

(array) Default configuration values for this class.

Inherited from Solar_Markdown_Plugin.

Keys are ...

markdown
(Solar_Markdown) The "parent" Markdown object.

$_Solar_Markdown_Wiki_MethodSynopsis

(array) User-defined configuration values.

Keys are ...

synopsis
(string) The "main" format string.
access
(string) The format string for access type.
return
(string) The format string for return type.
method
(string) The format string for the method name.
param
(string) The format string for required params.
param_default
(string) The format string for params with a default value.
throws
(string) The format string for throws.
list_sep
(string) The list separator for params and throws.

$_chars

(string) These should be encoded as special Markdown characters.

Inherited from Solar_Markdown_Plugin.

$_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',
);
?>

$_is_block

(bool) This is a block plugin.

Inherited from Solar_Markdown_Plugin.

$_is_cleanup

(bool) Do not run this plugin during the "cleanup" phase.

Inherited from Solar_Markdown_Plugin.

$_is_prepare

(bool) Do not run this plugin during the "prepare" phase.

Inherited from Solar_Markdown_Plugin.

$_is_span

(bool) This is not a span plugin.

Inherited from Solar_Markdown_Plugin.

$_markdown

(Solar_Markdown) The "parent" Markdown object.

Inherited from Solar_Markdown_Plugin.

$_nested_brackets

(string) The regular expression for nested brackets.

Inherited from Solar_Markdown_Plugin.

Built by the constructor based on $_nested_brackets_depth.

$_nested_brackets_depth

(int) The max depth for nested brackets.

Inherited from Solar_Markdown_Plugin.

Private

None.