Muster_SimpleWiki_Parser Class Reference

Muster Software Copyright (c) Henrik Bechmann, Toronto, Canada 2009-2012. More...

Public Member Functions
Property accessors
	metadata ()
	Get metadata from parsed markup.
	markerdata ()
	Get markerdata from parsed markup.
	preprocessed_markup ()
	Get preprocessed markup, before parsing.
	argchars ($argchars=NULL)
	Get or set decorator argument character set (default '^()').
Protected Attributes
Regular expression properties
$_rules holds the core rules combined into the applied regular expressions. The rest of these properties hold the applied regular expressions used by the dom creation (*_node) methods) See also: _set_rules _set_re
	$link_inline_re
	Object that holds basic rules to be combined into applied regular expressions.
	$image_inline_re
	image inline parse
	$item_inline_re
	list inline item parse
	$defitem_inline_re
	definition inline item parse
	$cell_re
	quick table cell parse
	$decorator_re
	parse anything's decorator arguments
	$tablerow_setaside_re
	setaside for table row
	$pre_escape_re
	remove escape from pre
	$_rules
	object containing rules which combine into applied regular expressions
	$block_re
	block parse
	$inline_re
	inline parse
DOM control properties
	$_curnode
	the current node being processed
	$_leaftextnode
	the leaftextnode, which holds presentation text (no markup), and is alwasy of type SimpleWiki_DocNode::TEXT
	$_root
	the root document node
Data properties
	$_raw
	the original souce text to be processed
	$_preprocessed_raw
	the original souce text after preprocessing, but before parsing
	$_argchars = '^()'
	character set allowed for decorators (class names, properties and their values, attribuets and their values
	$_metadata
	metadata object possibly generated from first line of markup ("```## ...")
	$_markerdata
	from preprocessing, an object with textlength, markercount, markers
	$_markers
	Transient: from preprocessing, an array with marker objects, later folded into _markerdata.
Create Parser
	__construct ($text)
	Sets rules, sets regular expressions, and prepares any passed text.
	_set_rules ()
	Set rules for parsing.
	_set_re ($rules)
	combine (set) the rules into applied regular expressions.
Parse control methods
	prepare ($markup)
	Prepares the text for processing.
	parse ()
	Parse the prepared markup.
	_parse_block ($raw)
	Use the _block_re assembled regular expressions to parse the raw text for block structures.
	_parse_inline ($raw)
	Use the _inline_re assembled regular expressions to parse the raw text for inline structures.
	_create_node ($preg_groups)
	Directs parsed data from _parse_block and _parse_inline to the appropriate node creation method.
Setaside support
	$_pre_markers = array()
	markers to replace preformatted data
	$_pre_markup = array()
	preformatted element markup, matching markers
	$_pre_count = 0
	count to include in generated preformatted marker identifier
	$_tablerow_markers = array()
	structure to set aside row contents before parsing row structure itself
	$_tablerow_markup = array()
	tablerow element markup, matching markers
	$_tablerow_count = 0
	count to include in generated tablerow marker identifier
	add_pre_and_code_markers ($preg_groups)
	mark locations of preformatted data.
	add_tablerow_markers ($preg_groups)
	mark locations of tablerow data.
Parse support methods
A handful of methods that provide support for parsing.
	get_decoration ($decorator_string)
	gets common argument structure for decorators and block declarations.
	get_selected_ancestor ($node, $types)
	get the ancestor node of the passed node that has a type as listed in the second argument Look up the tree (starting with $node) to the first occurence of one of the listed types of nodes or root.
	preprocess_raw_markup ($raw)
	pre process the markup.
	preprocess_markerdata ($matches)
	preprocess marker data.
	preprocess_metadata ($matches)
	preprocess metadata.
	set_node_decoration ($node, $decorator_string)
	parse decorator and declaration arguments from string to structure into a node.
Dom creation methods
These methods are invoked by _create_node, based on the subgroup name of the first successful regular expression. The name is assembled with _<subgroupname>_node. See also: _create_node
	_char_node ($preg_groups)
	Character batch added to text stream.
	_escape_node ($preg_groups)
	Escaped character added to text stream.
	_blankline_node ($preg_groups)
	Triggers new block.
	_paragraph_node ($preg_groups)
	Creates paragraph node.
	_heading_node ($preg_groups)
	Creates heading node.
	_emph_node ($preg_groups)
	Create an emphasis node, or return from one.
	_strong_node ($preg_groups)
	Create a strong node, or return from one.
	_linebreak_node ($preg_groups)
	Create a linebreak node.
	_horizontalrule_node ($preg_groups)
	Create a horizontal rule node.
	_link_node ($preg_groups)
	Create a link node.
	_image_node ($preg_groups)
	Create an image node.
	_list_node ($preg_groups)
	Create a list node.
	_item_node ($preg_groups)
	Create a list item, and a list node if necessary.
	_deflist_node ($preg_groups)
	Create a definition list node.
	_defitem_node ($preg_groups)
	Create a definition term and description, and a definition list node if necessary.
	_table_node ($preg_groups)
	Process a quick table row.
	_span_node ($preg_groups)
	Create a span node.
	_blockdivider_node ($preg_groups)
	Block divider, a standalone decorator.
	_code_node ($preg_groups)
	Create an inline code node.
	_pre_node ($preg_groups)
	Create a block preformatted node.
	_blockdef_node ($preg_groups)
	Create a block node.
	_macro_node ($preg_groups)
	Create inline macro.
	_blockmacro_node ($preg_groups)
	Create block macro.
Debug functions
	display_regex ()
	Display the regex assemblies.
	display_dom ($root)
	Display the dom.
	display_dom_add_child ($node, &$childarray)
	Support for display the dom.

---

Detailed Description

Muster Software Copyright (c) Henrik Bechmann, Toronto, Canada 2009-2012.

All rights reserved. See "musterlicence.txt" for licencing information. mustersoftware.net

Version:

1.0

Date:

February 9, 2012 Parses wiki markup into tree of document nodes. public methods: $parser = new SimpleWikiParser($text) - create instance of parser for text

• parse() - main method, parses text, returns document object model (tree)
• prepare($markup) - reset with new markup
• metadata() - set with ```## arguments on first line
• argchars($argchars = NULL) - get or set characters allowed for arguments
• get_selected_ancestor($node, $types)
• parse_arguments($decorator)
• for debugging:
  • display_regex()
  • display_dom($dom)
• see _create_node($preg_groups) below, which is the controller for the parsing process.

Definition at line 26 of file muster_simplewiki_parser.php.

---

Constructor & Destructor Documentation

__construct

(

$

text

)

Sets rules, sets regular expressions, and prepares any passed text.

Parameters:

string

$text

markup text to be parsed (can be NULL)

Returns:

void

Definition at line 82 of file muster_simplewiki_parser.php.

---

Member Function Documentation

_blankline_node

(

$

preg_groups

)

[protected]

Triggers new block.

This is done by resetting the current block to the nearest ancestor blockdef, or the root document.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 762 of file muster_simplewiki_parser.php.

_blockdef_node

(

$

preg_groups

)

[protected]

Create a block node.

SimpleWiki_DocNode::BLOCKDEF. Set reference to closest document, blockdef, list_item or def_desc ancestor. Create node, set decoration, parse inline portion and parse block portion.

Sets property $node->blocktag. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1345 of file muster_simplewiki_parser.php.

_blockdivider_node

(

$

preg_groups

)

[protected]

Block divider, a standalone decorator.

SimpleWiki_DocNode::BLOCKDIVIDER.

|:b decoration:|

Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1272 of file muster_simplewiki_parser.php.

_blockmacro_node

(

$

preg_groups

)

[protected]

Create block macro.

SimpleWiki_DocNode::MACRO. The text portion is both saved as text and parsed.

Sets property $node->macroname. Sets property $node->textcontent if text is present. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text.

Definition at line 1418 of file muster_simplewiki_parser.php.

_char_node

(

$

preg_groups

)

[protected]

Character batch added to text stream.

Creates leaftextnode SimpleWiki_DocNode::TEXT if required. Creates a 'text' leaftextnode if none exists and adds the found characters to its content property.

Sets property $leaftextnode->textcontent.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 735 of file muster_simplewiki_parser.php.

_code_node

(

$

preg_groups

)

[protected]

Create an inline code node.

SimpleWiki_DocNode::CODE.

Sets property $node->textcontent. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1289 of file muster_simplewiki_parser.php.

_create_node

(

$

preg_groups

)

[protected]

Directs parsed data from _parse_block and _parse_inline to the appropriate node creation method.

Regular expressions are organized such that sucess results in assigning a string to the first subgroup name of the expression rule. The first subgroup name of the expression rule corresponds to the first part of the assembled name of the node creation method. This allows _create_node to search through the preg_groups for the first named array entry, and use that name to direct the preg_groups data to the method that can use the parsed data to create a dom element.

Parameters:

array

$preg_groups

taken from preg_replace_callback

Returns:

void

Definition at line 486 of file muster_simplewiki_parser.php.

_defitem_node

(

$

preg_groups

)

[protected]

Create a definition term and description, and a definition list node if necessary.

SimpleWiki_DocNode::DEF_LIST, SimpleWiki_DocNode::DEF_TERM, SimpleWiki_DocNode::DEF_DESC.

Sets property $list->level. Sets property $list->decoration. Sets property $term->decoration. Sets property $desc->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1080 of file muster_simplewiki_parser.php.

_deflist_node

(

$

preg_groups

)

[protected]

Create a definition list node.

Parses the definition list markup as a whole, components to be processed by _item_node.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1064 of file muster_simplewiki_parser.php.

_emph_node

(

$

preg_groups

)

[protected]

Create an emphasis node, or return from one.

SimpleWiki_DocNode::EMPHASIS.

If we are in an emphasis node, the emphasis markup denotes and end to the node. Otherwise a new emphasis node is created.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 856 of file muster_simplewiki_parser.php.

_escape_node

(

$

preg_groups

)

[protected]

Escaped character added to text stream.

Creates leaftextnode SimpleWiki_DocNode::TEXT if required. Creates a 'text' leaftextnode if none exists and adds the escaped character to its content property. The escape character itself is left behind.

Sets property $leaftextnode->textcontent.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 750 of file muster_simplewiki_parser.php.

_heading_node

(

$

preg_groups

)

[protected]

Creates heading node.

SimpleWiki_DocNode::HEADING. Changes current node to nearest block or document.

Creates a heading node, and does an inline parse of the heading text.

Sets property $node->level. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 823 of file muster_simplewiki_parser.php.

_horizontalrule_node

(

$

preg_groups

)

[protected]

Create a horizontal rule node.

SimpleWiki_DocNode::HORIZONTALRULE. Moves to the nearest document or block ancestor, and creates a horizontalrule node.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 904 of file muster_simplewiki_parser.php.

_image_node

(

$

preg_groups

)

[protected]

Create an image node.

SimpleWiki_DocNode::IMAGE. Parse the image text.

Sets property $node->target. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 953 of file muster_simplewiki_parser.php.

_item_node

(

$

preg_groups

)

[protected]

Create a list item, and a list node if necessary.

SimpleWiki_DocNode::ORDERED_LIST, SimpleWiki_DocNode::UNORDERED_LIST, SimpleWiki_DocNode::LIST_ITEM.

Sets property $list->level. Sets property $list->decoration. Sets property $item->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1000 of file muster_simplewiki_parser.php.

_linebreak_node

(

$

preg_groups

)

[protected]

Create a linebreak node.

SimpleWiki_DocNode::LINEBREAK. Creates a linebreak node unconditionally.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 892 of file muster_simplewiki_parser.php.

_link_node

(

$

preg_groups

)

[protected]

Create a link node.

SimpleWiki_DocNode::LINK. Parse the link text.

Sets property $node->target. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 918 of file muster_simplewiki_parser.php.

_list_node

(

$

preg_groups

)

[protected]

Create a list node.

Parses the list markup as a whole, components to be processed by _item_node.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 985 of file muster_simplewiki_parser.php.

_macro_node

(

$

preg_groups

)

[protected]

Create inline macro.

SimpleWiki_DocNode::MACRO. The text portion is both saved as text and parsed.

Sets property $node->macroname. Sets property $node->textcontent if text is present. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text.

Definition at line 1384 of file muster_simplewiki_parser.php.

_paragraph_node

(

$

preg_groups

)

[protected]

Creates paragraph node.

SimpleWiki_DocNode::PARAGRAPH. If the current node is a table, table_row, or a list, then the current node is set to the nearest ancestor block or document.

If the current node is a block or document, a new paragraph node is created.

Then the paragraph is parsed for inline parsing.

Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Todo:

why not just go straight to nearest document or blockdef?

Definition at line 782 of file muster_simplewiki_parser.php.

_parse_block

(

$

raw

)

[protected]

Use the _block_re assembled regular expressions to parse the raw text for block structures.

This method directs match processing to the _create_node controller, which then directs processing to the node creation method of the found (parsed) text

Parameters:

string

$raw

raw markup text

Returns:

void

See also:

_create_node

Definition at line 456 of file muster_simplewiki_parser.php.

_parse_inline

(

$

raw

)

[protected]

Use the _inline_re assembled regular expressions to parse the raw text for inline structures.

This method directs match processing to the _create_node controller, which then directs processing to the node creation method of the found (parsed) text

Parameters:

string

$raw

raw markup text

Returns:

void

See also:

_create_node

Definition at line 470 of file muster_simplewiki_parser.php.

_pre_node

(

$

preg_groups

)

[protected]

Create a block preformatted node.

SimpleWiki_DocNode::PREFORMATTED.

Sets property $node->textcontent. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1309 of file muster_simplewiki_parser.php.

_set_re

(

$

rules

)

[protected]

combine (set) the rules into applied regular expressions.

The following applied regular expressions are set by combining rules. See source code for details.

• block_re
• inline_re
• link_inline_re
• image_inline_re
• item_inline_re
• defitem_inline_re
• cell_re
• tablerow_setaside_re
• pre_escape_re
• decorator_re

Definition at line 318 of file muster_simplewiki_parser.php.

_set_rules

(

)

[protected]

Set rules for parsing.

Creates a generic object, addes rules to it, and saves it to $this->_rules.

Rules are combined into applied regular expressions in _set_re.

The first subgroup name of each rule matches the first part of the node method name called by _create_node to create a dom node for the markup fragment.

Returns:

void

Specific rules:

char: characters except those that start inline markup: "/*\[{%<~" (emphasis, strong, linebreak, link, image/code, span, macro, escape), char is default expression for inline string.

blankline: empty line that separates blocks, especially paragraphs

paragraph: text not otherwise parsed with block parsing - handed over to inline parsing

headings: =*

emph: emphasis // there must be no ":" in front of the "//" or there must be whitespace after the forward slashes. This avoids italic rendering in urls with unknown protocols

strong: "**"

linebreak: "\\"

link: marked links: '[[...]]'

image: '{{...}}'

deflist: definition list ':* ... :: ... '. Matches the whole list, separate items are parsed later.

defitem: definition list item: Matches single list item. Isolates decorators, markup, term, and definition

list: ordered or unordered lists. Matches the whole list, separate items are parsed later. The list *must* start with a single bullet.

item: list item, matches single list item. Isolates decorators, markup, contents

table: simple tables, one line per row. table requires closing pipe

cell: break table row into cells. used for preg_match in table_node

escape: '~'

span: span decorator '% ... '. Empty decorator (optional) connotes end of span

blockdivider: '|:b ... :|' on line by itself.

code: '%c ...'

pre: block '{{{ ...'

pre_escape: allow ~ before closing included pre brace set (}}}). Simply removed.

blockdef: block declarations

macro: << ... >> inline

blockmacro: block version to prevent generation of <p> markup, allows surrounding whitespace

decorator: re to pull standard decorator structure: with or without operator; with or withoug '' or "" delimiters

Definition at line 99 of file muster_simplewiki_parser.php.

_span_node

(

$

preg_groups

)

[protected]

Create a span node.

SimpleWiki_DocNode::SPAN. A span with a decorator opens a new span. An empty span (%%) closes an existing span, or is written as text if no span has been opened.

Sets property $leaftextnode->textcontent from markup with error. SimpleWiki_DocNode::TEXT. Sets property $node->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1237 of file muster_simplewiki_parser.php.

_strong_node

(

$

preg_groups

)

[protected]

Create a strong node, or return from one.

SimpleWiki_DocNode::STRONG.

If we are in an strong node, the strong markup denotes and end to the node. Otherwise a new strong node is created.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 875 of file muster_simplewiki_parser.php.

_table_node

(

$

preg_groups

)

[protected]

Process a quick table row.

Create a table node if necessary. SimpleWiki_DocNode::TABLE. Create a table row node. SimpleWiki_DocNode::TABLE_ROW. Create and parse cell nodes. SimpleWiki_DocNode::TABLE_HEADCELL, SimpleWiki_DocNode::TABLE_CELL.

Sets property $table->decoration. Sets property $row->decoration. Sets property $cell->decoration.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

void which removes the found string from the raw text

Definition at line 1161 of file muster_simplewiki_parser.php.

add_pre_and_code_markers

(

$

preg_groups

)

[protected]

mark locations of preformatted data.

Set aside preformatted data, generate unique marker in the code for the data.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

string to be used by preg_replace_callback to replace the found text

Todo:

determine if this method is still required - add_pre_and_code_markers

Definition at line 523 of file muster_simplewiki_parser.php.

add_tablerow_markers

(

$

preg_groups

)

[protected]

mark locations of tablerow data.

set aside tablerow data

Set aside tablerow data, generate unique marker in the code for the data.

Parameters:

array

$preg_groups

as returned by preg_replace_callback

Returns:

string to be used by preg_replace_callback to replace the found text

Definition at line 546 of file muster_simplewiki_parser.php.

argchars

(

$

argchars = NULL

)

Get or set decorator argument character set (default '^()').

Parameters:

string

$argchars

content of character set expression: '[' . $argchars . ']'

Returns:

string

Definition at line 397 of file muster_simplewiki_parser.php.

display_dom

(

$

root

)

Display the dom.

Definition at line 1476 of file muster_simplewiki_parser.php.

display_dom_add_child	(	$	node,
		&$	childarray
	)		[protected]

Support for display the dom.

See also:

display_dom

Definition at line 1488 of file muster_simplewiki_parser.php.

display_regex

(

)

Display the regex assemblies.

Definition at line 1451 of file muster_simplewiki_parser.php.

get_decoration

(

$

decorator_string

)

gets common argument structure for decorators and block declarations.

Parameters:

string

$decorator_string

the string found in decorators and block declarations

Returns:

object with attributes, properties, and classes properties, if found

Definition at line 650 of file muster_simplewiki_parser.php.

get_selected_ancestor	(	$	node,
		$	types
	)

get the ancestor node of the passed node that has a type as listed in the second argument Look up the tree (starting with $node) to the first occurence of one of the listed types of nodes or root.

If $node is in the list then the current node is returned.

Parameters:

object	$node	the node requesting the ancestor
array	$types	the types of ancestors being requested

Returns:

object the requested node (could be self)

Definition at line 710 of file muster_simplewiki_parser.php.

markerdata

(

)

Get markerdata from parsed markup.

Gets the markerdata from search of markers on the markup text.

The markerdata->markers array contains an object for each marker, with the properties string name, object decorator integer offset

Returns:

object, with the properties integer markercount, integer textlength (final length of the markup text), array markers

See also:

Muster_SimpleWiki::markerdata

Definition at line 380 of file muster_simplewiki_parser.php.

metadata

(

)

Get metadata from parsed markup.

Gets the metadata from the metadata section of the parsed markup.

Returns:

object, with three possible properties:array classes, object properties, object attributes

See also:

Muster_SimpleWiki::metadata

Definition at line 369 of file muster_simplewiki_parser.php.

parse

(

)

Parse the prepared markup.

Parse preprocesses the raw markup, then calls the internal parse_block routine.

Returns:

object Document Node of the root DOM node

Definition at line 439 of file muster_simplewiki_parser.php.

prepare

(

$

markup

)

Prepares the text for processing.

Creates node SimpleWiki_DocNode::DOCUMENT.

Parameters:

string

$markup

(markup text)

Returns:

object $this (so the method can be chained)

This method creates the root document node (SimpleWiki_DocNode), and initializes the parser with the root node, the current node, and the leaftextnode.

Is called by constructor for any markup passed on creation, or can be called separately for iterative parsiong. $todo move preprocess_markup to prepare

Definition at line 424 of file muster_simplewiki_parser.php.

preprocess_markerdata

(

$

matches

)

[protected]

preprocess marker data.

Find {{##markername markedecoration##}} markers, remove them, and collect data about them including offsets.

Parameters:

array

$matches

as returned from preg_replace_callback

Returns:

text without the markers

See also:

markerdata

Definition at line 608 of file muster_simplewiki_parser.php.

preprocess_metadata

(

$

matches

)

[protected]

preprocess metadata.

Remove line continuation characters, and store metadata structure in _metadata property.

Parameters:

array

$matches

from preg_replace_callback

Returns:

string '' removes metadata from markup to be processed

See also:

preprocess_raw_markup

Definition at line 637 of file muster_simplewiki_parser.php.

preprocess_raw_markup

(

$

raw

)

[protected]

pre process the markup.

• capture the metadata from the first line, if present.
• remove comments
• remove line continuations

  Parameters:

  string

  $raw

  source markup

  Returns:

  string preprocessed markup

Definition at line 572 of file muster_simplewiki_parser.php.

preprocessed_markup

(

)

Get preprocessed markup, before parsing.

Preprocessed markup has metadata, comments, line coninuations, and markers removed.

Returns:

string, the preprocessed markup

See also:

Muster_SimpleWiki::preprocessed_markup

Definition at line 389 of file muster_simplewiki_parser.php.

set_node_decoration	(	$	node,
		$	decorator_string
	)		[protected]

parse decorator and declaration arguments from string to structure into a node.

Parameters:

object	$node	the node having the decoration
string	$decorator_string	the pre-parsed string containing the argument data

Returns:

void

Definition at line 694 of file muster_simplewiki_parser.php.

---

Field Documentation

$_argchars = '^()' [protected]

character set allowed for decorators (class names, properties and their values, attribuets and their values

Definition at line 65 of file muster_simplewiki_parser.php.

$_curnode [protected]

the current node being processed

Definition at line 53 of file muster_simplewiki_parser.php.

$_leaftextnode [protected]

the leaftextnode, which holds presentation text (no markup), and is alwasy of type SimpleWiki_DocNode::TEXT

Definition at line 55 of file muster_simplewiki_parser.php.

$_markerdata [protected]

from preprocessing, an object with textlength, markercount, markers

Definition at line 70 of file muster_simplewiki_parser.php.

$_markers [protected]

Transient: from preprocessing, an array with marker objects, later folded into _markerdata.

Each marker object contains offset, name, decoration. Marker objects are indexed through integer in order, as well as by name index

Definition at line 74 of file muster_simplewiki_parser.php.

$_metadata [protected]

metadata object possibly generated from first line of markup ("```## ...")

Definition at line 68 of file muster_simplewiki_parser.php.

$_pre_count = 0 [protected]

count to include in generated preformatted marker identifier

Definition at line 515 of file muster_simplewiki_parser.php.

$_pre_markers = array() [protected]

markers to replace preformatted data

Definition at line 511 of file muster_simplewiki_parser.php.

$_pre_markup = array() [protected]

preformatted element markup, matching markers

Definition at line 513 of file muster_simplewiki_parser.php.

$_preprocessed_raw [protected]

the original souce text after preprocessing, but before parsing

Definition at line 63 of file muster_simplewiki_parser.php.

$_raw [protected]

the original souce text to be processed

Definition at line 61 of file muster_simplewiki_parser.php.

$_root [protected]

the root document node

Definition at line 57 of file muster_simplewiki_parser.php.

$_rules [protected]

object containing rules which combine into applied regular expressions

Definition at line 46 of file muster_simplewiki_parser.php.

$_tablerow_count = 0 [protected]

count to include in generated tablerow marker identifier

Definition at line 539 of file muster_simplewiki_parser.php.

$_tablerow_markers = array() [protected]

structure to set aside row contents before parsing row structure itself

Definition at line 535 of file muster_simplewiki_parser.php.

$_tablerow_markup = array() [protected]

tablerow element markup, matching markers

Definition at line 537 of file muster_simplewiki_parser.php.

$block_re [protected]

block parse

Definition at line 47 of file muster_simplewiki_parser.php.

$cell_re [protected]

quick table cell parse

Definition at line 42 of file muster_simplewiki_parser.php.

$decorator_re [protected]

parse anything's decorator arguments

Definition at line 43 of file muster_simplewiki_parser.php.

$defitem_inline_re [protected]

definition inline item parse

Definition at line 41 of file muster_simplewiki_parser.php.

$image_inline_re [protected]

image inline parse

Definition at line 39 of file muster_simplewiki_parser.php.

$inline_re [protected]

inline parse

Definition at line 48 of file muster_simplewiki_parser.php.

$item_inline_re [protected]

list inline item parse

Definition at line 40 of file muster_simplewiki_parser.php.

$link_inline_re [protected]

Object that holds basic rules to be combined into applied regular expressions.

See also:

_set_rules link inline parse

Definition at line 38 of file muster_simplewiki_parser.php.

$pre_escape_re [protected]

remove escape from pre

Definition at line 45 of file muster_simplewiki_parser.php.

$tablerow_setaside_re [protected]

setaside for table row

Definition at line 44 of file muster_simplewiki_parser.php.

---

The documentation for this class was generated from the following file:

• muster_simplewiki_parser.php