[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: phpDocumentor_XML_Beautifier_Tokenizer

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converters/XML/DocBook/peardoc2/Tokenizer.php

Class Overview


Highlights source code using parse()



Inherited Variables

Inherited Methods

Class Details

[line 50]
Highlights source code using parse()

[ Top ]

Class Variables

$eventHandlers = array(
                                PHPDOC_XMLTOKEN_EVENT_NOEVENTS => 'normalHandler',
                                PHPDOC_XMLTOKEN_EVENT_XML => 'parseXMLHandler',
                                PHPDOC_XMLTOKEN_EVENT_PI => 'parsePiHandler',
                                PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE => 'attrHandler',
                                PHPDOC_XMLTOKEN_EVENT_OPENTAG => 'tagHandler',
                                PHPDOC_XMLTOKEN_EVENT_IN_CDATA => 'realcdataHandler',
                                PHPDOC_XMLTOKEN_EVENT_DEF => 'defHandler',
                                PHPDOC_XMLTOKEN_EVENT_CLOSETAG => 'closetagHandler',
                                PHPDOC_XMLTOKEN_EVENT_ENTITY => 'entityHandler',
                                PHPDOC_XMLTOKEN_EVENT_COMMENT => 'commentHandler',
                                PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE => 'stringHandler',
                                PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE => 'stringHandler',
                                PHPDOC_XMLTOKEN_EVENT_CDATA => 'parseCdataHandler',

[line 64]

Type:   array

[ Top ]

Method Detail

phpDocumentor_XML_Beautifier_Tokenizer (Constructor)   [line 570]

phpDocumentor_XML_Beautifier_Tokenizer phpDocumentor_XML_Beautifier_Tokenizer( )

Initialize the $tokenpushEvent, $wordpushEvent arrays

[ Top ]

checkEventPop   [line 535]

mixed checkEventPop( $word, $pevent)

this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
  • Return: returns false, or the event number popped off of the stack



[ Top ]

checkEventPush   [line 513]

mixed checkEventPush( $word, $pevent)

this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
  • Return: returns false, or the event number



[ Top ]

configWordParser   [line 504]

void configWordParser( $value $e)

tell the parser's WordParser $wp to set up tokens to parse words by.

tokens are word separators. In English, a space or punctuation are examples of tokens. In PHP, a token can be a ;, a parenthesis, or even the word "function"


$value   $e     integer an event number

[ Top ]

getParserEventName   [line 661]

void getParserEventName( $value)



[ Top ]

incdataHandler   [line 408]

void incdataHandler( object XML $parser, string $cdata)

Handler for real character data
  • Access: protected


object XML   $parser     parser object
string   $cdata     CDATA

[ Top ]

parseString   [line 108]

bool parseString( string $parse_data, Converter 1, false|string 2, false|integer 3)

Parse a new file

The parse() method is a do...while() loop that retrieves tokens one by one from the $_event_stack, and uses the token event array set up by the class constructor to call event handlers.

The event handlers each process the tokens passed to them, and use the _addoutput() method to append the processed tokens to the $_line variable. The word parser calls newLineNum() every time a line is reached.

In addition, the event handlers use special linking functions _link() and its cousins (_classlink(), etc.) to create in-code hyperlinks to the documentation for source code elements that are in the source code.


Converter   1     
false|string   2     full path to file with @filesource tag, if this is a @filesource parse
false|integer   3     starting line number from {@source linenum}
string   $parse_data     

[ Top ]

setupStates   [line 553]

void setupStates( boolean $parsedata, false|string 1)

Initialize all parser state variables


false|string   1     name of class we are going to start from
boolean   $parsedata     true if we are highlighting an inline {@source} tag's output

[ Top ]

Documentation generated on Sun, 02 Sep 2012 00:03:17 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.