WikiParser Class Reference

List of all members.

Detailed Description

Definition at line 29 of file class.WikiParser.php.

Public Member Functions

 WikiParser ()
 parse_file ($filename)
 parse_string ($str)
 parse_lines ($arr_lines)
 parse_text ()
 parse the text wiki
 parse_paragraph ()
 parse_block ()
 parse_info ()
 parse_list ()
 parse_listitem ($mark)
 get_current_line ()
 get the current line that is being parsed
 end_of_lines ()
 return true if the index is at the end of the lines
 next_line ()
 move the index to the nex line
 append_line (&$tpl, $line='UNDEFINED')
 append the current line to the given template
 link_template (&$parent, $child)
 add a link from the parent template to the child template
 empty_line ()
 nonempty_line ()
 block_start ()
 block_end ()
 get_listitem_mark ()
 get_indentation ($mark)
 return the indentaion of the given mark
 get_bullet ($mark)
 return the bullet of the given mark
 list_start ($mark='')
 return true if the current line starts a new list
 list_end ($mark)
 listitem_start ($mark)
 listitem_end ($mark)
 template_list ()
 (debug) Outputs the data of each template in $tpl_collection.
 tpl_to_tree ()
 (debug) Returns the structure of the loaded templates as a tree.
 to_tree ($tpl, $indent)
 Returns the structure of loaded templates as a tree.

Public Attributes

 $arr_lines
 lines that will be parsed and their index
 $idx


Member Function Documentation

WikiParser::WikiParser (  ) 

Definition at line 35 of file class.WikiParser.php.

References $tpl_collection.

WikiParser::parse_file ( filename  ) 

Definition at line 44 of file class.WikiParser.php.

References $arr_lines, and parse_lines().

WikiParser::parse_string ( str  ) 

Definition at line 57 of file class.WikiParser.php.

References $arr_lines, and parse_lines().

WikiParser::parse_lines ( arr_lines  ) 

Definition at line 69 of file class.WikiParser.php.

References $arr_lines, $tpl_collection, and parse_text().

Referenced by parse_file(), and parse_string().

WikiParser::parse_text (  ) 

parse the text wiki

Definition at line 82 of file class.WikiParser.php.

References block_start(), end_of_lines(), link_template(), list_start(), next_line(), nonempty_line(), parse_block(), parse_list(), and parse_paragraph().

Referenced by parse_lines().

WikiParser::parse_paragraph (  ) 

Definition at line 110 of file class.WikiParser.php.

References append_line(), block_start(), end_of_lines(), link_template(), list_start(), next_line(), nonempty_line(), parse_block(), and parse_list().

Referenced by parse_text().

WikiParser::parse_block (  ) 

Definition at line 139 of file class.WikiParser.php.

References append_line(), block_end(), block_start(), end_of_lines(), get_current_line(), link_template(), list_start(), next_line(), and parse_list().

Referenced by parse_info(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::parse_info (  ) 

Definition at line 176 of file class.WikiParser.php.

References append_line(), block_end(), block_start(), end_of_lines(), get_current_line(), link_template(), list_start(), next_line(), parse_block(), and parse_list().

WikiParser::parse_list (  ) 

Definition at line 216 of file class.WikiParser.php.

References end_of_lines(), get_bullet(), get_indentation(), get_listitem_mark(), link_template(), list_end(), listitem_start(), and parse_listitem().

Referenced by parse_block(), parse_info(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::parse_listitem ( mark  ) 

Definition at line 237 of file class.WikiParser.php.

References append_line(), block_start(), empty_line(), end_of_lines(), get_current_line(), link_template(), list_start(), listitem_end(), next_line(), parse_block(), and parse_list().

Referenced by parse_list().

WikiParser::get_current_line (  ) 

get the current line that is being parsed

Definition at line 276 of file class.WikiParser.php.

Referenced by append_line(), block_end(), block_start(), empty_line(), get_listitem_mark(), list_end(), listitem_end(), nonempty_line(), parse_block(), parse_info(), and parse_listitem().

WikiParser::end_of_lines (  ) 

return true if the index is at the end of the lines

Definition at line 283 of file class.WikiParser.php.

Referenced by parse_block(), parse_info(), parse_list(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::next_line (  ) 

move the index to the nex line

Definition at line 290 of file class.WikiParser.php.

Referenced by list_end(), parse_block(), parse_info(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::append_line ( &$  tpl,
line = 'UNDEFINED' 
)

append the current line to the given template

Definition at line 296 of file class.WikiParser.php.

References get_current_line().

Referenced by parse_block(), parse_info(), parse_listitem(), and parse_paragraph().

WikiParser::link_template ( &$  parent,
child 
)

add a link from the parent template to the child template

Definition at line 303 of file class.WikiParser.php.

References $tpl_collection.

Referenced by parse_block(), parse_info(), parse_list(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::empty_line (  ) 

Definition at line 312 of file class.WikiParser.php.

References get_current_line().

Referenced by parse_listitem().

WikiParser::nonempty_line (  ) 

Definition at line 318 of file class.WikiParser.php.

References get_current_line().

Referenced by parse_paragraph(), and parse_text().

WikiParser::block_start (  ) 

Definition at line 324 of file class.WikiParser.php.

References get_current_line().

Referenced by parse_block(), parse_info(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::block_end (  ) 

Definition at line 334 of file class.WikiParser.php.

References get_current_line().

Referenced by parse_block(), and parse_info().

WikiParser::get_listitem_mark (  ) 

Definition at line 340 of file class.WikiParser.php.

References get_current_line().

Referenced by list_end(), list_start(), listitem_end(), listitem_start(), and parse_list().

WikiParser::get_indentation ( mark  ) 

return the indentaion of the given mark

Definition at line 349 of file class.WikiParser.php.

Referenced by list_end(), list_start(), listitem_end(), and parse_list().

WikiParser::get_bullet ( mark  ) 

return the bullet of the given mark

Definition at line 356 of file class.WikiParser.php.

Referenced by parse_list().

WikiParser::list_start ( mark = ''  ) 

return true if the current line starts a new list

Definition at line 363 of file class.WikiParser.php.

References get_indentation(), and get_listitem_mark().

Referenced by parse_block(), parse_info(), parse_listitem(), parse_paragraph(), and parse_text().

WikiParser::list_end ( mark  ) 

Definition at line 392 of file class.WikiParser.php.

References get_current_line(), get_indentation(), get_listitem_mark(), and next_line().

Referenced by parse_list().

WikiParser::listitem_start ( mark  ) 

Definition at line 435 of file class.WikiParser.php.

References get_listitem_mark().

Referenced by parse_list().

WikiParser::listitem_end ( mark  ) 

Definition at line 450 of file class.WikiParser.php.

References get_current_line(), get_indentation(), and get_listitem_mark().

Referenced by parse_listitem().

WikiParser::template_list (  ) 

(debug) Outputs the data of each template in $tpl_collection.

Definition at line 498 of file class.WikiParser.php.

References $tpl_collection.

WikiParser::tpl_to_tree (  ) 

(debug) Returns the structure of the loaded templates as a tree.

Definition at line 523 of file class.WikiParser.php.

References $tpl_collection, and to_tree().

WikiParser::to_tree ( tpl,
indent 
)

Returns the structure of loaded templates as a tree.

Definition at line 537 of file class.WikiParser.php.

References $tpl_collection.

Referenced by tpl_to_tree().


Member Data Documentation

WikiParser::$arr_lines

lines that will be parsed and their index

Definition at line 32 of file class.WikiParser.php.

Referenced by parse_file(), parse_lines(), and parse_string().

WikiParser::$idx

Definition at line 33 of file class.WikiParser.php.


Generated on Wed Jan 9 08:27:52 2008 for DokBookWiki by  doxygen 1.5.2