array $_charactersAllowed = array () (line 169)

Characters currently allowed

Note that this will only be evaluated in loop mode; in search mode this would ruin every performance increase. Note that only single characters are permitted here, no strings. Please also note that in loop mode, StringParser::_charactersSearch is evaluated before this variable.

If in strict mode, parsing is stopped if a character that is not allowed is encountered. If not in strict mode, the character is simply ignored.

• access: protected

integer $_cpos = -1 (line 109)

Current position in raw text

• access: protected

int $_parserMode = STRINGPARSER_MODE_SEARCH (line 88)

String parser mode

There are two possible modes: searchmode and loop mode. In loop mode every single character is looked at in a loop and it is then decided what action to take. This is the most straight-forward approach to string parsing but due to the nature of PHP as a scripting language, it can also cost performance. In search mode the class posseses a list of relevant characters for parsing and uses the http://www.php.net/strpos function to search for the next relevant character. The search mode will be faster than the loop mode in most circumstances but it is also more difficult to implement. The subclass that does the string parsing itself will define which mode it will implement.

• see: STRINGPARSER_MODE_SEARCH, STRINGPARSER_MODE_LOOP
• access: protected

• StringParser_BBCode::$_parserMode : String parser mode

array $_postfilters = array () (line 190)

Postfilters

• access: protected

bool $_recentlyReparsed = false (line 197)

Recently reparsed?

• access: protected

array $_stack = array () (line 102)

Parse stack

• access: protected

string $_text = '' (line 95)

Raw text

• access: protected

addFilter (line 216)

Add a filter

• see: STRINGPARSER_FILTER_PRE, STRINGPARSER_FILTER_POST
• access: public

• int $type: The type of the filter
• mixed $callback: The callback to call

parse (line 272)

This function parses the text

• return: Either the root object of the tree if no output method is defined, the tree reoutput to e.g. a string or false if an internal error occured, such as a parse error if in strict mode or the object is already parsing a text.
• access: public

• string $text: The text to parse

_appendToLastTextChild (line 681)

Append text to last text child of current top parser stack node

• return: On success, the function returns true, else false
• access: protected

• string $text: The text to append

_applyPrefilters (line 380)

Apply prefilters

It is possible to specify prefilters for the parser to do some manipulating of the string beforehand.

_handleStatus (line 526)

Abstract method: Handle status

• access: protected

• int $status: The current status
• string $needle: The needle that was found

• StringParser_BBCode::_handleStatus() : Handle status

_modifyTree (line 415)

Abstract method: Manipulate the tree

• access: protected

• StringParser_BBCode::_modifyTree() : Abstract method: Manipulate the tree

_parserInit (line 501)

Abstract method: Initialize the parser

• access: protected

_pushNode (line 749)

Adds a node to the current parse stack

• return: True on success, else false.
• see: StringParser_Node, StringParser::_stack
• access: protected

• object $node: The node that is to be added

_searchLoop (line 537)

Search mode loop

• access: protected

_strDetect (line 730)

Detects a string at the current position

• return: The string that was detected or the needle
• access: protected

• array $needles: The strings that are to be detected
• int $offset: The current offset

_topNode (line 778)

Execute a method on the top element

• access: protected